Struct RpcHandle 

pub struct RpcHandle<Node, EthApi>
where
    Node: FullNodeComponents,
    EthApi: EthApiTypes,
{
    pub rpc_server_handles: RethRpcServerHandles,
    pub rpc_registry: RpcRegistry<Node, EthApi>,
    pub engine_events: EventSender<ConsensusEngineEvent<<<Node as FullNodeTypes>::Types as NodeTypes>::Primitives>>,
    pub beacon_engine_handle: ConsensusEngineHandle<<<Node as FullNodeTypes>::Types as NodeTypes>::Payload>,
    pub engine_shutdown: EngineShutdown,
}

Handle to the launched RPC servers.

Fields

rpc_server_handles: RethRpcServerHandles

Handles to launched servers.

rpc_registry: RpcRegistry<Node, EthApi>

Configured RPC modules.

engine_events: EventSender<ConsensusEngineEvent<<<Node as FullNodeTypes>::Types as NodeTypes>::Primitives>>

Notification channel for engine API events

Caution: This is a multi-producer, multi-consumer broadcast and allows grants access to dispatch events

beacon_engine_handle: ConsensusEngineHandle<<<Node as FullNodeTypes>::Types as NodeTypes>::Payload>

Handle to the beacon consensus engine.

engine_shutdown: EngineShutdown

Handle to trigger engine shutdown.

Implementations

impl<Node, EthApi> RpcHandle<Node, EthApi>

where Node: FullNodeComponents, EthApi: EthApiTypes,

pub const fn rpc_server_handles(&self) -> &RethRpcServerHandles

Returns the RPC server handles.

pub const fn consensus_engine_handle( &self, ) -> &ConsensusEngineHandle<<<Node as FullNodeTypes>::Types as NodeTypes>::Payload>

Returns the consensus engine handle.

This handle can be used to interact with the engine service directly.

pub const fn consensus_engine_events( &self, ) -> &EventSender<ConsensusEngineEvent<<<Node as FullNodeTypes>::Types as NodeTypes>::Primitives>>

Returns the consensus engine events sender.

pub const fn eth_api(&self) -> &EthApi

Returns the EthApi instance of the rpc server.

pub fn admin_api( &self, ) -> AdminApi<<Node as FullNodeComponents>::Network, <<Node as FullNodeTypes>::Types as NodeTypes>::ChainSpec, <Node as FullNodeComponents>::Pool>

where <<Node as FullNodeTypes>::Types as NodeTypes>::ChainSpec: EthereumHardforks,

Returns an instance of the AdminApi for the rpc server.

Methods from Deref<Target = RpcRegistryInner<<Node as FullNodeTypes>::Provider, <Node as FullNodeComponents>::Pool, <Node as FullNodeComponents>::Network, EthApi, <Node as FullNodeComponents>::Evm, <Node as FullNodeComponents>::Consensus>>

pub fn eth_api(&self) -> &EthApi

Returns a reference to the installed EthApi.

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

Returns a reference to the installed EthHandlers.

pub fn pool(&self) -> &Pool

Returns a reference to the pool

pub fn tasks(&self) -> &Runtime

Returns a reference to the tasks type

pub fn provider(&self) -> &Provider

Returns a reference to the provider

pub fn evm_config(&self) -> &Evm

Returns a reference to the evm config

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, Pool>

where Network: Peers, Pool: TransactionPool + 'static,

Instantiates AdminApi

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

Instantiates Web3Api

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

where Network: Peers, Pool: TransactionPool + 'static,

Register Admin Namespace

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

Register Web3 Namespace

pub fn register_eth( &mut self, ) -> &mut RpcRegistryInner<Provider, Pool, Network, EthApi, EvmConfig, 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, EthApi, EvmConfig, Consensus>

where EthApi: TraceExt<Primitives = N> + 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, EthApi, EvmConfig, Consensus>

where EthApi: EthTransactions + TraceExt,

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, EthApi, EvmConfig, 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, EthApi, EvmConfig, Consensus>

where EthApi: EthApiSpec,

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, EthApi, EvmConfig, 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>

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 + Call,

Instantiates EthBundle Api

Panics

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

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

where EthApi: FullEthApiTypes,

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,

Instantiates NetApi

Panics

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

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

Instantiates RethApi

pub fn create_auth_module<Payload>( &self, engine_api: impl IntoEngineApiRpcModule, beacon_engine_handle: ConsensusEngineHandle<Payload>, ) -> AuthRpcModule

where Payload: PayloadTypes,

Configures the auth module that includes the

• engine_ namespace
• reth_ 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 RethRpcModules 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, EthApi> Clone for RpcHandle<Node, EthApi>

where Node: FullNodeComponents, EthApi: EthApiTypes,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Node, EthApi> Debug for RpcHandle<Node, EthApi>

where Node: FullNodeComponents, EthApi: EthApiTypes, RpcRegistry<Node, EthApi>: Debug,

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

Formats the value using the given formatter.

impl<Node, EthApi> Deref for RpcHandle<Node, EthApi>

where Node: FullNodeComponents, EthApi: EthApiTypes,

type Target = RpcRegistry<Node, EthApi>

The resulting type after dereferencing.

fn deref(&self) -> &<RpcHandle<Node, EthApi> as Deref>::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.