Skip to main content

RpcModuleBuilder

reth_ethereum::rpc::builder

Struct RpcModuleBuilder 

Source 
pub struct RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus> { /* private fields */ }
Available on crate feature rpc only.
Expand description

A builder type to configure the RPC module: See RpcModule

This is the main entrypoint and the easiest way to configure an RPC server.

Implementations§

Source§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>

Source

pub const fn new( provider: Provider, pool: Pool, network: Network, executor: Runtime, evm_config: EvmConfig, consensus: Consensus, ) -> RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>

Create a new instance of the builder

Source

pub fn with_provider<P>( self, provider: P, ) -> RpcModuleBuilder<N, P, Pool, Network, EvmConfig, Consensus>

Configure the provider instance.

Source

pub fn with_pool<P>( self, pool: P, ) -> RpcModuleBuilder<N, Provider, P, Network, EvmConfig, Consensus>

Configure the transaction pool instance.

Source

pub fn with_noop_pool( self, ) -> RpcModuleBuilder<N, Provider, NoopTransactionPool, Network, EvmConfig, Consensus>

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.

Source

pub fn with_network<Net>( self, network: Net, ) -> RpcModuleBuilder<N, Provider, Pool, Net, EvmConfig, Consensus>

Configure the network instance.

Source

pub fn with_noop_network( self, ) -> RpcModuleBuilder<N, Provider, Pool, NoopNetwork, EvmConfig, Consensus>

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.

Source

pub fn with_executor( self, executor: Runtime, ) -> RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>

Configure the task executor to use for additional tasks.

Source

pub fn with_evm_config<E>( self, evm_config: E, ) -> RpcModuleBuilder<N, Provider, Pool, Network, E, Consensus>

Configure the evm configuration type

Source

pub fn with_consensus<C>( self, consensus: C, ) -> RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, C>

Configure the consensus implementation.

Source

pub fn eth_api_builder<ChainSpec>( &self, ) -> EthApiBuilder<RpcNodeCoreAdapter<Provider, Pool, Network, EvmConfig>, RpcConverter<Ethereum, EvmConfig, EthReceiptConverter<ChainSpec>>>
where Provider: Clone, Pool: Clone, Network: Clone, EvmConfig: Clone, RpcNodeCoreAdapter<Provider, Pool, Network, EvmConfig>: RpcNodeCore<Evm = EvmConfig>, <RpcNodeCoreAdapter<Provider, Pool, Network, EvmConfig> as RpcNodeCore>::Provider: ChainSpecProvider<ChainSpec = ChainSpec>,

Instantiates a new EthApiBuilder from the configured components.

Source

pub fn bootstrap_eth_api<ChainSpec>( &self, ) -> EthApi<RpcNodeCoreAdapter<Provider, Pool, Network, EvmConfig>, RpcConverter<Ethereum, EvmConfig, EthReceiptConverter<ChainSpec>>>
where Provider: Clone, Pool: Clone, Network: Clone, EvmConfig: ConfigureEvm, RpcNodeCoreAdapter<Provider, Pool, Network, EvmConfig>: RpcNodeCore<Evm = EvmConfig>, <RpcNodeCoreAdapter<Provider, Pool, Network, EvmConfig> as RpcNodeCore>::Provider: ChainSpecProvider<ChainSpec = ChainSpec>, RpcConverter<Ethereum, EvmConfig, EthReceiptConverter<ChainSpec>>: RpcConvert, (): PendingEnvBuilder<EvmConfig>,

Initializes a new EthApiServer with the configured components and default settings.

Note: This spawns all necessary tasks.

See also EthApiBuilder.

Source§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where Provider: FullRpcProvider<Block = <N as NodePrimitives>::Block, Receipt = <N as NodePrimitives>::Receipt, Header = <N as NodePrimitives>::BlockHeader> + CanonStateSubscriptions<Primitives = N> + ForkChoiceSubscriptions<Header = <N as NodePrimitives>::BlockHeader> + PersistedBlockSubscriptions + ChangeSetReader + NodePrimitivesProvider<Primitives = N>, Pool: TransactionPool + 'static, Network: NetworkInfo + Peers + Clone + 'static, EvmConfig: ConfigureEvm<Primitives = N> + 'static, N: NodePrimitives, Consensus: FullConsensus<N> + Clone + 'static,

Source

pub fn build_with_auth_server<EthApi, Payload>( self, module_config: TransportRpcModuleConfig, engine: impl IntoEngineApiRpcModule, eth: EthApi, engine_events: EventSender<ConsensusEngineEvent<N>>, beacon_engine_handle: ConsensusEngineHandle<Payload>, ) -> (TransportRpcModules, AuthRpcModule, RpcRegistryInner<Provider, Pool, Network, EthApi, EvmConfig, Consensus>)
where EthApi: FullEthApiServer<Provider = Provider, Pool = Pool>, Payload: PayloadTypes,

Configures all RpcModules 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.

Source

pub fn into_registry<EthApi>( self, config: RpcModuleConfig, eth: EthApi, engine_events: EventSender<ConsensusEngineEvent<N>>, ) -> RpcRegistryInner<Provider, Pool, Network, EthApi, EvmConfig, Consensus>
where EthApi: FullEthApiServer<Provider = Provider, Pool = Pool>,

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

This is useful for getting access to API handlers directly

Source

pub fn build<EthApi>( self, module_config: TransportRpcModuleConfig, eth: EthApi, engine_events: EventSender<ConsensusEngineEvent<N>>, ) -> TransportRpcModules
where EthApi: FullEthApiServer<Provider = Provider, Pool = Pool>,

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

Trait Implementations§

Source§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> Clone for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where N: Clone, Provider: Clone, Pool: Clone, Network: Clone, EvmConfig: Clone, Consensus: Clone,

Source§

fn clone( &self, ) -> RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> Debug for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where N: Debug, Provider: Debug, Pool: Debug, Network: Debug, EvmConfig: Debug, Consensus: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<N> Default for RpcModuleBuilder<N, (), (), (), (), ()>
where N: NodePrimitives,

Source§

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

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

Auto Trait Implementations§

§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> !RefUnwindSafe for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>

§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> !UnwindSafe for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>

§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> Freeze for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where Provider: Freeze, Pool: Freeze, Network: Freeze, EvmConfig: Freeze, Consensus: Freeze, PhantomData<N>: Freeze,

§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> Send for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where Provider: Send, Pool: Send, Network: Send, EvmConfig: Send, Consensus: Send, PhantomData<N>: Send,

§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> Sync for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where Provider: Sync, Pool: Sync, Network: Sync, EvmConfig: Sync, Consensus: Sync, PhantomData<N>: Sync,

§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> Unpin for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where Provider: Unpin, Pool: Unpin, Network: Unpin, EvmConfig: Unpin, Consensus: Unpin, PhantomData<N>: Unpin,

§

impl<N, Provider, Pool, Network, EvmConfig, Consensus> UnsafeUnpin for RpcModuleBuilder<N, Provider, Pool, Network, EvmConfig, Consensus>
where Provider: UnsafeUnpin, Pool: UnsafeUnpin, Network: UnsafeUnpin, EvmConfig: UnsafeUnpin, Consensus: UnsafeUnpin, PhantomData<N>: UnsafeUnpin,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. 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
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> FmtForward for T

§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext 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
Source§

impl<T> Instrument for T

Source§

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

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

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

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

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

§

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

§

fn type_id(&self) -> TypeId

Returns the lifetime-erased type ID of self.
§

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>, 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>, 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>, 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>, 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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

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<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

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

Mutable access to the BorrowMut<B> 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<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

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

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, 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.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::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
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

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

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

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.