Struct BlockHeader

pub struct BlockHeader { /* private fields */ }

The header of a block. It contains metadata about the block, commitments to the current state of the chain and the hash of the proof that attests to the integrity of the chain.

A block header includes the following fields:

• version specifies the version of the protocol.
• prev_block_commitment is the hash of the previous block header.
• block_num is a unique sequential number of the current block.
• chain_commitment is a commitment to an MMR of the entire chain where each block is a leaf.
• account_root is a commitment to account database.
• nullifier_root is a commitment to the nullifier database.
• note_root is a commitment to all notes created in the current block.
• tx_commitment is a commitment to the set of transaction IDs which affected accounts in the block.
• tx_kernel_commitment a commitment to all transaction kernels supported by this block.
• proof_commitment is the commitment of the block’s STARK proof attesting to the correct state transition.
• timestamp is the time when the block was created, in seconds since UNIX epoch. Current representation is sufficient to represent time up to year 2106.
• sub_commitment is a sequential hash of all fields except the note_root.
• commitment is a 2-to-1 hash of the sub_commitment and the note_root.

Implementations

impl BlockHeader

pub fn new( version: u32, prev_block_commitment: RpoDigest, block_num: BlockNumber, chain_commitment: RpoDigest, account_root: RpoDigest, nullifier_root: RpoDigest, note_root: RpoDigest, tx_commitment: RpoDigest, tx_kernel_commitment: RpoDigest, proof_commitment: RpoDigest, timestamp: u32, ) -> BlockHeader

Creates a new block header.

pub fn version(&self) -> u32

Returns the protocol version.

pub fn commitment(&self) -> RpoDigest

Returns the commitment of the block header.

pub fn sub_commitment(&self) -> RpoDigest

Returns the sub commitment of the block header.

The sub commitment is a sequential hash of all block header fields except the note root. This is used in the block commitment computation which is a 2-to-1 hash of the sub commitment and the note root [hash(sub_commitment, note_root)]. This procedure is used to make the note root easily accessible without having to unhash the entire header.

pub fn prev_block_commitment(&self) -> RpoDigest

Returns the commitment to the previous block header.

pub fn block_num(&self) -> BlockNumber

Returns the block number.

pub fn block_epoch(&self) -> u16

Returns the epoch to which this block belongs.

This is the block number shifted right by BlockNumber::EPOCH_LENGTH_EXPONENT.

pub fn chain_commitment(&self) -> RpoDigest

Returns the chain commitment.

pub fn account_root(&self) -> RpoDigest

Returns the account database root.

pub fn nullifier_root(&self) -> RpoDigest

Returns the nullifier database root.

pub fn note_root(&self) -> RpoDigest

Returns the note root.

pub fn tx_commitment(&self) -> RpoDigest

Returns the commitment to all transactions in this block.

The commitment is computed as sequential hash of (transaction_id, account_id) tuples. This makes it possible for the verifier to link transaction IDs to the accounts which they were executed against.

pub fn tx_kernel_commitment(&self) -> RpoDigest

Returns the transaction kernel commitment.

The transaction kernel commitment is computed as a sequential hash of all transaction kernel hashes.

pub fn proof_commitment(&self) -> RpoDigest

Returns the proof commitment.

pub fn timestamp(&self) -> u32

Returns the timestamp at which the block was created, in seconds since UNIX epoch.

pub fn epoch_block_num(&self) -> BlockNumber

Returns the block number of the epoch block to which this block belongs.

pub fn compute_tx_commitment( updated_accounts: impl Iterator<Item = (TransactionId, AccountId)>, ) -> RpoDigest

Computes a commitment to the provided list of transactions.

Trait Implementations

impl Clone for BlockHeader

fn clone(&self) -> BlockHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockHeader

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

Formats the value using the given formatter.

impl Deserializable for BlockHeader

fn read_from<R>(source: &mut R) -> Result<BlockHeader, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for BlockHeader

fn eq(&self, other: &BlockHeader) -> 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 Serializable for BlockHeader

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

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

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for BlockHeader

impl StructuralPartialEq for BlockHeader