reth_ethereum::rpc::types::engine::payload

Enum ExecutionPayload

pub enum ExecutionPayload {
    V1(ExecutionPayloadV1),
    V2(ExecutionPayloadV2),
    V3(ExecutionPayloadV3),
}

Available on crate feature rpc only.

Expand description

An execution payload, which can be either ExecutionPayloadV1, ExecutionPayloadV2, or ExecutionPayloadV3.

Variants§

§

Implementations§

§

impl ExecutionPayload

pub fn from_block_slow<T, H>( block: &Block<T, H>, ) -> (ExecutionPayload, ExecutionPayloadSidecar)
where T: Encodable2718 + Transaction, H: BlockHeader + Sealable,

Converts [alloy_consensus::Block] to ExecutionPayload and also returns the ExecutionPayloadSidecar extracted from the block.

Note: This re-calculates the block hash.

pub fn from_block_unchecked<T, H>( block_hash: FixedBytes<32>, block: &Block<T, H>, ) -> (ExecutionPayload, ExecutionPayloadSidecar)
where T: Encodable2718 + Transaction, H: BlockHeader,

Converts [alloy_consensus::Block] to ExecutionPayload and also returns the ExecutionPayloadSidecar extracted from the block.

pub fn try_into_block_with_sidecar<T>( self, sidecar: &ExecutionPayloadSidecar, ) -> Result<Block<T>, PayloadError>
where T: Decodable2718,

Tries to create a new unsealed block from the given payload and payload sidecar.

Performs additional validation of extra_data and base_fee_per_gas fields.

§Note

The log bloom is assumed to be validated during serialization.

See https://github.com/ethereum/go-ethereum/blob/79a478bb6176425c2400e949890e668a3d9a3d05/core/beacon/types.go#L145

pub fn try_into_block_with_sidecar_with<T, F, E>( self, sidecar: &ExecutionPayloadSidecar, f: F, ) -> Result<Block<T>, PayloadError>
where F: FnMut(Bytes) -> Result<T, E>, E: Into<PayloadError>,

Converts ExecutionPayload to [Block] with sidecar and a custom transaction mapper.

The log bloom is assumed to be validated during serialization.

See https://github.com/ethereum/go-ethereum/blob/79a478bb6176425c2400e949890e668a3d9a3d05/core/beacon/types.go#L145

pub fn into_block_with_sidecar_raw( self, sidecar: &ExecutionPayloadSidecar, ) -> Result<Block<Bytes>, PayloadError>

Converts ExecutionPayload to [Block] with raw Bytes transactions and sidecar.

This is similar to Self::try_into_block_with_sidecar_with but returns the transactions as raw bytes without any conversion.

pub fn try_into_block<T>(self) -> Result<Block<T>, PayloadError>
where T: Decodable2718,

Converts ExecutionPayloadV1 to [Block].

Caution: This does not set fields that are not part of the payload and only part of the ExecutionPayloadSidecar:

parent_beacon_block_root
requests_hash

pub fn try_into_block_with<T, F, E>( self, f: F, ) -> Result<Block<T>, PayloadError>
where F: FnMut(Bytes) -> Result<T, E>, E: Into<PayloadError>,

Converts ExecutionPayload to [Block] with a custom transaction mapper.

Caution: This does not set fields that are not part of the payload and only part of the ExecutionPayloadSidecar:

parent_beacon_block_root
requests_hash

pub fn into_block_raw(self) -> Result<Block<Bytes>, PayloadError>

Converts ExecutionPayload to [Block] with raw Bytes transactions.

This is similar to Self::try_into_block_with but returns the transactions as raw bytes without any conversion.

pub const fn as_v1(&self) -> &ExecutionPayloadV1

Returns a reference to the V1 payload.

pub const fn as_v1_mut(&mut self) -> &mut ExecutionPayloadV1

Returns a mutable reference to the V1 payload.

pub fn into_v1(self) -> ExecutionPayloadV1

Consumes the payload and returns the V1 payload.

pub const fn as_v2(&self) -> Option<&ExecutionPayloadV2>

Returns a reference to the V2 payload, if any.

pub const fn as_v2_mut(&mut self) -> Option<&mut ExecutionPayloadV2>

Returns a mutable reference to the V2 payload, if any.

pub const fn as_v3(&self) -> Option<&ExecutionPayloadV3>

Returns a reference to the V2 payload, if any.

pub const fn as_v3_mut(&mut self) -> Option<&mut ExecutionPayloadV3>

Returns a mutable reference to the V2 payload, if any.

pub const fn withdrawals(&self) -> Option<&Vec<Withdrawal>>

Returns the withdrawals for the payload.

pub const fn transactions(&self) -> &Vec<Bytes>

Returns the transactions for the payload.

pub const fn transactions_mut(&mut self) -> &mut Vec<Bytes>

Returns a mutable reference to the transactions for the payload.

pub fn header_info(&self) -> HeaderInfo

Extracts essential information into one container type.

pub fn saturated_base_fee_per_gas(&self) -> u64

Returns the gas limit for the payload.

Note: this returns the u64 saturated base fee, but it is specified as U256.

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

Returns the blob gas used for the payload.

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

Returns the excess blob gas for the payload.

pub const fn gas_limit(&self) -> u64

Returns the gas limit for the payload.

pub const fn fee_recipient(&self) -> Address

Returns the fee recipient.

pub const fn timestamp(&self) -> u64

Returns the timestamp for the payload.

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

Returns the parent hash for the payload.

pub const fn block_hash(&self) -> FixedBytes<32>

Returns the block hash for the payload.

pub const fn block_number(&self) -> u64

Returns the block number for this payload.

pub const fn block_num_hash(&self) -> NumHash

Returns the block number for this payload.

pub const fn prev_randao(&self) -> FixedBytes<32>

Returns the prev randao for this payload.

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.

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 a None if no excess blob gas is set, no EIP-4844 support

pub 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.

Returns None if the blob_params are None.

pub fn decoded_transactions<T>( &self, ) -> impl Iterator<Item = Result<T, Eip2718Error>>
where T: Decodable2718,

Returns an iterator over the decoded transactions in this payload.

This iterator will decode transactions on the fly.

pub fn decoded_transactions_with_encoded<T>( &self, ) -> impl Iterator<Item = Result<WithEncoded<T>, Eip2718Error>>
where T: Decodable2718,

Returns iterator over decoded transactions with their original encoded bytes.

This iterator will decode transactions on the fly and return them with their bytes.

pub fn recovered_transactions<T>( &self, ) -> impl Iterator<Item = Result<Recovered<T>, RecoveryError>>
where T: Decodable2718 + SignerRecoverable,

Returns an iterator over the recovered transactions in this payload.

This iterator will decode and recover signer addresses for transactions on the fly.

pub fn recovered_transactions_with_encoded<T>( &self, ) -> impl Iterator<Item = Result<WithEncoded<Recovered<T>>, RecoveryError>>
where T: Decodable2718 + SignerRecoverable,

Returns an iterator over the recovered transactions in this payload with their original encoded bytes.

This iterator will decode and recover signer addresses for transactions on the fly and return them with their bytes.

Trait Implementations§

§

impl<'arbitrary> Arbitrary<'arbitrary> for ExecutionPayload

§

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

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

§

fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<ExecutionPayload, Error>

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

§

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. Read more

§

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. Read more

§

impl Clone for ExecutionPayload

§

fn clone(&self) -> ExecutionPayload

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for ExecutionPayload

§

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

Formats the value using the given formatter. Read more

§

impl<'de> Deserialize<'de> for ExecutionPayload

§

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

Deserialize this value from the given Serde deserializer. Read more

§