Module payload 

Re-exported payload related types

Modules

noop

A payload builder service task that does nothing.

test_utilstest-utils

Utils for testing purposes.

Structs

BuildNewPayload

A request to build a new payload.

BuiltPayloadExecutedBlock

Represents an executed block for payload building purposes.

EthBuiltPayload

Contains the built payload.

EthereumExecutionPayloadValidator

Execution payload validator.

PayloadBuilderHandle

A communication channel to the PayloadBuilderService.

PayloadBuilderService

A service that manages payload building tasks.

PayloadId

And 8-byte identifier for an execution payload.

PayloadStore

A communication channel to the PayloadBuilderService that can retrieve payloads.

Enums

BlobSidecars

An enum representing blob transaction sidecars belonging to EthBuiltPayload.

EngineApiMessageVersion

The version of Engine API message.

EngineObjectValidationError

Thrown when the payload or attributes are known to be invalid before processing.

InvalidPayloadAttributesError

Thrown when validating the correctness of a payloadattributes object.

KeepPayloadJobAlive

Whether the payload job should be kept alive or terminated after the payload was requested by the CL.

MessageValidationKind

A type that represents whether or not we are validating a payload or payload attributes.

NewPayloadError

Error validating payload received over newPayload API.

PayloadBuilderError

Possible error variants during payload building.

PayloadKind

Determines how we should choose the payload to return.

PayloadOrAttributes

A unified type for handling both execution payloads and payload attributes.

PayloadServiceCommand

Message type for the PayloadBuilderService.

VersionSpecificValidationError

Thrown when validating an execution payload OR payload attributes fails due to:

Traits

BuildNextEnv

Trait to build the EVM environment for the next block from the given payload attributes.

BuiltPayload

Represents a successfully built execution payload (block).

ExecutionPayload

Represents the core data structure of an execution payload.

PayloadAttributes

Basic attributes required to initiate payload construction.

PayloadAttributesBuilder

Factory trait for creating payload attributes.

PayloadJob

A type that can build a payload.

PayloadJobGenerator

A type that knows how to create new jobs for creating payloads.

PayloadTypes

Core trait that defines the associated types for working with execution payloads.

Functions

payload_id

Generates the payload id for the configured payload from the PayloadAttributes.

validate_block_access_list_presence

Validates the presence of the block access lists field according to the payload timestamp. After Amsterdam, block access list field must be Some. Before Amsterdam, block access list field must be None;

validate_execution_requests

Validates that execution requests are valid according to Engine API specification.

validate_parent_beacon_block_root_presence

Validate the presence of the parentBeaconBlockRoot field according to the given timestamp. This method is meant to be used with either a payloadAttributes field or a full payload, with the engine_forkchoiceUpdated and engine_newPayload methods respectively.

validate_payload_timestamp

Validates the timestamp depending on the version called:

validate_slot_number_presence

Validates the presence of the slot number field according to the payload timestamp. After Amsterdam, slot number field must be Some. Before Amsterdam, slot number field must be None;

validate_version_specific_fields

Validates the presence or exclusion of fork-specific fields based on the ethereum execution payload, or payload attributes, and the message version.

validate_withdrawals_presence

Validates the presence of the withdrawals field according to the payload timestamp. After Shanghai, withdrawals field must be Some. Before Shanghai, withdrawals field must be None;