Struct Block 

pub struct Block<V = Unchecked>
where
    V: Validation,
{ /* private fields */ }

Bitcoin block.

A collection of transactions with an attached proof of work.

See Bitcoin Wiki: Block for more information.

Bitcoin Core References

• CBlock definition

Implementations

impl Block<Unchecked>

pub fn new_unchecked(header: Header, transactions: Vec<Transaction>) -> Self

Constructs a new Block without doing any validation.

pub fn assume_checked( self, witness_root: Option<WitnessMerkleNode>, ) -> Block<Checked>

Ignores block validation logic and just assumes you know what you are doing.

You should only use this function if you trust the block i.e., it comes from a trusted node.

pub fn into_parts(self) -> (Header, Vec<Transaction>)

Decomposes block into its constituent parts.

pub fn as_parts(&self) -> (&Header, &[Transaction])

Returns the constituent parts of the block by reference.

pub fn validate(self) -> Result<Block<Checked>, InvalidBlockError>

Validates (or checks) a block.

We define valid as:

• The Merkle root of the header matches Merkle root of the transaction list.
• The witness commitment in coinbase matches the transaction list.

Errors

Returns an error if:

• The block has no transactions.
• The first transaction is not a coinbase transaction.
• The Merkle root of the header does not match the Merkle root of the transaction list.
• The witness commitment in the coinbase does not match the transaction list.

pub fn check_merkle_root(&self) -> bool

Checks if Merkle root of header matches Merkle root of the transaction list.

pub fn compute_witness_commitment( &self, witness_reserved_value: &[u8], ) -> Option<(WitnessMerkleNode, WitnessCommitment)>

Computes the witness commitment for a list of transactions.

pub fn check_witness_commitment(&self) -> (bool, Option<WitnessMerkleNode>)

Checks if witness commitment in coinbase matches the transaction list.

impl Block<Checked>

pub fn header(&self) -> &Header

Gets a reference to the block header.

pub fn transactions(&self) -> &[Transaction]

Gets a reference to the block’s list of transactions.

pub fn cached_witness_root(&self) -> Option<WitnessMerkleNode>

Returns the cached witness root if one is present.

It is assumed that a block will have the witness root calculated and cached as part of the validation process.

impl<V: Validation> Block<V>

pub fn block_hash(&self) -> BlockHash

Returns the block hash.

Trait Implementations

impl<'a> Arbitrary<'a> for Block

Available on crate features arbitrary and alloc only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<V> Clone for Block<V>

where V: Validation + Clone,

fn clone(&self) -> Block<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V> Debug for Block<V>

where V: Validation + Debug,

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

Formats the value using the given formatter.

impl Decodable for Block

Available on crate feature alloc only.

type Decoder = BlockDecoder

Associated decoder for the type.

fn decoder() -> Self::Decoder

Constructs a “default decoder” for the type.

impl Encodable for Block

Available on crate feature alloc only.

type Encoder<'e> = Encoder2<HeaderEncoder<'e>, Encoder2<CompactSizeEncoder, SliceEncoder<'e, Transaction>>> where Self: 'e

The encoder associated with this type. Conceptually, the encoder is like an iterator which yields byte slices.

fn encoder(&self) -> Self::Encoder<'_>

Constructs a “default encoder” for the type.

impl From<&Block> for BlockHash

Available on crate feature alloc only.

fn from(block: &Block) -> Self

Converts to this type from the input type.

impl From<Block> for BlockHash

Available on crate feature alloc only.

fn from(block: Block) -> Self

Converts to this type from the input type.

impl<V> PartialEq for Block<V>

where V: Validation + PartialEq,

fn eq(&self, other: &Block<V>) -> 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<V> Eq for Block<V>

where V: Validation + Eq,

impl<V> StructuralPartialEq for Block<V>

where V: Validation,