Struct zebra_state::LatestChainTip

pub struct LatestChainTip {
    receiver: WatchReceiver<Option<ChainTipBlock>>,
}

Efficient access to the state’s current best chain tip.

Each method returns data from the latest tip, regardless of how many times you call it.

Cloned instances provide identical tip data.

The chain tip data is based on:

• the best non-finalized chain tip, if available, or
• the finalized tip.

Note

If a lot of blocks are committed at the same time, the latest tip will skip some blocks in the chain.

Fields

receiver: WatchReceiver<Option<ChainTipBlock>>

The receiver for the current chain tip’s data.

Implementations

impl LatestChainTip

fn new(receiver: Receiver<Option<ChainTipBlock>>) -> Self

Create a new LatestChainTip from a watch channel receiver.

fn with_chain_tip_block<U, F>(&self, f: F) -> Option<U>

where F: FnOnce(&ChainTipBlock) -> U,

Maps the current data ChainTipData to Option<U> by applying a function to the watched value, while holding the receiver lock as briefly as possible.

This helper method is a shorter way to borrow the value from the [watch::Receiver] and extract some information from it, while also adding the current chain tip block’s fields as records to the current span.

A single read lock is acquired to clone T, and then released after the clone. See the performance note on WatchReceiver::with_watch_data.

Does not mark the watched data as seen.

Correctness

To avoid deadlocks, see the correctness note on WatchReceiver::with_watch_data.

Trait Implementations

impl ChainTip for LatestChainTip

fn best_tip_changed(&mut self) -> BestTipChanged<'_>

Returns when the state tip changes.

Marks the state tip as seen when the returned future completes.

fn mark_best_tip_seen(&mut self)

Mark the current best state tip as seen.

fn best_tip_height(&self) -> Option<Height>

Returns the height of the best chain tip.

fn best_tip_hash(&self) -> Option<Hash>

Returns the block hash of the best chain tip.

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

Returns the height and the hash of the best chain tip.

fn best_tip_block_time(&self) -> Option<DateTime<Utc>>

Returns the block time of the best chain tip.

fn best_tip_height_and_block_time(&self) -> Option<(Height, DateTime<Utc>)>

Returns the height and the block time of the best chain tip. Returning both values at the same time guarantees that they refer to the same chain tip.

fn best_tip_mined_transaction_ids(&self) -> Arc<[Hash]>

Returns the mined transaction IDs of the transactions in the best chain tip block.

fn estimate_network_chain_tip_height( &self, network: &Network, now: DateTime<Utc>, ) -> Option<Height>

Return an estimate of the network chain tip’s height.

fn estimate_distance_to_network_chain_tip( &self, network: &Network, ) -> Option<(i64, Height)>

Return an estimate of how many blocks there are ahead of Zebra’s best chain tip until the network chain tip, and Zebra’s best chain tip height.

impl Clone for LatestChainTip

fn clone(&self) -> LatestChainTip

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LatestChainTip

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

Formats the value using the given formatter.