Struct RpcRegistryInner

pub struct RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>
where
    Provider: BlockReader,
    EthApi: EthApiTypes,
{ /* private fields */ }

A Helper type the holds instances of the configured modules.

Implementations

impl<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Provider: StateProviderFactory + BlockReader<Block = <<Events as NodePrimitivesProvider>::Primitives as NodePrimitives>::Block, Receipt = <<Events as NodePrimitivesProvider>::Primitives as NodePrimitives>::Receipt> + EvmEnvProvider + Clone + Unpin + 'static, Pool: Send + Sync + Clone + 'static, Network: Clone + 'static, Events: CanonStateSubscriptions + Clone + 'static, Tasks: TaskSpawner + Clone + 'static, EthApi: EthApiTypes + 'static, BlockExecutor: BlockExecutorProvider,

pub fn new<EvmConfig>( provider: Provider, pool: Pool, network: Network, executor: Tasks, events: Events, consensus: Consensus, config: RpcModuleConfig, evm_config: EvmConfig, eth_api_builder: Box<dyn FnOnce(&EthApiBuilderCtx<Provider, Pool, EvmConfig, Network, Tasks, Events>) -> EthApi>, block_executor: BlockExecutor, payload_validator: Arc<dyn PayloadValidator<Block = <Provider as BlockReader>::Block>>, ) -> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where EvmConfig: ConfigureEvm<Header = <Provider as HeaderProvider>::Header>,

Creates a new, empty instance.

impl<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Provider: BlockReader, EthApi: EthApiTypes,

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

Returns a reference to the installed EthApi.

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

Returns a reference to the installed EthHandlers.

pub const 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 const fn pool(&self) -> &Pool

Returns a reference to the pool

pub const fn events(&self) -> &Events

Returns a reference to the events type

pub const fn tasks(&self) -> &Tasks

Returns a reference to the tasks type

pub const 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

impl<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Network: NetworkInfo + Clone + 'static, EthApi: EthApiTypes, Provider: BlockReader + ChainSpecProvider, <Provider as ChainSpecProvider>::ChainSpec: EthereumHardforks, BlockExecutor: BlockExecutorProvider,

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

impl<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Provider: FullRpcProvider + AccountReader + ChangeSetReader, Network: NetworkInfo + Peers + Clone + 'static, Tasks: TaskSpawner + Clone + 'static, EthApi: EthApiServer<<<EthApi as EthApiTypes>::NetworkTypes as Network>::TransactionResponse, Block<<<EthApi as EthApiTypes>::NetworkTypes as Network>::TransactionResponse, <<EthApi as EthApiTypes>::NetworkTypes as Network>::HeaderResponse>, <<EthApi as EthApiTypes>::NetworkTypes as Network>::ReceiptResponse, <<EthApi as EthApiTypes>::NetworkTypes as Network>::HeaderResponse> + EthApiTypes, BlockExecutor: BlockExecutorProvider,

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

impl<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Provider: FullRpcProvider + AccountReader + ChangeSetReader, Network: NetworkInfo + Peers + Clone + 'static, Tasks: TaskSpawner + Clone + 'static, EthApi: EthApiTypes, BlockExecutor: BlockExecutorProvider,

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

impl<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Provider: FullRpcProvider<Block = <<BlockExecutor as BlockExecutorProvider>::Primitives as NodePrimitives>::Block> + AccountReader + ChangeSetReader, Pool: TransactionPool + 'static, Network: NetworkInfo + Peers + Clone + 'static, Tasks: TaskSpawner + Clone + 'static, Events: CanonStateSubscriptions<Primitives = <BlockExecutor as BlockExecutorProvider>::Primitives> + Clone + 'static, EthApi: FullEthApiServer, <EthApi as RpcNodeCore>::Provider: BlockReader<Block = <<BlockExecutor as BlockExecutorProvider>::Primitives as NodePrimitives>::Block, Receipt = <<BlockExecutor as BlockExecutorProvider>::Primitives as NodePrimitives>::Receipt, Header = <<BlockExecutor as BlockExecutorProvider>::Primitives as NodePrimitives>::BlockHeader>, BlockExecutor: BlockExecutorProvider, Consensus: FullConsensus<<BlockExecutor as BlockExecutorProvider>::Primitives> + Clone + 'static,

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 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<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> Clone for RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Provider: Clone + BlockReader, Pool: Clone, Network: Clone, Tasks: Clone, Events: Clone, EthApi: Clone + EthApiTypes, BlockExecutor: Clone, Consensus: Clone, <Provider as BlockReader>::Block: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus> Debug for RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi, BlockExecutor, Consensus>

where Provider: Debug + BlockReader, Pool: Debug, Network: Debug, Tasks: Debug, Events: Debug, EthApi: Debug + EthApiTypes, BlockExecutor: Debug, Consensus: Debug, <Provider as BlockReader>::Block: Debug,

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

Formats the value using the given formatter.

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.