Struct SentHashes

pub(crate) struct SentHashes {
    bufs: Vec<VecDeque<(Hash, Height)>>,
    curr_buf: VecDeque<(Hash, Height)>,
    sent: HashMap<Hash, Vec<OutPoint>>,
    known_utxos: HashMap<OutPoint, Utxo>,
    pub(crate) can_fork_chain_at_hashes: bool,
}

Fields

bufs: Vec<VecDeque<(Hash, Height)>>

A list of previously sent block batches, each batch is in increasing height order. We use this list to efficiently prune outdated hashes that are at or below the finalized tip.

curr_buf: VecDeque<(Hash, Height)>

The list of blocks sent in the current batch, in increasing height order.

sent: HashMap<Hash, Vec<OutPoint>>

Stores a set of hashes that have been sent to the block write task but may not be in the finalized state yet.

known_utxos: HashMap<OutPoint, Utxo>

Known UTXOs.

can_fork_chain_at_hashes: bool

Whether the hashes in this struct can be used check if the chain can be forked. This is set to false until all checkpoint-verified block hashes have been pruned.

Implementations

impl SentHashes

pub fn add(&mut self, block: &SemanticallyVerifiedBlock)

Stores the block’s hash, height, and UTXOs, so they can be used to check if a block or UTXO is available in the state.

Assumes that blocks are added in the order of their height between finish_batch calls for efficient pruning.

pub fn add_finalized(&mut self, block: &CheckpointVerifiedBlock)

Stores the checkpoint verified block’s hash, height, and UTXOs, so they can be used to check if a block or UTXO is available in the state.

Used for checkpoint verified blocks close to the final checkpoint, so the semantic block verifier can look up their UTXOs.

Assumes that blocks are added in the order of their height between finish_batch calls for efficient pruning.

For more details see add().

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

Try to look up this UTXO in any sent block.

pub fn finish_batch(&mut self)

Finishes the current block batch, and stores it for efficient pruning.

pub fn prune_by_height(&mut self, height_bound: Height)

Prunes sent blocks at or below height_bound.

Finishes the batch if finish_batch() hasn’t been called already.

Assumes that blocks will be added in order of their heights between each finish_batch() call, so that blocks can be efficiently and reliably removed by height.

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

Returns true if SentHashes contains the hash

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

Returns true if the chain can be forked at the provided hash

fn update_metrics_for_block(&self, height: Height)

Update sent block metrics after a block is sent.

fn update_metrics_for_cache(&self)

Update sent block cache metrics after the sent blocks are modified.

Trait Implementations

impl Debug for SentHashes

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

Formats the value using the given formatter.

impl Default for SentHashes

fn default() -> SentHashes

Returns the “default value” for a type.