Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MuncleUscles merged 2 commits into from
Sep 3, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fec8c1
docs: prepare consensus v0.6 release
MuncleUscles Sep 2, 2026
a61e824
docs: align v0.6 lifecycle interfaces
MuncleUscles Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,454 changes: 1,454 additions & 0 deletions data/consensus-v06-error-selectors.json
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
"description": "GenLayer documentation",
"scripts": {
"dev": "npm run node-generate-changelog && npm run node-update-setup-guide && npm run node-update-config && npm run node-update-docker-compose && npm run node-update-monitoring-docker-compose && npm run node-update-monitoring-alloy-config && npm run node-update-greybox && npm run node-generate-api-docs && node scripts/generate-full-docs.js && node scripts/check-llm-exports.js && next dev",
"build": "npm run check:protocol-docs && npm run node-generate-changelog && npm run node-update-setup-guide && npm run node-update-config && npm run node-update-docker-compose && npm run node-update-monitoring-docker-compose && npm run node-update-monitoring-alloy-config && npm run node-update-greybox && npm run node-generate-api-docs && node scripts/generate-full-docs.js && node scripts/check-llm-exports.js && next build",
"build": "npm run check:protocol-docs && npm run check:v06-release-docs && npm run node-generate-changelog && npm run node-update-setup-guide && npm run node-update-config && npm run node-update-docker-compose && npm run node-update-monitoring-docker-compose && npm run node-update-monitoring-alloy-config && npm run node-update-greybox && npm run node-generate-api-docs && node scripts/generate-full-docs.js && node scripts/check-llm-exports.js && next build",
"start": "next start",
"test:e2e": "playwright test",
"generate-sitemap": "node scripts/generate-sitemap-xml.js",
"check:protocol-docs": "node scripts/check-protocol-docs.js",
"check:v06-release-docs": "node scripts/check-v06-release-docs.js",
"node-generate-changelog": "node scripts/generate-changelog.js",
"node-generate-api-docs": "node scripts/generate-api-docs.js",
"node-update-setup-guide": "node scripts/update-setup-guide-versions.js",
Expand Down
11 changes: 5 additions & 6 deletions pages/api-references/genlayer-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ Large numbers that exceed JavaScript's safe integer range are automatically hand
USAGE:
genlayer receipt <txId> Get transaction receipt
genlayer appeal <txId> Appeal a transaction
genlayer appeal-bond <txId> Show minimum appeal bond required
genlayer appeal-bond <txId> Show full appeal charge (bond + induced-work funding)

OPTIONS (receipt):
--status <status> Status to wait for (default: FINALIZED)
Expand All @@ -244,17 +244,17 @@ OPTIONS (receipt):
--stderr Print only stderr from the receipt

OPTIONS (appeal):
--bond <amount> Appeal bond amount (e.g. 500gen, 0.5gen). Auto-calculated if omitted
--bond <amount> Total appeal charge: bond + induced-work funding. Auto-calculated if omitted
--rpc <rpcUrl> RPC URL override

EXAMPLES:
# Check the minimum bond required to appeal
# Check the full charge required to appeal
genlayer appeal-bond 0x1234...

# Appeal with auto-calculated bond
# Appeal with an authoritative, auto-calculated charge
genlayer appeal 0x1234...

# Appeal with explicit bond
# Appeal with an explicit total charge
genlayer appeal 0x1234... --bond 500gen
```

Expand Down Expand Up @@ -522,4 +522,3 @@ We welcome contributions to GenLayerJS SDK! Whether it's new features, improved
## License

This project is licensed under the ... License - see the [LICENSE](LICENSE) file for details.

2 changes: 1 addition & 1 deletion pages/api-references/genlayer-cli/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Version: `0.39.1`
- `genlayer network` — Network configuration
- `genlayer receipt` — Get transaction receipt by hash
- `genlayer appeal` — Appeal a transaction by its hash
- `genlayer appeal-bond` — Show minimum appeal bond required for a transaction
- `genlayer appeal-bond` — Show the full appeal charge (bond plus induced-work funding)
- `genlayer trace` — Get execution trace for a transaction (return data, stdout, stderr, GenVM logs)
- `genlayer finalize` — Finalize a transaction that is ready to be finalized (public call)
- `genlayer finalize-batch` — Finalize a batch of idle transactions in a single call (public call)
Expand Down
2 changes: 1 addition & 1 deletion pages/api-references/genlayer-cli/transactions/appeal-bond.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: appeal-bond
---

Show minimum appeal bond required for a transaction
Show the full appeal charge required for a transaction. The historical command name is retained for compatibility; the returned value includes the bond and induced-work funding.

### Usage

Expand Down
4 changes: 2 additions & 2 deletions pages/api-references/genlayer-cli/transactions/appeal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: appeal
---

Appeal a transaction by its hash
Appeal a transaction by its hash. The CLI binds the active decision and uses the schedule-extending appeal path; if `--bond` is omitted it reads the authoritative bond-plus-funding charge.

### Usage

Expand All @@ -16,6 +16,6 @@ Appeal a transaction by its hash

| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --bond &lt;amount&gt; | Appeal bond amount (e.g. 500gen, 0.5gen). Auto-calculated if omitted | No | |
| | --bond &lt;amount&gt; | Total appeal charge (bond + induced-work funding; e.g. 500gen, 0.5gen). Auto-calculated if omitted | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
| -h | --help | display help for command | No | |
2 changes: 1 addition & 1 deletion pages/api-references/genlayer-cli/transactions/receipt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Get transaction receipt by hash

| Short | Long | Description | Required | Default |
| --- | --- | --- | :---: | --- |
| | --status &lt;status&gt; | Transaction status to wait for (UNINITIALIZED, PENDING, PROPOSING, COMMITTING, REVEALING, ACCEPTED, UNDETERMINED, FINALIZED, CANCELED, APPEAL_REVEALING, APPEAL_COMMITTING, READY_TO_FINALIZE, VALIDATORS_TIMEOUT, LEADER_TIMEOUT) (default: "FINALIZED") | No | |
| | --status &lt;status&gt; | Transaction status to wait for (UNINITIALIZED, PENDING, PROPOSING, COMMITTING, REVEALING, ACCEPTED, UNDETERMINED, FINALIZED, CANCELED, APPEAL_REVEALING, APPEAL_COMMITTING, VALIDATORS_TIMEOUT, LEADER_TIMEOUT, LEADER_REVEALING) (default: "FINALIZED") | No | |
| | --retries &lt;retries&gt; | Number of retries | No | `100` |
| | --interval &lt;interval&gt; | Interval between retries in milliseconds (default: 5000) | No | |
| | --rpc &lt;rpcUrl&gt; | RPC URL for the network | No | |
Expand Down
Loading
Loading