Skip to content

adds beacon api - #81

Merged
ninaiiad merged 45 commits into
mainfrom
od/beacon_api
Sep 3, 2026
Merged

adds beacon api#81
ninaiiad merged 45 commits into
mainfrom
od/beacon_api

Conversation

@0w3n-d

@0w3n-d 0w3n-d commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@vladimir-ea

Copy link
Copy Markdown
Collaborator

can we add the beacon api to the engine api tile? it seems overkill to have cores assigned to marshalling http requests and responses for each api?

we could make this a component that is not an actual Tile but has a spin or loop method that could be called from a tile? that would give some flexibility in how it is deployed.

@vladimir-ea

Copy link
Copy Markdown
Collaborator

can we add the beacon api to the engine api tile? it seems overkill to have cores assigned to marshalling http requests and responses for each api?

we could make this a component that is not an actual Tile but has a spin or loop method that could be called from a tile? that would give some flexibility in how it is deployed.

also - if we run the http server as a separate tile then we should just run Axum in a single thread runtime and not take on the maintenance risk of writing our own web-server.

@0w3n-d

0w3n-d commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator Author

can we add the beacon api to the engine api tile? it seems overkill to have cores assigned to marshalling http requests and responses for each api?

we could make this a component that is not an actual Tile but has a spin or loop method that could be called from a tile? that would give some flexibility in how it is deployed.

I do think the current tile setup is likely not optimal but we should probably wait until everything is running and we've gathered a bunch of data before deciding to consolidate tiles? When feature complete the system will have 3 integration points. p2p, Beacon api, and engine api. Currently it looks like we have 3 tiles for p2p stuff. Putting the Beacon and engine api in the same tile seems premature.

@0w3n-d

0w3n-d commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator Author

can we add the beacon api to the engine api tile? it seems overkill to have cores assigned to marshalling http requests and responses for each api?
we could make this a component that is not an actual Tile but has a spin or loop method that could be called from a tile? that would give some flexibility in how it is deployed.

also - if we run the http server as a separate tile then we should just run Axum in a single thread runtime and not take on the maintenance risk of writing our own web-server.

I don't see why we'd go in that direction. That would pull in all of tokio and so on. Seems like the opposite to our approach elsewhere. The Beacon api is the interface to the validator client and commit boost and so on. If our design goals center low level, high performance, and innovation we probably shouldn't outsource a key interface to the axum, hypr, tokio stack.

Axum is just a nice wrapper around hypr and hypr is just state machine that sits on the same two crates I'm using here. Mio and httparse. And unlike the p2p interface, this one is purely internal so minimal security risk.

@vladimir-ea

Copy link
Copy Markdown
Collaborator

can we add the beacon api to the engine api tile? it seems overkill to have cores assigned to marshalling http requests and responses for each api?
we could make this a component that is not an actual Tile but has a spin or loop method that could be called from a tile? that would give some flexibility in how it is deployed.

I do think the current tile setup is likely not optimal but we should probably wait until everything is running and we've gathered a bunch of data before deciding to consolidate tiles? When feature complete the system will have 3 integration points. p2p, Beacon api, and engine api. Currently it looks like we have 3 tiles for p2p stuff. Putting the Beacon and engine api in the same tile seems premature.

well yes to not predetermining the tiles - which is why it makes sense as much as possible to create components that are not tiles but can be called from tiles

@vladimir-ea

Copy link
Copy Markdown
Collaborator

can we add the beacon api to the engine api tile? it seems overkill to have cores assigned to marshalling http requests and responses for each api?
we could make this a component that is not an actual Tile but has a spin or loop method that could be called from a tile? that would give some flexibility in how it is deployed.

also - if we run the http server as a separate tile then we should just run Axum in a single thread runtime and not take on the maintenance risk of writing our own web-server.

I don't see why we'd go in that direction. That would pull in all of tokio and so on. Seems like the opposite to our approach elsewhere. The Beacon api is the interface to the validator client and commit boost and so on. If our design goals center low level, high performance, and innovation we probably shouldn't outsource a key interface to the axum, hypr, tokio stack.

Axum is just a nice wrapper around hypr and hypr is just state machine that sits on the same two crates I'm using here. Mio and httparse. And unlike the p2p interface, this one is purely internal so minimal security risk.

the concern is not security, its just maintaining code which implements something that is already available and widely used - I see no issue in running tokio in a separate tile - or separate process on the same machine - if its for non-hot-path things.

@Bronek

Bronek commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

I have worked with Claude.ai to prepare a new design for Beacon API - the basic principles have been added to this branch in d096b51. Comments below will provide more details.

@Bronek

Bronek commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

Design notes from Claude.ai


Goal (from team, channeled by Bronek)

  • No separate tile (loop_body) for any API access — serving (beacon_api) or calling (engine).
  • One new spine-attached tile (working name client_server) hosting hardcoded crates: beacon_api (kept name, refactored mechanics, HTTP server) and engine_api (renamed from engine, HTTP client).
  • Open: seam location for HTTP machinery (host implements client+server and provides them to hosted crates, vs crates implement internally).
  • Wanted: table-based dispatch for HTTP request handling (server side). Open: same for engine_api client side — decide on pros/cons.
  • Principles: simplicity without performance compromise; for HTTP specifically, simplicity + consistency take precedence (unavoidable multi-ms latency tax).

Mapped facts the designs rest on

  • TileConfig::new(n, None): n is a CPU core id; each tile = one OS thread pinned to its own core, busy-polling. Cores 1–7 taken (Controller, Network, BeaconState, Storage, Engine, DataColumns, BeaconApi). Merging engine + beacon_api frees a core — the mechanical driver behind "one tile for APIs".
  • crates/beacon_api (prototype, 596 lines): mio+httparse server, hardcoded 0.0.0.0:5051, blocking poll(100ms) in loop_body (must die in a shared loop), exact-match routing via closure F: Fn(&ParsedRequest, &mut Vec<u8>), 2 endpoints, no live state, 16 MiB/conn read buffers, no conn cap, ignores spine adapter. In-code TODO: parameterised routing needed.
  • crates/engine (mature): non-blocking mio client (poll Duration::ZERO), HttpPool one-req-per-conn growing unboundedly (10 MB read + 10 MB write per conn), hand-rolled JWT HS256 (1 s token cache), simd_json. One free function per method; response correlation FxHashMap<u64, ReqKind>; dispatch = match on EngineReq (inbound) and ReqKind (completion). HOT PATH: newPayload transcodes SSZ→JSON straight into persistent 10 MB scratch (client.rs:156-177, types.rs:269,345) — must be preserved verbatim. Dead parallel UDS transport ipc.rs (474-line near-copy of http.rs).
  • Spine contract (unchanged by any design): queues engine_reqs / engine_resps / engine_health; requests carry TCacheRead handles; responses written to tile-owned TCache. Producers: BeaconState, DataColumns.
  • State access for future endpoints: BeaconStateReader::read(|rv| ..) seqlock; closures short + re-runnable; None pre-bootstrap (docs/beacon-state-architecture.md §4-5).
  • Test gap: neither mio event loop has any end-to-end test (test-or-broken rule).
  • SpineAdapter::connect_tile is public — tests can build a real spine and drive loop_body by hand (verified by design agent A).

