Skip to main content

EngineOrchestratorBuilder

reth_engine_tree::launch

Struct EngineOrchestratorBuilder 

Source 
pub struct EngineOrchestratorBuilder<N, Client, S, V, C>
where
    N: ProviderNodeTypes,
{
Show 16 fields
    pub engine_kind: EngineApiKind,
    pub consensus: Arc<dyn FullConsensus<N::Primitives>>,
    pub client: Client,
    pub incoming_requests: S,
    pub pipeline: Pipeline<N>,
    pub pipeline_task_spawner: Runtime,
    pub provider: ProviderFactory<N>,
    pub blockchain_db: BlockchainProvider<N>,
    pub pruner: PrunerWithFactory<ProviderFactory<N>>,
    pub payload_builder: PayloadBuilderHandle<N::Payload>,
    pub payload_validator: V,
    pub overlay_manager: OverlayManager<N::Primitives>,
    pub tree_config: TreeConfig,
    pub sync_metrics_tx: MetricEventsSender,
    pub evm_config: C,
    pub runtime: Runtime,

}
Expand description

Components needed to build the engine ChainOrchestrator that drives the chain forward.

build spawns and wires together the following components:

  • BasicBlockDownloader — downloads blocks on demand from the network during live sync.
  • PersistenceHandle — spawns the persistence service on a background thread for writing blocks and performing pruning outside the critical consensus path.
  • EngineApiTreeHandler — spawns the tree handler that processes engine API requests (newPayload, forkchoiceUpdated) and maintains the in-memory chain state.
  • EngineApiRequestHandler + EngineHandler — glue that routes incoming CL messages to the tree handler and manages download requests.
  • PipelineSync — wraps the staged sync [Pipeline] for backfill sync when the node needs to catch up over large block ranges.

The returned orchestrator implements [Stream] and yields ChainEvents.

Fields§

§engine_kind: EngineApiKind

The engine API flavor to run.

§consensus: Arc<dyn FullConsensus<N::Primitives>>

Consensus used to validate downloaded and incoming blocks.

§client: Client

Network client used to download blocks during live sync.

§incoming_requests: S

Incoming consensus layer messages.

§pipeline: Pipeline<N>

Staged sync pipeline used for backfill.

§pipeline_task_spawner: Runtime

Runtime the pipeline runs on.

§provider: ProviderFactory<N>

Provider factory handed to the persistence service.

§blockchain_db: BlockchainProvider<N>

Blockchain provider backing the engine tree.

§pruner: PrunerWithFactory<ProviderFactory<N>>

Pruner run by the persistence service.

§payload_builder: PayloadBuilderHandle<N::Payload>

Handle to the payload builder service.

§payload_validator: V

Validator for incoming payloads.

§overlay_manager: OverlayManager<N::Primitives>

Overlay manager for state on top of the database.

§tree_config: TreeConfig

Engine tree configuration.

§sync_metrics_tx: MetricEventsSender

Sender for sync metric events.

§evm_config: C

EVM configuration used to execute payloads.

§runtime: Runtime

Runtime used to spawn engine tree tasks.

Implementations§

Source§

impl<N, Client, S, V, C> EngineOrchestratorBuilder<N, Client, S, V, C>
where N: ProviderNodeTypes, Client: BlockClient<Block = <N::Primitives as NodePrimitives>::Block> + BlockAccessListsClient + 'static, S: Stream<Item = BeaconEngineMessage<N::Payload>> + Send + Sync + Unpin + 'static, V: EngineValidator<N::Payload> + WaitForCaches, C: ConfigureEvm<Primitives = N::Primitives> + 'static,

Source

pub fn build( self, ) -> EngineOrchestrator<N::Payload, N::Primitives, Client, S, PipelineSync<N>>

Spawns the engine services and returns the ChainOrchestrator driving them.

Source

