Struct zebra_state::service::queued_blocks::QueuedBlocks

pub struct QueuedBlocks {
    blocks: HashMap<Hash, (SemanticallyVerifiedBlock, Sender<Result<Hash, BoxError>>)>,
    by_parent: HashMap<Hash, HashSet<Hash>>,
    by_height: BTreeMap<Height, HashSet<Hash>>,
    known_utxos: HashMap<OutPoint, Utxo>,
}

A queue of blocks, awaiting the arrival of parent blocks.

Fields

blocks: HashMap<Hash, (SemanticallyVerifiedBlock, Sender<Result<Hash, BoxError>>)>

Blocks awaiting their parent blocks for contextual verification.

by_parent: HashMap<Hash, HashSet<Hash>>

Hashes from queued_blocks, indexed by parent hash.

by_height: BTreeMap<Height, HashSet<Hash>>

Hashes from queued_blocks, indexed by block height.

known_utxos: HashMap<OutPoint, Utxo>

Known UTXOs.

Implementations

impl QueuedBlocks

pub fn queue( &mut self, new: (SemanticallyVerifiedBlock, Sender<Result<Hash, BoxError>>), )

Queue a block for eventual verification and commit.

Panics

• if a block with the same block::Hash has already been queued.

pub fn has_queued_children(&self, parent_hash: Hash) -> bool

Returns true if there are any queued children of parent_hash.

pub fn dequeue_children( &mut self, parent_hash: Hash, ) -> Vec<(SemanticallyVerifiedBlock, Sender<Result<Hash, BoxError>>)>

Dequeue and return all blocks that were waiting for the arrival of parent.

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

Remove all queued blocks whose height is less than or equal to the given finalized_tip_height.

pub fn get_mut( &mut self, hash: &Hash, ) -> Option<&mut (SemanticallyVerifiedBlock, Sender<Result<Hash, BoxError>>)>

Return the queued block if it has already been registered

fn update_metrics(&self)

Update metrics after the queue is modified

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

Try to look up this UTXO in any queued block.

pub fn drain( &mut self, ) -> Drain<'_, Hash, (SemanticallyVerifiedBlock, Sender<Result<Hash, BoxError>>)>

Clears known_utxos, by_parent, and by_height, then drains blocks. Returns all key-value pairs of blocks as an iterator.

Doesn’t update the metrics, because it is only used when the state is being dropped.

Trait Implementations

impl Debug for QueuedBlocks

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

Formats the value using the given formatter.

impl Default for QueuedBlocks

fn default() -> QueuedBlocks

Returns the “default value” for a type.