Enum FoundryHeader 

pub enum FoundryHeader {
    Tempo(TempoHeader),
    Ethereum(Header),
}

Consensus header used by Foundry’s multi-network tooling.

The variant order is significant for untagged serde deserialization. Self::Tempo must stay first because Ethereum headers ignore unknown fields and would otherwise silently deserialize Tempo state dumps as Self::Ethereum.

Variants

Tempo(TempoHeader)

Tempo consensus header.

Ethereum(Header)

Ethereum consensus header.

Implementations

impl FoundryHeader

pub const fn new(inner: Header, is_tempo: bool) -> Self

Creates a header for the selected network.

pub const fn tempo(inner: Header) -> Self

Creates a Tempo header from its Ethereum-shaped fields.

pub const fn as_tempo(&self) -> Option<&TempoHeader>

Returns the Tempo header when this is a Tempo block.

pub const fn inner(&self) -> &Header

Returns the inner Ethereum-shaped header.

const fn inner_mut(&mut self) -> &mut Header

pub const fn set_transactions_root(&mut self, transactions_root: B256)

Sets the transactions root shared by Ethereum and Tempo headers.

pub const fn set_ommers_hash(&mut self, ommers_hash: B256)

Sets the ommers root shared by Ethereum and Tempo headers.

pub fn into_inner(self) -> Header

Consumes the wrapper and returns the inner Ethereum-shaped header.

pub fn hash_slow(&self) -> B256

Computes the canonical network header hash.

Methods from Deref<Target = Header>

pub fn hash_slow(&self) -> FixedBytes<32>

Heavy function that will calculate hash of data and will not save the change to metadata.

Use [Header::seal_slow] and unlock if you need the hash to be persistent.

pub fn ommers_hash_is_empty(&self) -> bool

Check if the ommers hash equals to empty hash list.

pub fn transaction_root_is_empty(&self) -> bool

Check if the transaction root equals to empty root.

pub fn blob_fee(&self, blob_params: BlobParams) -> Option<u128>

Returns the blob fee for this block according to the EIP-4844 spec.

Returns None if excess_blob_gas is None

pub fn next_block_blob_fee(&self, blob_params: BlobParams) -> Option<u128>

Returns the blob fee for the next block according to the EIP-4844 spec.

Returns None if excess_blob_gas is None.

See also [Self::next_block_excess_blob_gas]

pub fn next_block_base_fee(&self, base_fee_params: BaseFeeParams) -> Option<u64>

Calculate base fee for next block according to the EIP-1559 spec.

Returns a None if no base fee is set, no EIP-1559 support

pub fn next_block_excess_blob_gas(&self, blob_params: BlobParams) -> Option<u64>

Calculate excess blob gas for the next block according to the EIP-4844 spec.

Returns None if excess_blob_gas, blob_gas_used, or base_fee_per_gas is not set.

pub fn size(&self) -> usize

Calculate a heuristic for the in-memory size of the [Header].

pub fn parent_num_hash(&self) -> NumHash

Returns the parent block’s number and hash

Note: for the genesis block the parent number is 0 and the parent hash is the zero hash.

pub fn num_hash_slow(&self) -> NumHash

Returns the block’s number and hash.

Note: this hashes the header.

pub fn num_hash_with_parent_slow(&self) -> BlockWithParent

Returns the block’s number and hash with the parent hash.

Note: this hashes the header.

pub fn shanghai_active(&self) -> bool

True if the shanghai hardfork is active.

This function checks that the withdrawals root field is present.

pub fn cancun_active(&self) -> bool

True if the Cancun hardfork is active.

This function checks that the blob gas used field is present.

pub fn prague_active(&self) -> bool

True if the Prague hardfork is active.

This function checks that the requests hash is present.

pub fn amsterdam_active(&self) -> bool

True if the Amsterdam hardfork is active.

This function checks that the block access list hash is present.

Trait Implementations

impl AsRef<FoundryHeader> for FoundryHeader

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl BlockHeader for FoundryHeader

fn parent_hash(&self) -> B256

Retrieves the parent hash of the block

fn ommers_hash(&self) -> B256

Retrieves the ommers hash of the block

fn beneficiary(&self) -> Address

Retrieves the beneficiary (miner) of the block

fn state_root(&self) -> B256

Retrieves the state root hash of the block

fn transactions_root(&self) -> B256

Retrieves the transactions root hash of the block

fn receipts_root(&self) -> B256

Retrieves the receipts root hash of the block

fn withdrawals_root(&self) -> Option<B256>

Retrieves the withdrawals root hash of the block, if available

fn logs_bloom(&self) -> Bloom

Retrieves the logs bloom filter of the block

fn difficulty(&self) -> U256

Retrieves the difficulty of the block

fn number(&self) -> u64

Retrieves the block number

fn gas_limit(&self) -> u64

Retrieves the gas limit of the block

fn gas_used(&self) -> u64

Retrieves the gas used by the block

fn timestamp(&self) -> u64

