be_rpc

Documentation

Index

• Constants
• func GetBeRpcAPIs(ctx *server.Context, clientCtx client.Context, ...) []rpc.API
• func RegisterAPINamespace(ns string, creator APICreator, allowOverride bool) error
• func RegisterMessageInvolversExtractor(m sdk.Msg, extractor berpctypes.MessageInvolversExtractor)
• func RegisterMessageParser(m sdk.Msg, parser berpctypes.MessageParser)
• type APICreator

Constants

const (
	DymRollAppBlockExplorerNamespace = "be"

	ApiVersion = "1.0"
)

RPC namespaces and API version

Functions

func GetBeRpcAPIs

func GetBeRpcAPIs(ctx *server.Context,
	clientCtx client.Context,
	tendermintWebsocketClient *rpcclient.WSClient,
	requestInterceptorCreator func(backend.BackendI) backend.RequestInterceptor,
	externalServices berpctypes.ExternalServices,
) []rpc.API

GetBeRpcAPIs returns the list of all BE-Json-APIs

func RegisterAPINamespace

func RegisterAPINamespace(ns string, creator APICreator, allowOverride bool) error

RegisterAPINamespace registers a new API namespace with the API creator. This function fails if the namespace is already registered. Legacy TODO BE: call to this function to register before startup

func RegisterMessageInvolversExtractor

func RegisterMessageInvolversExtractor(m sdk.Msg, extractor berpctypes.MessageInvolversExtractor)

RegisterMessageInvolversExtractor registers a new involvers extractor for the given message type. This overrides any existing extractor for the given message type. Contract: the extractor must be registered before the server starts. Legacy TODO BE: call to this function to register before startup

func RegisterMessageParser

func RegisterMessageParser(m sdk.Msg, parser berpctypes.MessageParser)

RegisterMessageParser registers a new parser for the given message type. This overrides any existing parser for the given message type. Contract: the parser must be registered before the server starts. Legacy TODO BE: call to this function to register before startup

Types

type APICreator

type APICreator = func(
	ctx *server.Context,
	clientCtx client.Context,
	tendermintWebsocketClient *rpcclient.WSClient,
	messageParsers map[string]berpctypes.MessageParser,
	messageInvolversExtractors map[string]berpctypes.MessageInvolversExtractor,
	requestInterceptorCreator func(i backend.BackendI) backend.RequestInterceptor,
	externalServices berpctypes.ExternalServices,
) []rpc.API

APICreator creates the JSON-RPC API implementations.