Struct subspace_archiving::archiver::Archiver

pub struct Archiver { /* private fields */ }

Block archiver for Subspace blockchain.

It takes new confirmed (at K depth) blocks and concatenates them into a buffer, buffer is sliced into segments of [RecordedHistorySegment::SIZE] size, segments are sliced into source records of [RawRecord::SIZE], records are erasure coded, committed to with [Kzg], then commitments with witnesses are appended and records become pieces that are returned alongside corresponding segment header header.

Panics

Panics when operating on blocks, whose length doesn’t fit into u32 (should never be the case in blockchain context anyway).

Implementations

impl Archiver

pub fn new(kzg: Kzg, erasure_coding: ErasureCoding) -> Self

Create a new instance

pub fn with_initial_state( kzg: Kzg, erasure_coding: ErasureCoding, segment_header: SegmentHeader, encoded_block: &[u8], object_mapping: BlockObjectMapping, ) -> Result<Self, ArchiverInstantiationError>

Create a new instance of the archiver with initial state in case of restart.

block corresponds to last_archived_block and will be processed accordingly to its state.

pub fn last_archived_block_number(&self) -> Option<BlockNumber>

Get last archived block if there was any

pub fn add_block( &mut self, bytes: Vec<u8>, object_mapping: BlockObjectMapping, incremental: bool, ) -> Vec<NewArchivedSegment>

Adds new block to internal buffer, potentially producing pieces and segment header headers.

Incremental archiving can be enabled if amortized block addition cost is preferred over throughput.

Trait Implementations

impl Clone for Archiver

fn clone(&self) -> Archiver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Archiver

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

Formats the value using the given formatter.