docs: release v5.0.1 docs — unified Alpha (Mainnet) + Testnet version, refresh networks.md, deprecate v5.0.0/v4.3.1 - #24763
Merged
Merged
Conversation
alejoamiras
marked this pull request as ready for review
July 17, 2026 14:29
aminsammara
approved these changes
Jul 17, 2026
…, refresh networks.md, deprecate v5.0.0/v4.3.1 # v5.0.1 docs release (Alpha + Testnet unified) Runs the `/release-docs` workflow for the `v5.0.1` tag, using `https://v5.testnet.rpc.aztec-labs.com` as the network source of truth, per the request in #ecosystem. ## Versioning - **Developer and network/operator docs** both cut at `v5.0.1`, with **both `mainnet` and `testnet` release channels pointing at it** (single "Alpha / Testnet (v5.0.1)" version in the dropdown, same as the v4.3.x unified precedent). Cut with `RELEASE_TYPE=mainnet` per that precedent. - **Deprecated/removed**: `version-v5.0.0` (old testnet) and `version-v4.3.1` (old Alpha v4) developer + network snapshots and sidebars. - The network snapshot is cut from `next`'s `docs-operate` source so the new **role-based operator documentation** (68c0042, which describes v5 as current) ships with this release instead of waiting for the next cut. Its macros are resolved at v5.0.1. ## networks.md **Testnet column** (from live RPC + on-chain `cast` queries against the new rollup, all matching what was already on `next` post-rollup-upgrade): version → `5.0.1`; v5.0.1-canonical MultiCall Entrypoint and SponsoredFPC (below). **Alpha (Mainnet) column** — version → `5.0.1`, RPC kept at dRPC per request. The mainnet Registry (`0x35b22e09…`) now has rollup **version 3 = `4248094967`** registered and canonical — the v5 deployment — so all per-rollup addresses were resolved on-chain from it (Rollup `0x91ff8bbd…`, Inbox, Outbox, Fee Juice Portal, Slasher, Tally Slashing Proposer, Slash Payload Cloneable, Honk Verifier, Reward Distributor, Reward Booster). Governance-level contracts (Registry, Governance, Governance Proposer, GSE, Fee Juice, Staking Asset, Coin Issuer) verified unchanged on-chain. L2 protocol addresses updated to the v5 layout (Class Registry `0x01`, Instance Registry `0x02`, Fee Juice `0x03`). **Governance table**: slashing rows updated from on-chain values of both new Tally Slashing Proposers (quorum 65/128, round 4 epochs = 128 slots on both networks). Release-channel examples refreshed from 4.x to 5.x. ## L2 canonical addresses (derived with v5.0.1 tooling, cross-checked on a live v5.0.1 local network) - **SponsoredFPC**: `0x1441491b59934ec64f8c98f17c91f23c01ca2a45dbb35caf123146ec76f9970c` (changed from 5.0.0's `0x0628…` — the aztec-nr partial-note fix in this patch changed the artifact). Applied to `networks.md` and `getting_started_on_testnet.md` (source + snapshot). - **MultiCall Entrypoint**: `0x246d60af8b79a5dceece7d2388921203401c0df02ce674c5781c6c2162922986` (changed from 5.0.0 — pinned standard contracts were regenerated in this patch). ## Generated references (all regenerated at the tag) - Aztec.nr + TypeScript API docs into **both** `static/*-api/mainnet` and `static/*-api/testnet` (both networks now run v5.0.1). - `aztec`, `aztec-wallet`, `aztec-up` CLI references (via the release wrapper, so `init`/`new`/`test` are included; wallet usage lines now correctly read `aztec-wallet`). - Node JSON-RPC API reference (65 methods) and the operator `aztec start --help` CLI reference. ## Migration notes Source file restructured to match what shipped: new `## 5.0.1` section (history-note nullification helper rename, `set_as_fee_payer` setup-phase assert, PXE per-`(l1ChainId, rollupAddress, schemaVersion)` stores), and the published v5.0.0 snapshot's `## 5.0.0` section adopted verbatim (the prior release had only moved TBD→5.0.0 in the snapshot, not the source). ## Reconciliation with `next` (skill step 12) Ported into the v5.0.1 snapshot: fees.md Fee Juice bridging section (predates the 5.0.0 cut but was missed by it), counter-tutorial scaffold-test note, `typescript@^5.3.3` pin, `@aztec/viem@2.38.2` in the token-bridge install line. Fixed stale `MessageDelivery` API-reference links in source + snapshot. Skipped next-side changes not valid at v5.0.1 (e.g. removal of the `generated/default.json` step, which is only obsolete after #24434). Tag-newer content (initializerless accounts, key-derivation docs) is kept in the snapshot and left untouched in `next`'s source. ## Validation - `yarn build` passes on this branch: 0 broken redirect targets, 0 broken API-ref links, 0 spellcheck issues. (Known non-fatal `valkeys` anchor warning remains, plus pre-existing docker-compose anchor warnings from the operator restructure source.) - Functional smoke test on a **v5.0.1 local network built from the tag**: sponsored-FPC registration at salt 0, `create-account` with `fpc-sponsored` payment, `TokenContract` deploy, `mint_to_public` (revertCode 0), `simulate balance_of_public` → `100n`, exactly as the getting-started guide documents. The node also registered MultiCall at `0x246d60af…`, confirming the networks.md value. ## Follow-ups for the release operators 1. **The new testnet SponsoredFPC (`0x1441…`) must be deployed and funded on testnet** when the network upgrades to 5.0.1 — the currently funded FPC is 5.0.0's `0x0628…`. 2. The dRPC Alpha endpoint currently still serves the old rollup (nodeVersion 4.4.0); the Alpha column describes the new canonical v5 rollup, which nodes will follow after upgrading. 3. Mainnet **Staking Registry** kept at the v4 value `0x042dF8f4…` (no on-chain getter; bytecode verified still present) — please confirm it carries over to the v5 deployment. --- *Created by [claudebox](https://claudebox.work/v2/sessions/08b04eb0669bcfbb/jobs/1) · group: `slackbot` · [Slack thread](https://aztecfoundation.slack.com/archives/C0B24G1GFGB/p1784247618790429?thread_ts=1784247618.790429&cid=C0B24G1GFGB)*
AztecBot
force-pushed
the
cb/docs-release-v5.0.1
branch
from
July 17, 2026 15:07
b8d15fe to
6b6eb1f
Compare
AztecBot
enabled auto-merge
July 17, 2026 15:07
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Jul 17, 2026
…es of truth (#24770) Generalizes the verification lessons from the v5.0.1 docs release (#24763) — specifically from cross-checking the machine-derived `networks.md` values against the hand-written ones in #24756 — into the `/release-docs` and `/release-network-docs` skills, so every future release re-checks all of it against sources of truth instead of trusting carried-forward or hand-transcribed values. The two discrepancies that cross-check caught, which motivate the rules: - The mainnet rollup version was hand-converted from `0xfd39c8f7` and shipped wrong (`4248094967` instead of `4248422647`). - The Alpha Execution Delay was carried forward as 30 days when the live `Governance.getConfiguration()` says 2 days — the governance table had no re-verification step at all. ## What the skills now require, every release A new **"Re-verify every figure against its source of truth"** subsection in `/release-docs` Step 9 (referenced from `/release-network-docs` Step 4), plus a Key Point: - **EIP-55 checksums**: every L1 address goes through `cast to-check-sum-address` before landing in the tables. - **Decimal conversions**: on-chain hex is converted with `cast to-dec`, never by eye. - **Rollup version**: read from each network's rollup via `getVersion()` and cross-checked against the RPC's `rollupVersion`; in the pre-release flow the target rollup's on-chain value wins. - **L1 chain id**: `cast chain-id` must agree with the docs row and the node RPC's `l1ChainId`. - **Governance parameters table** (previously never mentioned by the skills): queried on-chain for both columns — Proposer Quorum from the Governance Proposer (`QUORUM_SIZE`/`ROUND_SIZE`), Voting/Execution delays from `Governance.getConfiguration()` decoded against the tag's `IGovernance` struct (with a warning about the 256-second compressed time fields), Slashing Quorum/Round Size from the Tally Slashing Proposer (`QUORUM`, `ROUND_SIZE`, `ROUND_SIZE_IN_EPOCHS`). - **Cross-check human-owned data**: when the network team has a parallel deployment update in flight, diff every value against it and resolve discrepancies by querying the chain, then reconcile with the owner before shipping. Stacked on #24763 (which already added the `cast to-dec` note and the migration-notes TBD rule); once that merges this PR retargets to `next` and carries only these two skill files. --- *Created by [claudebox](https://claudebox.work/v2/sessions/08b04eb0669bcfbb/jobs/4) · group: `slackbot` · [Slack thread](https://aztecfoundation.slack.com/archives/C0B24G1GFGB/p1784247618790429?thread_ts=1784247618.790429&cid=C0B24G1GFGB)*
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.
v5.0.1 docs release (Alpha + Testnet unified)
Runs the
/release-docsworkflow for thev5.0.1tag, usinghttps://v5.testnet.rpc.aztec-labs.comas the network source of truth, per the request in #ecosystem.Versioning
v5.0.1, with bothmainnetandtestnetrelease channels pointing at it (single "Alpha / Testnet (v5.0.1)" version in the dropdown, same as the v4.3.x unified precedent). Cut withRELEASE_TYPE=mainnetper that precedent.version-v5.0.0(old testnet) andversion-v4.3.1(old Alpha v4) developer + network snapshots and sidebars.next'sdocs-operatesource so the new role-based operator documentation (68c0042, which describes v5 as current) ships with this release instead of waiting for the next cut. Its macros are resolved at v5.0.1.networks.md
Testnet column (from live RPC + on-chain
castqueries against the new rollup, all matching what was already onnextpost-rollup-upgrade): version →5.0.1; v5.0.1-canonical MultiCall Entrypoint and SponsoredFPC (below).Alpha (Mainnet) column — version →
5.0.1, RPC kept at dRPC per request. The mainnet Registry (0x35b22e09…) now has rollup version 3 =4248094967registered and canonical — the v5 deployment — so all per-rollup addresses were resolved on-chain from it (Rollup0x91ff8bbd…, Inbox, Outbox, Fee Juice Portal, Slasher, Tally Slashing Proposer, Slash Payload Cloneable, Honk Verifier, Reward Distributor, Reward Booster). Governance-level contracts (Registry, Governance, Governance Proposer, GSE, Fee Juice, Staking Asset, Coin Issuer) verified unchanged on-chain. L2 protocol addresses updated to the v5 layout (Class Registry0x01, Instance Registry0x02, Fee Juice0x03).Governance table: slashing rows updated from on-chain values of both new Tally Slashing Proposers (quorum 65/128, round 4 epochs = 128 slots on both networks). Release-channel examples refreshed from 4.x to 5.x.
L2 canonical addresses (derived with v5.0.1 tooling, cross-checked on a live v5.0.1 local network)
0x1441491b59934ec64f8c98f17c91f23c01ca2a45dbb35caf123146ec76f9970c(changed from 5.0.0's0x0628…— the aztec-nr partial-note fix in this patch changed the artifact). Applied tonetworks.mdandgetting_started_on_testnet.md(source + snapshot).0x246d60af8b79a5dceece7d2388921203401c0df02ce674c5781c6c2162922986(changed from 5.0.0 — pinned standard contracts were regenerated in this patch).Generated references (all regenerated at the tag)
static/*-api/mainnetandstatic/*-api/testnet(both networks now run v5.0.1).aztec,aztec-wallet,aztec-upCLI references (via the release wrapper, soinit/new/testare included; wallet usage lines now correctly readaztec-wallet).aztec start --helpCLI reference.Migration notes
Source file restructured to match what shipped: new
## 5.0.1section (history-note nullification helper rename,set_as_fee_payersetup-phase assert, PXE per-(l1ChainId, rollupAddress, schemaVersion)stores), and the published v5.0.0 snapshot's## 5.0.0section adopted verbatim (the prior release had only moved TBD→5.0.0 in the snapshot, not the source).Reconciliation with
next(skill step 12)Ported into the v5.0.1 snapshot: fees.md Fee Juice bridging section (predates the 5.0.0 cut but was missed by it), counter-tutorial scaffold-test note,
typescript@^5.3.3pin,@aztec/viem@2.38.2in the token-bridge install line. Fixed staleMessageDeliveryAPI-reference links in source + snapshot. Skipped next-side changes not valid at v5.0.1 (e.g. removal of thegenerated/default.jsonstep, which is only obsolete after #24434). Tag-newer content (initializerless accounts, key-derivation docs) is kept in the snapshot and left untouched innext's source.Validation
yarn buildpasses on this branch: 0 broken redirect targets, 0 broken API-ref links, 0 spellcheck issues. (Known non-fatalvalkeysanchor warning remains, plus pre-existing docker-compose anchor warnings from the operator restructure source.)create-accountwithfpc-sponsoredpayment,TokenContractdeploy,mint_to_public(revertCode 0),simulate balance_of_public→100n, exactly as the getting-started guide documents. The node also registered MultiCall at0x246d60af…, confirming the networks.md value.Follow-ups for the release operators
0x1441…) must be deployed and funded on testnet when the network upgrades to 5.0.1 — the currently funded FPC is 5.0.0's0x0628….0x042dF8f4…(no on-chain getter; bytecode verified still present) — please confirm it carries over to the v5 deployment.Created by claudebox · group:
slackbot· Slack thread