refactor(x/bank/v2): migrate to handlers (#21659)

x/bank/proto/buf.gen.gogo.yaml

@@ -3,6 +3,6 @@ plugins:
   - name: gocosmos
     out: ..
     opt: plugins=grpc,Mgoogle/protobuf/any.proto=github.com/cosmos/gogoproto/types/any
-  - name: grpc-gateway
-    out: ..
-    opt: logtostderr=true,allow_colon_final_segments=true
+  # - name: grpc-gateway ## TODO find a way to exclude v2
+  #   out: ..
+  #   opt: logtostderr=true,allow_colon_final_segments=true

x/bank/proto/cosmos/bank/v2/query.proto

@@ -2,22 +2,11 @@ syntax = "proto3";
 package cosmos.bank.v2;
 
 import "gogoproto/gogo.proto";
-import "google/api/annotations.proto";
-import "cosmos/query/v1/query.proto";
 import "amino/amino.proto";
 import "cosmos/bank/v2/bank.proto";
 
 option go_package = "cosmossdk.io/x/bank/v2/types";
 
-// Query defines the gRPC querier service.
-service Query {
-  // Params queries the parameters of x/bank module.
-  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
-    option (cosmos.query.v1.module_query_safe) = true;
-    option (google.api.http).get               = "/cosmos/bank/v2/params";
-  }
-}
-
 // QueryParamsRequest defines the request type for querying x/bank/v2 parameters.
 message QueryParamsRequest {}
 

x/bank/proto/cosmos/bank/v2/tx.proto

@@ -9,15 +9,6 @@ import "amino/amino.proto";
 
 option go_package = "cosmossdk.io/x/bank/v2/types";
 
-// Msg defines the bank Msg service.
-service Msg {
-  option (cosmos.msg.v1.service) = true;
-
-  // UpdateParams defines a governance operation for updating the x/bank/v2 module parameters.
-  // The authority is defined in the keeper.
-  rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse) {}
-}
-
 // MsgUpdateParams is the Msg/UpdateParams request type.
 message MsgUpdateParams {
   option (cosmos.msg.v1.signer) = "authority";

x/bank/v2/autocli.go

@@ -1,40 +1,36 @@
 package bankv2
 
 import (
-	"fmt"
-
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
-	"cosmossdk.io/x/bank/v2/types"
-
-	"github.com/cosmos/cosmos-sdk/version"
 )
 
 // AutoCLIOptions implements the autocli.HasAutoCLIConfig interface.
 func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
-	return &autocliv1.ModuleOptions{
-		Query: &autocliv1.ServiceCommandDescriptor{
-			Service: types.Query_serviceDesc.ServiceName,
-			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
-				{
-					RpcMethod: "Params",
-					Use:       "params",
-					Short:     "Query current bank/v2 parameters",
-				},
-			},
-		},
-		Tx: &autocliv1.ServiceCommandDescriptor{
-			Service:              types.Msg_serviceDesc.ServiceName,
-			EnhanceCustomCommand: true,
-			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
-				{
-					RpcMethod:      "UpdateParams",
-					Use:            "update-params-proposal <params>",
-					Short:          "Submit a proposal to update bank module params. Note: the entire params must be provided.",
-					Example:        fmt.Sprintf(`%s tx bank update-params-proposal '{ }'`, version.AppName),
-					PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "params"}},
-					GovProposal:    true,
-				},
-			},
-		},
-	}
+	return nil // Disable AutoCLI until https://github.com/cosmos/cosmos-sdk/issues/21682 is resolved.
+	// return &autocliv1.ModuleOptions{
+	// 	Query: &autocliv1.ServiceCommandDescriptor{
+	// 		Service: "cosmos.bank.v2.Query",
+	// 		RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+	// 			{
+	// 				RpcMethod: "Params",
+	// 				Use:       "params",
+	// 				Short:     "Query current bank/v2 parameters",
+	// 			},
+	// 		},
+	// 	},
+	// 	Tx: &autocliv1.ServiceCommandDescriptor{
+	// 		Service:              "cosmos.bank.v2.Msg",
+	// 		EnhanceCustomCommand: true,
+	// 		RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+	// 			{
+	// 				RpcMethod:      "UpdateParams",
+	// 				Use:            "update-params-proposal <params>",
+	// 				Short:          "Submit a proposal to update bank module params. Note: the entire params must be provided.",
+	// 				Example:        fmt.Sprintf(`%s tx bank update-params-proposal '{ }'`, version.AppName),
+	// 				PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "params"}},
+	// 				GovProposal:    true,
+	// 			},
+	// 		},
+	// 	},
+	// }
 }

x/bank/v2/keeper/handlers.go

