Struct Header 

pub struct Header<N>
where
    N: Network,
{ /* private fields */ }

The header for the block contains metadata that uniquely identifies the block.

Implementations

impl<N> Header<N>

where N: Network,

pub fn genesis( ratifications: &Ratifications<N>, transactions: &Transactions<N>, ratified_finalize_operations: Vec<FinalizeOperation<N>>, ) -> Result<Header<N>, Error>

Initializes the genesis block header.

pub fn is_genesis(&self) -> Result<bool, Error>

Returns true if the block header is a genesis block header.

Return an error if the header is malformed.

impl<N> Header<N>

where N: Network,

pub fn to_root(&self) -> Result<Field<N>, Error>

Returns the block header root.

pub fn to_path( &self, leaf: &HeaderLeaf<N>, ) -> Result<MerklePath<N, snarkvm_console_program::::state_path::configuration::HeaderPath::{constant#0}>, Error>

Returns the Merkle path for the Merkle tree of the block header.

pub fn to_leaf(&self, id: &Field<N>) -> Result<HeaderLeaf<N>, Error>

Returns the Merkle leaf for the given ID in the header.

pub fn to_tree( &self, ) -> Result<MerkleTree<N, BHP<N, 8, 54>, BHP<N, 6, 43>, snarkvm_console_program::::state_path::configuration::HeaderTree::{constant#0}>, Error>

Returns an instance of the Merkle tree for the block header.

impl<N> Header<N>

where N: Network,

pub fn verify( &self, expected_previous_state_root: <N as Network>::StateRoot, expected_transactions_root: Field<N>, expected_finalize_root: Field<N>, expected_ratifications_root: Field<N>, expected_solutions_root: Field<N>, expected_subdag_root: Field<N>, expected_round: u64, expected_height: u32, expected_cumulative_weight: u128, expected_cumulative_proof_target: u128, expected_coinbase_target: u64, expected_proof_target: u64, expected_last_coinbase_target: u64, expected_last_coinbase_timestamp: i64, expected_timestamp: i64, current_timestamp: i64, ) -> Result<(), Error>

Ensures the block header is correct.

impl<N> Header<N>

where N: Network,

pub fn from( previous_state_root: <N as Network>::StateRoot, transactions_root: Field<N>, finalize_root: Field<N>, ratifications_root: Field<N>, solutions_root: Field<N>, subdag_root: Field<N>, metadata: Metadata<N>, ) -> Result<Header<N>, Error>

Initializes a new block header with the given inputs.

pub fn is_valid(&self) -> bool

Returns true if the block header is well-formed.

Consider using Self::check_validity to get more information on invalid block headers.

pub fn check_validity(&self) -> Result<(), Error>

Returns Ok(()) if the block header is well-formed, and error describing (one of) the problem(s) in the block header.

pub const fn previous_state_root(&self) -> <N as Network>::StateRoot

Returns the previous state root from the block header.

pub const fn transactions_root(&self) -> Field<N>

Returns the transactions root in the block header.

pub const fn finalize_root(&self) -> Field<N>

Returns the finalize root in the block header.

pub const fn ratifications_root(&self) -> Field<N>

Returns the ratifications root in the block header.

pub const fn solutions_root(&self) -> Field<N>

Returns the solutions root in the block header.

pub const fn subdag_root(&self) -> Field<N>

Returns the subdag root in the block header.

pub const fn metadata(&self) -> &Metadata<N>

Returns the metadata in the block header.

pub const fn network(&self) -> u16

Returns the network ID of the block.

pub const fn round(&self) -> u64

Returns the round number of the block.

pub const fn height(&self) -> u32

Returns the height of the block.

pub const fn cumulative_weight(&self) -> u128

Returns the cumulative weight for this block.

pub const fn cumulative_proof_target(&self) -> u128

Returns the cumulative proof target for this block.

pub const fn coinbase_target(&self) -> u64

Returns the coinbase target for this block.

pub const fn proof_target(&self) -> u64

Returns the proof target for this block.

pub const fn last_coinbase_target(&self) -> u64

Returns the coinbase target of the last coinbase.

pub const fn last_coinbase_timestamp(&self) -> i64

Returns the Unix timestamp (UTC) of the last coinbase.

pub const fn timestamp(&self) -> i64

Returns the Unix timestamp (UTC) for this block.

Trait Implementations

impl<N> Clone for Header<N>

where N: Clone + Network, <N as Network>::StateRoot: Clone,

fn clone(&self) -> Header<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Header<N>

where N: Network,

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

Prints the header as a JSON-string.

impl<'de, N> Deserialize<'de> for Header<N>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<Header<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the header from a JSON-string or buffer.

impl<N> Display for Header<N>

where N: Network,

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

Displays the header as a JSON-string.

impl<N> FromBytes for Header<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<Header<N>, Error>

where R: Read,

Reads the block header from the buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N> FromStr for Header<N>

where N: Network,

fn from_str(header: &str) -> Result<Header<N>, <Header<N> as FromStr>::Err>

Initializes the header from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Hash for Header<N>

where N: Hash + Network, <N as Network>::StateRoot: Hash,

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<N> PartialEq for Header<N>

where N: PartialEq + Network, <N as Network>::StateRoot: PartialEq,

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

where N: Network,

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

where S: Serializer,

Serializes the header to a JSON-string or buffer.

impl<N> ToBytes for Header<N>

where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes the block header to the buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> Copy for Header<N>

where N: Copy + Network, <N as Network>::StateRoot: Copy,

impl<N> Eq for Header<N>

where N: Eq + Network, <N as Network>::StateRoot: Eq,

impl<N> StructuralPartialEq for Header<N>

where N: Network,