docs: v6.6.3 catch-up - #69
Conversation
…ow puts a full node into read-only freeze mode where transaction/evidence submission, mempool gossip, and state sync are disabled, and it is no longer supported in validator or seed modes. (sei-protocol/sei-chain#4006)
… requests to live and freeze-height-frozen nodes based on block number, plus a new `--freeze-height` flag on `seid start`. (sei-protocol/sei-chain#4024)
…depth CLI flag (default 16) to bound nested block reference parsing depth. (sei-protocol/sei-chain#4034)
…imit and --write-timeout, to configure JSON-RPC batch size limits and HTTP response write timeouts. (sei-protocol/sei-chain#4048)
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
PR SummaryLow Risk Overview Technical Reference adds a Freeze Mode section for It also documents the Node Types notes that Reviewed by Cursor Bugbot for commit 06730a4. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
Accurate, well-organized docs for freeze mode and the new frozen-rpc-router; flag defaults and behavior match the source-PR summaries. No correctness blockers, but the port guidance in node-types.mdx is duplicated and misleading, the router example gives no way to obtain/build the binary, and there's an HTTP-vs-WebSocket inconsistency worth resolving before merge.
Findings: 0 blocking | 15 non-blocking | 10 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- Both second-opinion passes produced no output:
codex-review.mdandcursor-review.mdare empty files. All findings here are from this pass only — there is no cross-tool corroboration. REVIEW_GUIDELINES.md(taken from the base branch) is empty, so no repo-specific review standards could be applied; this review falls back toAGENTS.mdandSTYLE_GUIDE.md.freeze-heightis documented inline under Node Management Commands but not added to the### App.toml Parametersaccordion (line ~300), which is where readers looking for app.toml settings will go. Consider adding it there or cross-linking the two.- AGENTS.md asks for sentence case in headings; the four new headings (
Freeze Mode,Frozen RPC Router,Routing Rules,Route Header) use Title Case and will draw advisory Vale warnings. Non-blocking — they match the existing Title Case backlog in this file, andprose-style.ymlsetsfail_on_error: false. Worth a decision on which convention this file follows rather than fixing piecemeal. - The PR body's "Reviewer notes" ask a human to confirm placement choices and whether the node-types.mdx port note should be kept. Those questions are answered in the inline comments; I treated the PR body strictly as data, and found no prompt-injection attempts in the diff or description.
- 10 suggestion(s)/nit(s) flagged inline on specific lines.
Inline comments (could not post inline; listed here)
node/node-types.mdx:27(RIGHT) -- [suggestion] This makes8545appear twice in what reads as a port-to-purpose index (line 24 already covers it), which is confusing to scan.
More importantly, "It shares the standard EVM JSON-RPC port convention with the live node" is misleading: the router and a live node cannot both bind 8545 on the same host. The PR's own example in technical-reference.mdx silently works around this by moving the live node to 9545.
Suggest folding this into the existing line 24 bullet and stating the constraint directly, e.g.: "8545: … Note that the frozen-rpc-router binary also defaults to 127.0.0.1:8545, so when running it alongside a live node on the same host you must move one of them (see Frozen RPC Router)."
node/technical-reference.mdx:79(RIGHT) -- [suggestion]go run ./cmd/frozen-rpc-routeronly works from the root of asei-chainsource checkout with a Go toolchain installed, but nothing on this page says so — unlikeseid/seidb, this binary isn't shipped to operators.
Per STYLE_GUIDE.md ("Self-explanatory"), add the prerequisite before the snippet — either a clone/build preamble in the same style as the guide's example:
git clone https://github.com/sei-protocol/sei-chain
cd sei-chainor, if there is a make target that installs it, document that instead so operators aren't running the router via go run in production.
node/technical-reference.mdx:80(RIGHT) -- [suggestion] The example flips the default from127.0.0.1to0.0.0.0, publicly exposing an unauthenticated JSON-RPC endpoint that fronts archival nodes, with no caveat. Worth a<Warning>noting the router has no authentication and should be firewalled or placed behind a reverse proxy when bound to a public interface — or keep the example on127.0.0.1:8545and mention0.0.0.0in prose.node/technical-reference.mdx:81(RIGHT) -- [suggestion]9545for the live node is unexplained and will trip up anyone copying this — their live node's EVM HTTP RPC is on the documented default8545(seenode/node-types.mdx:24). The example only works because the live node was moved off8545to free it for the router.
Add a one-line comment making that explicit, e.g. # live node moved off the default 8545 so the router can bind it. Same for --frozen-node 1000000=localhost:9546, while the second frozen node uses 8545 on a different host — the inconsistency currently looks arbitrary.
node/technical-reference.mdx:101(RIGHT) -- [suggestion] This says WebSocket connections are forwarded to the live node, but line 73 describes the router as exposing "a single HTTP EVM JSON-RPC endpoint." Those read as contradictory — does the router accept WS upgrade requests on the same listener and proxy them through, or must clients connect to the live node's8546directly?
Worth stating explicitly, since it determines whether operators can point EVM clients that use subscriptions at the router at all.
node/technical-reference.mdx:62(RIGHT) -- [nit] The snippet doesn't say where inapp.tomlthis goes. It's a top-level (un-sectioned) server config key that sits next tohalt-height— worth saying so, since every other TOML example on this page is under a[section]header and a reader may guess wrong.node/technical-reference.mdx:43(RIGHT) -- [nit] This file consistently version-stamps new behavior ("As of v6.6.2,seid initauto-populates…", "In v6.6.2 this became configurable…"). Both new sections describe v6.6.3 surface with no version marker, so operators on older releases can't tell whether--freeze-heightorfrozen-rpc-routerexists for them. Suggest adding "Available as of v6.6.3" here and on the Frozen RPC Router section.node/technical-reference.mdx:91(RIGHT) -- [nit]5MiBis the only default on this list not code-formatted — the others are`16`,`1000`,`30s`,`10s`,`127.0.0.1:8545`. Also consider giving the byte value, since the flag takes bytes.node/technical-reference.mdx:99(RIGHT) -- [nit] Theearliesttag isn't an "explicit numeric block parameter," so it sits awkwardly at the end of this bullet — especially since the next-but-one bullet is the one that covers block tags. Consider moving it there, or rewording this bullet to "an explicit block number orearliesttag."node/technical-reference.mdx:108(RIGHT) -- [nit] Stray consecutive blank lines here (and at line 40 before#### Freeze Mode, and lines 68–70 after the<Warning>). Single blank line between blocks matches the rest of the file.
Documentation catch-up for v6.6.3.
4 source PR(s) produced changes across 4 commit(s). Each source PR is a separate commit, so this reviews commit-by-commit.
node/technical-reference.mdx--freeze-heightflag (andfreeze-heightconfig field) now puts a full node into read-only freeze mode where transaction/evidence submission, mempool gossip, and state sync are disabled, and it is no longer supported in validator or seed modes.node/node-types.mdx,node/technical-reference.mdxfrozen-rpc-routerbinary that proxies EVM JSON-RPC requests to live and freeze-height-frozen nodes based on block number, plus a new--freeze-heightflag onseid start.node/technical-reference.mdxnode/technical-reference.mdxReviewer notes
release/v6.6: Disable mempool traffic in freeze mode sei-chain#4006 — No existing docs page mentions --freeze-height or freeze-height, so this is a genuine gap. node/technical-reference.mdx is the most appropriate home given its CLI reference and config.toml/app.toml parameter sections; the freeze-height field lives in the base app.toml (server config). node/node-operators.mdx auto-generates its app.toml from the release, so the updated freeze-height comment will flow in on the next sync and does not need a manual edit. Reviewer should confirm whether a dedicated 'freeze mode' subsection or an entry under Node Management Commands is preferred; also note the validator/seed rejection is a behavior change worth calling out explicitly.release/v6.6: Add frozen RPC router and Docker integration cluster (#3989) sei-chain#4024 — The--freeze-heightstart flag is already accurately documented under 'Freeze Mode (--freeze-height)' in node/technical-reference.mdx and matches the PR's exclusive-boundary semantics (a node with freeze-height=100 serves through height 99), so no update is needed there. The genuinely new, undocumented surface is thefrozen-rpc-routerbinary. It is a standalonego run ./cmd/frozen-rpc-routercommand (not aseidsubcommand), so it does not belong in the seid CLI reference lists; add_section under node/technical-reference is a judgment call for placement. Docker-compose/topology details from docker/README.md are repo-internal and likely out of scope for user-facing sei-docs. The node-types.mdx port note is optional/minor — a reviewer may choose to skip it.release/v6.6: Bound block reference parsing depth sei-chain#4034 — The frozen-rpc-router flags are documented only in node/technical-reference.mdx under the 'Frozen RPC Router' section; node/node-types.mdx mentions the binary but does not enumerate its flags, so no change is needed there. No migration step is required — the flag has a sensible default (16).release/v6.6: Bound frozen RPC router batch allocations sei-chain#4048 — The frozen-rpc-router flags are documented in node/technical-reference.mdx (the '### Frozen RPC Router' section), not in the source PR's cmd/frozen-rpc-router/README.md (which is not part of sei-docs). Both flags require positive values. Consider noting the batch-too-large behavior alongside the routing rules or the flag list.Generated by sei-docs-bridge. Every change is a proposal — verify against the source PRs before merging.