Struct RecoveredBlock

pub struct RecoveredBlock<B: Block> { /* private fields */ }

A block with senders recovered from the block’s transactions.

This type is a SealedBlock with a list of senders that match the transactions in the block.

Sealing

This type uses lazy sealing to avoid hashing the header until it is needed:

RecoveredBlock::new_unhashed creates a recovered block without hashing the header. RecoveredBlock::new creates a recovered block with the corresponding block hash.

Recovery

Sender recovery is fallible and can fail if any of the transactions fail to recover the sender. A SealedBlock can be upgraded to a RecoveredBlock using the RecoveredBlock::try_recover or SealedBlock::try_recover method.

Implementations

impl<B: Block> RecoveredBlock<B>

pub fn new(block: B, senders: Vec<Address>, hash: BlockHash) -> Self

Creates a new recovered block instance with the given senders as provided and the block hash.

Note: This expects that the given senders match the transactions in the block.

pub fn new_unhashed(block: B, senders: Vec<Address>) -> Self

Creates a new recovered block instance with the given senders as provided.

Note: This expects that the given senders match the transactions in the block.

pub fn senders(&self) -> &[Address]

Returns the recovered senders.

pub fn senders_iter(&self) -> impl Iterator<Item = &Address>

Returns an iterator over the recovered senders.

pub fn into_block(self) -> B

Consumes the type and returns the inner block.

pub const fn sealed_block(&self) -> &SealedBlock<B>

Returns a reference to the sealed block.

pub const fn new_sealed(block: SealedBlock<B>, senders: Vec<Address>) -> Self

Creates a new recovered block instance with the given SealedBlock and senders as provided

pub fn try_new( block: B, senders: Vec<Address>, hash: BlockHash, ) -> Result<Self, SealedBlockRecoveryError<B>>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer to recover the senders.

pub fn try_new_unchecked( block: B, senders: Vec<Address>, hash: BlockHash, ) -> Result<Self, SealedBlockRecoveryError<B>>

A safer variant of Self::new that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

pub fn try_new_unhashed( block: B, senders: Vec<Address>, ) -> Result<Self, RecoveryError>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer to recover the senders.

pub fn try_new_unhashed_unchecked( block: B, senders: Vec<Address>, ) -> Result<Self, RecoveryError>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

pub fn try_recover(block: B) -> Result<Self, RecoveryError>

Recovers the senders from the transactions in the block using SignedTransaction::recover_signer.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_unchecked(block: B) -> Result<Self, RecoveryError>

Recovers the senders from the transactions in the block using SignedTransaction::recover_signer_unchecked.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed( block: SealedBlock<B>, ) -> Result<Self, SealedBlockRecoveryError<B>>

Recovers the senders from the transactions in the block using SignedTransaction::recover_signer.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed_unchecked( block: SealedBlock<B>, ) -> Result<Self, SealedBlockRecoveryError<B>>

Recovers the senders from the transactions in the sealed block using SignedTransaction::recover_signer_unchecked.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed_with_senders( block: SealedBlock<B>, senders: Vec<Address>, ) -> Result<Self, SealedBlockRecoveryError<B>>

A safer variant of Self::new_unhashed that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

Returns an error if any of the transactions fail to recover the sender.

pub fn try_recover_sealed_with_senders_unchecked( block: SealedBlock<B>, senders: Vec<Address>, ) -> Result<Self, SealedBlockRecoveryError<B>>

A safer variant of Self::new that checks if the number of senders is equal to the number of transactions in the block and recovers the senders from the transactions, if not using SignedTransaction::recover_signer_unchecked to recover the senders.

pub fn hash_ref(&self) -> &BlockHash

Returns the block hash.

pub fn hash(&self) -> BlockHash

Returns a copy of the block hash.

pub fn num_hash(&self) -> BlockNumHash

Return the number hash tuple.

pub fn block_with_parent(&self) -> BlockWithParent

Return a [BlockWithParent] for this header.

pub fn clone_header(&self) -> B::Header

Clone the header.

pub fn clone_sealed_header(&self) -> SealedHeader<B::Header>

Clones the internal header and returns a SealedHeader sealed with the hash.

pub fn clone_sealed_block(&self) -> SealedBlock<B>

Clones the wrapped block and returns the SealedBlock sealed with the hash.

pub fn into_header(self) -> B::Header

Consumes the block and returns the block’s header.

pub fn into_body(self) -> B::Body

