Enum PayloadStatusEnum

pub enum PayloadStatusEnum {
    Valid,
    Invalid {
        validation_error: String,
    },
    Syncing,
    Accepted,
}

Represents the status response of a payload.

Variants

Valid

VALID is returned by the engine API in the following calls:

• newPayload: if the payload was already known or was just validated and executed
• forkchoiceUpdate: if the chain accepted the reorg (might ignore if it’s stale)

Invalid

INVALID is returned by the engine API in the following calls:

• newPayload: if the payload failed to execute on top of the local chain
• forkchoiceUpdate: if the new head is unknown, pre-merge, or reorg to it fails

Fields

validation_error: String

The error message for the invalid payload.

Syncing

SYNCING is returned by the engine API in the following calls:

• newPayload: if the payload was accepted on top of an active sync
• forkchoiceUpdate: if the new head was seen before, but not part of the chain

Accepted

ACCEPTED is returned by the engine API in the following calls:

• newPayload: if the payload was accepted, but not processed (side chain)

Implementations

impl PayloadStatusEnum

pub const fn as_str(&self) -> &'static str

Returns the string representation of the payload status.

pub fn validation_error(&self) -> Option<&str>

Returns the validation error if the payload status is invalid.

pub const fn is_syncing(&self) -> bool

Returns true if the payload status is syncing.

pub const fn is_valid(&self) -> bool

Returns true if the payload status is valid.

pub const fn is_invalid(&self) -> bool

Returns true if the payload status is invalid.

Trait Implementations

impl Clone for PayloadStatusEnum

fn clone(&self) -> PayloadStatusEnum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadStatusEnum

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PayloadStatusEnum

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PayloadStatusEnum

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

Formats the value using the given formatter.

impl From<PayloadError> for PayloadStatusEnum

fn from(error: PayloadError) -> PayloadStatusEnum

Converts to this type from the input type.

impl From<PayloadStatusEnum> for ForkchoiceStatus

fn from(status: PayloadStatusEnum) -> ForkchoiceStatus

Converts to this type from the input type.

impl PartialEq for PayloadStatusEnum

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

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 PayloadStatusEnum

impl StructuralPartialEq for PayloadStatusEnum

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes

Size for each variant:

• Valid: 0 bytes
• Invalid: 24 bytes
• Syncing: 0 bytes
• Accepted: 0 bytes