Struct reth_node_builder::NodeBuilder

source · 
pub struct NodeBuilder<DB> { /* private fields */ }
Expand description

Declaratively construct a node.

NodeBuilder provides a builder-like interface for composing components of a node.

§Order

Configuring a node starts out with a NodeConfig (this can be obtained from cli arguments for example) and then proceeds to configure the core static types of the node: NodeTypes, these include the node’s primitive types and the node’s engine types.

Next all stateful components of the node are configured, these include all the components of the node that are downstream of those types, these include:

Once all the components are configured, the node is ready to be launched.

On launch the builder returns a fully type aware NodeHandle that has access to all the configured components and can interact with the node.

There are convenience functions for networks that come with a preset of types and components via the Node trait, see reth_node_ethereum::EthereumNode or reth_node_optimism::OptimismNode.

The NodeBuilder::node function configures the node’s types and components in one step.

§Components

All components are configured with a NodeComponentsBuilder that is responsible for actually creating the node components during the launch process. The ComponentsBuilder is a general purpose implementation of the NodeComponentsBuilder trait that can be used to configure the executor, network, transaction pool and payload builder of the node. It enforces the correct order of configuration, for example the network and the payload builder depend on the transaction pool type that is configured first.

All builder traits are generic over the node types and are invoked with the BuilderContext that gives access to internals of the that are needed to configure the components. This include the original config, chain spec, the database provider and the task executor,

§Hooks

Once all the components are configured, the builder can be used to set hooks that are run at specific points in the node’s lifecycle. This way custom services can be spawned before the node is launched [NodeBuilder::on_component_initialized], or once the rpc server(s) are launched [NodeBuilder::on_rpc_started]. The [NodeBuilder::extend_rpc_modules] can be used to inject custom rpc modules into the rpc server before it is launched. See also RpcContext All hooks accept a closure that is then invoked at the appropriate time in the node’s launch process.

§Flow

The NodeBuilder is intended to sit behind a CLI that provides the necessary NodeConfig input: NodeBuilder::new

From there the builder is configured with the node’s types, components, and hooks, then launched with the [NodeBuilder::launch] method. On launch all the builtin internals, such as the Database and its providers BlockchainProvider are initialized before the configured NodeComponentsBuilder is invoked with the BuilderContext to create the transaction pool, network, and payload builder components. When the RPC is configured, the corresponding hooks are invoked to allow for custom rpc modules to be injected into the rpc server: [NodeBuilder::extend_rpc_modules]

Finally all components are created and all services are launched and a NodeHandle is returned that can be used to interact with the node: FullNode

The following diagram shows the flow of the node builder from CLI to a launched node.

graph TD; CLI::parse-->NodeCommand NodeCommand--execute-->NodeBuilder subgraph "Builder" NodeBuilder--"with_types"-->NodeBuilderT NodeBuilderT("NodeBuilder(Types)")--"with_components"-->NodeBuilderC NodeBuilderC("NodeBuilder(Types, Components)")--"extend_rpc_modules"-->NodeBuilderC NodeBuilderC--"on_rpc_started"-->NodeBuilderC end NodeBuilderC--"launch"-->launch subgraph launch database("database init")-->tree("blockchain tree init") tree--BuilderContext-->components{"build_components"} subgraph components ComponentsBuilder--"first creates"-->Pool Pool--"then creates"-->PayloadService Pool--"then creates"-->Network end components--"launch rpc"-->RpcContext RpcContext--invokes-->extend_rpc_modules RpcContext--invokes-->on_rpc_started end launch--"FullNode"-->NodeHandle

§Internals

The node builder is fully type safe, it uses the NodeTypes trait to enforce that all components are configured with the correct types. However the database types and with that the provider trait implementations are currently created by the builder itself during the launch process, hence the database type is not part of the NodeTypes trait and the node’s components, that depend on the database, are configured separately. In order to have a nice trait that encapsulates the entire node the [FullNodeComponents] trait was introduced. This trait has convenient associated types for all the components of the node. After [NodeBuilder::launch] the NodeHandle contains an instance of FullNode that implements the [FullNodeComponents] trait and has access to all the components of the node. Internally the node builder uses several generic adapter types that are then map to traits with associated types for ease of use.

§Limitations

Currently the launch process is limited to ethereum nodes and requires all the components specified above. It also expects beacon consensus with the ethereum engine API that is configured by the builder itself during launch. This might change in the future.

Implementations§

source§

impl NodeBuilder<()>

source

pub fn new(config: NodeConfig) -> Self

Create a new NodeBuilder.

source§

impl<DB> NodeBuilder<DB>

source

pub fn config(&self) -> &NodeConfig

Returns a reference to the node builder’s config.

source

pub fn with_database<D>(self, database: D) -> NodeBuilder<D>

Configures the underlying database that the node will use.

source

pub fn with_launch_context( self, task_executor: TaskExecutor, data_dir: ChainPath<DataDirPath> ) -> WithLaunchContext<NodeBuilder<DB>>

Preconfigure the builder with the context to launch the node.

This provides the task executor and the data directory for the node.

source

pub fn testing_node( self, task_executor: TaskExecutor ) -> WithLaunchContext<NodeBuilder<Arc<TempDatabase<DatabaseEnv>>>>

Creates an ephemeral preconfigured node for testing purposes.

source§

impl<DB> NodeBuilder<DB>
where DB: Database + DatabaseMetrics + DatabaseMetadata + Clone + Unpin + 'static,

source

pub fn with_types<T>(self) -> NodeBuilderWithTypes<RethFullAdapter<DB, T>>
where T: NodeTypes,

Configures the types of the node.

source

pub fn node<N>( self, node: N ) -> NodeBuilderWithComponents<RethFullAdapter<DB, N>, N::ComponentsBuilder>
where N: Node<RethFullAdapter<DB, N>>,

Preconfigures the node with a specific node implementation.

This is a convenience method that sets the node’s types and components in one call.

Auto Trait Implementations§

§

impl<DB> Freeze for NodeBuilder<DB>
where DB: Freeze,

§

impl<DB> RefUnwindSafe for NodeBuilder<DB>
where DB: RefUnwindSafe,

§

impl<DB> Send for NodeBuilder<DB>
where DB: Send,

§

impl<DB> Sync for NodeBuilder<DB>
where DB: Sync,

§

impl<DB> Unpin for NodeBuilder<DB>
where DB: Unpin,

§

impl<DB> UnwindSafe for NodeBuilder<DB>
where DB: UnwindSafe,

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

§

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

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

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> 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> 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: 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
source§

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

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

§

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

Converts to T by calling Into<T>::into.
§

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

Tries to convert to T by calling TryInto<T>::try_into.
§

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

§

type Error = Infallible

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

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

Performs the conversion.
source§

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

§

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
§

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

§

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

§

impl<T> MaybeSendSync for T

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.