Struct miden_client::blocks::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_hash is the hash of the previous block header.
• block_num is a unique sequential number of the current block.
• chain_root 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_hash is a commitment to a set of IDs of transactions which affected accounts in the block.
• proof_hash is a hash of a 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_hash is a sequential hash of all fields except the note_root.
• hash is a 2-to-1 hash of the sub_hash and the note_root.

Implementations

impl BlockHeader

pub fn new( version: u32, prev_hash: RpoDigest, block_num: u32, chain_root: RpoDigest, account_root: RpoDigest, nullifier_root: RpoDigest, note_root: RpoDigest, tx_hash: RpoDigest, proof_hash: RpoDigest, timestamp: u32, ) -> BlockHeader

Creates a new block header.

pub fn version(&self) -> u32

Returns the protocol version.

pub fn hash(&self) -> RpoDigest

Returns the hash of the block header.

pub fn sub_hash(&self) -> RpoDigest

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

pub fn prev_hash(&self) -> RpoDigest

Returns the hash of the previous block header.

pub fn block_num(&self) -> u32

Returns the block number.

pub fn chain_root(&self) -> RpoDigest

Returns the chain root.

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_hash(&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 proof_hash(&self) -> RpoDigest

Returns the proof hash.

pub fn timestamp(&self) -> u32

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

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<'de> Deserialize<'de> for BlockHeader

fn deserialize<__D>( __deserializer: __D, ) -> Result<BlockHeader, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BlockHeader

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BlockHeader

impl Eq for BlockHeader

impl StructuralPartialEq for BlockHeader