Enum TipAction

pub enum TipAction {
    Grow {
        block: ChainTipBlock,
    },
    Reset {
        height: Height,
        hash: Hash,
    },
}

Actions that we can take in response to a ChainTipChange.

Variants

Grow

The chain tip was updated continuously, using a child block of the previous block.

The genesis block action is a Grow.

Fields

block: ChainTipBlock

Information about the block used to grow the chain.

Reset

The chain tip was reset to a block with height and hash.

Resets can happen for different reasons:

• a newly created or cloned ChainTipChange, which is behind the current tip,
• extending the chain with a network upgrade activation block,
• switching to a different best Chain, also known as a rollback, and
• receiving multiple blocks since the previous change.

To keep the code and tests simple, Zebra performs the same reset actions, regardless of the reset reason.

Resets do not have the transaction hashes from the tip block, because all transactions should be cleared by a reset.

Fields

height: Height

The block height of the tip, after the chain reset.

hash: Hash

The block hash of the tip, after the chain reset.

Mainly useful for logging and debugging.

Implementations

impl TipAction

pub fn is_reset(&self) -> bool

Is this tip action a Reset?

pub fn best_tip_hash(&self) -> Hash

Returns the block hash of this tip action, regardless of the underlying variant.

pub fn best_tip_height(&self) -> Height

Returns the block height of this tip action, regardless of the underlying variant.

pub fn best_tip_hash_and_height(&self) -> (Hash, Height)

Returns the block hash and height of this tip action, regardless of the underlying variant.

pub(crate) fn grow_with(block: ChainTipBlock) -> Self

Returns a Grow based on block.

pub(crate) fn reset_with(block: ChainTipBlock) -> Self

Returns a Reset based on block.

Trait Implementations

impl Clone for TipAction

fn clone(&self) -> TipAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TipAction

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

Formats the value using the given formatter.

impl PartialEq for TipAction

fn eq(&self, other: &TipAction) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TipAction

impl StructuralPartialEq for TipAction