Consumes the block and returns the block’s body.

pub fn into_sealed_block(self) -> SealedBlock<B>

Consumes the block and returns the SealedBlock and drops the recovered senders.

pub fn split_sealed(self) -> (SealedBlock<B>, Vec<Address>)

Consumes the type and returns its components.

pub fn split(self) -> (B, Vec<Address>)

Consumes the type and returns its components.

pub fn transactions_with_sender( &self, ) -> impl Iterator<Item = (&Address, &<B::Body as BlockBody>::Transaction)> + '_

Returns an iterator over all transactions and their sender.

pub fn clone_transactions_recovered( &self, ) -> impl Iterator<Item = Recovered<<B::Body as BlockBody>::Transaction>> + '_

Returns an iterator over cloned Recovered<Transaction>

pub fn transactions_recovered( &self, ) -> impl Iterator<Item = Recovered<&<B::Body as BlockBody>::Transaction>> + '_

Returns an iterator over Recovered<&Transaction>

pub fn into_transactions_recovered( self, ) -> impl Iterator<Item = Recovered<<B::Body as BlockBody>::Transaction>>

Consumes the type and returns an iterator over all Recovered transactions in the block.

pub fn into_transactions(self) -> Vec<<B::Body as BlockBody>::Transaction>

Consumes the block and returns the transactions of the block.

impl<B: Block> RecoveredBlock<B>

pub const fn senders_mut(&mut self) -> &mut Vec<Address>

Available on crate feature test-utils only.

Returns a mutable reference to the recovered senders.

pub fn push_sender(&mut self, sender: Address)

Available on crate feature test-utils only.

Appends the sender to the list of senders.

impl<B: TestBlock> RecoveredBlock<B>

pub fn set_header(&mut self, header: B::Header)

Available on crate feature test-utils only.

Updates the block header.

pub fn set_hash(&mut self, hash: BlockHash)

Available on crate feature test-utils only.

Updates the block hash.

pub const fn header_mut(&mut self) -> &mut B::Header

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub const fn block_mut(&mut self) -> &mut B::Body

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub fn set_parent_hash(&mut self, hash: BlockHash)

Available on crate feature test-utils only.

Updates the parent block hash.

pub fn set_block_number(&mut self, number: BlockNumber)

Available on crate feature test-utils only.

Updates the block number.

pub fn set_state_root(&mut self, state_root: B256)

Available on crate feature test-utils only.

Updates the block state root.

pub fn set_difficulty(&mut self, difficulty: U256)

Available on crate feature test-utils only.

Updates the block difficulty.

Methods from Deref<Target = SealedBlock<B>>

pub fn hash_ref(&self) -> &BlockHash

Returns a reference to the block hash.

pub fn hash(&self) -> B256

Returns the block hash.

pub fn clone_block(&self) -> B

Clones the wrapped block.

pub fn header(&self) -> &B::Header

Returns reference to block header.

pub fn body(&self) -> &B::Body

Returns reference to block body.

pub fn rlp_length(&self) -> usize

Returns the length of the block.

pub fn senders(&self) -> Result<Vec<Address>, RecoveryError>

Recovers all senders from the transactions in the block.

Returns None if any of the transactions fail to recover the sender.

pub fn num_hash(&self) -> BlockNumHash

Return the number hash tuple.

pub fn block_with_parent(&self) -> BlockWithParent

Return a [BlockWithParent] for this header.

pub fn sealed_header(&self) -> &SealedHeader<B::Header>

Returns the Sealed header.

pub fn sealed_header_ref(&self) -> SealedHeader<&B::Header>

Returns the wrapped SealedHeader<B::Header> as SealedHeader<&B::Header>.

pub fn clone_sealed_header(&self) -> SealedHeader<B::Header>

Clones the wrapped header and returns a SealedHeader sealed with the hash.

pub fn blob_versioned_hashes_iter(&self) -> impl Iterator<Item = &B256> + '_

Returns an iterator over all blob versioned hashes from the block body.

pub fn transaction_count(&self) -> usize

Returns the number of transactions in the block.

pub fn ensure_transaction_root_valid(&self) -> Result<(), GotExpected<B256>>

Ensures that the transaction root in the block header is valid.

The transaction root is the Keccak 256-bit hash of the root node of the trie structure populated with each transaction in the transactions list portion of the block.

Returns

Returns Ok(()) if the calculated transaction root matches the one stored in the header, indicating that the transactions in the block are correctly represented in the trie.

