Struct BatchStream

pub struct BatchStream<P, BF>
where
    P: BatchStreamProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,
    BF: L2ChainProvider + Debug,
{ /* private fields */ }

BatchStream stage in the derivation pipeline.

This stage is introduced in the Holocene hardfork. It slots in between the ChannelReader and BatchQueue stages, buffering span batches until they are validated.

Implementations

impl<P, BF> BatchStream<P, BF>

where P: BatchStreamProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug, BF: L2ChainProvider + Debug,

pub const fn new( prev: P, config: Arc<RollupConfig>, fetcher: BF, ) -> BatchStream<P, BF>

Create a new BatchStream stage.

pub fn is_active(&self) -> Result<bool, PipelineErrorKind>

Returns if the BatchStream stage is active based on the origin timestamp and holocene activation timestamp.

pub fn get_single_batch( &mut self, parent: L2BlockInfo, l1_origins: &[BlockInfo], ) -> Result<SingleBatch, PipelineErrorKind>

Gets a SingleBatch from the in-memory buffer.

pub fn try_hydrate_buffer( &mut self, parent: L2BlockInfo, l1_origins: &[BlockInfo], ) -> Result<(), PipelineErrorKind>

Hydrates the buffer with single batches derived from the span batch, if there is one queued up.

Trait Implementations

impl<P, BF> Debug for BatchStream<P, BF>

where P: Debug + BatchStreamProvider + OriginAdvancer + OriginProvider + SignalReceiver, BF: Debug + L2ChainProvider,

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

Formats the value using the given formatter.

impl<P, BF> NextBatchProvider for BatchStream<P, BF>

where P: BatchStreamProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug, BF: L2ChainProvider + Send + Debug,

fn flush(&mut self)

Allows the stage to flush the buffer in the crate::stages::BatchStream if an invalid single batch is found. Pre-holocene hardfork, this will be a no-op.

fn span_buffer_size(&self) -> usize

Returns the number of SingleBatches that are currently buffered in the BatchStream from a SpanBatch.

fn next_batch<'life0, 'life1, 'async_trait>( &'life0 mut self, parent: L2BlockInfo, l1_origins: &'life1 [BlockInfo], ) -> Pin<Box<dyn Future<Output = Result<Batch, PipelineErrorKind>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, BatchStream<P, BF>: 'async_trait,

Returns the next Batch in the ChannelReader stage, if the stage is not complete. This function can only be called once while the stage is in progress, and will return None on subsequent calls unless the stage is reset or complete. If the stage is complete and the batch has been consumed, an PipelineError::Eof error is returned.

impl<P, BF> OriginAdvancer for BatchStream<P, BF>

where P: BatchStreamProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug, BF: L2ChainProvider + Send + Debug,

fn advance_origin<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), PipelineErrorKind>> + Send + 'async_trait>>

where 'life0: 'async_trait, BatchStream<P, BF>: 'async_trait,

Advances the internal state of the lowest stage to the next l1 origin. This method is the equivalent of the reference implementation advance_l1_block.

impl<P, BF> OriginProvider for BatchStream<P, BF>

where P: BatchStreamProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug, BF: L2ChainProvider + Debug,

fn origin(&self) -> Option<BlockInfo>

Returns the optional L1 BlockInfo origin.

impl<P, BF> SignalReceiver for BatchStream<P, BF>

where P: BatchStreamProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug + Send, BF: L2ChainProvider + Send + Debug,

fn signal<'life0, 'async_trait>( &'life0 mut self, signal: Signal, ) -> Pin<Box<dyn Future<Output = Result<(), PipelineErrorKind>> + Send + 'async_trait>>

where 'life0: 'async_trait, BatchStream<P, BF>: 'async_trait,

Receives a signal from the driver.