Skip to content

docs: prepare Consensus v0.6 and Studio v0.123 release - #472

Open
MuncleUscles wants to merge 2 commits into
docs/protocol-understanding-refreshfrom
docs/v0.6-release
Open

docs: prepare Consensus v0.6 and Studio v0.123 release#472
MuncleUscles wants to merge 2 commits into
docs/protocol-understanding-refreshfrom
docs/v0.6-release

Conversation

@MuncleUscles

@MuncleUscles MuncleUscles commented Sep 2, 2026

Copy link
Copy Markdown
Member

Delivery context

Depends-On:

Cross-stack release qualification remains owned by genlayerlabs/genlayer-e2e#756. Node v0.6 interface PR #1800 and CLI fee PR #412 are already merged. This docs layer is deliberately downstream of, and outside, the frozen six-PR product landing cut.

Source snapshots used for generated/reference content and integration examples:

  • Consensus: 2f78febfc06866e59e7f12db848664e95ce99e8e
  • Node v0.6 merged interface: 6666892c3ee124e3804e391688c4156a4736fdac
  • GenLayerJS: 2f8122e81862bd5f6cf0daabcfa34b99a1bb0600
  • GenLayerPY: 39c54bcc5bc9de3a635bbd5f6a2e3db0310f7ab1
  • CLI release-prep source: 054200d
  • Transaction Kit release-prep source: 3f3d75c

Problem and outcome

The next-release documentation was split across old draft PRs and still contained materially stale behavior: pre-ECVRF randomness, first-contract-only developer rewards, obsolete SDK calls and network commands, incomplete appeal charges, an old custom-error set, and the pre-resolution-kernel 15-status lifecycle.

This layer prepares the complete Consensus v0.6 / Studio v0.123 documentation release:

  • fee-funded deploy/write flows, cap timing, refunds, message allocations, fee profiles, and Transaction Kit policy verification;
  • safe decision-bound appeals through topUpAndSubmitAppeal, including bond + induced-work funding and the exact 2.5× successful bond return;
  • Studio-dev endpoints and chain identity, with studio-next described only as an optional browser alias;
  • coherent tooling-RC and application migration guidance;
  • current read, write, lifecycle, deployment, payable-value, and outcome-verification tutorials;
  • the exact 14-status ontology, stored-only gen_getTransactionStatus, advanced gen_getTransactionLifecycle, and action-based finalization readiness;
  • v0.6 receipt fields, including previousStatus: null, fee accounting, status names, and the complete execution-vote enum;
  • ECVRF randomness, creation-frozen tribunals, judicial consequences, keeper roles, and corrected economics;
  • Developer NFT behavior across all deployments and the bounded 50-epoch claim path;
  • refreshed GenLayerJS, GenLayerPY, Node, and CLI API references from the train heads;
  • an exhaustive 363-selector v0.6 error index with source-revision provenance.

The imported Node receipt source still showed LeaderRevealing at its former ordinal 14 even though #1800 removed ReadyToFinalize; this layer corrects it to 13 and adds a regression check so a later docs sync cannot silently restore the wrong ordinal.

Superseded drafts

This PR consolidates and corrects the useful material from #425, #428, #432, #436, and #439. It replaces the stale integration bundle #441; those PRs should not be merged on top of this layer.

Implementation and validation

  • Added a build-time v0.6 release-doc checker covering 36 release-critical pages, internal links, code-fence syntax, SDK and Node method presence, known stale claims, lifecycle ordinals, economic invariants, network IDs, and all 363 unique custom-error selectors.
  • npm run build: passing, including 232 static routes, TypeScript validation, generated node API docs, complete docs bundles, and LLM export checks.
  • npm run check:protocol-docs: passing (27 concept pages and all 14 transaction statuses).
  • npm run check:v06-release-docs: passing (363 unique selectors and behavior anchors).
  • git diff --check: passing.
  • Two coherent commits; worktree clean at 0f712376.

Full product E2E is not duplicated from this docs-only PR; #756 owns qualification of the exact product snapshot. Publication should wait for the upstream train and matching tooling RC names to become final. The actual Studio deployment, DNS aliases, and package/container releases are intentionally outside this PR.

Document fee-funded transactions, safe appeals, Studio preview networks, tooling RC integration, ECVRF selection, tribunals, developer rewards, keeper operations, and migration guidance. Refresh the JavaScript and Python API surfaces from the exact train heads and add a build-time release invariant check over 363 consensus error selectors and critical behavior anchors.\n\nValidated with the complete 231-route production build, protocol-doc checks, release-doc checks, generated API/LLM exports, and whitespace checks.
@coderabbitai

coderabbitai Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 780fbc1c-2f2b-4c84-96ca-8d59b17f801c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@MuncleUscles MuncleUscles self-assigned this Sep 2, 2026
Remove the obsolete ReadyToFinalize status, renumber the terminal phase statuses to the 14-value consensus ontology, document gen_getTransactionLifecycle, and update receipt fields including fee accounting and the absent previousStatus. Strengthen protocol and release checks so the old ordinal model, status timestamp projection, and incomplete vote enum fail before publication.\n\nValidated with the 232-route production build, both documentation checks, generated API and LLM exports, and whitespace checks.
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.

1 participant