Struct reth :: rpc :: builder :: RpcModuleBuilder Copy item path

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>

pub const fn new( provider: Provider, pool: Pool, network: Network, executor: Tasks, events: Events, evm_config: EvmConfig, ) -> RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>

Create a new instance of the builder

pub fn with_provider( self, provider: P, ) -> RpcModuleBuilder<P, Pool, Network, Tasks, Events, EvmConfig>
where P: BlockReader + StateProviderFactory + EvmEnvProvider + 'static,

Configure the provider instance.

pub fn with_pool( self, pool: P, ) -> RpcModuleBuilder<Provider, P, Network, Tasks, Events, EvmConfig>
where P: TransactionPool + 'static,

Configure the transaction pool instance.

pub fn with_noop_pool( self, ) -> RpcModuleBuilder<Provider, NoopTransactionPool, Network, Tasks, Events, EvmConfig>

Configure a NoopTransactionPool instance.

Caution: This will configure a pool API that does absolutely nothing. This is only intended for allow easier setup of namespaces that depend on the EthApi which requires a TransactionPool implementation.

pub fn with_network<N>( self, network: N, ) -> RpcModuleBuilder<Provider, Pool, N, Tasks, Events, EvmConfig>
where N: NetworkInfo + Peers + 'static,

Configure the network instance.

pub fn with_noop_network( self, ) -> RpcModuleBuilder<Provider, Pool, NoopNetwork, Tasks, Events, EvmConfig>

Configure a NoopNetwork instance.

Caution: This will configure a network API that does absolutely nothing. This is only intended for allow easier setup of namespaces that depend on the EthApi which requires a NetworkInfo implementation.

pub fn with_executor<T>( self, executor: T, ) -> RpcModuleBuilder<Provider, Pool, Network, T, Events, EvmConfig>
where T: TaskSpawner + 'static,

Configure the task executor to use for additional tasks.

pub fn with_tokio_executor( self, ) -> RpcModuleBuilder<Provider, Pool, Network, TokioTaskExecutor, Events, EvmConfig>

Configure TokioTaskExecutor as the task executor to use for additional tasks.

This will spawn additional tasks directly via tokio::task::spawn, See TokioTaskExecutor.

pub fn with_events<E>( self, events: E, ) -> RpcModuleBuilder<Provider, Pool, Network, Tasks, E, EvmConfig>
where E: CanonStateSubscriptions + 'static,

Configure the event subscriber instance

pub fn with_evm_config<E>( self, evm_config: E, ) -> RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, E>
where E: ConfigureEvm + 'static,

Configure the evm configuration type

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: FullRpcProvider + AccountReader + ChangeSetReader, Pool: TransactionPool + 'static, Network: NetworkInfo + Peers + Clone + 'static, Tasks: TaskSpawner + Clone + 'static, Events: CanonStateSubscriptions + Clone + 'static, EvmConfig: ConfigureEvm,

pub fn build_with_auth_server<EngineApi, EngineT, EthApi, EthApiB>( self, module_config: TransportRpcModuleConfig, engine: EngineApi, eth: EthApiB, ) -> (TransportRpcModules, AuthRpcModule, RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi>)
where EngineT: EngineTypes + 'static, EngineApi: EngineApiServer<EngineT>, EthApiB: FnOnce(&EthApiBuilderCtx<Provider, Pool, EvmConfig, Network, Tasks, Events>) -> EthApi + 'static, EthApi: FullEthApiServer,

Configures all [RpcModule]s specific to the given TransportRpcModuleConfig which can be used to start the transport server(s).

This behaves exactly as RpcModuleBuilder::build for the TransportRpcModules, but also configures the auth (engine api) server, which exposes a subset of the eth_ namespace.

pub fn into_registry<EthApi, EthApiB>( self, config: RpcModuleConfig, eth: EthApiB, ) -> RpcRegistryInner<Provider, Pool, Network, Tasks, Events, EthApi>
where EthApiB: FnOnce(&EthApiBuilderCtx<Provider, Pool, EvmConfig, Network, Tasks, Events>) -> EthApi + 'static,

Converts the builder into a RpcRegistryInner which can be used to create all components.

This is useful for getting access to API handlers directly:

§Example

use reth_evm::ConfigureEvm;
use reth_network_api::noop::NoopNetwork;
use reth_provider::test_utils::{NoopProvider, TestCanonStateSubscriptions};
use reth_rpc_builder::{EthApiBuild, RpcModuleBuilder};
use reth_tasks::TokioTaskExecutor;
use reth_transaction_pool::noop::NoopTransactionPool;

fn init<Evm: ConfigureEvm + 'static>(evm: Evm) {
    let mut registry = RpcModuleBuilder::default()
        .with_provider(NoopProvider::default())
        .with_pool(NoopTransactionPool::default())
        .with_network(NoopNetwork::default())
        .with_executor(TokioTaskExecutor::default())
        .with_events(TestCanonStateSubscriptions::default())
        .with_evm_config(evm)
        .into_registry(Default::default(), EthApiBuild::build);

    let eth_api = registry.eth_api();
}

pub fn build<EthApi, EthApiB>( self, module_config: TransportRpcModuleConfig, eth: EthApiB, ) -> TransportRpcModules
where EthApiB: FnOnce(&EthApiBuilderCtx<Provider, Pool, EvmConfig, Network, Tasks, Events>) -> EthApi + 'static, EthApi: FullEthApiServer,

Configures all [RpcModule]s specific to the given TransportRpcModuleConfig which can be used to start the transport server(s).

Trait Implementations§

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> Clone for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: Clone, Pool: Clone, Network: Clone, Tasks: Clone, Events: Clone, EvmConfig: Clone,

fn clone( &self, ) -> RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> Debug for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: Debug, Pool: Debug, Network: Debug, Tasks: Debug, Events: Debug, EvmConfig: Debug,

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

Formats the value using the given formatter. Read more

impl Default for RpcModuleBuilder<(), (), (), (), (), ()>

fn default() -> RpcModuleBuilder<(), (), (), (), (), ()>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> Freeze for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: Freeze, Pool: Freeze, Network: Freeze, Tasks: Freeze, Events: Freeze, EvmConfig: Freeze,

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> RefUnwindSafe for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: RefUnwindSafe, Pool: RefUnwindSafe, Network: RefUnwindSafe, Tasks: RefUnwindSafe, Events: RefUnwindSafe, EvmConfig: RefUnwindSafe,

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> Send for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: Send, Pool: Send, Network: Send, Tasks: Send, Events: Send, EvmConfig: Send,

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> Sync for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: Sync, Pool: Sync, Network: Sync, Tasks: Sync, Events: Sync, EvmConfig: Sync,

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> Unpin for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: Unpin, Pool: Unpin, Network: Unpin, Tasks: Unpin, Events: Unpin, EvmConfig: Unpin,

impl<Provider, Pool, Network, Tasks, Events, EvmConfig> UnwindSafe for RpcModuleBuilder<Provider, Pool, Network, Tasks, Events, EvmConfig>
where Provider: UnwindSafe, Pool: UnwindSafe, Network: UnwindSafe, Tasks: UnwindSafe, Events: UnwindSafe, EvmConfig: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryClone for T
where T: Clone,

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeDebug for T
where T: Debug,

impl<T> MaybeSend for T
where T: Send,