Struct BlockLocator 

pub struct BlockLocator {
    pub block_hash: BlockHash,
    pub height: u32,
    pub previous_blocks: [Option<BlockHash>; 12],
}

Identifies a position in the chain by its block hash and height, along with recent ancestor hashes used to locate the fork point of a reorg.

Fields

block_hash: BlockHash

The block’s hash.

height: u32

The block’s height.

previous_blocks: [Option<BlockHash>; 12]

Ancestor block hashes immediately before Self::block_hash, in reverse chronological order.

These ensure we can find the fork point of a reorg if our block source no longer has the previous tip after a restart.

Implementations

impl BlockLocator

pub fn from_network(network: Network) -> Self

Constructs a BlockLocator that represents the genesis block at height 0 of the given network.

pub fn new(block_hash: BlockHash, height: u32) -> Self

Returns a BlockLocator as identified by the given block hash and height.

This is not exported to bindings users directly as the bindings auto-generate an equivalent new.

pub fn advance(&mut self, new_hash: BlockHash)

Advances to a new block at height Self::height + 1.

pub fn update_for_new_tip( &mut self, new_tip_hash: BlockHash, new_tip_height: u32, )

Updates this locator for a new chain tip, either delegating to Self::advance if the new block is simply one higher than the current tip and wiping Self::previous_blocks if a few blocks have been skipped.

pub fn get_hash_at_height(&self, height: u32) -> Option<BlockHash>

Returns the block hash at the given height, if available in our history.

pub fn find_common_ancestor( &self, other: &BlockLocator, ) -> Option<(BlockHash, u32)>

Finds the most recent common ancestor between two BlockLocators by searching their ancestor hash histories.

Returns the common block hash and height, or None if no common block is found in the available histories.

Trait Implementations

impl Clone for BlockLocator

fn clone(&self) -> BlockLocator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockLocator

impl Debug for BlockLocator

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

Formats the value using the given formatter.

impl Eq for BlockLocator

impl Hash for BlockLocator

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BlockLocator

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

Equality operator ==.

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

Inequality operator !=.

impl Readable for BlockLocator

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl StructuralPartialEq for BlockLocator

impl Writeable for BlockLocator

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.