Struct Header

pub struct Header<H = Header> {
    pub hash: BlockHash,
    pub inner: H,
    pub total_difficulty: Option<U256>,
    pub size: Option<U256>,
}

RPC representation of block header, wrapping a consensus header.

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

Fields

hash: BlockHash

Hash of the block

inner: H

Inner consensus header.

total_difficulty: Option<U256>

Total difficulty

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

size: Option<U256>

Integer the size of this block in bytes.

Implementations

impl<H> Header<H>

pub fn new(inner: H) -> Self

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>) -> Self

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.

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<U256>, size: Option<U256>, ) -> Self

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

pub const fn with_total_difficulty(self, total_difficulty: Option<U256>) -> Self

Set the total difficulty of the block.

pub const fn with_size(self, size: Option<U256>) -> Self

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.

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.

impl<H: BlockHeader> Header<H>

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

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 extra_data(&self) -> &Bytes

Retrieves the block’s extra data field

fn header_info(&self) -> HeaderInfo

Extracts essential information into one container type.

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

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

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

Formats the value using the given formatter.

impl<H: Default> Default for Header<H>

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) -> &Self::Target

Dereferences the value.

impl<H> DerefMut for Header<H>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

where H: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<H> From<Header<H>> for Sealed<H>

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

Converts to this type from the input type.

impl From<Header> for Header

fn from(header: Header) -> Self

Converts to this type from the input type.

impl From<Header> for WithOtherFields<Header>

fn from(inner: Header) -> Self

Converts to this type from the input type.

impl<H: Hash> Hash for Header<H>

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

fn hash(&self) -> BlockHash

Block hash

impl<H: PartialEq> PartialEq for Header<H>

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

where H: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<H: Eq> Eq for Header<H>

impl<H> StructuralPartialEq for Header<H>