Skip to content

feat: add ssz to engine api #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
barnabasbusa wants to merge 12 commits into
base: main
Choose a base branch
from
+1,058 −0
Draft

feat: add ssz to engine api #764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f59dce4
feat: add ssz to engine api
barnabasbusa Mar 3, 2026
905d42c
add def for each method
barnabasbusa Mar 4, 2026
998b97e
docs(ssz-encoding): update SSZ type mappings and container notes to r…
barnabasbusa Mar 4, 2026
47049bb
fix spellchecker
barnabasbusa Mar 4, 2026
3d3a00e
make payload ssz
barnabasbusa Mar 4, 2026
1228e83
add rest
barnabasbusa Mar 4, 2026
234a3e6
add capabilities and version
barnabasbusa Mar 4, 2026
bfa6d56
docs(ssz-encoding): clarify SSZ representation of optional types and …
barnabasbusa Mar 4, 2026
2e1fad1
fix all ambiguity
barnabasbusa Mar 4, 2026
71476f2
docs(ssz-encoding.md): update SSZ REST transport negotiation document…
barnabasbusa Mar 4, 2026
c5b490f
docs(ssz-encoding): clarify SSZ transport negotiation details
barnabasbusa Mar 4, 2026
c616edd
docs(ssz-encoding): address PR #764 review — caching, DoS, nullable t…
barnabasbusa Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/engine/common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This document specifies common definitions and requirements affecting Engine API
- [Errors](#errors)
- [Timeouts](#timeouts)
- [Encoding](#encoding)
- [Binary SSZ transport](#binary-ssz-transport)
- [Capabilities](#capabilities)
- [engine_exchangeCapabilities](#engine_exchangecapabilities)
- [Request](#request)
Expand Down Expand Up @@ -136,6 +137,14 @@ Values of a field of `QUANTITY` type **MUST** be encoded as a hexadecimal string

*Note:* Byte order of encoded value having `QUANTITY` type is big-endian.

### Binary SSZ transport

Clients **MAY** support a binary SSZ transport as an alternative to JSON-RPC. The binary transport uses resource-oriented REST endpoints with raw SSZ request and response bodies (`application/octet-stream`), eliminating JSON and hex-encoding overhead for fast CL-EL communication. Endpoints follow Beacon API conventions with path-based versioning (e.g., `POST /engine/v5/payloads`).
Copy link
Copy Markdown

@nazarhussain nazarhussain Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current specs define the capabilities as JSON-RPC methods names like:

  • engine_newPayloadV2
  • engine_getPayloadV5

This suggestion change the capabilities vocabulary to strings like POST /engine/v5/payloads.

This is protocol change, not just a transport addition.


When both the consensus layer and execution layer clients support the binary SSZ transport, they **SHOULD** use it. When either client does not support it, both **MUST** fall back to JSON-RPC encoding.

The full specification is defined in the [Binary SSZ Transport](./ssz-encoding.md) document.

[json-rpc-spec]: https://playground.open-rpc.org/?schemaUrl=https://raw.githubusercontent.com/ethereum/execution-apis/assembled-spec/openrpc.json&uiSchema[appBar][ui:splitView]=false&uiSchema[appBar][ui:input]=false&uiSchema[appBar][ui:examplesDropdown]=false

## Capabilities
Expand Down
Loading
Loading