Struct BlockStore

pub struct BlockStore<N: Network, B: BlockStorage<N>> { /* private fields */ }

The block store.

Implementations

impl<N: Network, B: BlockStorage<N>> BlockStore<N, B>

pub fn open<S: Clone + Into<StorageMode>>(storage: S) -> Result<Self>

Initializes the block store.

pub fn insert(&self, block: &Block<N>) -> Result<()>

Stores the given block into storage.

pub fn remove_last_n_from_tree_only(&self, n: u32) -> Result<()>

Reverts the Merkle tree to its shape before the insertion of the last ‘n’ blocks.

pub fn remove_last_n(&self, n: u32) -> Result<()>

Removes the last ‘n’ blocks from storage.

pub fn transaction_store(&self) -> &TransactionStore<N, B::TransactionStorage>

Returns the transaction store.

pub fn transition_store(&self) -> &TransitionStore<N, B::TransitionStorage>

Returns the transition store.

pub fn start_atomic(&self)

Starts an atomic batch write operation.

pub fn is_atomic_in_progress(&self) -> bool

Checks if an atomic batch is in progress.

pub fn atomic_checkpoint(&self)

Checkpoints the atomic batch.

pub fn clear_latest_checkpoint(&self)

Clears the latest atomic batch checkpoint.

pub fn atomic_rewind(&self)

Rewinds the atomic batch to the previous checkpoint.

pub fn abort_atomic(&self)

Aborts an atomic batch write operation.

pub fn finish_atomic(&self) -> Result<()>

Finishes an atomic batch write operation.

pub fn storage_mode(&self) -> &StorageMode

Returns the storage mode.

pub fn pause_atomic_writes(&self) -> Result<()>

Pauses atomic writes.

pub fn unpause_atomic_writes<const DISCARD_BATCH: bool>(&self) -> Result<()>

Unpauses atomic writes.

impl<N: Network, B: BlockStorage<N>> BlockStore<N, B>

pub fn find_block_height_from_state_root( &self, state_root: N::StateRoot, ) -> Result<Option<u32>>

Returns the block height that contains the given state root.

pub fn find_block_hash( &self, transaction_id: &N::TransactionID, ) -> Result<Option<N::BlockHash>>

Returns the block hash that contains the given transaction ID.

pub fn find_block_height_from_solution_id( &self, solution_id: &SolutionID<N>, ) -> Result<Option<u32>>

Returns the block height that contains the given solution ID.

impl<N: Network, B: BlockStorage<N>> BlockStore<N, B>

pub fn current_state_root(&self) -> N::StateRoot

Returns the current state root.

pub fn current_block_height(&self) -> u32

Returns the current block height.

pub fn get_state_root(&self, block_height: u32) -> Result<Option<N::StateRoot>>

Returns the state root that contains the given block height.

pub fn get_state_path_for_commitment( &self, commitment: &Field<N>, ) -> Result<StatePath<N>>

Returns a state path for the given commitment.

pub fn get_previous_block_hash( &self, height: u32, ) -> Result<Option<N::BlockHash>>

Returns the previous block hash of the given block height.

pub fn get_block_hash(&self, height: u32) -> Result<Option<N::BlockHash>>

Returns the block hash for the given block height.

pub fn get_block_height(&self, block_hash: &N::BlockHash) -> Result<Option<u32>>

Returns the block height for the given block hash.

pub fn get_block_header( &self, block_hash: &N::BlockHash, ) -> Result<Option<Header<N>>>

Returns the block header for the given block hash.

pub fn get_block_authority( &self, block_hash: &N::BlockHash, ) -> Result<Option<Authority<N>>>

Returns the block authority for the given block hash.

pub fn get_block_ratifications( &self, block_hash: &N::BlockHash, ) -> Result<Option<Ratifications<N>>>

Returns the block ratifications for the given block hash.

