Struct FinalizedState

pub struct FinalizedState {
    pub db: ZebraDb,
    /* private fields */
}

The finalized part of the chain state, stored in the db.

rocksdb allows concurrent writes through a shared reference, so clones of the finalized state represent the same database instance. When the final clone is dropped, the database is closed.

This is different from NonFinalizedState::clone(), which returns an independent copy of the chains.

Fields

db: ZebraDb

The underlying database.

rocksdb allows reads and writes via a shared reference, so this database object can be freely cloned. The last instance that is dropped will close the underlying database.

Implementations

impl FinalizedState

pub fn new(config: &Config, network: &Network) -> Self

Returns an on-disk database instance for config, network, and elastic_db. If there is no existing database, creates a new database on disk.

pub fn network(&self) -> Network

Returns the configured network for this database.

pub fn commit_finalized( &mut self, ordered_block: (CheckpointVerifiedBlock, Sender<Result<Hash, BoxError>>), prev_note_commitment_trees: Option<NoteCommitmentTrees>, ) -> Result<(CheckpointVerifiedBlock, NoteCommitmentTrees), BoxError>

Commit a checkpoint-verified block to the state.

It’s the caller’s responsibility to ensure that blocks are committed in order.

pub fn commit_finalized_direct( &mut self, finalizable_block: FinalizableBlock, prev_note_commitment_trees: Option<NoteCommitmentTrees>, source: &str, ) -> Result<(Hash, NoteCommitmentTrees), BoxError>

Immediately commit a finalized block to the finalized state.

This can be called either by the non-finalized state (when finalizing a block) or by the checkpoint verifier.

Use source as the source of the block in log messages.

Errors

• Propagates any errors from writing to the DB
• Propagates any errors from updating history and note commitment trees
• If hashFinalSaplingRoot / hashLightClientRoot / hashBlockCommitments does not match the expected value

Trait Implementations

impl Clone for FinalizedState

fn clone(&self) -> FinalizedState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FinalizedState

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

Formats the value using the given formatter.