rpc

Documentation

Index

• func GetCfxClientFromContext(ctx context.Context) sdk.ClientOperator
• func GetEthClientFromContext(ctx context.Context) *node.Web3goClient
• func MustNewEvmSpaceServer(router infuraNode.Router, exposedModules []string, option ...EthAPIOption) *rpc.Server
• func MustNewNativeSpaceBridgeServer(config *CfxBridgeServerConfig) *rpc.Server
• func MustNewNativeSpaceServer(router infuraNode.Router, gashandler *handler.GasStationHandler, ...) *rpc.Server
• type API
• type CfxAPIOption
• type CfxBridgeServerConfig
• type EthAPIOption

Functions

func GetCfxClientFromContext

func GetCfxClientFromContext(ctx context.Context) sdk.ClientOperator

func GetEthClientFromContext

func GetEthClientFromContext(ctx context.Context) *node.Web3goClient

func MustNewEvmSpaceServer

func MustNewEvmSpaceServer(
	router infuraNode.Router, exposedModules []string, option ...EthAPIOption,
) *rpc.Server

MustNewEvmSpaceServer new evm space RPC server by specifying router, and exposed modules. `exposedModules` is a list of API modules to expose via the RPC interface. If the module list is empty, all RPC API endpoints designated public will be exposed.

func MustNewNativeSpaceBridgeServer

func MustNewNativeSpaceBridgeServer(config *CfxBridgeServerConfig) *rpc.Server

func MustNewNativeSpaceServer

func MustNewNativeSpaceServer(
	router infuraNode.Router, gashandler *handler.GasStationHandler,
	exposedModules []string, option ...CfxAPIOption,
) *rpc.Server

MustNewNativeSpaceServer new core space RPC server by specifying router, handler and exposed modules. Argument exposedModules is a list of API modules to expose via the RPC interface. If the module list is empty, all RPC API endpoints designated public will be exposed.

Types

type API

type API struct {
	Namespace string      // namespace under which the rpc methods of Service are exposed
	Version   string      // api version
	Service   interface{} // receiver instance which holds the methods
	Public    bool        // indication if the methods must be considered safe for public use
}

API describes the set of methods offered over the RPC interface

type CfxAPIOption

type CfxAPIOption struct {
	StoreHandler  *handler.CfxStoreHandler
	LogApiHandler *handler.CfxLogsApiHandler
	Relayer       *relay.TxnRelayer
}

type CfxBridgeServerConfig

type CfxBridgeServerConfig struct {
	EthNode        string
	CfxNode        string
	ExposedModules []string
	Endpoint       string `default:":32537"`
}

type EthAPIOption

type EthAPIOption struct {
	StoreHandler  *handler.EthStoreHandler
	LogApiHandler *handler.EthLogsApiHandler
}