Conversation
tuler
marked this pull request as ready for review
October 1, 2026 19:02
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Adds
openapi.yamlat the repo root: an OpenAPI 3.1 definition of the 14 routes the sequencer serves, derived from the Axum handlers and serde wire types and cross-checked against the README API section.POST /tx,GET /fee,GET /nonce,GET /domainGET /ws/subscribe,GET /history,GET /historical-l1-inputsGET /finalized_state/inclusion_block,GET /finalized_state,GET /latest_snapshot,GET /finalized_snapshotGET /livez,GET /readyz,GET /healthzNo code or behavior changes.
Why
A machine-readable description of the API for client generation, documentation tooling, and app developers integrating against the sequencer.
Risk / compatibility notes
$refresolves, but it has not been run through an OpenAPI linter (e.g. Redocly or Spectral)./ws/subscribedocuments the handshake and its refusals; the frame shape is theBroadcastTxMessageschema, referenced through a non-standardx-websocket-messagesextension./ws/subscribereturns a plain-text400for bad query fields, and the snapshot routes return empty-body404/500, rather than the{ok, code, message}shape.u64fields are typedintegerwith the fullu64maximum, which exceeds strictformat: int64; some generators may complain or pick a signed type.🤖 Generated with Claude Code