Struct SpanBatch

pub struct SpanBatch {
    pub parent_check: FixedBytes<20>,
    pub l1_origin_check: FixedBytes<20>,
    pub genesis_timestamp: u64,
    pub chain_id: u64,
    pub batches: Vec<SpanBatchElement>,
    pub origin_bits: SpanBatchBits,
    pub block_tx_counts: Vec<u64>,
    pub txs: SpanBatchTransactions,
}

The span batch contains the input to build a span of L2 blocks in derived form.

Fields

parent_check: FixedBytes<20>

First 20 bytes of the first block’s parent hash

l1_origin_check: FixedBytes<20>

First 20 bytes of the last block’s L1 origin hash

genesis_timestamp: u64

Genesis block timestamp

chain_id: u64

Chain ID

batches: Vec<SpanBatchElement>

List of block input in derived form

origin_bits: SpanBatchBits

Caching - origin bits

block_tx_counts: Vec<u64>

Caching - block tx counts

txs: SpanBatchTransactions

Caching - span batch txs

Implementations

impl SpanBatch

pub fn starting_timestamp(&self) -> u64

Returns the starting timestamp for the first batch in the span.

Safety

Panics if Self::batches is empty.

pub fn final_timestamp(&self) -> u64

Returns the final timestamp for the last batch in the span.

Safety

Panics if Self::batches is empty.

pub fn starting_epoch_num(&self) -> u64

Returns the epoch number for the first batch in the span.

Safety

Panics if Self::batches is empty.

pub fn check_origin_hash(&self, hash: FixedBytes<32>) -> bool

Checks if the first 20 bytes of the given hash match the L1 origin check.

pub fn check_parent_hash(&self, hash: FixedBytes<32>) -> bool

Checks if the first 20 bytes of the given hash match the parent check.

pub fn get_singular_batches( &self, l1_origins: &[BlockInfo], l2_safe_head: L2BlockInfo, ) -> Result<Vec<SingleBatch>, SpanBatchError>

Converts all SpanBatchElements after the L2 safe head to SingleBatches. The resulting SingleBatches do not contain a parent hash, as it is populated by the Batch Queue stage.

pub fn append_singular_batch( &mut self, singular_batch: SingleBatch, seq_num: u64, ) -> Result<(), SpanBatchError>

Append a SingleBatch to the SpanBatch. Updates the L1 origin check if need be.

pub async fn check_batch<BV: BatchValidationProvider>( &self, cfg: &RollupConfig, l1_blocks: &[BlockInfo], l2_safe_head: L2BlockInfo, inclusion_block: &BlockInfo, fetcher: &mut BV, ) -> BatchValidity

Checks if the span batch is valid.

pub async fn check_batch_prefix<BF: BatchValidationProvider>( &self, cfg: &RollupConfig, l1_origins: &[BlockInfo], l2_safe_head: L2BlockInfo, inclusion_block: &BlockInfo, fetcher: &mut BF, ) -> (BatchValidity, Option<L2BlockInfo>)

Checks the validity of the batch’s prefix.

This function is used for post-Holocene hardfork to perform batch validation as each batch is being loaded in.

Trait Implementations

impl Clone for SpanBatch

fn clone(&self) -> SpanBatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpanBatch

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

Formats the value using the given formatter.

impl Default for SpanBatch

fn default() -> SpanBatch

Returns the “default value” for a type.

impl PartialEq for SpanBatch

fn eq(&self, other: &SpanBatch) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<SpanBatch> for RawSpanBatch

type Error = SpanBatchError

The type returned in the event of a conversion error.

fn try_from(value: SpanBatch) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SpanBatch

impl StructuralPartialEq for SpanBatch