Struct NonFinalizedState

pub struct NonFinalizedState {
    pub network: Network,
    /* private fields */
}

The state of the chains in memory, including queued blocks.

Clones of the non-finalized state contain independent copies of the chains. This is different from FinalizedState::clone(), which returns a shared reference to the database.

Most chain data is clone-on-write using Arc.

Fields

network: Network

The configured Zcash network.

Implementations

impl NonFinalizedState

pub fn new(network: &Network) -> NonFinalizedState

Returns a new non-finalized state for network.

pub fn chain_iter(&self) -> impl Iterator<Item = &Arc<Chain>>

Returns an iterator over the non-finalized chains, with the best chain first.

pub fn finalize(&mut self) -> FinalizableBlock

Finalize the lowest height block in the non-finalized portion of the best chain and update all side-chains to match.

pub fn commit_block( &mut self, prepared: SemanticallyVerifiedBlock, finalized_state: &ZebraDb, ) -> Result<(), ValidateContextError>

Commit block to the non-finalized state, on top of:

• an existing chain’s tip, or
• a newly forked chain.

pub fn invalidate_block(&mut self, block_hash: Hash) -> Result<Hash, BoxError>

Invalidate block with hash block_hash and all descendants from the non-finalized state. Insert the new chain into the chain_set and discard the previous.

pub fn reconsider_block( &mut self, block_hash: Hash, finalized_state: &ZebraDb, ) -> Result<Vec<Hash>, ReconsiderError>

Reconsiders a previously invalidated block and its descendants into the non-finalized state based on a block_hash. Reconsidered blocks are inserted into the previous chain and re-inserted into the chain_set.

pub fn commit_new_chain( &mut self, prepared: SemanticallyVerifiedBlock, finalized_state: &ZebraDb, ) -> Result<(), ValidateContextError>

Commit block to the non-finalized state as a new chain where its parent is the finalized tip.

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

Returns the length of the non-finalized portion of the current best chain or None if the best chain has no blocks.

pub fn root_height(&self) -> Option<Height>

Returns the root height of the non-finalized state, if the non-finalized state is not empty.

pub fn any_chain_contains(&self, hash: &Hash) -> bool

Returns true if hash is contained in the non-finalized portion of any known chain.

pub fn find_chain<P>(&self, predicate: P) -> Option<Arc<Chain>>

where P: FnMut(&Chain) -> bool,

Returns the first chain satisfying the given predicate.

If multiple chains satisfy the predicate, returns the chain with the highest difficulty. (Using the tip block hash tie-breaker.)

pub fn any_utxo(&self, outpoint: &OutPoint) -> Option<Utxo>

Returns the transparent::Utxo pointed to by the given transparent::OutPoint if it is present in any chain.

UTXOs are returned regardless of whether they have been spent.

pub fn any_block_by_hash(&self, hash: Hash) -> Option<Arc<Block>>

Returns the block with the given hash in any chain.

pub fn any_prev_block_hash_for_hash(&self, hash: Hash) -> Option<Hash>

Returns the previous block hash for the given block hash in any chain.

pub fn best_hash(&self, height: Height) -> Option<Hash>

Returns the hash for a given block::Height if it is present in the best chain.

pub fn best_tip(&self) -> Option<(Height, Hash)>

Returns the tip of the best chain.

pub fn best_tip_block(&self) -> Option<&ContextuallyVerifiedBlock>

Returns the block at the tip of the best chain.

pub fn best_height_by_hash(&self, hash: Hash) -> Option<Height>

Returns the height of hash in the best chain.

pub fn any_height_by_hash(&self, hash: Hash) -> Option<Height>

Returns the height of hash in any chain.

pub fn best_chain(&self) -> Option<&Arc<Chain>>

Return the non-finalized portion of the current best chain.

pub fn chain_count(&self) -> usize

Return the number of chains.

pub fn invalidated_blocks( &self, ) -> IndexMap<Height, Arc<Vec<ContextuallyVerifiedBlock>>>

Return the invalidated blocks.

pub fn disable_metrics(&mut self)

Stop tracking metrics for this non-finalized state and all its chains.

Trait Implementations

impl Clone for NonFinalizedState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NonFinalizedState

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

Formats the value using the given formatter.

impl Drop for NonFinalizedState

fn drop(&mut self)

Executes the destructor for this type.