Struct BlockEvent

pub struct BlockEvent<B> {
    pub block: B,
    pub checkpoint: CheckPoint,
}

A newly emitted block from Emitter.

Fields

block: B

Either a full [Block] or [Header] of the new block.

checkpoint: CheckPoint

The checkpoint of the new block.

A CheckPoint is a node of a linked list of BlockIds. This checkpoint is linked to all BlockIds originally passed in Emitter::new as well as emitted blocks since then. These blocks are guaranteed to be of the same chain.

This is important as BDK structures require block-to-apply to be connected with another block in the original chain.

Implementations

impl<B> BlockEvent<B>

pub fn block_height(&self) -> u32

The block height of this new block.

pub fn block_hash(&self) -> BlockHash

The block hash of this new block.

pub fn connected_to(&self) -> BlockId

The BlockId of a previous block that this block connects to.

This either returns a BlockId of a previously emitted block or from the chain we started with (passed in as last_cp in Emitter::new).

This value is derived from BlockEvent::checkpoint.

Trait Implementations

impl<B: Debug> Debug for BlockEvent<B>

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

Formats the value using the given formatter.