pub fn build_with_backfill<B: BackfillSync + Unpin, E>( self, backfill: impl FnOnce(Pipeline<N>, Runtime) -> Result<B, E>, ) -> Result<EngineOrchestrator<N::Payload, N::Primitives, Client, S, B>, E>

Like Self::build, backfilling through the BackfillSync backfill makes from the staged [Pipeline] and its runtime, instead of PipelineSync.

The backfill is built before any engine service is spawned, so its error aborts the build.

Trait Implementations§

Source§

impl<N, Client: Debug, S: Debug, V: Debug, C: Debug> Debug for EngineOrchestratorBuilder<N, Client, S, V, C>
where N: ProviderNodeTypes + Debug, N::Primitives: Debug, N::Payload: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<N, Client, S, V, C> !RefUnwindSafe for EngineOrchestratorBuilder<N, Client, S, V, C>

§

impl<N, Client, S, V, C> !Sync for EngineOrchestratorBuilder<N, Client, S, V, C>

§

impl<N, Client, S, V, C> !UnwindSafe for EngineOrchestratorBuilder<N, Client, S, V, C>

§

impl<N, Client, S, V, C> Freeze for EngineOrchestratorBuilder<N, Client, S, V, C>
where <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx: Sized, <N as NodeTypes>::Primitives: Sized, Arc<dyn FullConsensus<<N as NodeTypes>::Primitives>>: Freeze, Client: Freeze, S: Freeze, Pipeline<N>: Freeze, ProviderFactory<N>: Freeze, BlockchainProvider<N>: Freeze, Pruner<<ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW, ProviderFactory<N>>: Freeze, PayloadBuilderHandle<<N as NodeTypes>::Payload>: Freeze, V: Freeze, OverlayManager<<N as NodeTypes>::Primitives>: Freeze, C: Freeze,

§

impl<N, Client, S, V, C> Send for EngineOrchestratorBuilder<N, Client, S, V, C>
where <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx: Sized, <N as NodeTypes>::Primitives: Sized, Arc<dyn FullConsensus<<N as NodeTypes>::Primitives>>: Send, Client: Send, S: Send, Pipeline<N>: Send, ProviderFactory<N>: Send, BlockchainProvider<N>: Send, Pruner<<ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW, ProviderFactory<N>>: Send, PayloadBuilderHandle<<N as NodeTypes>::Payload>: Send, V: Send, OverlayManager<<N as NodeTypes>::Primitives>: Send, C: Send,

§

impl<N, Client, S, V, C> Unpin for EngineOrchestratorBuilder<N, Client, S, V, C>
where <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx: Sized, <N as NodeTypes>::Primitives: Sized, Arc<dyn FullConsensus<<N as NodeTypes>::Primitives>>: Unpin, Client: Unpin, S: Unpin, Pipeline<N>: Unpin, ProviderFactory<N>: Unpin, BlockchainProvider<N>: Unpin, Pruner<<ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW, ProviderFactory<N>>: Unpin, PayloadBuilderHandle<<N as NodeTypes>::Payload>: Unpin, V: Unpin, OverlayManager<<N as NodeTypes>::Primitives>: Unpin, C: Unpin,

§

impl<N, Client, S, V, C> UnsafeUnpin for EngineOrchestratorBuilder<N, Client, S, V, C>
where <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx: Sized, <N as NodeTypes>::Primitives: Sized, Arc<dyn FullConsensus<<N as NodeTypes>::Primitives>>: UnsafeUnpin, Client: UnsafeUnpin, S: UnsafeUnpin, Pipeline<N>: UnsafeUnpin, ProviderFactory<N>: UnsafeUnpin, BlockchainProvider<N>: UnsafeUnpin, Pruner<<ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW, ProviderFactory<N>>: UnsafeUnpin, PayloadBuilderHandle<<N as NodeTypes>::Payload>: UnsafeUnpin, V: UnsafeUnpin, OverlayManager<<N as NodeTypes>::Primitives>: UnsafeUnpin, C: 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,

§

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

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.