Crate alloy_rpc_types_engine

alloy-rpc-types-engine

Types for the engine Ethereum JSON-RPC namespace.

Engine API types: https://github.com/ethereum/execution-apis/blob/main/src/engine/authentication.md and https://eips.ethereum.org/EIPS/eip-3675, following the execution specs https://github.com/ethereum/execution-apis/tree/6709c2a795b707202e93c4f2867fa0bf2640a84f/src/engine.

Re-exports

pub use payload::*;

Modules

payload

Payload types.

Structs

BlobAndProofV1

Blob type returned in responses to engine_getBlobsV1: https://github.com/ethereum/execution-apis/pull/559

CancunPayloadFields

Fields introduced in engine_newPayloadV3 that are not present in the ExecutionPayload RPC object.

Claimsjwt

Claims in JWT are used to represent a set of information about an entity.

ClientVersionV1

Contains information which identifies a client implementation.

ExecutionPayloadSidecar

Container type for all available additional newPayload request parameters that are not present in the ExecutionPayload object itself.

ForkchoiceState

This structure encapsulates the fork choice state

ForkchoiceUpdated

Represents a successfully processed forkchoice state update.

JwtSecretjwt

Value-object holding a reference to a hex-encoded 256-bit secret key.

MaybeCancunPayloadFields

A container type for CancunPayloadFields that may or may not be present.

MaybePraguePayloadFields

A container type for PraguePayloadFields that may or may not be present.

PraguePayloadFields

Fields introduced in engine_newPayloadV4 that are not present in the ExecutionPayload RPC object.

TransitionConfiguration

This structure contains configurable settings of the transition process.

Enums

ClientCode

This enum defines a standard for specifying a client with just two letters. Clients teams which have a code reserved in this list MUST use this code when identifying themselves.

ForkchoiceUpdateError

A standalone forkchoice update errors for RPC.

ForkchoiceUpdateVersion

The version of the engine api.

JwtErrorjwt

Errors returned by the JwtSecret

PayloadError

Error that can occur when handling payloads.

PayloadValidationError

Various errors that can occur when validating a payload or forkchoice update.

Constants

CAPABILITIES

The list of all supported Engine capabilities available over the engine endpoint.

INVALID_FORK_CHOICE_STATE_ERROR

invalid forkchoice state error code.

INVALID_FORK_CHOICE_STATE_ERROR_MSG

invalid forkchoice state error message.

INVALID_PAYLOAD_ATTRIBUTES_ERROR

invalid payload attributes error code.

INVALID_PAYLOAD_ATTRIBUTES_ERROR_MSG

invalid payload attributes error message.

Type Aliases

ForkChoiceUpdateResult

Represents possible variants of a processed forkchoice update.