Struct Header 

pub struct Header<H = Header> {
    pub hash: FixedBytes<32>,
    pub inner: H,
    pub total_difficulty: Option<Uint<256, 4>>,
    pub size: Option<Uint<256, 4>>,
}

Available on crate feature rpc only.

RPC representation of block header, wrapping a consensus header.

This wraps the consensus header and adds additional fields for RPC.

The block hash is trusted metadata received from RPC or a seal, not a live view of inner. Mutating or mapping the inner header does not recompute the hash and can make the two inconsistent. Use Self::new or reseal the inner header when a recomputed hash is required.

Fields

hash: FixedBytes<32>

Hash of the block as received from RPC or a trusted seal.

inner: H

Inner consensus header.

total_difficulty: Option<Uint<256, 4>>

Total difficulty

Note: This field is now effectively deprecated: https://github.com/ethereum/execution-apis/pull/570

size: Option<Uint<256, 4>>

Integer the size of this block in bytes.

Implementations

impl<H> Header<H>

pub fn new(inner: H) -> Header<H>

where H: Sealable,

Create a new Header from a consensus header.

Note: This will compute the hash of the header.

pub fn from_sealed(header: Sealed<H>) -> Header<H>

Create a new Header from a sealed consensus header.

Note: This does not set the total difficulty or size of the block.

pub fn into_sealed(self) -> Sealed<H>

Consumes the type and returns the [Sealed] header.

This uses the stored hash without verification or recomputation.

pub fn into_consensus(self) -> H

Consumes the type and returns the wrapped consensus header.

pub fn from_consensus( header: Sealed<H>, total_difficulty: Option<Uint<256, 4>>, size: Option<Uint<256, 4>>, ) -> Header<H>

Create a new Header from a sealed consensus header and additional fields.

pub const fn with_total_difficulty( self, total_difficulty: Option<Uint<256, 4>>, ) -> Header<H>

Set the total difficulty of the block.

pub const fn with_size(self, size: Option<Uint<256, 4>>) -> Header<H>

Set the size of the block.

pub fn map<H1>(self, f: impl FnOnce(H) -> H1) -> Header<H1>

Applies the given closure to the inner header.

The stored hash is preserved without checking that the mapped header has the same hash.

pub fn try_map<H1, E>( self, f: impl FnOnce(H) -> Result<H1, E>, ) -> Result<Header<H1>, E>

Applies the given fallible closure to the inner header.

The stored hash is preserved without checking that the mapped header has the same hash.

impl<H> Header<H>

where H: BlockHeader,

pub fn blob_fee(&self) -> 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_excess_blob_gas(&self, blob_params: BlobParams) -> Option<u64>

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

Returns a None if no excess blob gas is set, no EIP-4844 support

Trait Implementations

impl<'arbitrary, H> Arbitrary<'arbitrary> for Header<H>

where H: Arbitrary<'arbitrary>,

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Header<H>, Error>

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

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Header<H>, 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<H> AsRef<H> for Header<H>

fn as_ref(&self) -> &H

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

impl<H> BlockHeader for Header<H>

where H: BlockHeader,

fn parent_hash(&self) -> FixedBytes<32>

Retrieves the parent hash of the block

fn ommers_hash(&self) -> FixedBytes<32>

Retrieves the ommers hash of the block

fn beneficiary(&self) -> Address

Retrieves the beneficiary (miner) of the block

fn state_root(&self) -> FixedBytes<32>

Retrieves the state root hash of the block

fn transactions_root(&self) -> FixedBytes<32>

Retrieves the transactions root hash of the block

fn receipts_root(&self) -> FixedBytes<32>

Retrieves the receipts root hash of the block

fn withdrawals_root(&self) -> Option<FixedBytes<32>>

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) -> Uint<256, 4>

Retrieves the difficulty of the block

fn number(&self) -> u64

Retrieves the block number

fn gas_limit(&self) -> u64

A scalar value equal to the current limit of gas expenditure per block; formally Hl. Under EIP-8037 it bounds each of the block’s two gas dimensions (execution and state) separately, not their sum.

fn gas_used(&self) -> u64

A scalar value equal to the total gas used in transactions in this block; formally Hg. Under EIP-8037 this is the larger of the block’s execution-gas and state-gas totals, counted before refunds (EIP-7778), so it need not equal the last receipt’s cumulativeGasUsed. State totals remain net of state refills.

fn timestamp(&self) -> u64

Retrieves the timestamp of the block

fn mix_hash(&self) -> Option<FixedBytes<32>>

Retrieves the mix hash of the block, if available

fn nonce(&self) -> Option<FixedBytes<8>>

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<FixedBytes<32>>

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

fn requests_hash(&self) -> Option<FixedBytes<32>>

Retrieves the requests hash of the block, if available

fn block_access_list_hash(&self) -> Option<FixedBytes<32>>

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<H> Clone for Header<H>

where H: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H> Debug for Header<H>

where H: Debug,

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

Formats the value using the given formatter.

impl<H> Default for Header<H>

where H: Default,

fn default() -> Header<H>

Returns the “default value” for a type.

impl<H> Deref for Header<H>

type Target = H

The resulting type after dereferencing.

fn deref(&self) -> &<Header<H> as Deref>::Target

Dereferences the value.

impl<H> DerefMut for Header<H>

fn deref_mut(&mut self) -> &mut <Header<H> as Deref>::Target

Mutably dereferences the value.

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

where H: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<H> Eq for Header<H>

where H: Eq,

impl<H> From<Header<H>> for SealedHeader<H>

fn from(value: Header<H>) -> SealedHeader<H>

Converts to this type from the input type.

impl From<Header> for Header

fn from(header: Header) -> Header

Converts to this type from the input type.

impl<T> FromConsensusHeader<T> for Header<T>

where T: Sealable,

fn from_consensus_header( header: SealedHeader<T>, block_size: Option<usize>, ) -> Header<T>

Takes a consensus header and converts it into self.

impl<H> Hash for Header<H>

where H: 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<H> HeaderResponse for Header<H>

where H: BlockHeader,

fn hash(&self) -> FixedBytes<32>

Block hash

fn num_hash(&self) -> NumHash

Returns the BlockNumHash of this header.

impl<H> PartialEq for Header<H>

where H: PartialEq,

fn eq(&self, other: &Header<H>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<H> Serialize for Header<H>

where H: Serialize,

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<H> StructuralPartialEq for Header<H>

where H: PartialEq,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.