reth_stages_api

Struct Pipeline

Source 
pub struct Pipeline<N: ProviderNodeTypes> { /* private fields */ }
Expand description

A staged sync pipeline.

The pipeline executes queued stages serially. An external component determines the tip of the chain and the pipeline then executes each stage in order from the current local chain tip and the external chain tip. When a stage is executed, it will run until it reaches the chain tip.

After the entire pipeline has been run, it will run again unless asked to stop (see [Pipeline::set_max_block]).

include_mmd!("docs/mermaid/pipeline.mmd“)

§Unwinding

In case of a validation error (as determined by the consensus engine) in one of the stages, the pipeline will unwind the stages in reverse order of execution. It is also possible to request an unwind manually (see Pipeline::unwind).

§Defaults

The DefaultStages are used to fully sync reth.

Implementations§

Source§

impl<N: ProviderNodeTypes> Pipeline<N>

Source

pub fn builder() -> PipelineBuilder<<ProviderFactory<N> as DatabaseProviderFactory>::ProviderRW>

Construct a pipeline using a PipelineBuilder.

Source

pub const fn minimum_block_number(&self) -> Option<u64>

Return the minimum block number achieved by any stage during the execution of the pipeline.

Source

pub fn set_tip(&self, tip: B256)

Set tip for reverse sync.

Source

pub fn events(&self) -> EventStream<PipelineEvent>

Listen for events on the pipeline.

Source§

impl<N: ProviderNodeTypes> Pipeline<N>

Source

pub fn register_metrics(&mut self) -> Result<(), PipelineError>

Registers progress metrics for each registered stage

Source

pub fn run_as_fut(self, target: Option<PipelineTarget>) -> PipelineFut<N>

Consume the pipeline and run it until it reaches the provided tip, if set. Return the pipeline and its result as a future.

Source

pub async fn run(&mut self) -> Result<(), PipelineError>

Run the pipeline in an infinite loop. Will terminate early if the user has specified a max_block in the pipeline.

Source

pub async fn run_loop(&mut self) -> Result<ControlFlow, PipelineError>

Performs one pass of the pipeline across all stages. After successful execution of each stage, it proceeds to commit it to the database.

If any stage is unsuccessful at execution, we proceed to unwind. This will undo the progress across the entire pipeline up to the block that caused the error.

Returns the control flow after it ran the pipeline. This will be ControlFlow::Continue or ControlFlow::NoProgress of the last stage in the pipeline (for example the Finish stage). Or ControlFlow::Unwind of the stage that caused the unwind.

Source

pub fn move_to_static_files(&self) -> RethResult<()>

Run static file producer and pruner to move all data from the database to static files for corresponding segments, according to their stage checkpoints:

CAUTION: This method locks the static file producer Mutex, hence can block the thread if the lock is occupied.

Source

pub fn unwind( &mut self, to: BlockNumber, bad_block: Option<BlockNumber>, ) -> Result<(), PipelineError>

Unwind the stages to the target block.

If the unwind is due to a bad block the number of that block should be specified.

Trait Implementations§

Source§

impl<N: ProviderNodeTypes> Debug for Pipeline<N>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<N> Freeze for Pipeline<N>
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, <<N as NodeTypes>::Primitives as NodePrimitives>::BlockBody: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Block: Sized, <N as NodeTypes>::ChainSpec: Sized, <N as NodeTypesWithDB>::DB: Freeze,

§

impl<N> !RefUnwindSafe for Pipeline<N>

§

impl<N> Send for Pipeline<N>
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, <<N as NodeTypes>::Primitives as NodePrimitives>::BlockBody: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Block: Sized, <N as NodeTypes>::ChainSpec: Sized,

§

impl<N> Sync for Pipeline<N>
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, <<N as NodeTypes>::Primitives as NodePrimitives>::BlockBody: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Block: Sized, <N as NodeTypes>::ChainSpec: Sized,

§

impl<N> Unpin for Pipeline<N>
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, <<N as NodeTypes>::Primitives as NodePrimitives>::BlockBody: Sized, <<N as NodeTypes>::Primitives as NodePrimitives>::Block: Sized, <N as NodeTypes>::ChainSpec: Sized,

§

impl<N> !UnwindSafe for Pipeline<N>

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

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
§

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

§

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

§

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.