Skip to content

Commit 6b6eb1f

Browse files
committed
docs: release v5.0.1 docs — unified Alpha (Mainnet) + Testnet version, 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)*
1 parent 0fb2989 commit 6b6eb1f

3,580 files changed

Lines changed: 114256 additions & 60743 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/skills/release-docs/SKILL.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,13 @@ docs (Step 11), the generated content is included in the snapshot automatically.
252252
2. Create the new `## <new version>` heading below `## TBD` (and below any
253253
`## Unreleased` sections). Move the items identified in step 1 under it.
254254

255-
3. Ensure `## TBD` remains at the top with a blank line separating it from the
256-
next heading.
255+
3. Ensure `## TBD` remains at the top of the **source** file with a blank line
256+
separating it from the next heading. The source keeps the (now usually
257+
empty) `## TBD` heading as the working bucket for future notes — but the
258+
**versioned snapshot must not ship it**: after the cut (Step 11), delete the
259+
empty `## TBD` heading (and any empty `## Unreleased` headings) from
260+
`developer_versioned_docs/version-v<new_version>/docs/resources/migration_notes.md`
261+
so released docs never show an empty TBD section.
257262

258263
4. Check for missing migration items by analyzing the diff between the previous
259264
release tag and the new one:
@@ -283,6 +288,10 @@ Juice, Coin Issuer, Reward Distributor, Governance Proposer, Fee Asset Handler,
283288
Staking Registry, Slash Factory). Re-resolve the per-rollup set; for the rest,
284289
confirm the existing values still hold (e.g. `cast code <addr>` returns bytecode).
285290

291+
When a value read on-chain comes back as hex (e.g. a rollup version from
292+
`getVersion()`), convert it with `cast to-dec <hex>` — never by eye. A
293+
hand-converted rollup version has shipped wrong before.
294+
286295
#### Tier 1: Query on-chain from known contracts
287296

288297
First check whether the RPC response already includes `gseAddress` in
@@ -464,6 +473,12 @@ Also verify that macros were resolved in the network versioned snapshot — chec
464473
that `docs/network_versioned_docs/version-v<new_version>/` contains no raw
465474
`#release_version` or `#release_network` placeholders.
466475

476+
**Strip the empty `## TBD` heading from the cut snapshot.** The source
477+
migration notes keep `## TBD` as the working bucket for future entries, but a
478+
final release snapshot must not render an empty TBD section. After the cut,
479+
remove the empty `## TBD` (and any empty `## Unreleased (...)`) headings from
480+
`developer_versioned_docs/version-v<new_version>/docs/resources/migration_notes.md`.
481+
467482
#### Hardcoded version references
468483

469484
Grep source and the new snapshot for the old version and update each hit. Skip

docs/developer_version_config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"mainnet": "v4.3.1",
3-
"testnet": "v5.0.0"
2+
"mainnet": "v5.0.1",
3+
"testnet": "v5.0.1"
44
}

docs/developer_versioned_docs/version-v4.3.1/ai_tooling.md

Lines changed: 0 additions & 129 deletions
This file was deleted.

0 commit comments

Comments
 (0)