Struct ChainTipChange

pub struct ChainTipChange {
    latest_chain_tip: LatestChainTip,
    last_change_hash: Option<Hash>,
    network: Network,
}

A chain tip change monitor.

Awaits changes and resets of the state’s best chain tip, returning the latest TipAction once the state is updated.

Each cloned instance separately tracks the last block data it provided. If the best chain fork has changed since the last tip change on that instance, it returns a Reset.

The chain tip data is based on:

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

Fields

latest_chain_tip: LatestChainTip

The receiver for the current chain tip’s data.

last_change_hash: Option<Hash>

The most recent block::Hash provided by this instance.

Note

If the best chain fork has changed, or some blocks have been skipped, this hash will be different to the last returned ChainTipBlock.hash.

network: Network

The network for the chain tip.

Implementations

impl ChainTipChange

pub async fn wait_for_tip_change(&mut self) -> Result<TipAction, RecvError>

Wait until the tip has changed, then return the corresponding TipAction.

The returned action describes how the tip has changed since the last call to this method.

If there have been no changes since the last time this method was called, it waits for the next tip change before returning.

If there have been multiple changes since the last time this method was called, they are combined into a single TipAction::Reset.

Returns an error if communication with the state is lost.

Note

If a lot of blocks are committed at the same time, the change will skip some blocks, and return a Reset.

pub fn last_tip_change(&mut self) -> Option<TipAction>

Returns:

• Some(TipAction) if there has been a change since the last time the method was called.
• None if there has been no change.

See Self::wait_for_tip_change for details.

fn action(&self, block: ChainTipBlock) -> TipAction

Return an action based on block and the last change we returned.

fn new(latest_chain_tip: LatestChainTip, network: &Network) -> Self

Create a new ChainTipChange from a LatestChainTip receiver and Network.

async fn tip_block_change(&mut self) -> Result<ChainTipBlock, RecvError>

Wait until the next chain tip change, then return the corresponding ChainTipBlock.

Returns an error if communication with the state is lost.

pub fn latest_chain_tip(&self) -> LatestChainTip

Returns the inner LatestChainTip.

Trait Implementations

impl Clone for ChainTipChange

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainTipChange

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

Formats the value using the given formatter.