Struct bdk_chain::bitcoin::bip152::HeaderAndShortIds

pub struct HeaderAndShortIds {
    pub header: Header,
    pub nonce: u64,
    pub short_ids: Vec<ShortId>,
    pub prefilled_txs: Vec<PrefilledTransaction>,
}

A structure to relay a block header, short IDs, and a select few transactions.

A HeaderAndShortIds structure is used to relay a block header, the short transactions IDs used for matching already-available transactions, and a select few transactions which we expect a peer may be missing.

Fields

header: Header

The header of the block being provided.

nonce: u64

A nonce for use in short transaction ID calculations.

short_ids: Vec<ShortId>

The short transaction IDs calculated from the transactions which were not provided explicitly in prefilled_txs.

prefilled_txs: Vec<PrefilledTransaction>

Used to provide the coinbase transaction and a select few which we expect a peer may be missing.

Implementations

impl HeaderAndShortIds

pub fn from_block( block: &Block, nonce: u64, version: u32, prefill: &[usize] ) -> Result<HeaderAndShortIds, Error>

Create a new HeaderAndShortIds from a full block.

The version number must be either 1 or 2.

The prefill slice indicates which transactions should be prefilled in the block. It should contain the indexes in the block of the txs to prefill. It must be ordered. 0 should not be included as the coinbase tx is always prefilled.

Nodes SHOULD NOT use the same nonce across multiple different blocks.

Trait Implementations

impl Clone for HeaderAndShortIds

fn clone(&self) -> HeaderAndShortIds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderAndShortIds

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

Formats the value using the given formatter.

impl Decodable for HeaderAndShortIds

fn consensus_decode_from_finite_reader<R>( r: &mut R ) -> Result<HeaderAndShortIds, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

fn consensus_decode<R>(r: &mut R) -> Result<HeaderAndShortIds, Error>

where R: Read + ?Sized,

Decode an object with a well-defined format.

impl Encodable for HeaderAndShortIds

fn consensus_encode<R>(&self, r: &mut R) -> Result<usize, Error>

where R: Write + ?Sized,

Encodes an object with a well-defined format.

impl Hash for HeaderAndShortIds

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

where __H: Hasher,

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 Ord for HeaderAndShortIds

fn cmp(&self, other: &HeaderAndShortIds) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for HeaderAndShortIds

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for HeaderAndShortIds

fn partial_cmp(&self, other: &HeaderAndShortIds) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for HeaderAndShortIds

impl StructuralPartialEq for HeaderAndShortIds