feat(server/v2/grpcgateway): register grpcgateway server and module endpoints

CHANGELOG.md

@@ -51,6 +51,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i
 * RocksDB libraries have been upgraded to support RockDB v9 instead of v8.
 * (testutil/integration) [#22616](https://github.com/cosmos/cosmos-sdk/pull/22616) Remove double context in integration tests v1.
     * Use integrationApp.Context() instead of creating a context prior.
+* (server) [#22701](https://github.com/cosmos/cosmos-sdk/pull/22701) Register grpcgateway server and module endpoints for server/v2.
 
 ### Bug Fixes
 

server/v2/api/grpc/server.go

@@ -128,6 +128,10 @@ func (s *Server[T]) StartCmdFlags() *pflag.FlagSet {
 	return flags
 }
 
+func (s *Server[T]) GrpcServer() *grpc.Server {
+	return s.grpcSrv
+}
+
 func makeUnknownServiceHandler(
 	handlers map[string]appmodulev2.Handler,
 	queryable func(ctx context.Context, version uint64, msg transaction.Msg) (transaction.Msg, error),

server/v2/api/grpcgateway/server.go

@@ -31,7 +31,7 @@ type Server[T transaction.Tx] struct {
 
 	server            *http.Server
 	gRPCSrv           *grpc.Server
-	gRPCGatewayRouter *runtime.ServeMux
+	GRPCGatewayRouter *runtime.ServeMux
 }
 
 // New creates a new gRPC-gateway server.
@@ -53,7 +53,7 @@ func New[T transaction.Tx](
 
 	s := &Server[T]{
 		gRPCSrv: grpcSrv,
-		gRPCGatewayRouter: runtime.NewServeMux(
+		GRPCGatewayRouter: runtime.NewServeMux(
 			// Custom marshaler option is required for gogo proto
 			runtime.WithMarshalerOption(runtime.MIMEWildcard, marshalerOption),
 
@@ -83,6 +83,13 @@ func New[T transaction.Tx](
 	return s, nil
 }
 
+// NewWithConfigOptions creates a new gRPC-gateway server with the provided config options.
+func NewWithConfigOptions[T transaction.Tx](opts ...CfgOption) *Server[T] {
+	return &Server[T]{
+		cfgOptions: opts,
+	}
+}
+
 func (s *Server[T]) Name() string {
 	return ServerName
 }
@@ -108,7 +115,7 @@ func (s *Server[T]) Start(ctx context.Context) error {
 	}
 
 	mux := http.NewServeMux()
-	mux.Handle("/", s.gRPCGatewayRouter)
+	mux.Handle("/", s.GRPCGatewayRouter)
 
 	s.server = &http.Server{
 		Addr:    s.config.Address,

simapp/v2/simdv2/cmd/commands.go

@@ -12,6 +12,7 @@
 	runtimev2 "cosmossdk.io/runtime/v2"
 	serverv2 "cosmossdk.io/server/v2"
 	grpcserver "cosmossdk.io/server/v2/api/grpc"
+	"cosmossdk.io/server/v2/api/grpcgateway"
 	"cosmossdk.io/server/v2/api/rest"
 	"cosmossdk.io/server/v2/api/telemetry"
 	"cosmossdk.io/server/v2/cometbft"
@@ -20,6 +21,7 @@
 	confixcmd "cosmossdk.io/tools/confix/cmd"
 
 	"github.com/cosmos/cosmos-sdk/client"
+	sdkclient "github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/config"
 	"github.com/cosmos/cosmos-sdk/client/debug"
 	"github.com/cosmos/cosmos-sdk/client/keys"
@@ -31,8 +33,13 @@
 	genutilcli "github.com/cosmos/cosmos-sdk/x/genutil/client/cli"
 	genutiltypes "github.com/cosmos/cosmos-sdk/x/genutil/types"
 	v2 "github.com/cosmos/cosmos-sdk/x/genutil/v2/cli"
+	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
 )
 
+type ModuleWithGRPCGateway interface {
+	RegisterGRPCGatewayRoutes(clientCtx sdkclient.Context, mux *gwruntime.ServeMux)
+}
+
 // CommandDependencies is a struct that contains all the dependencies needed to initialize the root command.
 // an alternative design could fetch these even later from the command context
 type CommandDependencies[T transaction.Tx] struct {
@@ -83,6 +90,7 @@
 			&serverstore.Server[T]{},
 			&telemetry.Server[T]{},
 			&rest.Server[T]{},
+			&grpcgateway.Server[T]{},
 		)
 	}
 
@@ -140,6 +148,24 @@
 		return nil, err
 	}
 
+	grpcSrv := grpcServer.GrpcServer()
+
+	grpcgatewayServer, err := grpcgateway.New[T](
+		logger,
+		deps.GlobalConfig,
+		grpcSrv,
+		simApp.InterfaceRegistry(),
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, mod := range deps.ModuleManager.Modules() {
+		if gmod, ok := mod.(ModuleWithGRPCGateway); ok {
+			gmod.RegisterGRPCGatewayRoutes(deps.ClientContext, grpcgatewayServer.GRPCGatewayRouter)
+		}
+	}
+
 	// wire server commands
 	return serverv2.AddCommands[T](
 		rootCmd,
@@ -152,6 +178,7 @@
 		storeComponent,
 		telemetryServer,
 		restServer,
+		grpcgatewayServer,
 	)
 }
 

simapp/v2/simdv2/cmd/testnet.go

@@ -20,6 +20,7 @@ import (
 	runtimev2 "cosmossdk.io/runtime/v2"
 	serverv2 "cosmossdk.io/server/v2"
 	"cosmossdk.io/server/v2/api/grpc"
+	"cosmossdk.io/server/v2/api/grpcgateway"
 	"cosmossdk.io/server/v2/cometbft"
 	"cosmossdk.io/server/v2/store"
 	banktypes "cosmossdk.io/x/bank/types"
@@ -192,6 +193,7 @@ func initTestnetFiles[T transaction.Tx](
 	for i := 0; i < args.numValidators; i++ {
 		var portOffset int
 		grpcConfig := grpc.DefaultConfig()
+		grpcgatewayConfig := grpcgateway.DefaultConfig()
 		if args.singleMachine {
 			portOffset = i
 			p2pPortStart = 16656 // use different start point to not conflict with rpc port
@@ -205,6 +207,11 @@ func initTestnetFiles[T transaction.Tx](
 				MaxRecvMsgSize: grpc.DefaultConfig().MaxRecvMsgSize,
 				MaxSendMsgSize: grpc.DefaultConfig().MaxSendMsgSize,
 			}
+
+			grpcgatewayConfig = &grpcgateway.Config{
+				Enable:  true,
+				Address: fmt.Sprintf("127.0.0.1:%d", apiPort+portOffset),
+			}
 		}
 
 		nodeDirName := fmt.Sprintf("%s%d", args.nodeDirPrefix, i)
@@ -338,7 +345,9 @@ func initTestnetFiles[T transaction.Tx](
 		cometServer := cometbft.NewWithConfigOptions[T](cometbft.OverwriteDefaultConfigTomlConfig(nodeConfig))
 		storeServer := &store.Server[T]{}
 		grpcServer := grpc.NewWithConfigOptions[T](grpc.OverwriteDefaultConfig(grpcConfig))
-		server := serverv2.NewServer[T](serverCfg, cometServer, storeServer, grpcServer)
+
+		grpcgatewayServer := grpcgateway.NewWithConfigOptions[T](grpcgateway.OverwriteDefaultConfig(grpcgatewayConfig))
+		server := serverv2.NewServer[T](serverCfg, cometServer, storeServer, grpcServer, grpcgatewayServer)
 		err = server.WriteConfig(filepath.Join(nodeDir, "config"))
 		if err != nil {
 			return err

tests/systemtests/go.mod

@@ -167,3 +167,5 @@ require (
 	pgregory.net/rapid v1.1.0 // indirect
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )
+
+replace cosmossdk.io/systemtests => ../../systemtests

tests/systemtests/go.sum

@@ -16,8 +16,6 @@ cosmossdk.io/math v1.4.0 h1:XbgExXFnXmF/CccPPEto40gOO7FpWu9yWNAZPN3nkNQ=
 cosmossdk.io/math v1.4.0/go.mod h1:O5PkD4apz2jZs4zqFdTr16e1dcaQCc5z6lkEnrrppuk=
 cosmossdk.io/store v1.1.0 h1:LnKwgYMc9BInn9PhpTFEQVbL9UK475G2H911CGGnWHk=
 cosmossdk.io/store v1.1.0/go.mod h1:oZfW/4Fc/zYqu3JmQcQdUJ3fqu5vnYTn3LZFFy8P8ng=
-cosmossdk.io/systemtests v1.0.0-rc.1.0.20241128092904-215d5c16f64d h1:zZUt9DD+3qvwnpQHPwYJ5+NEUU4wMFeNpPBegWMfbn8=
-cosmossdk.io/systemtests v1.0.0-rc.1.0.20241128092904-215d5c16f64d/go.mod h1:ME2eFY/+2CjaFrPOMW8paPXupMzYaDMTKQ1sRvi71hU=
 cosmossdk.io/x/tx v0.13.3-0.20240419091757-db5906b1e894 h1:kHEvzVqpNv/9pnaEPBsgE/FMc+cVmWjSsInRufkZkpQ=
 cosmossdk.io/x/tx v0.13.3-0.20240419091757-db5906b1e894/go.mod h1:Tb6/tpONmtL5qFdOMdv1pdvrtJNxcazZBoz04HB71ss=
 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=