Struct RpcHandle

pub struct RpcHandle<Node: FullNodeComponents, EthApi: EthApiTypes> {
    pub rpc_server_handles: RethRpcServerHandles,
    pub rpc_registry: RpcRegistry<Node, EthApi>,
}

Handle to the launched RPC servers.

Fields

rpc_server_handles: RethRpcServerHandles

Handles to launched servers.

rpc_registry: RpcRegistry<Node, EthApi>

Configured RPC modules.

Methods from Deref<Target = RpcRegistryInner<Node::Provider, Node::Pool, Node::Network, TaskExecutor, Node::Provider, EthApi, Node::Executor, Node::Consensus>>

pub fn eth_api(&self) -> &EthApi

Returns a reference to the installed EthApi.

pub fn eth_handlers(&self) -> &EthHandlers<Provider, Events, EthApi>

Returns a reference to the installed EthHandlers.

pub fn eth_cache( &self, ) -> &EthStateCache<<Provider as BlockReader>::Block, <Provider as ReceiptProvider>::Receipt>

Returns the EthStateCache frontend

This will spawn exactly one EthStateCache service if this is the first time the cache is requested.

pub fn pool(&self) -> &Pool

Returns a reference to the pool

pub fn events(&self) -> &Events

Returns a reference to the events type

pub fn tasks(&self) -> &Tasks

Returns a reference to the tasks type

pub fn provider(&self) -> &Provider

Returns a reference to the provider

pub fn methods(&self) -> Vec<Methods>

Returns all installed methods

pub fn module(&self) -> RpcModule<()>

Returns a merged RpcModule

pub fn admin_api( &self, ) -> AdminApi<Network, <Provider as ChainSpecProvider>::ChainSpec>

where Network: Peers,

Instantiates AdminApi

pub fn web3_api(&self) -> Web3Api<Network>

Instantiates Web3Api

pub fn register_admin( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Network: Peers,

Register Admin Namespace

pub fn register_web3( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

Register Web3 Namespace

pub fn register_eth( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

Register Eth Namespace

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn register_ots( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where EthApi: TraceExt + EthTransactions,

Register Otterscan Namespace

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn register_debug( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where EthApi: EthApiSpec + EthTransactions + TraceExt, <BlockExecutor as BlockExecutorProvider>::Primitives: NodePrimitives<Block = <<EthApi as RpcNodeCore>::Provider as BlockReader>::Block>,

Register Debug Namespace

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn register_trace( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where EthApi: TraceExt,

Register Trace Namespace

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn register_net( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where EthApi: EthApiSpec + 'static,

Register Net Namespace

See also Self::eth_api

Panics

If called outside of the tokio runtime.

pub fn register_reth( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

Register Reth namespace

See also Self::eth_api

Panics

If called outside of the tokio runtime.

pub fn otterscan_api(&self) -> OtterscanApi<EthApi>

Instantiates OtterscanApi

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn trace_api(&self) -> TraceApi<EthApi>

where EthApi: TraceExt,

Instantiates TraceApi

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn bundle_api(&self) -> EthBundle<EthApi>

where EthApi: EthTransactions + LoadPendingBlock + Call,

Instantiates EthBundle Api

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn debug_api(&self) -> DebugApi<EthApi, BlockExecutor>

where EthApi: EthApiSpec + EthTransactions + TraceExt, <BlockExecutor as BlockExecutorProvider>::Primitives: NodePrimitives<Block = <<EthApi as RpcNodeCore>::Provider as BlockReader>::Block>,

Instantiates DebugApi

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn net_api(&self) -> NetApi<Network, EthApi>

where EthApi: EthApiSpec + 'static,

Instantiates NetApi

Panics

If called outside of the tokio runtime. See also Self::eth_api

pub fn reth_api(&self) -> RethApi<Provider>

Instantiates RethApi

pub fn validation_api(&self) -> ValidationApi<Provider, BlockExecutor>

where Consensus: FullConsensus<<BlockExecutor as BlockExecutorProvider>::Primitives> + Clone + 'static, Provider: BlockReader<Block = <<BlockExecutor as BlockExecutorProvider>::Primitives as NodePrimitives>::Block>,

Instantiates ValidationApi

pub fn create_auth_module<EngineApi, EngineT>( &self, engine_api: EngineApi, ) -> AuthRpcModule

where EngineT: EngineTypes, EngineApi: EngineApiServer<EngineT>,

Configures the auth module that includes the

• engine_ namespace
• api_ namespace

Note: This does not register the engine_ in this registry.

pub fn create_transport_rpc_modules( &mut self, config: TransportRpcModuleConfig, ) -> TransportRpcModules

Configure a TransportRpcModules using the current registry. This creates [RpcModule] instances for the modules selected by the config.

pub fn module_for(&mut self, config: &RpcModuleSelection) -> RpcModule<()>

Populates a new [RpcModule] based on the selected [RethRpcModule]s in the given [RpcModuleSelection]

pub fn reth_methods( &mut self, namespaces: impl Iterator<Item = RethRpcModule>, ) -> Vec<Methods>

Returns the [Methods] for the given [RethRpcModule]

If this is the first time the namespace is requested, a new instance of API implementation will be created.

Panics

If called outside of the tokio runtime. See also Self::eth_api

Trait Implementations

impl<Node: Clone + FullNodeComponents, EthApi: Clone + EthApiTypes> Clone for RpcHandle<Node, EthApi>

fn clone(&self) -> RpcHandle<Node, EthApi>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Node: FullNodeComponents, EthApi: EthApiTypes> Debug for RpcHandle<Node, EthApi>

where RpcRegistry<Node, EthApi>: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Node: FullNodeComponents, EthApi: EthApiTypes> Deref for RpcHandle<Node, EthApi>

type Target = RpcRegistry<Node, EthApi>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.