Recommendation (Claude's, for team review)

  1. Crates: client_server (tile: single mio Poll, token slab, loop composition), httpcore (one connection state machine, both roles, byte interfaces — no Poll, no sockets in signatures), beacon_api (ROUTES table + handlers + Request/Response/ApiCtx, transport-free), engine_api (renamed engine: codecs, correlation, JWT, ReqKind match, transport-free; scratch handed in, hot path verbatim).
  2. No traits at host↔hosted seams: two hardcoded crates = plain fields + fn calls (one adapter = hypothetical seam). A future third crate edits the host tile — accepted, cheap, honest.
  3. Transport testability via byte-level interfaces (C/D convergence): httpcore machines tested on byte slices with deterministic chunking (partial reads, pipelining, keep-alive, oversize) — no Mux trait needed when the seam is already &[u8].
    3a. Two production transports (team decision): TCP + UDS. Because the transport set is closed and we control it, represent it as an enum, not a trait — enum Stream { Tcp(mio::net::TcpStream), Uds(mio::net::UnixStream) } with match-forwarding read/write/register (both impl Read+Write+Source), plus enum Bind { Tcp(SocketAddr), Unix(PathBuf) } in config (B's shape). Same principle as client dispatch: closed set → enum; open set → table. Monomorphic, no generics in hosted-crate signatures (D's TcpOrUds). UDS applies to the engine_api client pool first; the server side gets the same Bind enum for free. UnixStream::pair() doubles as a portless, deterministic test transport for full-machine tests (B's suggestion).
  4. Dispatch: server table as converged; client enum match as unanimous.
  5. Test plan (test-or-broken), three tiers:
    a. Unit (socket-free, fast): router+handler tests through the table with real seqlock fixture pairs (typos in patterns fail in tests, not prod); httpcore byte-machine tests with deterministic chunking; golden-byte engine tests incl. counting-allocator assertion that newPayload allocates zero (the hot-path invariant finally gets a failing test).
    b. Integration over REAL http://localhost (team-requested, 2026-08-14): cargo tests/ dir tests that construct the real tile (real mio Poll, real TCP listener) and hand-crank loop_body in a plain test loop — no flux threads/pinning needed since loop_body is a plain fn and SpineAdapter::connect_tile is public. Test issues real HTTP over loopback (std::net or minimal client). DESIGN REQUIREMENTS this imposes: (i) bind address configurable (kills hardcoded 0.0.0.0:5051), (ii) bind to port 0 in tests and EXPOSE the actual bound address (local_addr()) so tests discover the ephemeral port, (iii) everything non-blocking means the test loop spins deterministically — fast, no sleeps. Same technique covers the UDS bind (tempdir socket path).
    c. Full-loop: beacon-api request served over loopback WHILE an EL call is in flight against a canned local EL — the merged-loop interleaving invariant no prototype ever tested; one such smoke test per transport as the seatbelt.
  6. Bounded client pool + server conn cap + configurable bind (kills three prototype liabilities in passing).

First step of the client_server tile consolidation (docs/adr/0001): the
HTTP/1.1 connection state machine (parse, keep-alive, pipelining, response
framing) moves out of beacon_api into a new transport-free crate with
bytes-only interfaces, so it can be tested without sockets and shared with
the client role next. beacon_api keeps its tile, poll, and endpoints
unchanged; behavior is byte-identical. Framing tests move with the machine
and gain deterministic chunking coverage (single-byte feeds, pipelined
requests split across feeds, oversize rejection, dispatch-after-drain).

Assisted-by: Claude:claude-fable-5
@Bronek

Bronek commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

Implementation plan from Claude.ai


Commit sequence

Strategy: build the new transport alongside the old, migrate consumers one by one, consolidate tiles last. No commit mixes a move with a behavior change.

C1 — crates/httpcore skeleton (server role). b977f93
New crate silver_httpcore: the server-side connection byte-machine extracted from beacon_api's tile.rs (parse → dispatch-closure → frame response; keep-alive + pipelining preserved). Interfaces are bytes/ frames — no Poll, no sockets in signatures. Migrate beacon_api's 14 parser tests + add deterministic-chunking tests (partial reads, pipelined split across pumps, oversize reject). beacon_api crate switches to httpcore for framing but its tile stays attached and behaviorally identical (still its own Poll; the 100 ms block dies in C5, not here).

C2 — httpcore client role; engine consumes it; delete ipc.rs. 42d86da
Client-side connection machine (one-request-per-conn, Content-Length framing, WouldBlock resumption) moves from engine http.rs into httpcore, generic over Stream. ipc.rs (474 dead lines) deleted — UDS is now a Stream variant. Engine crate keeps: pool policy, JSON-RPC, JWT, correlation, ReqKind — all protocol. Engine's 66 tests keep passing; add golden-byte round-trip test through the new machine incl. JWT header. Bounded pool cap introduced here (config, default generous).

C3 — beacon_api table dispatch + Request/Response/ApiCtx. e7cbd99
Const ROUTES table ((Method, pattern) → handler fn), pattern compiled to Lit/Param segments at init, zero-alloc Params (inline ≤4), router owns 404/405, handlers own 400; ApiCtx { state: BeaconStateReader, identity, outbox }. Rewrite the two existing endpoints as table rows; /metrics still stubbed. Router+handler tests through the table with fixture seqlock pairs; 503-before-bootstrap test. [AMENDED: Accept/content-type field deferred to the M2 SSZ-negotiation work — httpcore doesn't expose request headers yet, and a parsed-but-unread field is dead API. Outbox/NodeCommand deferred to its first consumer (same principle as the C1 Stream/Bind deferral). Reader-in-ApiCtx conditional on cheap fixture + srv.rs-example construction — implementer investigates and reports. New behavior sanctioned: 405 for known-path-wrong-method (today the method is ignored entirely).]

C4 — rename crates/enginecrates/engine_api. 96a900c
Purely mechanical, own commit: directory, package name silver_engine_api, workspace member + dep entries, imports, docs/spine-message-flow.md prose. "Names track current reality" — also rename lingering engine-named locals in touched files. No logic changes.

C5 — crates/client_server tile; consolidation. 36f291e
New tile crate constructs/holds the beacon_api server component and the engine_api client component; loop_body composes their pumps (all non-blocking). [AMENDED: TWO Polls, not the single shared Poll + token slab from the recommendation sketch — C2 landed the pool with its own Poll inside engine_api's verified event paths; unifying would churn them to save one epoll_wait(0)/iteration (noise per team latency ruling) at the cost of token-space partitioning. Design D's argument, now backed by C2's shape. Revisit only if measurement ever says otherwise. No outbox — deferred since C3.] beacon_api's own tile and EngineTile deleted; main.rs attaches client_server once (cores renumber, one core freed); srv.rs example updated. Config: beacon-api bind via Config builder + file + --beacon-api-bind; execution_endpoint accepts socket path; tile exposes local_addr(). Tests: tier-b integration (real localhost HTTP against hand-cranked loop_body via public SpineAdapter::connect_tile, port 0 + local_addr); tier-c full-loop (beacon-api request served WHILE canned-EL call in flight); UDS variants of both (tempdir socket path).

C6 — counting-allocator hot-path test + smoke. bd42255
Zero-allocation assertion on the newPayload transcode path (CountingAllocator exists in main.rs idiom); one real-socket smoke per transport per direction. Any leftover prototype liabilities: connection cap on server, 16 MiB→sane read cap, /eth/v1/events → clean 404.

Bronek added 4 commits August 17, 2026 12:03
Second step of the client_server consolidation (docs/adr/0001, 0002): the
engine's connection byte machine (request framing, Content-Length response
parsing, partial-I/O resumption) moves to silver_httpcore as the client-role
sibling of the server machine, and the transport becomes the closed-set
Stream enum (Tcp | Uds). The newline-framed ipc.rs (dead code) is deleted;
Unix-socket support is now the same HTTP pool over Stream::Uds, proven by a
real UDS round-trip test asserting the JWT bearer header on the wire.

Engine keeps all protocol: pool policy, JSON-RPC, JWT, correlation, ReqKind
dispatch. The newPayload transcode path is untouched (verified: one body
copy before and after). Request framing is pinned by golden-byte tests
captured from the previous implementation.

New: EngineConfig::max_connections (default 32) bounds the previously
unbounded pool; spine intake gates on pool capacity via consume_one, so
excess requests wait on the queue. Healthcheck issuance gates on capacity
too. A connect that cannot start (resolve/connect/register error) now fails
the rpc through the normal error path instead of stranding it forever --
previously masked by unbounded pool growth, fatal under a cap.

Behavior notes: an empty Content-Length value is now rejected instead of
read as zero; the Connecting-state error checks for UDS follow the TCP
shape (the old distrusting variant was unreachable dead code).

Known limitation (follow-up tracked in Linear): no per-request deadline, so
an EL that accepts requests but never responds can gate intake while the
engine_reqs ring (1024 slots) overwrites oldest entries.

Assisted-by: Claude:claude-fable-5
Third step of the client_server consolidation (docs/adr/0003): the inline
exact-match path closure becomes a const route table -- (method, pattern,
handler fn) compiled once at init into literal/param segments, linearly
scanned, with zero-alloc borrowed params (inline capacity 4). The router
owns 404 (byte-identical to before) and the new 405 for known-path/wrong-
method -- previously the HTTP method was ignored entirely. Handlers own 400,
and ApiCtx::read_state_or_503 pins the pre-bootstrap contract: a
BeaconStateReader (now threaded from the beacon-state tile) answering None
yields 503 with the beacon-api error JSON shape.

Identity moves to body-bytes-plus-per-request framing; wire bytes are
byte-identical, pinned by a golden test captured from the previous
implementation. Duplicate patterns (modulo param names) and >4 params
panic at init. Adding an endpoint is now one table row + one handler + one
socket-free test through the table.

Assisted-by: Claude:claude-fable-5
Names track current reality: since C2 the crate is a pure engine-API
protocol client (JSON-RPC, JWT, correlation, ReqKind dispatch) over the
shared silver_httpcore transport, and "Engine API" is the established name
for the EL protocol it speaks. Package silver_engine becomes
silver_engine_api. Purely mechanical; no logic changes. The EngineTile type
and the spine-flow doc's "Engine" tile naming are untouched -- the tile
itself dissolves in the upcoming consolidation commit, which owns that doc
update.

Assisted-by: Claude:claude-fable-5
Realizes docs/adr/0001: one spine-attached tile now hosts all API access.
BeaconApiTile and EngineTile dissolve into transport-free-of-flux
components -- BeaconApi (own mio Poll, now polled with Duration::ZERO: the
100 ms blocking poll is gone) and EngineApi (EngineTile's intake/spin logic
verbatim; C2's pool and event paths untouched) -- composed by plain function
calls in ClientServerTile::loop_body. The tile attaches at core 5; core 7
is freed. Server activity now feeds flux work-tracking (the old beacon
tile ignored its adapter).

Config: beacon_api_bind (default 0.0.0.0:5051, preserving today's
behavior) via config file, builder, and --beacon-api-bind; binds parse as
TCP addr or unix socket path (httpcore Bind/Listener, UDS serving
included); execution_endpoint accepts http:// or a socket path, panicking
on any other scheme. BeaconApi::local_addr exposes the resolved bind so
tests bind port 0 and discover the ephemeral port.

New integration tests drive the real tile over a real spine
(SpineAdapter::connect_tile) with hand-cranked loop_body: identity served
over real TCP and UDS sockets, and the merged-loop invariant from ADR 0004
gets its first test -- a beacon-api request served while four engine calls
sit unanswered on a fake EL, with the FCU completion still correlating
afterwards. The pool-cap test migrates to the merged tile intact.

Accept now drains until WouldBlock (single-accept could strand a
simultaneous second connection under edge-triggered registration), and
EngineApi::spin no-ops without an EL client instead of panicking, since
the merged loop calls it unconditionally in unsafe_no_el mode.

Assisted-by: Claude:claude-fable-5
@Bronek

Bronek commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

@vladimir-ea @0w3n-d note a limitation in the C5, we may want to revisit it:


Single beacon_api bind As of C5 the node binds exactly ONE listener — TCP or UDS, chosen by beacon_api_bind. If we want simultaneous surfaces (local VC over UDS + TCP on specific interfaces), the additive change is: BeaconApi holds a list of listeners (one reserved token each; accept loop per listener; connections already transport-uniform via Stream), config becomes a list of binds. Router, handlers, connection handling untouched.

Closes out the consolidation plan (C6). The newPayload transcode's
zero-allocation invariant finally gets a failing-capable test: a dedicated
integration binary installs a counting global allocator, warms every
buffer (scratch, connection write buffer, JWT second-cache, pending map)
through real UDS round trips against the fake EL, then asserts the next
send performs exactly zero heap allocations -- with the JWT cache's
wall-clock second handled by retry rather than a weakened assertion.

Server hardening: beacon_api_max_connections (default 64) accepts-and-
drops beyond the cap (leaving the backlog unaccepted would go silent
under edge-triggered registration until the next SYN). ServerConnection's
16 MiB eagerly-boxed read buffer becomes a 4 KiB lazily-doubling Vec with
the same hard cap and byte-identical rejection, and read_space now
compacts the partial tail to the buffer front -- previously a long-lived
pipelined keep-alive connection crept its offsets toward the cap and
would spuriously reject small requests (the new creep test feeds 2x the
cap in small requests and fails against the old code, which also could
not construct on a default test-thread stack).

GET /eth/v1/events is pinned as 404: v1 defers SSE, all surveyed
validator clients poll (.local/beacon-api-vc-surface.md). Real-socket
smoke coverage audited across {server,client} x {TCP,UDS}: all four
combinations already exercised; none added.

Assisted-by: Claude:claude-fable-5
@vladimir-ea

Copy link
Copy Markdown
Collaborator

Recommendation (Claude's, for team review)

  1. Crates: client_server (tile: single mio Poll, token slab, loop composition), httpcore (one connection state machine, both roles, byte interfaces — no Poll, no sockets in signatures), beacon_api (ROUTES table + handlers + Request/Response/ApiCtx, transport-free), engine_api (renamed engine: codecs, correlation, JWT, ReqKind match, transport-free; scratch handed in, hot path verbatim).

agree that a single mio::Poll should be used across both apis - note that you can have a blocking poll if we are using the Flux thread_park feature (which we should probably make the default for silver?) b/c that hooks the Poll into the signalling mechanism (via mio::Waker https://github.com/gattaca-com/flux/blob/c73a663f62111fd4466551e53790b2d2f576608f/crates/flux-communication/src/park.rs#L160).

@0w3n-d

0w3n-d commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator Author

@vladimir-ea @0w3n-d note a limitation in the C5, we may want to revisit it:

Single beacon_api bind As of C5 the node binds exactly ONE listener — TCP or UDS, chosen by beacon_api_bind. If we want simultaneous surfaces (local VC over UDS + TCP on specific interfaces), the additive change is: BeaconApi holds a list of listeners (one reserved token each; accept loop per listener; connections already transport-uniform via Stream), config becomes a list of binds. Router, handlers, connection handling untouched.

Probably OK for now. UDS would most likely be used for out bound connections to the EL, as EL and CL often run on the same machine. But on the listener side normally people run a VC on a different machine for security, maybe used by solo stakers or for testing but TCP is probably fine for those cases too.

@Bronek

Bronek commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Proposed API scope by Claude.ai


Beacon API: the validator-client surface (scoping beacon_api v1)

Date: 2026-08-14. Method: primary sources only — ethereum/beacon-APIs OpenAPI at tag v4.0.0 (current stable, 2025-10-14, Fulu-era; v5.0.0-alpha.x = Gloas dev), plus source of five VCs: Lighthouse sigp/lighthouse@unstable (LH), Teku Consensys/teku@master (TK), Nimbus status-im/nimbus-eth2@unstable (NB), Prysm OffchainLabs/prysm@develop (PR), Vouch attestantio/vouch + attestantio/go-eth2-client (VO). Five parallel research agents, one per client; every claim below carries a file path.

Caveat: PR's REST mode is still experimental and flag-gated (--enable-beacon-rest-api, config/features/flags.go:128; gRPC stays default through v8). PR-only rows are weighted accordingly.

Spec baseline (v4.0.0): v1 variants of pool attestations, aggregate_attestation, aggregate_and_proofs, and block/blinded-block publish are REMOVED (release notes, PR #549); block production is v3-only. So the Electra/Fulu-era surface is v2/v3 where marked below — silver never needs the v1 variants. Gloas (v5-alpha) later adds: v4 blocks, v2 proposer duties, ptc duties, payload_attestation_data, pool/payload_attestations, execution_payload_envelopes/bids, proposer_preferences, v2 node/version, topics head_v2 / execution_payload_available. LH/TK/PR already carry client code for these — out of v1 scope but the routing table should expect them.

(a) Endpoint table

Spec link = path under github.com/ethereum/beacon-APIs/blob/v4.0.0/. Verdict: MUST = exercised by ≥1 surveyed VC in default-config normal operation; SHOULD = specific clients / common configs; OPT = niche, subcommand, or DVT.

MUST — core duty cycle (all five VCs unless noted)

Endpoint Method Spec (apis/…) VCs Verdict
/eth/v1/beacon/genesis GET beacon/genesis.yaml all MUST (startup poll loops: LH wait_for_genesis, PR 1 s retry)
/eth/v1/config/spec GET config/spec.yaml LH TK NB VO MUST (TK/VO hard-require at startup; LH/NB compat checks; PR never calls it)
/eth/v1/config/fork_schedule GET config/fork_schedule.yaml NB VO MUST (NB polls every epoch, fork_service.nim; VO computes domains from it, gec http/domain.go:95)
/eth/v1/node/version GET node/version.yaml LH NB PR VO MUST (trivial)
/eth/v1/node/syncing GET node/syncing.yaml all MUST (health/readiness polling in every client)
/eth/v1/beacon/states/{id}/validators POST + GET beacon/states/validators.yaml TK NB PR VO MUST both verbs (TK/PR POST-first with GET fallback; NB POST-only; VO POST w/ pubkeys)
/eth/v1/beacon/states/{id}/validators/{validator_id} GET beacon/states/validator.yaml LH MUST (LH resolves indices per-pubkey, duties_service.rs ~L822)
/eth/v1/validator/duties/attester/{epoch} POST validator/duties/attester.yaml all MUST
/eth/v1/validator/duties/proposer/{epoch} GET validator/duties/proposer.yaml all MUST (v1; LH-unstable already prefers Gloas v2 w/ v1 fallback flag)
/eth/v1/validator/duties/sync/{epoch} POST validator/duties/sync.yaml all MUST
/eth/v1/validator/attestation_data GET validator/attestation_data.yaml all MUST (latency-critical, ~1/3 slot deadline)
/eth/v2/beacon/pool/attestations POST beacon/pool/attestations.v2.yaml all MUST (v2 only post-Electra; carries Eth-Consensus-Version req header)
/eth/v2/validator/aggregate_attestation GET validator/aggregate_attestation.v2.yaml all MUST (v2 only)
/eth/v2/validator/aggregate_and_proofs POST validator/aggregate_and_proofs.v2.yaml all MUST (v2 only; version header)
/eth/v3/validator/blocks/{slot} GET validator/block.v3.yaml all MUST (params: randao_reveal, graffiti, skip_randao_verification, builder_boost_factor; resp headers: Eth-Consensus-Version, Eth-Execution-Payload-Blinded, Eth-Execution-Payload-Value, Eth-Consensus-Block-Value)
/eth/v2/beacon/blocks POST beacon/blocks/blocks.v2.yaml all MUST (must parse broadcast_validation query: TK always sends it, NB sends gossip, LH omits; version header)
/eth/v1/beacon/pool/sync_committees POST beacon/pool/sync_committees.yaml all MUST
/eth/v1/validator/sync_committee_contribution GET validator/sync_committee_contribution.yaml all MUST
/eth/v1/validator/contribution_and_proofs POST validator/sync_committee_contribution_and_proof.yaml all MUST
/eth/v1/beacon/blocks/{block_id}/root GET beacon/blocks/root.yaml LH NB PR VO MUST (sync-committee message path, block_id=head)
/eth/v1/validator/beacon_committee_subscriptions POST validator/beacon_committee_subscriptions.yaml all MUST
/eth/v1/validator/sync_committee_subscriptions POST validator/sync_committee_subscriptions.yaml LH TK NB VO MUST (PR derives subnets itself)
/eth/v1/validator/prepare_beacon_proposer POST validator/prepare_beacon_proposer.yaml all MUST (NB re-sends every slot)
/eth/v1/validator/liveness/{epoch} POST validator/liveness.yaml LH TK NB PR MUST (doppelganger; NB default-ON conf.nim; LH/TK opt-in)
/eth/v1/beacon/headers/{block_id} GET beacon/headers/header.yaml NB PR VO MUST (NB default paths: finalized-header slashing-db pruning duties_service.nim:747, poll block monitor; VO proposer path)
/eth/v1/events GET (SSE) eventstream/index.yaml all connect by default MUST for production quality; deferrable at bring-up — see (b)

SHOULD — client- or config-specific

Endpoint Method Spec (apis/…) VCs Verdict
/eth/v2/beacon/blinded_blocks POST beacon/blocks/blinded_blocks.v2.yaml LH TK NB PR SHOULD — only reachable once produceBlockV3 can return blinded (external builder); VO unblinds via relay instead
/eth/v1/validator/register_validator POST validator/register_validator.yaml all, builder-gated SHOULD — accept-and-ignore is valid until builder support (NB asserts --payload-builder; VO posts as secondary)
/eth/v1/node/health GET node/health.yaml PR SHOULD (trivial: 200/206/503 by sync state)
/eth/v1/node/peer_count GET node/peer_count.yaml TK SHOULD (TK BeaconNodeReadinessManager wants ≥50 peers)
/eth/v1/config/deposit_contract GET config/deposit_contract.yaml PR VO SHOULD (static data)
/eth/v1/beacon/states/{id}/fork GET beacon/states/fork.yaml PR SHOULD
/eth/v1/beacon/states/{id}/finality_checkpoints GET beacon/states/finality_checkpoints.yaml PR SHOULD
/eth/v1/beacon/states/{id}/committees GET beacon/states/committees.yaml PR SHOULD (PR duties.go Committees)
/eth/v1/beacon/headers GET (list) beacon/headers/headers.yaml PR SHOULD
/eth/v2/beacon/blocks/{block_id} GET beacon/blocks/block.v2.yaml VO SHOULD (sync-duty inclusion verification, cache)

OPT — niche / out of normal operation

Endpoint VCs Note
GET /eth/v2/beacon/pool/attestations VO multi-instance mode only
POST /eth/v1/beacon/pool/voluntary_exits TK PR exit subcommands, not duty flow
POST /eth/v1/validator/{beacon,sync}_committee_selections LH TK NB PR DVT-only (--distributed / Obol flag)
POST validator/persistent_subnets_subscription TK Teku-proprietary (non-/eth); 404 is tolerated
Gloas set (v4 blocks, ptc duties, payload attestations, envelopes, proposer_preferences) LH TK PR defer until Gloas fork scheduling

(b) /eth/v1/events per client — NO client hard-requires it

  • LH (new on unstable): head monitor ON by default (enable_beacon_head_monitor: true, validator_client/src/config.rs L139), topic head only (beacon_node_fallback/src/beacon_head_monitor.rs L109). Purpose: attest immediately on head arrival. Stream failure = warn + auto-restart; attestations fall back to the ~1/3-slot deadline poll (attestation_service.rs L297–327). --disable-beacon-head-monitor exists.
  • TK: EventSourceBeaconChainEventAdapter subscribes head always; + attester_slashing, proposer_slashing only with --shut-down-when-validator-slashed-enabled (default false). ForkAwareTimeBasedEventAdapter runs CONCURRENTLY from genesis — all duty timers fire with or without the stream; SSE only adds early attestation + reorg-aware duty refresh.
  • NB: block monitor --block-monitor-type ∈ {disabled, poll, event}, default event (conf.nim:1113), topic head only (block_service.nim:503). poll mode (3× GET headers/head per slot) is a fully supported alternative; SSE failure = debug log + retry.
  • PR: topics head_v2 + execution_payload_available (api/client/event/event_stream.go:34); auto-falls back to head if the BN 400s on head_v2 (multi_event_stream.go L145). Reconnects forever (1 s→16 s backoff); duties are polled regardless. Without events: attests at full deadline, no dependent-root duty refresh.
  • VO: topics head + block (services/controller/standard/service.go:187-188), SSE via r3labs/sse, reconnect every 1 s (gec http/events.go:62). Drives early attest/sync-msg (fastTrackJobs), reorg duty re-fetch, block-root cache. Attestation jobs are ALSO scheduled at slot+slotDuration/3 (attester.go:110) — stream absence slows, not breaks.

Conclusion: polling fallback exists everywhere; the penalty for omitting SSE is degraded attestation latency (no early attest), no reorg-triggered duty refresh, and constant reconnect hammering (VO every 1 s, PR ≤16 s, LH/NB retries) polluting logs on both sides. Union of topics to serve when implemented: head, block (head_v2 declined via 400 is handled by PR). Slashing topics only for TK's opt-in shutdown feature.

(c) SSZ vs JSON

MUST accept/serve SSZ (application/octet-stream):

  • POST /eth/v2/beacon/blocks + blinded: LH sends SSZ ONLY — no JSON fallback (post_beacon_blocks_v2_ssz, eth2 lib L525; block_service.rs L741–770). TK/PR/VO also post SSZ-first (TK sticky-flips to JSON on 415; PR caches 415 per host w/ TTL; VO submitproposal.go:80). NB posts JSON. => server must decode BOTH, keyed by Content-Type + Eth-Consensus-Version request header.
  • GET /eth/v3/validator/blocks/{slot}: all five send Accept preferring octet-stream (TK q=0.9 default-on flag; LH SSZ-first w/ JSON retry; NB preferSSZ; PR q=0.95; VO q=1.0). Serving JSON is legal (clients switch on response Content-Type) but SSZ is the expected fast path; version/blinded-ness MUST come via response headers either way.

JSON-only in practice (spec allows SSZ on some, no surveyed VC uses it): attestation_data, aggregate_attestation v2, aggregate_and_proofs v2, pool attestations v2 (NB batch mode --batch-attestations posts SSZ, default off), register_validator (TK hardcodes JSON, OkHttpValidatorTypeDefClient), all duties, subscriptions, sync-committee family, validators queries, liveness, all bootstrap. VO alone sends SSZ-preferring Accept on GET v2 blocks/{id} (gec http.go:270) — JSON response is accepted.

v1 rule of thumb: SSZ decode on block publish, SSZ encode on block produce; JSON everywhere (incl. those two, for NB publish and any 415/downgrade path). Everything else JSON-only is spec-conformant and matches observed client behaviour.

(d) Conclusion for the client_server tile design

  1. v1 must serve ~25 routes (MUST rows): 3 duties, attestation_data + 3 attestation submit/aggregate routes (v2), produce v3 + publish v2, 3 sync-committee routes + contribution pair, 2 subnet subscriptions, prepare_beacon_proposer, liveness, validators lookup (POST+GET+by-id), genesis/spec/fork_schedule/version/syncing, blocks/{id}/root, headers/{id}. The SHOULD tier adds ~10 mostly-trivial reads. Fits the const ROUTES table + linear scan design comfortably.
  2. SSE is avoidable at first: every surveyed VC degrades to polling. Acceptable for bring-up; not acceptable for production (latency + reconnect spam). It slots into the accepted design exactly as anticipated: an additive subscription mode on the connection state machine (long-lived conn, small appended writes on head/block from spine events, periodic : keep-alive comments), NOT big-body streaming. Return 400 for unsupported topics per spec (PR relies on this for head_v2 negotiation).
  3. Nothing else conflicts with the materialized-in-buffer model. Zero long-polling or chunked responses in any client path. Bounded worst cases: produceBlockV3 SSZ (single- digit MB), validators queries (VCs always pass their own id lists; only TK's GET fallback and VO's no-ids call could ask for more — cap/paginate is a policy choice, not a streaming need). Client call timeouts are tight (TK 10 s hard; attestation_data effectively sub-second useful window) — the sync-handler + short-seqlock-read model is the right fit.
  4. Content negotiation is part of the router contract: Accept parsing on produce-v3 (and optionally attestation_data/aggregate later), Content-Type + Eth-Consensus-Version on the three v2 publish routes, broadcast_validation query on block publish, and the four produce-v3 response headers. 415 responses are load-bearing (TK/PR downgrade logic); so is 400-on-bad-topic for /eth/v1/events.

@vladimir-ea

Copy link
Copy Markdown
Collaborator

@vladimir-ea @0w3n-d note a limitation in the C5, we may want to revisit it:
Single beacon_api bind As of C5 the node binds exactly ONE listener — TCP or UDS, chosen by beacon_api_bind. If we want simultaneous surfaces (local VC over UDS + TCP on specific interfaces), the additive change is: BeaconApi holds a list of listeners (one reserved token each; accept loop per listener; connections already transport-uniform via Stream), config becomes a list of binds. Router, handlers, connection handling untouched.

Probably OK for now. UDS would most likely be used for out bound connections to the EL, as EL and CL often run on the same machine. But on the listener side normally people run a VC on a different machine for security, maybe used by solo stakers or for testing but TCP is probably fine for those cases too.

note that you do not need an 'accept loop' for each listener - it is simply another token registered with the poll and you handle as an accept when it becomes readable - this is how the tcp accept currently works with mio.

@Bronek

Bronek commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

@vladimir-ea @0w3n-d note a limitation in the C5, we may want to revisit it:
Single beacon_api bind As of C5 the node binds exactly ONE listener — TCP or UDS, chosen by beacon_api_bind. If we want simultaneous surfaces (local VC over UDS + TCP on specific interfaces), the additive change is: BeaconApi holds a list of listeners (one reserved token each; accept loop per listener; connections already transport-uniform via Stream), config becomes a list of binds. Router, handlers, connection handling untouched.

Probably OK for now. UDS would most likely be used for out bound connections to the EL, as EL and CL often run on the same machine. But on the listener side normally people run a VC on a different machine for security, maybe used by solo stakers or for testing but TCP is probably fine for those cases too.

note that you do not need an 'accept loop' for each listener - it is simply another token registered with the poll and you handle as an accept when it becomes readable - this is how the tcp accept currently works with mio.

Yes, which is why I think this should be a cheap fix, so perhaps we just need to do it.

Bronek added 3 commits August 18, 2026 11:13
Outbound (CL-114): EngineConfig::request_timeout_secs, default 12. Each
pooled connection records its request's enqueue time; the poll sweep fails
any request older than the deadline through the existing error path,
freeing the connection and un-gating spine intake. Age is anchored at
enqueue, so a request stuck behind a blackholed connect expires on the
same clock. The default clears every per-method floor in the engine-api
spec (1s getPayload-class, 8s newPayload/fcu, 10s getPayloadBodies) --
those floors are minimum waits before aborting, and this deadline is a
wedge-breaker, not a latency target.

Inbound (CL-115): Config::beacon_api_idle_timeout_secs, default 75 -- a
keep-alive window spanning several 12s slots. Connections stamp activity
on accept and on every read or written byte; a coarse sweep (at most once
per second) reaps connections idle past the deadline, treating malformed,
partial, and silent input uniformly: a stalled receiver is idle, a
trickling-but-progressing peer is not. Reaped connections free their
beacon_api_max_connections slot, closing the cap-exhaustion scenario.

Assisted-by: Claude:claude-fable-5
beacon_api_bind becomes a list: a TOML array in the config file (default
["0.0.0.0:5051"], single-bind behavior unchanged), comma-delimited values
on --beacon-api-bind (a comma cannot appear in a socket address and is
pathological in a socket path). BeaconApi holds one listener per bind --
TCP and unix sockets side by side, multiple interfaces, several UDS paths
with distinct permissions. Listeners occupy the reserved token range
0..n; connection tokens allocate above it and wrap back to it. The
connection cap and idle sweep count connections across all listeners.

Bind::parse now rejects a string that contains ':' but is not a valid
socket address instead of silently treating it as a unix path: hostnames
are not resolved, and with several binds a typo'd address would
otherwise bind a stray socket file and half-serve rather than fail
loudly at startup.

An empty bind list panics at construction: a node with no API surface is
the same class of misconfiguration as an unbindable address.

Assisted-by: Claude:claude-fable-5
ADR-0002 records the QUIC/HTTP-3 rejection: QUIC mandates TLS 1.3
(RFC 9001), which the ADR already declares a non-goal, and no validator
client speaks HTTP/3 -- noted so the alternative is not re-litigated.

ADR-0004's SSE paragraph reflected a deferral the team has since
reversed: /eth/v1/events will be served, in-process, as the single
sanctioned exception to the materialized-response model, fed from a
spine events queue. The 404 shipped today is interim behavior;
implementation follows the initial endpoint surface, and the SSE design
round will amend the ADR with the concrete mechanism. Both ADRs are
still status: proposed, so they are amended in place rather than
superseded.

Assisted-by: Claude:claude-fable-5
@Bronek

Bronek commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Updated docs/adr in 828ebdb to include streaming in scope, for future implementation of /eth/v1/events (polling is wasteful on resources)

First M2 infrastructure commit (I1). ParsedRequest exposes the three
request headers content negotiation needs -- Accept, Content-Type,
Eth-Consensus-Version -- as borrowed fields (no general header map). A
Query iterator percent-decodes key/value pairs, zero-alloc when no
escape is present; '+' stays literal (RFC 3986, not form encoding), and
malformed escapes pass through rather than panic.

The parse path now distinguishes knowledge from ambiguity (CL-115's
framing): definitively malformed input -- httparse errors including more
than 64 headers, an unparseable or overflowing Content-Length -- gets an
immediate 400-and-close instead of silently stalling until the idle
sweep, while genuinely partial input still waits for more bytes.
Verified against httparse 1.10.1 at every truncation offset that a
request within limits can never be misclassified mid-stream. Side
effect: an HTTP/2 preface now draws a 400 instead of a silent stall.

Assisted-by: Claude:claude-fable-5
The comments motivating the 415 on registerValidator said Teku posts
the registrations as application/octet-stream first and downgrades to
JSON inside its 415 handler. Teku's production call site constructs the
request with SSZ preference hardcoded off, so the registrations it sends
are always JSON; the SSZ-first path its request class carries is reached
only from tests. Its block publish does go SSZ-first for real.

The 415 is still owed: the schema declares it for the endpoint's
octet-stream body variant, and a client sending SSZ keys its downgrade on
that code alone — the hardcoded flag flipping, or another client adopting
SSZ-first, is what the branch protects against.

proposer.v2.yaml names a single dependent root for every epoch,
get_block_root_at_slot(state, compute_start_slot_at_epoch(epoch - 1) - 1):
beacon-APIs #590 superseded the fork split #563 introduced, the head_v2
event having made it unnecessary by supplying the matching root directly.
Silver holds Fulu states and later ones only, so the activation-boundary
epoch that split's pre-Fulu branch existed for is out of contract here.
v2 answers one epoch back unconditionally, and the fork epoch it consulted
leaves ApiCtx with it.

Assisted-by: Claude:claude-fable-5
@Bronek

Bronek commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

Minor correction to the "Serve the validator client's receipt POSTs" 93cf03a . It justifies the 415 on register_validator by saying Teku posts the registrations as application/octet-stream first and turns SSZ off only inside its 415 handler. That is wrong for production Teku: the SSZ-first machinery in RegisterValidatorsRequest exists, but its only non-test call site constructs it with preferSszEncoding=false hardcoded (OkHttpValidatorTypeDefClient.java:179, at teku 8bf7e9ea81), so Teku sends these registrations as JSON and never exercises the 415. Teku's block publish does use genuine SSZ-first with a sticky 415 downgrade, which is where the claim was generalized from.

The code is unaffected — the 415 is correct because this endpoint's schema declares it, whoever triggers it — and the code comments repeating the Teku claim were already rewritten in "Correct client-behaviour claims and the v2 dependent root".

Comment thread docs/adr/0001-single-api-tile.md Outdated
Comment thread docs/adr/0004-sync-materialized-api.md Outdated
Comment thread docs/adr/0004-sync-materialized-api.md
Comment on lines 479 to 522
/// An entry differing from its predecessor is a block of the slot's own; a
/// repeated one is a slot that carried none. Reading the entry itself asks
/// only that the ring still cover the slot, so an empty slot answers with the
/// root it repeats.
#[test]
fn block_roots_name_the_slots_that_carried_a_block() {
let empty = RECORDED_STATE_SLOT - 2;
let (g, id) = recorded_ring(Some(empty));
let reader = g.view(id);
let state_slot = RECORDED_STATE_SLOT;

assert_eq!(reader.at_slot(empty), root_of(empty - 1), "the ring answers at the wrapped index");

assert_eq!(reader.proposed_at(empty - 1, state_slot), Some(root_of(empty - 1)));
assert_eq!(reader.proposed_at(empty, state_slot), None);
assert_eq!(reader.proposed_at(empty + 1, state_slot), Some(root_of(empty + 1)));

assert_eq!(reader.recorded_at(empty, state_slot), Some(root_of(empty - 1)));
assert_eq!(reader.recorded_at(empty + 1, state_slot), Some(root_of(empty + 1)));
}

/// The ring covers the `SLOTS_PER_HISTORICAL_ROOT` slots below the state's own,
/// and naming a block needs its predecessor's entry too — so the floor itself
/// cannot be named however distinct its entry is, and the state's own slot has
/// no entry until the `process_slot` that leaves it.
#[test]
fn block_roots_bound_which_slots_can_be_named() {
let (g, id) = recorded_ring(None);
let reader = g.view(id);
let state_slot = RECORDED_STATE_SLOT;
let floor = state_slot - SLOTS_PER_HISTORICAL_ROOT as u64;

assert_eq!(reader.proposed_at(floor + 1, state_slot), Some(root_of(floor + 1)));
assert_eq!(reader.proposed_at(floor, state_slot), None, "the floor has no predecessor");
assert_eq!(reader.proposed_at(floor - 1, state_slot), None, "below the floor");
assert_eq!(reader.proposed_at(state_slot, state_slot), None, "the state's own slot");
assert_eq!(reader.proposed_at(state_slot + 1, state_slot), None, "past it");

assert_eq!(reader.recorded_at(floor, state_slot), Some(root_of(floor)));
assert_eq!(reader.recorded_at(floor - 1, state_slot), None, "below the floor");
assert_eq!(reader.recorded_at(state_slot, state_slot), None, "the state's own slot");
}

/// A block's reveal accumulates into the current epoch's bucket; the boundary

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

we don't need these?

Comment thread crates/beacon_state/tile/src/tile/block.rs Outdated
Comment thread crates/beacon_state/tile/src/tile.rs
Comment on lines +36 to +41
Phase0,
Altair,
Bellatrix,
Capella,
Deneb,
Electra,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

given that we aren't able to support these forks I would prefer to remove this

Comment on lines +111 to +118
#[serde(default = "default_fork_version::<0x01000000>", with = "hex_0x")]
pub altair_fork_version: [u8; 4],
#[serde(default = "default_u64::<74240>")]
pub altair_fork_epoch: u64,
#[serde(default = "default_fork_version::<0x02000000>", with = "hex_0x")]
pub bellatrix_fork_version: [u8; 4],
#[serde(default = "default_u64::<144896>")]
pub bellatrix_fork_epoch: u64,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

do we need these?

Comment on lines +666 to +682
#[test]
fn every_fork_field_is_overridable() {
let spec: SpecConfig = toml::from_str(
r#"
ALTAIR_FORK_VERSION = "0x20000910"
ALTAIR_FORK_EPOCH = 0
FULU_FORK_EPOCH = 50688
DEPOSIT_CHAIN_ID = 560048
"#,
)
.unwrap();
assert_eq!(spec.altair_fork_version, [0x20, 0x00, 0x09, 0x10]);
assert_eq!(spec.altair_fork_epoch, 0);
assert_eq!(spec.fulu_fork_epoch, 50688);
assert_eq!(spec.deposit_chain_id, 560048);
assert_eq!(spec.bellatrix_fork_epoch, 144896, "untouched fields keep the mainnet default");
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

doesn't this just test the parser?

Comment thread crates/beacon_state/data/src/view.rs Outdated
#[derive(Clone, Copy, Default)]
struct ControlInner {
state_id: Option<StateId>,
head_block_root: B256,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This field is the coupling you flagged on the tile's status_event — a value no state read uses, in the control word every state read goes through. Agreed it should not be here; it comes out once the head root is published per accepted block on BeaconStateEvent::Status. Answered in full there: #81 (comment)

@Bronek

Bronek commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

@clanky-gattaca review

Bronek added 2 commits August 21, 2026 15:05
The beacon-api server and the engine-api client each owned an mio `Poll`,
so every `loop_body` of the application-boundary tile made two
`epoll_wait` calls to learn about sockets on one thread. Both now register
through one `Readiness`, and a single wait feeds both dispatches.

Sharing a loop shares a token space, and a token both tenants could
allocate would deliver one tenant's socket readiness into the other's
dispatch — where an API client hanging up fails the engine call that
happens to share its number. `TokenRange` partitions the space instead:
each tenant takes `share(index, TENANTS)`, allocates only inside its own
range, and skips events whose token falls outside it. Both halves are
enforced rather than documented: `at` asserts the offset is inside the
span, and each tenant asserts at construction that its range holds every
socket it can register at once — listeners plus the connection cap for the
server, the pool cap plus the first-run healthcheck's overshoot for the
client.

The server's connection offsets recycle over its range above the
listeners. Connections close in any order while the cursor only advances,
so the offset it wraps onto may still be held; the allocator probes
forward past live offsets, and the construction assert is what guarantees
it lands on a free one rather than replacing a live connection's map
entry.

Because a tenant now sees only the batch the shared wait produced, the
order inside `loop_body` decides latency: taking a request off the spine
flips its pooled connection's interest to WRITABLE, so the wait runs after
that intake and the request goes on the wire in the iteration that took
it. Measured on the tile's own tests, produce-to-wire is 1 iteration per
request where waiting first cost 2, and 1000 iterations make exactly 1000
`epoll_wait` calls against one epoll instance, down from 2000 against two.

The engine's dispatch walks that batch once, indexing connections by
token offset, instead of scanning every event once per connection — the
batch carries the server's events too, so the old shape cost
O(connections x events) over both tenants' sockets.

Limits: the timeout stays zero, so the loop still busy-polls; a blocking
wait needs an `mio::Waker` on the flux work signal, which is separate. The
healthcheck is enqueued inside the engine's spin, after the wait, so it
alone still reaches the EL an iteration late. And `share` truncates:
`usize::MAX / count` leaves the tokens above the last share owned by
nobody, which costs nothing while nothing allocates there.

ADR 0004's amendment described this loop as outstanding work; it now
describes the loop, leaving the waker and the timeout as what remains.

Assisted-by: Claude:claude-opus-5
u64::MAX
/// Mainnet deposit contract, live since 2020-11-04. Hoodi reuses the very
/// same address.
fn default_deposit_contract_address() -> [u8; 20] {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why not a constant with array? Also from where we get that numbers?

Bronek added 2 commits August 24, 2026 18:05
Every endpoint that needed a block store, the validator registry, duty
shuffling, liveness tracking or in-process peer counts answers a routed
501 instead of an answer assembled from the wrong data: blocks/{id}/root,
headers/{id}, the three validators reads, both proposer-duties versions,
sync duties, liveness, and node/peer_count. The route stays in the table
so a client can tell "this node does not serve it" from "no such
endpoint". Each surface returns in its own PR.

What each stub cuts out:

- The validators reads ran a full-registry scan inside the seqlock read
  closure — ~2M entries and ~0.9s with render at mainnet scale, against a
  reader contract whose lock-free budget is a handful of scalar pulls,
  while any ready connection multiplies the engine-call delay through the
  shared loop_body. ADR-0004 gains the amendment recording the deferral;
  the ~1GiB/~0.9s figures stand as the cost a bounded-render design must
  answer.
- Liveness answered not-live for every validator, which is the direction
  that silently clears a validator client's doppelganger protection.
  Refusing loudly protects better than answering from data silver does
  not track.
- node/peer_count read the PeerCounters shmem gauges across tiles — a
  second shared-memory read path beside BeaconStateReader, an
  application_boundary → silver_peer edge that existed only for it, and a
  gauge-zeroing in PeerManager::new against stale mapped files. All three
  revert; peer counts can ride the existing peer_stats queue instead.
- The duties and block reads consumed the head-root plumbing (control-word
  staging, ring predicates) that the next commit removes at the source.

The fire-and-forget POSTs stay: parsing and acknowledging is the whole
answer their schemas owe. So do the statics, node status, genesis, and
the two per-state scalar reads, which fit the read closure's budget.

Assisted-by: Claude Code:claude-fable-5
The seqlock control word carried the root of the block the published
state was applied from, staged by the tile as each block landed, so a
beacon-API request could name the head. With the block and duties
endpoints answering 501, nothing reads it — and it was the wrong value
anyway: fork choice re-heads on attestations without publishing, so the
last applied block and the head diverge whenever an import lands on a
branch fork choice passes over. A tile conclusion has no place in a
tier-1 data structure; whichever design serves those endpoints next
carries the head another way.

The ring and finality predicates that existed to interpret that root go
with it: RootsView::recorded_at/proposed_at, EpochView::finalizes_slot
and finalized_block_root.

What stays is what the served surface still reads:
BeaconStateEvent::Status carries head_optimistic, computed from fork
choice where the verdict lives, because node/syncing's is_optimistic
answers from it; EPOCHS_PER_SYNC_COMMITTEE_PERIOD stays in the data
crate because config/spec renders it.

Assisted-by: Claude Code:claude-fable-5
Assisted-by: Claude Code:claude-fable-5
use silver_httpcore::{Bind, Readiness, TokenRange};

/// A tenant added here takes the next share of a raised `TENANTS`, which keeps
/// every share disjoint without a base to compute.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

i have no idea what this comment means - what is a tenant and what is a 'TENANTS'?

use crate::json::Json;

const PRESET_BASE: &str = "mainnet";

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

why do we need all of these in this tile? are these all things served on the beacon api?

Assisted-by: Claude Code:claude-fable-5
@vladimir-ea

Copy link
Copy Markdown
Collaborator

i am going to merge this Pr as is - it is due to change with Flux http server - will follow up on the comments about the dead fork configs

A request head that filled the whole 16 MiB read buffer without ever
completing was dropped where it stood: read_space reported exhaustion,
dispatch had no complete request to answer, and the connection died by
reset with nothing on the wire. That contradicted the read loop's own
rule — a full buffer always leaves something to answer with — and a
reset before a parseable response is the failure mode validator-client
stacks punish hardest.

Every other overrun already had its verdict: a body declared past the
cap is a 413 from its headers, garbage is a 400. The unfinished head now
gets the 431 of RFC 6585, framed and lingered like every other reject,
so the sender reads the status instead of a reset.

The equivalent fix landed in flux's HTTP machine during its adversarial
review rounds; this carries it to the silver machine the flux one will
eventually replace.

Assisted-by: Claude Code:claude-fable-5
A crash leaves the socket file behind and every restart then fails with
AddrInUse. Bind now probes an existing path first: only an lstat-verified
socket whose connect comes back ConnectionRefused is unlinked — a live
listener accepts the probe and keeps its path, and a regular file is left
for the bind to fail on. Dropping the listener removes its own file so a
clean shutdown leaves nothing to probe.

Ported from the flux HTTP stack, which hit and fixed the same restart
failure (flux 9678523, ADR 0003).

Assisted-by: Claude Code:claude-fable-5
A bare path was accepted, connected, and then spoken to in HTTP/1.1. An
EL's IPC socket (reth --auth-ipc, geth.ipc) carries raw newline-framed
JSON-RPC with no HTTP envelope, so the connection succeeded and every
request was garbage to the EL. The path now fails at startup with a
message naming http:// as the only served scheme.

The UDS transport stays behind EngineClient::new_uds for the pool tests
and for the raw JSON-RPC framing that will make the path usable.

Assisted-by: Claude Code:claude-fable-5-1
Comment thread crates/beacon_state/tile/src/tile.rs
@ninaiiad
ninaiiad merged commit bb57596 into main Sep 3, 2026
3 checks passed
@ninaiiad
ninaiiad deleted the od/beacon_api branch September 3, 2026 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants