Enum OpExecutionPayload

pub enum OpExecutionPayload {
    V1(ExecutionPayloadV1),
    V2(ExecutionPayloadV2),
    V3(ExecutionPayloadV3),
    V4(OpExecutionPayloadV4),
}

Available on crate feature rpc-types-engine only.

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

Variants

V1(ExecutionPayloadV1)

V1 payload

V2(ExecutionPayloadV2)

V2 payload

V3(ExecutionPayloadV3)

V3 payload

V4(OpExecutionPayloadV4)

V4 payload

Implementations

impl OpExecutionPayload

pub fn from_block_slow<T, H>( block: &Block<T, H>, ) -> (OpExecutionPayload, OpExecutionPayloadSidecar)

where T: Encodable2718 + Transaction, H: BlockHeader + Sealable,

Conversion from alloy_consensus::Block. Also returns the OpExecutionPayloadSidecar extracted from the block.

See also from_block_unchecked.

Note: This re-calculates the block hash.

pub fn from_block_unchecked<T, H>( block_hash: FixedBytes<32>, block: &Block<T, H>, ) -> (OpExecutionPayload, OpExecutionPayloadSidecar)

where T: Encodable2718 + Transaction, H: BlockHeader,

Conversion from alloy_consensus::Block. Also returns the OpExecutionPayloadSidecar extracted from the block.

See also ExecutionPayload::from_block_unchecked. See also OpExecutionPayloadSidecar::from_block.

pub fn v2(payload: ExecutionPayloadInputV2) -> OpExecutionPayload

Creates a new instance from newPayloadV2 payload, i.e. V1 or V2 variant.

Spec: https://specs.optimism.io/protocol/exec-engine.html#engine_newpayloadv2

pub const fn v3(payload: ExecutionPayloadV3) -> OpExecutionPayload

Creates a new instance from newPayloadV3 payload, i.e. V3 variant.

Spec: https://specs.optimism.io/protocol/exec-engine.html#engine_newpayloadv3

pub const fn v4(payload: OpExecutionPayloadV4) -> OpExecutionPayload

Creates a new instance from newPayloadV4 payload, i.e. V4 variant.

Spec: https://specs.optimism.io/protocol/exec-engine.html#engine_newpayloadv4

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

Returns a reference to the V1 payload.

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

Returns a mutable reference to the V1 payload.

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

Returns a reference to the V2 payload, if any.

pub 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 V3 payload, if any.

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

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

pub const fn as_v4(&self) -> Option<&OpExecutionPayloadV4>

Returns a reference to the V4 payload, if any.

pub fn as_v4_mut(&mut self) -> Option<&mut OpExecutionPayloadV4>

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

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 fn try_into_block<T>(self) -> Result<Block<T>, OpPayloadError>

where T: Decodable2718 + Typed2718,

Converts OpExecutionPayload to Block.

Checks that payload doesn’t contain:

• blob transactions
• L1 withdrawals

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

• parent_beacon_block_root

See also: OpExecutionPayload::try_into_block_with_sidecar

pub fn try_into_block_with_sidecar<T>( self, sidecar: &OpExecutionPayloadSidecar, ) -> Result<Block<T>, OpPayloadError>

where T: Decodable2718 + Typed2718,

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

Additional to checks preformed in OpExecutionPayload::try_into_block, which is called under the hood, also checks that sidecar doesn’t contain:

• blob versioned hashes
• execution layer requests

See also docs for ExecutionPayload::try_into_block_with_sidecar.

Trait Implementations

impl Clone for OpExecutionPayload

fn clone(&self) -> OpExecutionPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpExecutionPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpExecutionPayload

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpExecutionPayload

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

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 Eq for OpExecutionPayload

impl StructuralPartialEq for OpExecutionPayload