refactor(x/**)!: genesis return errors

tests/integration/gov/genesis_test.go

@@ -102,8 +102,10 @@ func TestImportExportQueues(t *testing.T) {
 
 	authGenState, err := s1.AccountKeeper.ExportGenesis(ctx)
 	require.NoError(t, err)
-	bankGenState := s1.BankKeeper.ExportGenesis(ctx)
-	stakingGenState := s1.StakingKeeper.ExportGenesis(ctx)
+	bankGenState, err := s1.BankKeeper.ExportGenesis(ctx)
+	require.NoError(t, err)
+	stakingGenState, err := s1.StakingKeeper.ExportGenesis(ctx)
+	require.NoError(t, err)
 
 	// export the state and import it into a new app
 	govGenState, _ := gov.ExportGenesis(ctx, s1.GovKeeper)

tests/integration/staking/keeper/genesis_test.go

@@ -98,9 +98,11 @@ func TestInitGenesis(t *testing.T) {
 	delegations = append(delegations, genesisDelegations...)
 
 	genesisState := types.NewGenesisState(params, validators, delegations)
-	vals := (f.stakingKeeper.InitGenesis(f.sdkCtx, genesisState))
+	vals, err := (f.stakingKeeper.InitGenesis(f.sdkCtx, genesisState))
+	assert.NilError(t, err)
 
-	actualGenesis := (f.stakingKeeper.ExportGenesis(f.sdkCtx))
+	actualGenesis, err := (f.stakingKeeper.ExportGenesis(f.sdkCtx))
+	assert.NilError(t, err)
 	assert.DeepEqual(t, genesisState.Params, actualGenesis.Params)
 	assert.DeepEqual(t, genesisState.Delegations, actualGenesis.Delegations)
 
@@ -157,27 +159,23 @@ func TestInitGenesis_PoolsBalanceMismatch(t *testing.T) {
 		BondDenom:     "stake",
 	}
 
-	require.Panics(t, func() {
-		// setting validator status to bonded so the balance counts towards bonded pool
-		validator.Status = types.Bonded
-		f.stakingKeeper.InitGenesis(f.sdkCtx, &types.GenesisState{
-			Params:     params,
-			Validators: []types.Validator{validator},
-		})
-	},
-	// "should panic because bonded pool balance is different from bonded pool coins",
-	)
-
-	require.Panics(t, func() {
-		// setting validator status to unbonded so the balance counts towards not bonded pool
-		validator.Status = types.Unbonded
-		f.stakingKeeper.InitGenesis(f.sdkCtx, &types.GenesisState{
-			Params:     params,
-			Validators: []types.Validator{validator},
-		})
-	},
+	// setting validator status to bonded so the balance counts towards bonded pool
+	validator.Status = types.Bonded
+	_, err = f.stakingKeeper.InitGenesis(f.sdkCtx, &types.GenesisState{
+		Params:     params,
+		Validators: []types.Validator{validator},
+	})
+	// "should error because bonded pool balance is different from bonded pool coins",
+	require.NotNil(t, err)
+
+	// setting validator status to unbonded so the balance counts towards not bonded pool
+	validator.Status = types.Unbonded
+	_, err = f.stakingKeeper.InitGenesis(f.sdkCtx, &types.GenesisState{
+		Params:     params,
+		Validators: []types.Validator{validator},
+	})
 	// "should panic because not bonded pool balance is different from not bonded pool coins",
-	)
+	require.NotNil(t, err)
 }
 
 func TestInitGenesisLargeValidatorSet(t *testing.T) {
@@ -228,7 +226,8 @@ func TestInitGenesisLargeValidatorSet(t *testing.T) {
 		),
 	)
 
-	vals := f.stakingKeeper.InitGenesis(f.sdkCtx, genesisState)
+	vals, err := f.stakingKeeper.InitGenesis(f.sdkCtx, genesisState)
+	assert.NilError(t, err)
 
 	abcivals := make([]abci.ValidatorUpdate, 100)
 	for i, val := range validators[:100] {

types/module/core_module.go

@@ -95,7 +95,7 @@ func (c coreAppModuleAdaptor) ValidateGenesis(bz json.RawMessage) error {
 }
 
 // ExportGenesis implements HasGenesis
-func (c coreAppModuleAdaptor) ExportGenesis(ctx context.Context) json.RawMessage {
+func (c coreAppModuleAdaptor) ExportGenesis(ctx context.Context) (json.RawMessage, error) {
 	if module, ok := c.module.(appmodule.HasGenesisAuto); ok {
 		ctx := sdk.UnwrapSDKContext(ctx).WithGasMeter(storetypes.NewInfiniteGasMeter()) // avoid race conditions
 		target := genesis.RawJSONTarget{}
@@ -106,39 +106,43 @@ func (c coreAppModuleAdaptor) ExportGenesis(ctx context.Context) json.RawMessage
 
 		rawJSON, err := target.JSON()
 		if err != nil {
-			panic(err)
+			return nil, err
 		}
 
-		return rawJSON
+		return rawJSON, nil
 	}
 
 	if mod, ok := c.module.(HasABCIGenesis); ok {
-		return mod.ExportGenesis(ctx)
+		eg, err := mod.ExportGenesis(ctx)
+		if err != nil {
+			return nil, err
+		}
+		return eg, nil
 	}
 
 	if mod, ok := c.module.(HasGenesis); ok {
 		eg, err := mod.ExportGenesis(ctx)
 		if err != nil {
-			panic(err)
+			return nil, err
 		}
-		return eg
+		return eg, nil
 	}
 
-	return nil
+	return nil, nil
 }
 
 // InitGenesis implements HasGenesis
-func (c coreAppModuleAdaptor) InitGenesis(ctx context.Context, bz json.RawMessage) []abci.ValidatorUpdate {
+func (c coreAppModuleAdaptor) InitGenesis(ctx context.Context, bz json.RawMessage) ([]abci.ValidatorUpdate, error) {
 	if module, ok := c.module.(appmodule.HasGenesisAuto); ok {
 		// core API genesis
 		source, err := genesis.SourceFromRawJSON(bz)
 		if err != nil {
-			panic(err)
+			return nil, err
 		}
 
 		err = module.InitGenesis(ctx, source)
 		if err != nil {
-			panic(err)
+			return nil, err
 		}
 	}
 
@@ -149,11 +153,11 @@ func (c coreAppModuleAdaptor) InitGenesis(ctx context.Context, bz json.RawMessag
 	if mod, ok := c.module.(HasGenesis); ok {
 		err := mod.InitGenesis(ctx, bz)
 		if err != nil {
-			panic(err)
+			return nil, err
 		}
 
 	}
-	return nil
+	return nil, nil
 }
 
 // Name implements HasName

types/module/module.go

@@ -98,8 +98,8 @@ type HasGenesis = appmodulev2.HasGenesis
 // HasABCIGenesis is the extension interface for stateful genesis methods which returns validator updates.
 type HasABCIGenesis interface {
 	HasGenesisBasics
-	InitGenesis(context.Context, json.RawMessage) []abci.ValidatorUpdate
-	ExportGenesis(context.Context) json.RawMessage
+	InitGenesis(context.Context, json.RawMessage) ([]abci.ValidatorUpdate, error)
+	ExportGenesis(context.Context) (json.RawMessage, error)
 }
 
 // HasInvariants is the interface for registering invariants.
@@ -454,8 +454,10 @@ func (m *Manager) InitGenesis(ctx sdk.Context, _ codec.JSONCodec, genesisData ma
 			}
 		} else if module, ok := mod.(HasABCIGenesis); ok {
 			ctx.Logger().Debug("running initialization for module", "module", moduleName)
-			moduleValUpdates := module.InitGenesis(ctx, genesisData[moduleName])
-
+			moduleValUpdates, err := module.InitGenesis(ctx, genesisData[moduleName])
+			if err != nil {
+				return &abci.ResponseInitChain{}, err
+			}
 			// use these validator updates if provided, the module manager assumes
 			// only one module will update the validator set
 			if len(moduleValUpdates) > 0 {
@@ -534,8 +536,14 @@ func (m *Manager) ExportGenesisForModules(ctx sdk.Context, modulesToExport []str
 		} else if module, ok := mod.(HasABCIGenesis); ok {
 			channels[moduleName] = make(chan genesisResult)
 			go func(module HasABCIGenesis, ch chan genesisResult) {
-				ctx := ctx.WithGasMeter(storetypes.NewInfiniteGasMeter()) // avoid race conditions
-				ch <- genesisResult{module.ExportGenesis(ctx), nil}
+				ctx := ctx.WithGasMeter(storetypes.NewInfiniteGasMeter())
+				exportGenesis, err := module.ExportGenesis(ctx)
+				if err != nil {
+					ch <- genesisResult{nil, err}
+				} else {
+					// avoid race conditions
+					ch <- genesisResult{exportGenesis, nil}
+				}
 			}(module, channels[moduleName])
 		}
 	}
@@ -688,7 +696,10 @@ func (m Manager) RunMigrations(ctx context.Context, cfg Configurator, fromVM Ver
 				}
 			}
 			if module, ok := m.Modules[moduleName].(HasABCIGenesis); ok {
-				moduleValUpdates := module.InitGenesis(sdkCtx, module.DefaultGenesis())
+				moduleValUpdates, err := module.InitGenesis(sdkCtx, module.DefaultGenesis())
+				if err != nil {
+					return nil, err
+				}
 				// The module manager assumes only one module will update the
 				// validator set, and it can't be a new module.
 				if len(moduleValUpdates) > 0 {

x/authz/CHANGELOG.md

@@ -35,7 +35,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * [#19490](https://github.com/cosmos/cosmos-sdk/pull/19490) `appmodule.Environment` is received on the Keeper to get access to different application services.
 * [#18737](https://github.com/cosmos/cosmos-sdk/pull/18737) Update the keeper method `DequeueAndDeleteExpiredGrants` to take a limit argument for the number of grants to prune.
 * [#16509](https://github.com/cosmos/cosmos-sdk/pull/16509) `AcceptResponse` has been moved to sdk/types/authz and the `Updated` field is now of the type `sdk.Msg` instead of `authz.Authorization`.
-
+* [#19740](https://github.com/cosmos/cosmos-sdk/pull/19740) Verify `InitGenesis` and `ExportGenesis` module code and keeper code do not panic.
 ### Consensus Breaking Changes
 
 * [#19188](https://github.com/cosmos/cosmos-sdk/pull/19188) Remove creation of `BaseAccount` when sending a message to an account that does not exist.

x/authz/keeper/genesis.go

@@ -2,6 +2,7 @@ package keeper
 
 import (
 	"context"
+	"fmt"
 
 	"cosmossdk.io/x/authz"
 
@@ -28,7 +29,7 @@ func (k Keeper) InitGenesis(ctx context.Context, data *authz.GenesisState) error
 
 		a, ok := entry.Authorization.GetCachedValue().(authz.Authorization)
 		if !ok {
-			panic("expected authorization")
+			return fmt.Errorf("expected authorization")
 		}
 
 		err = k.SaveGrant(ctx, grantee, granter, a, entry.Expiration)

x/bank/CHANGELOG.md

@@ -38,6 +38,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * [#17569](https://github.com/cosmos/cosmos-sdk/pull/17569) `BurnCoins` takes an address instead of a module name
 * [#19477](https://github.com/cosmos/cosmos-sdk/pull/19477) `appmodule.Environment` is passed to bank `NewKeeper`
 * [#19627](https://github.com/cosmos/cosmos-sdk/pull/19627) The genesis api has been updated to match `appmodule.HasGenesis`.
+* [#19740](https://github.com/cosmos/cosmos-sdk/pull/19740) Verify `InitGenesis` and `ExportGenesis` module code and keeper code do not panic.
 
 ### Consensus Breaking Changes
 

x/bank/keeper/genesis.go

@@ -57,10 +57,10 @@ func (k BaseKeeper) InitGenesis(ctx context.Context, genState *types.GenesisStat
 }
 
 // ExportGenesis returns the bank module's genesis state.
-func (k BaseKeeper) ExportGenesis(ctx context.Context) *types.GenesisState {
+func (k BaseKeeper) ExportGenesis(ctx context.Context) (*types.GenesisState, error) {
 	totalSupply, _, err := k.GetPaginatedTotalSupply(ctx, &query.PageRequest{Limit: query.PaginationMaxLimit})
 	if err != nil {
-		panic(fmt.Errorf("unable to fetch total supply %v", err))
+		return nil, fmt.Errorf("unable to fetch total supply %v", err)
 	}
 
 	rv := types.NewGenesisState(
@@ -70,5 +70,5 @@ func (k BaseKeeper) ExportGenesis(ctx context.Context) *types.GenesisState {
 		k.GetAllDenomMetaData(ctx),
 		k.GetAllSendEnabledEntries(ctx),
 	)
-	return rv
+	return rv, nil
 }

x/bank/keeper/genesis_test.go

@@ -38,7 +38,8 @@ func (suite *KeeperTestSuite) TestExportGenesis() {
 
 	suite.Require().NoError(suite.bankKeeper.SetParams(ctx, types.DefaultParams()))
 
-	exportGenesis := suite.bankKeeper.ExportGenesis(ctx)
+	exportGenesis, err := suite.bankKeeper.ExportGenesis(ctx)
+	suite.Require().NoError(err)
 
 	suite.Require().Len(exportGenesis.Params.SendEnabled, 0) //nolint:staticcheck // we're testing the old way here
 	suite.Require().Equal(types.DefaultParams().DefaultSendEnabled, exportGenesis.Params.DefaultSendEnabled)

x/bank/keeper/keeper.go

@@ -27,7 +27,7 @@ type Keeper interface {
 	WithMintCoinsRestriction(types.MintingRestrictionFn) BaseKeeper
 
 	InitGenesis(context.Context, *types.GenesisState) error
-	ExportGenesis(context.Context) *types.GenesisState
+	ExportGenesis(context.Context) (*types.GenesisState, error)
 
 	GetSupply(ctx context.Context, denom string) sdk.Coin
 	HasSupply(ctx context.Context, denom string) bool

x/bank/module.go

@@ -145,7 +145,10 @@ func (am AppModule) InitGenesis(ctx context.Context, data json.RawMessage) error
 // ExportGenesis returns the exported genesis state as raw bytes for the bank
 // module.
 func (am AppModule) ExportGenesis(ctx context.Context) (json.RawMessage, error) {
-	gs := am.keeper.ExportGenesis(ctx)
+	gs, err := am.keeper.ExportGenesis(ctx)
+	if err != nil {
+		return nil, err
+	}
 	return am.cdc.MarshalJSON(gs)
 }
 

x/crisis/keeper/genesis.go

@@ -14,10 +14,10 @@ func (k *Keeper) InitGenesis(ctx context.Context, data *types.GenesisState) {
 }
 
 // ExportGenesis returns a GenesisState for a given context and keeper.
-func (k *Keeper) ExportGenesis(ctx context.Context) *types.GenesisState {
+func (k *Keeper) ExportGenesis(ctx context.Context) (*types.GenesisState, error) {
 	constantFee, err := k.ConstantFee.Get(ctx)
 	if err != nil {
-		panic(err)
+		return nil, err
 	}
-	return types.NewGenesisState(constantFee)
+	return types.NewGenesisState(constantFee), nil
 }

x/crisis/keeper/genesis_test.go

@@ -55,15 +55,17 @@ func (s *GenesisTestSuite) TestImportExportGenesis() {
 	constantFee := sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(1000))
 	err := s.keeper.ConstantFee.Set(s.sdkCtx, constantFee)
 	s.Require().NoError(err)
-	genesis := s.keeper.ExportGenesis(s.sdkCtx)
+	genesis, err := s.keeper.ExportGenesis(s.sdkCtx)
+	s.Require().NoError(err)
 
 	// set constant fee to zero
 	constantFee = sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(0))
 	err = s.keeper.ConstantFee.Set(s.sdkCtx, constantFee)
 	s.Require().NoError(err)
 
 	s.keeper.InitGenesis(s.sdkCtx, genesis)
-	newGenesis := s.keeper.ExportGenesis(s.sdkCtx)
+	newGenesis, err := s.keeper.ExportGenesis(s.sdkCtx)
+	s.Require().NoError(err)
 	s.Require().Equal(genesis, newGenesis)
 }