@@ -0,0 +1,60 @@
+package keeper
+
+import (
+	"bytes"
+	"context"
+	"errors"
+	"fmt"
+
+	"cosmossdk.io/x/bank/v2/types"
+)
+
+type handlers struct {
+	*Keeper
+}
+
+// NewHandlers creates a new bank/v2 handlers
+func NewHandlers(k *Keeper) handlers {
+	return handlers{k}
+}
+
+// UpdateParams updates the parameters of the bank/v2 module.
+func (h handlers) MsgUpdateParams(ctx context.Context, msg *types.MsgUpdateParams) (*types.MsgUpdateParamsResponse, error) {
+	authorityBytes, err := h.addressCodec.StringToBytes(msg.Authority)
+	if err != nil {
+		return nil, err
+	}
+
+	if !bytes.Equal(h.authority, authorityBytes) {
+		expectedAuthority, err := h.addressCodec.BytesToString(h.authority)
+		if err != nil {
+			return nil, err
+		}
+
+		return nil, fmt.Errorf("invalid authority; expected %s, got %s", expectedAuthority, msg.Authority)
+	}
+
+	if err := msg.Params.Validate(); err != nil {
+		return nil, err
+	}
+
+	if err := h.params.Set(ctx, msg.Params); err != nil {
+		return nil, err
+	}
+
+	return &types.MsgUpdateParamsResponse{}, nil
+}
+
+// QueryParams queries the parameters of the bank/v2 module.
+func (h handlers) QueryParams(ctx context.Context, req *types.QueryParamsRequest) (*types.QueryParamsResponse, error) {
+	if req == nil {
+		return nil, errors.New("empty request")
+	}
+
+	params, err := h.params.Get(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	return &types.QueryParamsResponse{Params: params}, nil
+}

x/bank/v2/module.go

@@ -3,9 +3,10 @@ package bankv2
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 
-	"google.golang.org/grpc"
+	gogoproto "github.com/cosmos/gogoproto/proto"
 
 	appmodulev2 "cosmossdk.io/core/appmodule/v2"
 	"cosmossdk.io/core/registry"
@@ -22,6 +23,8 @@ var (
 	_ appmodulev2.AppModule             = AppModule{}
 	_ appmodulev2.HasGenesis            = AppModule{}
 	_ appmodulev2.HasRegisterInterfaces = AppModule{}
+	_ appmodulev2.HasQueryHandlers      = AppModule{}
+	_ appmodulev2.HasMsgHandlers        = AppModule{}
 )
 
 // AppModule implements an application module for the bank module.
@@ -53,14 +56,6 @@ func (AppModule) RegisterInterfaces(registrar registry.InterfaceRegistrar) {
 	types.RegisterInterfaces(registrar)
 }
 
-// RegisterServices registers module services.
-func (am AppModule) RegisterServices(registrar grpc.ServiceRegistrar) error {
-	types.RegisterMsgServer(registrar, keeper.NewMsgServer(am.keeper))
-	types.RegisterQueryServer(registrar, keeper.NewQuerier(am.keeper))
-
-	return nil
-}
-
 // DefaultGenesis returns default genesis state as raw bytes for the bank module.
 func (am AppModule) DefaultGenesis() json.RawMessage {
 	return am.cdc.MustMarshalJSON(types.DefaultGenesisState())
@@ -95,3 +90,35 @@ func (am AppModule) ExportGenesis(ctx context.Context) (json.RawMessage, error)
 
 	return am.cdc.MarshalJSON(gs)
 }
+
+// RegisterMsgHandlers registers the message handlers for the bank module.
+func (am AppModule) RegisterMsgHandlers(router appmodulev2.MsgRouter) {
+	handlers := keeper.NewHandlers(am.keeper)
+
+	var errs error
+	if err := appmodulev2.RegisterHandler(
+		router, gogoproto.MessageName(&types.MsgUpdateParams{}), handlers.MsgUpdateParams,
+	); err != nil {
+		errs = errors.Join(errs, err)
+	}
+
+	if errs != nil {
+		panic(errs)
+	}
+}
+
+// RegisterQueryHandlers registers the query handlers for the bank module.
+func (am AppModule) RegisterQueryHandlers(router appmodulev2.QueryRouter) {
+	handlers := keeper.NewHandlers(am.keeper)
+
+	var errs error
+	if err := appmodulev2.RegisterHandler(
+		router, gogoproto.MessageName(&types.QueryParamsRequest{}), handlers.QueryParams,
+	); err != nil {
+		errs = errors.Join(errs, err)
+	}
+
+	if errs != nil {
+		panic(errs)
+	}
+}

x/bank/v2/types/codec.go

@@ -3,14 +3,10 @@ package types
 import (
 	"cosmossdk.io/core/registry"
 	"cosmossdk.io/core/transaction"
-
-	"github.com/cosmos/cosmos-sdk/types/msgservice"
 )
 
 func RegisterInterfaces(registrar registry.InterfaceRegistrar) {
 	registrar.RegisterImplementations((*transaction.Msg)(nil),
 		&MsgUpdateParams{},
 	)
-
-	msgservice.RegisterMsgServiceDesc(registrar, &_Msg_serviceDesc)
 }