grpcgateway

Documentation

Overview

Package grpcgateway utilizes the global gogoproto registry to create dynamic query handlers on net/http's mux router.

Header `x-cosmos-block-height` allows you to specify a height for the query.

Requests that do not have a dynamic handler registered will be routed to the canonical gRPC-Gateway mux.

Index

• Constants
• func CustomGRPCHeaderMatcher(key string) (string, bool)
• type CfgOption
  • func Disable() CfgOption
  • func OverwriteDefaultConfig(newCfg *Config) CfgOption
• type Config
  • func DefaultConfig() *Config
• type Server
  • func New[T transaction.Tx](logger log.Logger, config server.ConfigMap, ir jsonpb.AnyResolver, ...) (*Server[T], error)
  • func NewWithConfigOptions[T transaction.Tx](opts ...CfgOption) *Server[T]
  • func (s *Server[T]) Config() any
  • func (s *Server[T]) Name() string
  • func (s *Server[T]) Start(ctx context.Context) error
  • func (s *Server[T]) Stop(ctx context.Context) error

Constants

const GRPCBlockHeightHeader = "x-cosmos-block-height"

GRPCBlockHeightHeader is the gRPC header for block height.

const MaxBodySize = 1 << 20 // 1 MB

const ServerName = "grpc-gateway"

Functions

func CustomGRPCHeaderMatcher

func CustomGRPCHeaderMatcher(key string) (string, bool)

CustomGRPCHeaderMatcher for mapping request headers to GRPC metadata. HTTP headers that start with 'Grpc-Metadata-' are automatically mapped to gRPC metadata after removing prefix 'Grpc-Metadata-'. We can use this CustomGRPCHeaderMatcher if headers don't start with `Grpc-Metadata-`

Types

type CfgOption

type CfgOption func(*Config)

func Disable

func Disable() CfgOption

Disable the grpc server by default (default enabled).

func OverwriteDefaultConfig

func OverwriteDefaultConfig(newCfg *Config) CfgOption

OverwriteDefaultConfig overwrites the default config with the new config.

type Config

type Config struct {
	// Enable defines if the gRPC-Gateway should be enabled.
	Enable bool `mapstructure:"enable" toml:"enable" comment:"Enable defines if the gRPC-Gateway should be enabled."`

	// Address defines the address the gRPC-Gateway server binds to.
	Address string `mapstructure:"address" toml:"address" comment:"Address defines the address the gRPC-Gateway server binds to."`
}

func DefaultConfig

func DefaultConfig() *Config

type Server

type Server[T transaction.Tx] struct {
	GRPCGatewayRouter *runtime.ServeMux
	// contains filtered or unexported fields
}

func New

func New[T transaction.Tx](
	logger log.Logger,
	config server.ConfigMap,
	ir jsonpb.AnyResolver,
	appManager appmanager.AppManager[T],
	cfgOptions ...CfgOption,
) (*Server[T], error)

New creates a new gRPC-Gateway server.

func NewWithConfigOptions

func NewWithConfigOptions[T transaction.Tx](opts ...CfgOption) *Server[T]

NewWithConfigOptions creates a new gRPC-gateway server with the provided config options.

func (*Server[T]) Config

func (s *Server[T]) Config() any

func (*Server[T]) Name

func (s *Server[T]) Name() string

func (*Server[T]) Start

func (s *Server[T]) Start(ctx context.Context) error

func (*Server[T]) Stop

func (s *Server[T]) Stop(ctx context.Context) error