Skip to main content

Module engine_ssz_containers

Module engine_ssz_containers 

Source
Available on crate features node-api and node only.
Expand description

Experimental Engine API v2 REST-SSZ wire types.

These types intentionally live apart from the legacy JSON-RPC Engine API types because their SSZ encodings are not always wire-compatible. This module contains the shared endpoint containers and fork-specific payload containers from execution-apis PR #793, plus the experimental payload-with-witness response type that extends the same REST-SSZ model.

Structs§

BuiltPayloadAmsterdam
This structure maps to the Engine API v2 REST-SSZ payload-build response for Amsterdam.
BuiltPayloadOsaka
This structure maps to the Engine API v2 REST-SSZ payload-build response for Osaka.
BuiltPayloadParis
This structure maps to the Engine API v2 REST-SSZ payload-build response for Paris.
BuiltPayloadPrague
This structure maps to the Engine API v2 REST-SSZ payload-build response for Prague.
BuiltPayloadShanghai
This structure maps to the Engine API v2 REST-SSZ payload-build response for Shanghai.
ExecutionPayloadEnvelopeAmsterdam
Amsterdam payload-submission request.
ExecutionPayloadEnvelopeCancun
Cancun payload-submission request.
ExecutionPayloadEnvelopeOsaka
Osaka payload-submission request.
ExecutionPayloadEnvelopeParis
REST-SSZ payload-submission request containers.
ExecutionPayloadEnvelopePrague
Prague payload-submission request.
ExecutionPayloadEnvelopeShanghai
Shanghai payload-submission request.
ForkchoiceUpdateAmsterdam
Amsterdam forkchoice-update request.
ForkchoiceUpdateCancun
Cancun forkchoice-update request.
ForkchoiceUpdateOsaka
Osaka forkchoice-update request.
ForkchoiceUpdateParis
Paris forkchoice-update request.
ForkchoiceUpdatePrague
Prague forkchoice-update request.
ForkchoiceUpdateResponse
Engine API v2 REST-SSZ forkchoice update response.
ForkchoiceUpdateShanghai
Shanghai forkchoice-update request.
Optional
An Engine API v2 SSZ optional encoded as List[T, 1].
PayloadAttributesAmsterdam
Amsterdam payload attributes.
PayloadAttributesCancun
Cancun payload attributes.
PayloadAttributesParis
Paris payload attributes.
PayloadAttributesShanghai
Shanghai payload attributes.
PayloadStatus
Engine API v2 REST-SSZ payload status.

Enums§

BuiltPayloadConversionError
Error converting legacy payload-build envelopes into fork-specific REST-SSZ containers.
ConversionError
Error converting legacy Engine API values into v2 REST-SSZ values.
PayloadAttributesConversionError
Error converting legacy cross-fork payload attributes into a fork-specific SSZ container.

Type Aliases§

BuiltPayloadCancun
Engine API v2 REST-SSZ payload-build response for Cancun.
ExecutionPayloadAmsterdam
Amsterdam execution payload.
ExecutionPayloadCancun
Cancun execution payload.
ExecutionPayloadOsaka
Osaka execution payload.
ExecutionPayloadParis
Paris execution payload.
ExecutionPayloadPrague
Prague execution payload.
ExecutionPayloadShanghai
Shanghai execution payload.
PayloadAttributesOsaka
Osaka uses the Cancun payload-attributes schema.
PayloadAttributesPrague
Prague uses the Cancun payload-attributes schema.