feat!: simplify AppModuleBasic interface for CLI

cosmos · Jul 9, 2023 · adb03ec · adb03ec
1 parent 864ce72
commit adb03ec
Show file tree

Hide file tree

Showing 11 changed files with 8 additions and 60 deletions.
diff --git a/types/module/module.go b/types/module/module.go
@@ -60,8 +60,6 @@ type AppModuleBasic interface {
 
 	// client functionality
 	RegisterGRPCGatewayRoutes(client.Context, *runtime.ServeMux)
-	GetTxCmd() *cobra.Command
-	GetQueryCmd() *cobra.Command
 }
 
 // HasName allows the module to provide its own name for legacy purposes.
@@ -163,17 +161,21 @@ func (bm BasicManager) RegisterGRPCGatewayRoutes(clientCtx client.Context, rtr *
 // AddTxCommands adds all tx commands to the rootTxCmd.
 func (bm BasicManager) AddTxCommands(rootTxCmd *cobra.Command) {
 	for _, b := range bm {
-		if cmd := b.GetTxCmd(); cmd != nil {
-			rootTxCmd.AddCommand(cmd)
+		if mod, ok := b.(interface {
+			GetTxCmd() *cobra.Command
+		}); ok {
+			rootTxCmd.AddCommand(mod.GetTxCmd())
 		}
 	}
 }
 
 // AddQueryCommands adds all query commands to the rootQueryCmd.
 func (bm BasicManager) AddQueryCommands(rootQueryCmd *cobra.Command) {
 	for _, b := range bm {
-		if cmd := b.GetQueryCmd(); cmd != nil {
-			rootQueryCmd.AddCommand(cmd)
+		if mod, ok := b.(interface {
+			GetQueryCmd() *cobra.Command
+		}); ok {
+			rootQueryCmd.AddCommand(mod.GetQueryCmd())
 		}
 	}
 }

diff --git a/x/auth/vesting/module.go b/x/auth/vesting/module.go
@@ -70,11 +70,6 @@ func (ab AppModuleBasic) GetTxCmd() *cobra.Command {
 	return cli.GetTxCmd(ab.ac)
 }
 
-// GetQueryCmd returns the module's root query command. Currently, this is a no-op.
-func (AppModuleBasic) GetQueryCmd() *cobra.Command {
-	return nil
-}
-
 // AppModule extends the AppModuleBasic implementation by implementing the
 // AppModule interface.
 type AppModule struct {

diff --git a/x/consensus/module.go b/x/consensus/module.go
@@ -6,7 +6,6 @@ import (
 
 	abci "github.com/cometbft/cometbft/abci/types"
 	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
-	"github.com/spf13/cobra"
 	"google.golang.org/grpc"
 
 	modulev1 "cosmossdk.io/api/cosmos/consensus/module/v1"
@@ -67,16 +66,6 @@ func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *g
 	}
 }
 
-// GetTxCmd returns the root tx command
-func (AppModuleBasic) GetTxCmd() *cobra.Command {
-	return nil
-}
-
-// GetQueryCmd returns no root query command
-func (AppModuleBasic) GetQueryCmd() *cobra.Command {
-	return nil
-}
-
 // RegisterInterfaces registers interfaces and implementations of the bank module.
 func (AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry) {
 	types.RegisterInterfaces(registry)

diff --git a/x/crisis/module.go b/x/crisis/module.go
@@ -80,9 +80,6 @@ func (b AppModuleBasic) GetTxCmd() *cobra.Command {
 	return cli.NewTxCmd()
 }
 
-// GetQueryCmd returns no root query command for the crisis module.
-func (AppModuleBasic) GetQueryCmd() *cobra.Command { return nil }
-
 // RegisterInterfaces registers interfaces and implementations of the crisis
 // module.
 func (AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry) {

diff --git a/x/distribution/module.go b/x/distribution/module.go
@@ -82,11 +82,6 @@ func (ab AppModuleBasic) GetTxCmd() *cobra.Command {
 	return cli.NewTxCmd(ab.ac)
 }
 
-// GetQueryCmd returns the root query command for the distribution module.
-func (ab AppModuleBasic) GetQueryCmd() *cobra.Command {
-	return nil
-}
-
 // RegisterInterfaces implements InterfaceModule
 func (AppModuleBasic) RegisterInterfaces(registry cdctypes.InterfaceRegistry) {
 	types.RegisterInterfaces(registry)

diff --git a/x/evidence/module.go b/x/evidence/module.go
@@ -94,11 +94,6 @@ func (a AppModuleBasic) GetTxCmd() *cobra.Command {
 	return cli.GetTxCmd(evidenceCLIHandlers)
 }
 
-// GetQueryCmd returns the evidence module's root query command.
-func (AppModuleBasic) GetQueryCmd() *cobra.Command {
-	return nil
-}
-
 // RegisterInterfaces registers the evidence module's interface types
 func (AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry) {
 	types.RegisterInterfaces(registry)

diff --git a/x/feegrant/module/module.go b/x/feegrant/module/module.go
@@ -98,11 +98,6 @@ func (ab AppModuleBasic) GetTxCmd() *cobra.Command {
 	return cli.GetTxCmd(ab.ac)
 }
 
-// GetQueryCmd returns no root query command for the feegrant module.
-func (ab AppModuleBasic) GetQueryCmd() *cobra.Command {
-	return nil
-}
-
 // ----------------------------------------------------------------------------
 // AppModule
 // ----------------------------------------------------------------------------

diff --git a/x/genutil/module.go b/x/genutil/module.go
@@ -6,7 +6,6 @@ import (
 
 	abci "github.com/cometbft/cometbft/abci/types"
 	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
-	"github.com/spf13/cobra"
 
 	modulev1 "cosmossdk.io/api/cosmos/genutil/module/v1"
 	"cosmossdk.io/core/appmodule"
@@ -68,12 +67,6 @@ func (b AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, txEncodingConfig cl
 func (AppModuleBasic) RegisterGRPCGatewayRoutes(_ client.Context, _ *gwruntime.ServeMux) {
 }
 
-// GetTxCmd returns no root tx command for the genutil module.
-func (AppModuleBasic) GetTxCmd() *cobra.Command { return nil }
-
-// GetQueryCmd returns no root query command for the genutil module.
-func (AppModuleBasic) GetQueryCmd() *cobra.Command { return nil }
-
 // AppModule implements an application module for the genutil module.
 type AppModule struct {
 	AppModuleBasic

diff --git a/x/mint/module.go b/x/mint/module.go
@@ -83,11 +83,6 @@ func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *g
 // GetTxCmd returns no root tx command for the mint module.
 func (AppModuleBasic) GetTxCmd() *cobra.Command { return nil }
 
-// GetQueryCmd returns the root query command for the mint module.
-func (AppModuleBasic) GetQueryCmd() *cobra.Command {
-	return nil
-}
-
 // AppModule implements an application module for the mint module.
 type AppModule struct {
 	AppModuleBasic

diff --git a/x/params/module.go b/x/params/module.go
@@ -52,9 +52,6 @@ func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *g
 	}
 }
 
-// GetTxCmd returns no root tx command for the params module.
-func (AppModuleBasic) GetTxCmd() *cobra.Command { return nil }
-
 // GetQueryCmd returns no root query command for the params module.
 func (AppModuleBasic) GetQueryCmd() *cobra.Command {
 	return cli.NewQueryCmd()

diff --git a/x/staking/module.go b/x/staking/module.go
@@ -93,11 +93,6 @@ func (AppModuleBasic) GetTxCmd() *cobra.Command {
 	return cli.NewTxCmd()
 }
 
-// GetQueryCmd returns no root query command for the staking module.
-func (ab AppModuleBasic) GetQueryCmd() *cobra.Command {
-	return nil
-}
-
 // AppModule implements an application module for the staking module.
 type AppModule struct {
 	AppModuleBasic