refactor: modules should implement appmodule.AppModule (backport #18252…

…) (#18255) Co-authored-by: Julien Robert <[email protected]>
cosmos · Oct 25, 2023 · 301ceca · 301ceca
1 parent ef43d02
commit 301ceca
Show file tree

Hide file tree

Showing 5 changed files with 123 additions and 11 deletions.
diff --git a/baseapp/testutil/mock/mocks.go b/baseapp/testutil/mock/mocks.go
diff --git a/testutil/mock/types_mock_appmodule.go b/testutil/mock/types_mock_appmodule.go
diff --git a/testutil/mock/types_module_module.go b/testutil/mock/types_module_module.go
diff --git a/types/module/core_module.go b/types/module/core_module.go
@@ -18,20 +18,26 @@ import (
 )
 
 var (
+	_ appmodule.AppModule = coreAppModuleBasicAdaptor{}
+
 	_ AppModuleBasic = coreAppModuleBasicAdaptor{}
 	_ HasABCIGenesis = coreAppModuleBasicAdaptor{}
 	_ HasServices    = coreAppModuleBasicAdaptor{}
 )
 
-// CoreAppModuleBasicAdaptor wraps the core API module as an AppModule that this version
-// of the SDK can use.
-func CoreAppModuleBasicAdaptor(name string, module appmodule.AppModule) AppModuleBasic {
+// CoreAppModuleAdaptor wraps the core API module as an AppModule that this version of the SDK can use.
+func CoreAppModuleAdaptor(name string, module appmodule.AppModule) AppModule {
 	return coreAppModuleBasicAdaptor{
 		name:   name,
 		module: module,
 	}
 }
 
+// CoreAppModuleBasicAdaptor wraps the core API module as an AppModule that this version of the SDK can use.
+func CoreAppModuleBasicAdaptor(name string, module appmodule.AppModule) AppModule {
+	return CoreAppModuleAdaptor(name, module)
+}
+
 type coreAppModuleBasicAdaptor struct {
 	name   string
 	module appmodule.AppModule
@@ -194,3 +200,7 @@ func (c coreAppModuleBasicAdaptor) RegisterServices(cfg Configurator) {
 		}
 	}
 }
+
+func (c coreAppModuleBasicAdaptor) IsOnePerModuleType() {}
+
+func (c coreAppModuleBasicAdaptor) IsAppModule() {}
diff --git a/types/module/module.go b/types/module/module.go
@@ -199,6 +199,8 @@ type HasABCIGenesis interface {
 // its functionality has been moved to extension interfaces.
 // Deprecated: use appmodule.AppModule with a combination of extension interfaes interfaces instead.
 type AppModule interface {
+	appmodule.AppModule
+
 	AppModuleBasic
 }
 
@@ -288,6 +290,10 @@ func NewManager(modules ...AppModule) *Manager {
 	modulesStr := make([]string, 0, len(modules))
 	preBlockModulesStr := make([]string, 0)
 	for _, module := range modules {
+		if _, ok := module.(appmodule.AppModule); !ok {
+			panic(fmt.Sprintf("module %s does not implement appmodule.AppModule", module.Name()))
+		}
+
 		moduleMap[module.Name()] = module
 		modulesStr = append(modulesStr, module.Name())
 		if _, ok := module.(appmodule.HasPreBlocker); ok {