Retrieves the timestamp of the block

fn mix_hash(&self) -> Option<B256>

Retrieves the mix hash of the block, if available

fn nonce(&self) -> Option<B64>

Retrieves the nonce of the block, if available

fn base_fee_per_gas(&self) -> Option<u64>

Retrieves the base fee per gas of the block, if available

fn blob_gas_used(&self) -> Option<u64>

Retrieves the blob gas used by the block, if available

fn excess_blob_gas(&self) -> Option<u64>

Retrieves the excess blob gas of the block, if available

fn parent_beacon_block_root(&self) -> Option<B256>

Retrieves the parent beacon block root of the block, if available

fn requests_hash(&self) -> Option<B256>

Retrieves the requests hash of the block, if available

fn block_access_list_hash(&self) -> Option<B256>

Retrieves the block access list hash of the block, if available

fn slot_number(&self) -> Option<u64>

Retrieves the slot number of the block, if available

fn extra_data(&self) -> &Bytes

Retrieves the block’s extra data field

fn header_info(&self) -> HeaderInfo

Extracts essential information into one container type.

fn header_roots(&self) -> HeaderRoots

Returns all roots contained in the header.

fn blob_fee(&self, blob_params: BlobParams) -> Option<u128>

Returns the blob fee for this block according to the EIP-4844 spec.

fn next_block_excess_blob_gas(&self, blob_params: BlobParams) -> Option<u64>

Calculate excess blob gas for the next block according to the EIP-4844 spec.

fn maybe_next_block_excess_blob_gas( &self, blob_params: Option<BlobParams>, ) -> Option<u64>

Convenience function for [Self::next_block_excess_blob_gas] with an optional [BlobParams] argument.

fn next_block_blob_fee(&self, blob_params: BlobParams) -> Option<u128>

Returns the blob fee for the next block according to the EIP-4844 spec.

fn maybe_next_block_blob_fee( &self, blob_params: Option<BlobParams>, ) -> Option<u128>

Convenience function for [Self::next_block_blob_fee] with an optional [BlobParams] argument.

fn next_block_base_fee(&self, base_fee_params: BaseFeeParams) -> Option<u64>

Calculate base fee for next block according to the EIP-1559 spec.

fn validate_gas_limit( &self, desired_gas_limit: u64, gas_limit: u64, ) -> Result<(), GasLimitMismatch>

Validates that a child block’s gas limit is the closest possible value to the desired gas limit, using the default [GAS_LIMIT_BOUND_DIVISOR].

fn validate_gas_limit_with_bound_divisor( &self, desired_gas_limit: u64, gas_limit: u64, gas_limit_bound_divisor: u64, ) -> Result<(), GasLimitMismatch>

Validates that a child block’s gas limit is the closest possible value to the desired gas limit, using the provided gas limit bound divisor.

fn parent_num_hash(&self) -> NumHash

Returns the parent block’s number and hash

fn is_empty(&self) -> bool

Checks if the header is considered empty - has no transactions, no ommers or withdrawals

fn is_zero_difficulty(&self) -> bool

Checks if the block’s difficulty is set to zero, indicating a Proof-of-Stake header.

fn exceeds_allowed_future_timestamp(&self, present_timestamp: u64) -> bool

Checks if the block’s timestamp is in the future based on the present timestamp.

fn is_nonce_zero(&self) -> bool

Checks if the nonce exists, and if it exists, if it’s zero.

impl Clone for FoundryHeader

fn clone(&self) -> FoundryHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoundryHeader

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

Formats the value using the given formatter.

impl Decodable for FoundryHeader

fn decode(buf: &mut &[u8]) -> Result<Self>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

impl Default for FoundryHeader

fn default() -> Self

Returns the “default value” for a type.

impl Deref for FoundryHeader

type Target = Header

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for FoundryHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for FoundryHeader

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

impl Eq for FoundryHeader

impl From<Header> for FoundryHeader

fn from(value: Header) -> Self

Converts to this type from the input type.

impl From<TempoHeader> for FoundryHeader

fn from(value: TempoHeader) -> Self

Converts to this type from the input type.

impl Hash for FoundryHeader

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

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 PartialEq for FoundryHeader

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

fn hash_slow(&self) -> B256

Calculate the seal hash, this may be slow.

fn seal_slow(self) -> Sealed<Self>

Seal the object by calculating the hash. This may be slow.

fn seal_ref_slow(&self) -> Sealed<&Self>

Seal a borrowed object by calculating the hash. This may be slow.

fn seal_unchecked(self, seal: FixedBytes<32>) -> Sealed<Self>

Instantiate an unchecked seal. This should be used with caution.

fn seal_ref_unchecked(&self, seal: FixedBytes<32>) -> Sealed<&Self>

Instantiate an unchecked seal. This should be used with caution.

impl Serialize for FoundryHeader

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FoundryHeader

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1016 bytes

Size for each variant:

• Tempo: 1016 bytes
• Ethereum: 776 bytes