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, fork-specific payload containers, blob containers, payload-body containers, and the experimental payload-with-witness response type from the same REST-SSZ model.
Structs§
- Blob
Cells AndProofs - Blob cells and proofs with REST-SSZ optional cell positions.
- Blob
Entry - Blob response entry with explicit outer availability.
- Blobs
Response - Bounded blob response container.
- Blobs
V1Request - V1-V3 blob request container.
- Blobs
V4Request - V4 blob request container with a packed 128-bit index bitvector.
- Bodies
ByHash Request - REST-SSZ historical bodies-by-hash request.
- Bodies
Response - REST-SSZ historical bodies response.
- Body
Entry - Historical body response entry with explicit availability.
- Built
Payload Amsterdam - This structure maps to the Engine API v2 REST-SSZ payload-build response for Amsterdam.
- Built
Payload Osaka - This structure maps to the Engine API v2 REST-SSZ payload-build response for Osaka.
- Built
Payload Paris - This structure maps to the Engine API v2 REST-SSZ payload-build response for Paris.
- Built
Payload Prague - This structure maps to the Engine API v2 REST-SSZ payload-build response for Prague.
- Built
Payload Shanghai - This structure maps to the Engine API v2 REST-SSZ payload-build response for Shanghai.
- Execution
Payload Body Amsterdam - Fork-specific execution payload body for Amsterdam.
- Execution
Payload Body Paris - Fork-specific execution payload body for Paris.
- Execution
Payload Body Shanghai - Fork-specific execution payload body for Shanghai.
- Execution
Payload Envelope Amsterdam - Amsterdam payload-submission request.
- Execution
Payload Envelope Cancun - Cancun payload-submission request.
- Execution
Payload Envelope Osaka - Osaka payload-submission request.
- Execution
Payload Envelope Paris - REST-SSZ payload-submission request containers.
- Execution
Payload Envelope Prague - Prague payload-submission request.
- Execution
Payload Envelope Shanghai - Shanghai payload-submission request.
- Execution
Witness V1 - Canonical execution witness for
POST /payloads/witness. - Forkchoice
Update Amsterdam - Amsterdam forkchoice-update request.
- Forkchoice
Update Cancun - Cancun forkchoice-update request.
- Forkchoice
Update Osaka - Osaka forkchoice-update request.
- Forkchoice
Update Paris - Paris forkchoice-update request.
- Forkchoice
Update Prague - Prague forkchoice-update request.
- Forkchoice
Update Response - Engine API v2 REST-SSZ forkchoice update response.
- Forkchoice
Update Shanghai - Shanghai forkchoice-update request.
- Optional
- An Engine API v2 SSZ optional encoded as
List[T, 1]. - Payload
Attributes Amsterdam - Amsterdam payload attributes.
- Payload
Attributes Cancun - Cancun payload attributes.
- Payload
Attributes Paris - Paris payload attributes.
- Payload
Attributes Shanghai - Shanghai payload attributes.
- Payload
Status - Engine API v2 REST-SSZ payload status.
- Payload
Status With Witness - REST-SSZ response for
POST /payloads/witness.
Enums§
- Built
Payload Conversion Error - Error converting legacy payload-build envelopes into fork-specific REST-SSZ containers.
- Conversion
Error - Error converting legacy Engine API values into v2 REST-SSZ values.
- Execution
Payload Body Conversion Error - Error converting legacy cross-fork execution payload bodies into fork-specific containers.
- Payload
Attributes Conversion Error - Error converting legacy cross-fork payload attributes into a fork-specific SSZ container.
Constants§
- MAX_
BLOBS_ REQUEST - Maximum number of blobs in a REST-SSZ blob request or response.
- MAX_
BODIES_ REQUEST - Maximum number of payload bodies in a REST-SSZ request or response.
Type Aliases§
- Blobs
V1Response - V1 whole-blob response.
- Blobs
V2Request - V2 uses the V1 request schema.
- Blobs
V2Response - V2 all-or-nothing cell-proof response.
- Blobs
V3Request - V3 uses the V1 request schema.
- Blobs
V3Response - V3 partial cell-proof response.
- Blobs
V4Response - V4 partial cell-range response.
- Bodies
Response Amsterdam - Amsterdam historical bodies response.
- Bodies
Response Cancun - Cancun historical bodies response.
- Bodies
Response Osaka - Osaka historical bodies response.
- Bodies
Response Paris - Paris historical bodies response.
- Bodies
Response Prague - Prague historical bodies response.
- Bodies
Response Shanghai - Shanghai historical bodies response.
- Built
Payload Cancun - Engine API v2 REST-SSZ payload-build response for Cancun.
- Execution
Payload Amsterdam - Amsterdam execution payload.
- Execution
Payload Body Cancun - Cancun uses the Shanghai execution-payload-body schema.
- Execution
Payload Body Osaka - Osaka uses the Shanghai execution-payload-body schema.
- Execution
Payload Body Prague - Prague uses the Shanghai execution-payload-body schema.
- Execution
Payload Cancun - Cancun execution payload.
- Execution
Payload Osaka - Osaka execution payload.
- Execution
Payload Paris - Paris execution payload.
- Execution
Payload Prague - Prague execution payload.
- Execution
Payload Shanghai - Shanghai execution payload.
- Execution
Witness - Canonical execution witness for
POST /payloads/witness. - NewPayload
With Witness Response V1 - Backwards-compatible alias for the experimental witness response name.
- Payload
Attributes Osaka - Osaka uses the Cancun payload-attributes schema.
- Payload
Attributes Prague - Prague uses the Cancun payload-attributes schema.
- Witness
Code V1 - A contract-code byte list in an
ExecutionWitnessV1. - Witness
Header V1 - An RLP-encoded header byte list in an
ExecutionWitnessV1. - Witness
Node V1 - A trie-node byte list in an
ExecutionWitnessV1.