pub fn get_block_solutions( &self, block_hash: &N::BlockHash, ) -> Result<Solutions<N>>

Returns the block solutions for the given block hash.

pub fn get_solution(&self, solution_id: &SolutionID<N>) -> Result<Solution<N>>

Returns the prover solution for the given solution ID.

pub fn get_block_transactions( &self, block_hash: &N::BlockHash, ) -> Result<Option<Transactions<N>>>

Returns the block transactions for the given block hash.

pub fn get_block_aborted_transaction_ids( &self, block_hash: &N::BlockHash, ) -> Result<Option<Vec<N::TransactionID>>>

Returns the block aborted transaction IDs for the given block hash.

pub fn get_transaction( &self, transaction_id: &N::TransactionID, ) -> Result<Option<Transaction<N>>>

Returns the transaction for the given transaction ID.

pub fn get_confirmed_transaction( &self, transaction_id: &N::TransactionID, ) -> Result<Option<ConfirmedTransaction<N>>>

Returns the confirmed transaction for the given transaction ID.

pub fn get_unconfirmed_transaction( &self, transaction_id: &N::TransactionID, ) -> Result<Option<Transaction<N>>>

Returns the unconfirmed transaction for the given transaction ID.

pub fn get_block(&self, block_hash: &N::BlockHash) -> Result<Option<Block<N>>>

Returns the block for the given block hash.

pub fn get_program( &self, program_id: &ProgramID<N>, ) -> Result<Option<Program<N>>>

Returns the program for the given program ID.

pub fn get_batch_certificate( &self, certificate_id: &Field<N>, ) -> Result<Option<BatchCertificate<N>>>

Returns the batch certificate for the given certificate ID.

impl<N: Network, B: BlockStorage<N>> BlockStore<N, B>

pub fn contains_state_root(&self, state_root: &N::StateRoot) -> Result<bool>

Returns true if the given state root exists.

pub fn contains_block_height(&self, height: u32) -> Result<bool>

Returns true if the given block height exists.

pub fn contains_block_hash(&self, block_hash: &N::BlockHash) -> Result<bool>

Returns true if the given block hash exists.

pub fn contains_transaction_id( &self, transaction_id: &N::TransactionID, ) -> Result<bool>

Returns true if the given transaction ID exists.

pub fn contains_rejected_or_aborted_transaction_id( &self, transaction_id: &N::TransactionID, ) -> Result<bool>

Returns true if the given rejected transaction ID or aborted transaction ID exists.

pub fn contains_rejected_deployment_or_execution_id( &self, rejected_id: &Field<N>, ) -> Result<bool>

Returns true if the given rejected deployment or execution ID.

pub fn contains_certificate(&self, certificate_id: &Field<N>) -> Result<bool>

Returns true if the given certificate ID exists.

pub fn contains_solution_id(&self, solution_id: &SolutionID<N>) -> Result<bool>

Returns true if the given solution ID exists.

impl<N: Network, B: BlockStorage<N>> BlockStore<N, B>

pub fn state_roots(&self) -> impl '_ + Iterator<Item = Cow<'_, N::StateRoot>>

Returns an iterator over the state roots, for all blocks in self.

pub fn heights(&self) -> impl '_ + Iterator<Item = Cow<'_, u32>>

Returns an iterator over the block heights, for all blocks in self.

pub fn max_height(&self) -> Option<u32>

Returns the height of the latest block in the storage.

pub fn hashes(&self) -> impl '_ + Iterator<Item = Cow<'_, N::BlockHash>>

Returns an iterator over the block hashes, for all blocks in self.

pub fn solution_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, SolutionID<N>>>

Returns an iterator over the solution IDs, for all blocks in self.

Trait Implementations

impl<N: Clone + Network, B: Clone + BlockStorage<N>> Clone for BlockStore<N, B>

fn clone(&self) -> BlockStore<N, B>

Returns a copy of the value.

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

Performs copy-assignment from source.