docs(sequencer-client): rewrite top-level and timing READMEs#23149
Merged
Conversation
Rewrite the sequencer-client package README to document the current multi-block-per-slot architecture and proposer pipelining flow, and trim the timing-model README down to the pipelined case only since non-pipelined scheduling is being removed.
PhilWindle
approved these changes
May 13, 2026
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.
Motivation
The top-level
sequencer-client/README.mdwas years out of date — it still referred to single-block-per-slot building and made no mention of proposer pipelining or the multi-block checkpoint model. The timing-model README still documented both pipelined and non-pipelined scheduling even though the non-pipelined mode is about to be removed. New contributors (human or AI) lacked the context they need to make changes to block building.Approach
Rewrote the top-level README from scratch following the package's
readme-writerguidelines: slots / blocks / checkpoints, proposed vs checkpointed chain, an architecture diagram, theSequencerwork loop,CheckpointProposalJoblifecycle, per-block loop pseudocode, theSequencerPublisherMulticall3 bundling andsendRequestsAtsemantics, events, configuration reference, and failure modes. Trimmedsrc/sequencer/README.mdto cover only the pipelined timing model with formulas grounded inPipelinedCheckpointTimingModeland a corrected 72 s / 8 s walkthrough. Ran/codexfor a critical review and fixed all flagged issues (last-sub-slot-is-not-cooldown, event-emit timing, config env-var names, attestation-deadline nuance,insufficient-valid-txshandling, publisherpreChecksemantics).Changes
README.mdwith an architecture-first rewrite covering pipelining (build slot vs target slot, depth bound of 2, parent-invalidation discard), the per-slot job lifecycle, the publisher's Multicall3 flow, and the full config reference.src/sequencer/README.mdwith a pipelining-only timing model. DocumentstimeReservedAtEnd,maxNumberOfBlocks, per-state deadlines, proposer-vs-committee parallel timeline, and timing-variation handling.