Returns Err(error) if the transaction root validation fails, providing a GotExpected error containing the calculated and expected roots.

pub fn header_mut(&mut self) -> &mut B::Header

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub fn set_hash(&mut self, hash: BlockHash)

Available on crate feature test-utils only.

Updates the block hash.

pub fn body_mut(&mut self) -> &mut B::Body

Available on crate feature test-utils only.

Returns a mutable reference to the header.

pub fn set_parent_hash(&mut self, hash: BlockHash)

Available on crate feature test-utils only.

Updates the parent block hash.

pub fn set_block_number(&mut self, number: BlockNumber)

Available on crate feature test-utils only.

Updates the block number.

pub fn set_state_root(&mut self, state_root: B256)

Available on crate feature test-utils only.

Updates the block state root.

pub fn set_difficulty(&mut self, difficulty: U256)

Available on crate feature test-utils only.

Updates the block difficulty.

Trait Implementations

impl<'a, B> Arbitrary<'a> for RecoveredBlock<B>

where B: Block + Arbitrary<'a>,

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

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

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, 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<B: Block> BlockHeader for RecoveredBlock<B>

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

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 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<B: Clone + Block> Clone for RecoveredBlock<B>

fn clone(&self) -> RecoveredBlock<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Debug + Block> Debug for RecoveredBlock<B>

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

Formats the value using the given formatter.

impl<B: Block + Default> Default for RecoveredBlock<B>

fn default() -> Self

Returns the “default value” for a type.

impl<B: Block> Deref for RecoveredBlock<B>

type Target = SealedBlock<B>

The resulting type after dereferencing.

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

Dereferences the value.

impl<B> DerefMut for RecoveredBlock<B>

where B: Block,

Available on crate feature test-utils only.

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

Mutably dereferences the value.

impl<'de, B: Block> Deserialize<'de> for RecoveredBlock<B>

where SealedBlock<B>: Serialize + DeserializeOwned,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de, T: Block<Header: SerdeBincodeCompat, Body: SerdeBincodeCompat> + 'static> DeserializeAs<'de, RecoveredBlock<T>> for RecoveredBlock<'de, T>

Available on crate feature serde-bincode-compat only.

fn deserialize_as<D>(deserializer: D) -> Result<RecoveredBlock<T>, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, T: Block<Header: SerdeBincodeCompat, Body: SerdeBincodeCompat> + 'static> From<&'a RecoveredBlock<T>> for RecoveredBlock<'a, T>

Available on crate feature serde-bincode-compat only.

fn from(value: &'a RecoveredBlock<T>) -> Self

Converts to this type from the input type.

impl<'a, T: Block<Header: SerdeBincodeCompat, Body: SerdeBincodeCompat> + 'static> From<RecoveredBlock<'a, T>> for RecoveredBlock<T>

Available on crate feature serde-bincode-compat only.

fn from(value: RecoveredBlock<'a, T>) -> Self

Converts to this type from the input type.

impl<B: Block> From<RecoveredBlock<B>> for Sealed<B>

fn from(value: RecoveredBlock<B>) -> Self

Converts to this type from the input type.

impl<B: Block> InMemorySize for RecoveredBlock<B>

fn size(&self) -> usize

Returns a heuristic for the in-memory size of a struct.

impl<B: Block> PartialEq for RecoveredBlock<B>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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<T: Block<Header: SerdeBincodeCompat, Body: SerdeBincodeCompat> + 'static> SerdeBincodeCompat for RecoveredBlock<T>

Available on crate feature serde-bincode-compat only.

type BincodeRepr<'a> = RecoveredBlock<'a, T>

Serde representation of the type for bincode serialization.

fn as_repr(&self) -> Self::BincodeRepr<'_>

Convert this type into its bincode representation

fn from_repr(repr: Self::BincodeRepr<'_>) -> Self

Convert from the bincode representation

impl<B: Block> Serialize for RecoveredBlock<B>

where SealedBlock<B>: Serialize + DeserializeOwned,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Block<Header: SerdeBincodeCompat, Body: SerdeBincodeCompat> + 'static> SerializeAs<RecoveredBlock<T>> for RecoveredBlock<'_, T>

Available on crate feature serde-bincode-compat only.

fn serialize_as<S>( source: &RecoveredBlock<T>, serializer: S, ) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<B: Block> Eq for RecoveredBlock<B>

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.