fix(types): add fallbacks for CoreAppModuleBasicAdaptor (#16010)

julienrbrt · web-flow · commit b5c77d64521c · 2023-05-03T17:45:54.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Features
 
+* (types) [#15958](https://github.com/cosmos/cosmos-sdk/pull/15958) Add `module.NewBasicManagerFromManager` for creating a basic module manager from a module manager.
 * (runtime) [#15818](https://github.com/cosmos/cosmos-sdk/pull/15818) Provide logger through `depinject` instead of appBuilder.
 * (client) [#15597](https://github.com/cosmos/cosmos-sdk/pull/15597) Add status endpoint for clients.
 * (testutil/integration) [#15556](https://github.com/cosmos/cosmos-sdk/pull/15556) Introduce `testutil/integration` package for module integration testing.
@@ -68,6 +69,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
+* (simapp) [#15958](https://github.com/cosmos/cosmos-sdk/pull/15958) Refactor SimApp for removing the global basic manager.
 * (gov) [#15979](https://github.com/cosmos/cosmos-sdk/pull/15979) Improve gov error message when failing to convert v1 proposal to v1beta1.
 * (crypto) [#3129](https://github.com/cosmos/cosmos-sdk/pull/3129) New armor and keyring key derivation uses aead and encryption uses chacha20poly
 * (x/slashing) [#15580](https://github.com/cosmos/cosmos-sdk/pull/15580) Refactor the validator's missed block signing window to be a chunked bitmap instead of a "logical" bitmap, significantly reducing the storage footprint.
@@ -201,8 +203,9 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Bug Fixes
 
+* (types) [#16010](https://github.com/cosmos/cosmos-sdk/pull/16010) Let `module.CoreAppModuleBasicAdaptor` fallback to legacy genesis handling.
 * (x/group) [#16017](https://github.com/cosmos/cosmos-sdk/pull/16017) Correctly apply account number in group v2 migration.
-* (types) [#15691](https://github.com/cosmos/cosmos-sdk/pull/15691) Make Coin.Validate() check that .Amount is not nil
+* (types) [#15691](https://github.com/cosmos/cosmos-sdk/pull/15691) Make `Coin.Validate()` check that `.Amount` is not nil.
 * (x/auth) [#15059](https://github.com/cosmos/cosmos-sdk/pull/15059) `ante.CountSubKeys` returns 0 when passing a nil `Pubkey`.
 * (x/capability) [#15030](https://github.com/cosmos/cosmos-sdk/pull/15030) Prevent `x/capability` from consuming `GasMeter` gas during `InitMemStore`
 * (types/coin) [#14739](https://github.com/cosmos/cosmos-sdk/pull/14739) Deprecate the method `Coin.IsEqual` in favour of  `Coin.Equal`. The difference between the two methods is that the first one results in a panic when denoms are not equal. This panic lead to unexpected behavior
diff --git a/errors/CHANGELOG.md b/errors/CHANGELOG.md
@@ -34,11 +34,6 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Features
 
 * [#15989](https://github.com/cosmos/cosmos-sdk/pull/15989) Add `ErrStopIterating` for modules to use for breaking out of iteration.
-
-## v1.0.0
-
-### Features
-
 * [#10779](https://github.com/cosmos/cosmos-sdk/pull/10779) Import code from the `github.com/cosmos/cosmos-sdk/types/errors` package.
 * [#11274](https://github.com/cosmos/cosmos-sdk/pull/11274) Add `RegisterWithGRPCCode` function to associate a gRPC error code with errors.
 
diff --git a/orm/model/ormdb/module.go b/orm/model/ormdb/module.go
@@ -29,13 +29,17 @@ type ModuleDB interface {
 	// GenesisHandler returns an implementation of appmodule.HasGenesis
 	// to be embedded in or called from app module implementations.
 	// Ex:
-	//   type Keeper struct {
+	//   type AppModule struct {
 	//     appmodule.HasGenesis
 	//   }
 	//
 	//   func NewKeeper(db ModuleDB) *Keeper {
-	//     return &Keeper{HasGenesis: db.GenesisHandler()}
+	//     return &Keeper{genesisHandler: db.GenesisHandler()}
 	//   }
+	//
+	//  func NewAppModule(keeper keeper.Keeper) AppModule {
+	//    return AppModule{HasGenesis: keeper.GenesisHandler()}
+	//  }
 	GenesisHandler() appmodule.HasGenesis
 
 	private()
diff --git a/runtime/module.go b/runtime/module.go
@@ -164,11 +164,10 @@ func SetupAppBuilder(inputs AppInputs) {
 			continue
 		}
 
-		if basicMod, ok := mod.(module.AppModuleBasic); ok {
-			app.basicManager[name] = basicMod
-			basicMod.RegisterInterfaces(inputs.InterfaceRegistry)
-			basicMod.RegisterLegacyAminoCodec(inputs.LegacyAmino)
-		}
+		coreAppModuleBasic := module.CoreAppModuleBasicAdaptor(name, mod)
+		app.basicManager[name] = coreAppModuleBasic
+		coreAppModuleBasic.RegisterInterfaces(inputs.InterfaceRegistry)
+		coreAppModuleBasic.RegisterLegacyAminoCodec(inputs.LegacyAmino)
 	}
 }
 
diff --git a/types/module/core_module.go b/types/module/core_module.go
@@ -38,7 +38,7 @@ type coreAppModuleBasicAdapator struct {
 }
 
 // DefaultGenesis implements HasGenesis
-func (c coreAppModuleBasicAdapator) DefaultGenesis(codec.JSONCodec) json.RawMessage {
+func (c coreAppModuleBasicAdapator) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage {
 	if mod, ok := c.module.(appmodule.HasGenesis); ok {
 		target := genesis.RawJSONTarget{}
 		err := mod.DefaultGenesis(target.Target())
@@ -53,6 +53,11 @@ func (c coreAppModuleBasicAdapator) DefaultGenesis(codec.JSONCodec) json.RawMess
 
 		return res
 	}
+
+	if mod, ok := c.module.(HasGenesisBasics); ok {
+		return mod.DefaultGenesis(cdc)
+	}
+
 	return nil
 }
 
@@ -69,6 +74,10 @@ func (c coreAppModuleBasicAdapator) ValidateGenesis(cdc codec.JSONCodec, txConfi
 		}
 	}
 
+	if mod, ok := c.module.(HasGenesisBasics); ok {
+		return mod.ValidateGenesis(cdc, txConfig, bz)
+	}
+
 	return nil
 }
 
@@ -89,11 +98,16 @@ func (c coreAppModuleBasicAdapator) ExportGenesis(ctx sdk.Context, cdc codec.JSO
 
 		return rawJSON
 	}
+
+	if mod, ok := c.module.(HasGenesis); ok {
+		return mod.ExportGenesis(ctx, cdc)
+	}
+
 	return nil
 }
 
 // InitGenesis implements HasGenesis
-func (c coreAppModuleBasicAdapator) InitGenesis(ctx sdk.Context, _ codec.JSONCodec, bz json.RawMessage) []abci.ValidatorUpdate {
+func (c coreAppModuleBasicAdapator) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, bz json.RawMessage) []abci.ValidatorUpdate {
 	if module, ok := c.module.(appmodule.HasGenesis); ok {
 		// core API genesis
 		source, err := genesis.SourceFromRawJSON(bz)
@@ -106,6 +120,11 @@ func (c coreAppModuleBasicAdapator) InitGenesis(ctx sdk.Context, _ codec.JSONCod
 			panic(err)
 		}
 	}
+
+	if mod, ok := c.module.(HasGenesis); ok {
+		return mod.InitGenesis(ctx, cdc, bz)
+	}
+
 	return nil
 }
 
diff --git a/types/module/module.go b/types/module/module.go
@@ -101,6 +101,11 @@ func NewBasicManagerFromManager(manager *Manager, customModuleBasics map[string]
 			continue
 		}
 
+		if appModule, ok := module.(appmodule.AppModule); ok {
+			moduleMap[name] = CoreAppModuleBasicAdaptor(name, appModule)
+			continue
+		}
+
 		if basicMod, ok := module.(AppModuleBasic); ok {
 			moduleMap[name] = basicMod
 		}

Original file line number	Diff line number	Diff line change
`@@ -164,11 +164,10 @@ func SetupAppBuilder(inputs AppInputs) {`
`164`	`164`	`continue`
`165`	`165`	`}`
`166`	`166`
`167`		`- if basicMod, ok := mod.(module.AppModuleBasic); ok {`
`168`		`- app.basicManager[name] = basicMod`
`169`		`- basicMod.RegisterInterfaces(inputs.InterfaceRegistry)`
`170`		`- basicMod.RegisterLegacyAminoCodec(inputs.LegacyAmino)`
`171`		`- }`
	`167`	`+ coreAppModuleBasic := module.CoreAppModuleBasicAdaptor(name, mod)`
	`168`	`+ app.basicManager[name] = coreAppModuleBasic`
	`169`	`+ coreAppModuleBasic.RegisterInterfaces(inputs.InterfaceRegistry)`
	`170`	`+ coreAppModuleBasic.RegisterLegacyAminoCodec(inputs.LegacyAmino)`
`172`	`171`	`}`
`173`	`172`	`}`
`174`	`173`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ type coreAppModuleBasicAdapator struct {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`// DefaultGenesis implements HasGenesis`
`41`		`-func (c coreAppModuleBasicAdapator) DefaultGenesis(codec.JSONCodec) json.RawMessage {`
	`41`	`+func (c coreAppModuleBasicAdapator) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage {`
`42`	`42`	`if mod, ok := c.module.(appmodule.HasGenesis); ok {`
`43`	`43`	`target := genesis.RawJSONTarget{}`
`44`	`44`	`err := mod.DefaultGenesis(target.Target())`
`@@ -53,6 +53,11 @@ func (c coreAppModuleBasicAdapator) DefaultGenesis(codec.JSONCodec) json.RawMess`
`53`	`53`
`54`	`54`	`return res`
`55`	`55`	`}`
	`56`	`+`
	`57`	`+ if mod, ok := c.module.(HasGenesisBasics); ok {`
	`58`	`+ return mod.DefaultGenesis(cdc)`
	`59`	`+ }`
	`60`	`+`
`56`	`61`	`return nil`
`57`	`62`	`}`
`58`	`63`
`@@ -69,6 +74,10 @@ func (c coreAppModuleBasicAdapator) ValidateGenesis(cdc codec.JSONCodec, txConfi`
`69`	`74`	`}`
`70`	`75`	`}`
`71`	`76`
	`77`	`+ if mod, ok := c.module.(HasGenesisBasics); ok {`
	`78`	`+ return mod.ValidateGenesis(cdc, txConfig, bz)`
	`79`	`+ }`
	`80`	`+`
`72`	`81`	`return nil`
`73`	`82`	`}`
`74`	`83`
`@@ -89,11 +98,16 @@ func (c coreAppModuleBasicAdapator) ExportGenesis(ctx sdk.Context, cdc codec.JSO`
`89`	`98`
`90`	`99`	`return rawJSON`
`91`	`100`	`}`
	`101`	`+`
	`102`	`+ if mod, ok := c.module.(HasGenesis); ok {`
	`103`	`+ return mod.ExportGenesis(ctx, cdc)`
	`104`	`+ }`
	`105`	`+`
`92`	`106`	`return nil`
`93`	`107`	`}`
`94`	`108`
`95`	`109`	`// InitGenesis implements HasGenesis`
`96`		`-func (c coreAppModuleBasicAdapator) InitGenesis(ctx sdk.Context, _ codec.JSONCodec, bz json.RawMessage) []abci.ValidatorUpdate {`
	`110`	`+func (c coreAppModuleBasicAdapator) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, bz json.RawMessage) []abci.ValidatorUpdate {`
`97`	`111`	`if module, ok := c.module.(appmodule.HasGenesis); ok {`
`98`	`112`	`// core API genesis`
`99`	`113`	`source, err := genesis.SourceFromRawJSON(bz)`
`@@ -106,6 +120,11 @@ func (c coreAppModuleBasicAdapator) InitGenesis(ctx sdk.Context, _ codec.JSONCod`
`106`	`120`	`panic(err)`
`107`	`121`	`}`
`108`	`122`	`}`
	`123`	`+`
	`124`	`+ if mod, ok := c.module.(HasGenesis); ok {`
	`125`	`+ return mod.InitGenesis(ctx, cdc, bz)`
	`126`	`+ }`
	`127`	`+`
`109`	`128`	`return nil`
`110`	`129`	`}`
`111`	`130`
Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,11 @@ func NewBasicManagerFromManager(manager *Manager, customModuleBasics map[string]`
`101`	`101`	`continue`
`102`	`102`	`}`
`103`	`103`
	`104`	`+ if appModule, ok := module.(appmodule.AppModule); ok {`
	`105`	`+ moduleMap[name] = CoreAppModuleBasicAdaptor(name, appModule)`
	`106`	`+ continue`
	`107`	`+ }`
	`108`	`+`
`104`	`109`	`if basicMod, ok := module.(AppModuleBasic); ok {`
`105`	`110`	`moduleMap[name] = basicMod`
`106`	`111`	`}`