Commit 6b6eb1f
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
- .claude/skills/release-docs
- docs
- developer_versioned_docs
- version-v4.3.1
- docs
- aztec-js
- wallet-sdk
- aztec-nr
- framework-description
- advanced
- functions
- standards
- cli
- foundational-topics
- accounts
- advanced
- circuits
- storage
- ethereum-aztec-messaging
- pxe
- resources
- tutorials
- contract_tutorials
- js_tutorials
- version-v5.0.0
- docs
- aztec-js
- aztec-nr
- framework-description
- advanced
- functions
- standards
- cli
- foundational-topics
- accounts
- advanced
- circuits
- storage
- ethereum-aztec-messaging
- resources
- considerations
- tutorials
- contract_tutorials
- js_tutorials
- version-v5.0.1
- docs
- aztec-js
- aztec-nr
- framework-description
- advanced
- functions
- standards
- cli
- foundational-topics
- accounts
- advanced
- circuits
- storage
- ethereum-aztec-messaging
- pxe
- resources
- considerations
- tutorials
- contract_tutorials
- js_tutorials
- wallet-extension
- webapp
- wallet-sdk
- developer_versioned_sidebars
- docs-developers
- docs
- aztec-nr/framework-description
- cli
- resources
- tutorials/js_tutorials
- docs-operate/operators/reference
- docs
- network_versioned_docs
- version-v4.3.1/operators
- keystore
- reference
- changelog
- sequencer-management
- setup
- version-v5.0.0
- operators
- keystore
- monitoring
- reference
- changelog
- sequencer-management
- setup
- reference/changelog
- version-v5.0.1
- operators
- concepts
- full-node
- keystore
- monitoring
- prover
- provider
- reference
- changelog
- sequencer-management
- setup
- solo-sequencer
- tooling
- reference/changelog
- network_versioned_sidebars
- scripts
- src/clientModules
- static/aztec-nr-api
- mainnet
- noir_aztec
- authwit
- capsules
- context
- inputs
- contract_self
- contract_self_private
- contract_self_utility
- ephemeral
- event
- event_interface
- facts
- hash
- history
- note
- nullifier
- keys
- ephemeral
- macros
- dispatch
- messages
- delivery
- constrained_delivery
- handshake
- discovery
- private_notes
- process_message
- encoding
- encryption
- aes128
- poseidon2
- logs
- message_delivery
- msg_type
- offchain_messages
- processing
- log_retrieval_request
- log_retrieval_response
- offchain
- note
- note_getter_options
- note_interface
- note_metadata
- nullifier
- oracle
- aes128_decrypt
- auth_witness
- avm
- block_header
- call_private_function
- call_utility_function
- capsules
- contract_sync
- execution_cache
- execution
- fact_store
- get_contract_instance
- get_l1_to_l2_membership_witness
- get_membership_witness
- get_nullifier_membership_witness
- get_public_data_witness
- key_validation_request
- keys
- logging
- logs
- message_processing
- notes
- nullifiers
- offchain_effect
- public_call
- random
- resolve_custom_request
- resolve_tagging_strategy
- storage
- tx_phase
- tx_resolution
- version
- protocol
- abis
- accumulated_data
- avm_accumulated_data
- private_accumulated_data
- private_to_avm_accumulated_data
- private_to_public_accumulated_data
- private_to_rollup_accumulated_data
- append_only_tree_snapshot
- avm_circuit_public_inputs
- block_constant_data
- block_header
- call_context
- checkpoint_constant_data
- checkpoint_header
- contract_class_log
- epoch_constant_data
- fee_recipient
- function_data
- function_selector
- gas_fees
- gas_settings
- gas
- global_variables
- kernel_circuit_public_inputs
- private_to_public_kernel_circuit_public_inputs
- private_to_rollup_kernel_circuit_public_inputs
- log_hash
- log
- note_hash_leaf_preimage
- nullifier_leaf_preimage
- nullifier
- partial_state_reference
- private_call_request
- private_circuit_public_inputs
- private_kernel_data
- private_kernel/private_call_data
- private_log
- private_tx_constant_data
- protocol_contracts
- public_call_request
- public_data_write
- public_logs
- state_reference
- transaction
- tx_context
- tx_request
- tree_snapshots
- tx_constant_data
- validation_requests
- key_validation_request_and_separator
- key_validation_request
- private_validation_requests
- address
- aztec_address
- eth_address
- partial_address
- public_keys_hash
- salted_initialization_hash
- blob_data
- constants
- contract_class_id
- contract_instance
- data
- public_data_tree_leaf_preimage
- public_data_tree_leaf
- delayed_public_mutable
- scheduled_delay_change
- scheduled_value_change
- with_hash
- merkle_tree
- append_only_tree
- indexed_tree
- membership
- merkle_tree
- root
- test_utils
- messaging/l2_to_l1_message
- point
- proof
- proof_data
- verification_key
- vk_data
- public_keys
- side_effect
- counted
- scoped
- traits
- utils/arrays
- public_checks
- publish_contract_instance
- standard_addresses
- state_vars
- test
- helpers
- authwit
- tagging_secret_strategy
- test_environment
- txe_oracles
- utils
- mocks
- transient
- unconstrained_array
- utils
- conversion
- bytes_to_fields
- fields_to_bytes
- point
- poseidon
- poseidon2
- poseidon
- protocol_types
- abis
- accumulated_data
- avm_accumulated_data
- private_accumulated_data
- private_to_avm_accumulated_data
- private_to_public_accumulated_data
- private_to_rollup_accumulated_data
- append_only_tree_snapshot
- avm_circuit_public_inputs
- block_constant_data
- block_header
- call_context
- checkpoint_constant_data
- checkpoint_header
- contract_class_log
- epoch_constant_data
- fee_recipient
- function_data
- function_selector
- gas_fees
- gas_settings
- gas
- global_variables
- kernel_circuit_public_inputs
- private_to_public_kernel_circuit_public_inputs
- private_to_rollup_kernel_circuit_public_inputs
- log_hash
- log
- note_hash_leaf_preimage
- nullifier_leaf_preimage
- nullifier
- partial_state_reference
- private_call_request
- private_circuit_public_inputs
- private_kernel_data
- private_kernel/private_call_data
- private_log
- private_tx_constant_data
- protocol_contracts
- public_call_request
- public_data_write
- public_logs
- state_reference
- transaction
- tx_context
- tx_request
- tree_snapshots
- tx_constant_data
- validation_requests
- key_validation_request_and_separator
- key_validation_request
- private_validation_requests
- address
- aztec_address
- eth_address
- partial_address
- public_keys_hash
- salted_initialization_hash
- blob_data
- constants
- contract_class_id
- contract_instance
- data
- public_data_tree_leaf_preimage
- public_data_tree_leaf
- delayed_public_mutable
- scheduled_delay_change
- scheduled_value_change
- with_hash
- merkle_tree
- append_only_tree
- indexed_tree
- membership
- merkle_tree
- root
- test_utils
- messaging/l2_to_l1_message
- point
- proof
- proof_data
- verification_key
- vk_data
- public_keys
- side_effect
- counted
- scoped
- traits
- utils/arrays
- serde/serialization
- std
- aes128
- append
- array
- cmp
- collections
- bounded_vec
- umap
- compat
- convert
- default
- ecdsa_secp256k1
- ecdsa_secp256r1
- embedded_curve_ops
- field
- bn254
- hash
- keccak
- hint
- mem
- meta
- ctstring
- expr
- format_string
- function_def
- location
- module
- op
- quoted
- trait_constraint
- trait_def
- trait_impl
- type_def
- typed_expr
- typ
- unresolved_type
- ops
- option
- panic
- prelude
- runtime
- string
- test
- vector
- testnet
- noir_aztec
- context
- history/note
- keys
- ephemeral
- messages
- delivery/handshake
- encryption/poseidon2
- processing/log_retrieval_response
- oracle
- message_processing
- protocol
- constants
- hash
- point
- public_keys
- scalar
- traits
- test/helpers
- tagging_secret_strategy
- test_environment
- txe_oracles
- utils/point
- protocol_types/constants
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
252 | 252 | | |
253 | 253 | | |
254 | 254 | | |
255 | | - | |
256 | | - | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
257 | 262 | | |
258 | 263 | | |
259 | 264 | | |
| |||
283 | 288 | | |
284 | 289 | | |
285 | 290 | | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
286 | 295 | | |
287 | 296 | | |
288 | 297 | | |
| |||
464 | 473 | | |
465 | 474 | | |
466 | 475 | | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
| 479 | + | |
| 480 | + | |
| 481 | + | |
467 | 482 | | |
468 | 483 | | |
469 | 484 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
| 2 | + | |
| 3 | + | |
4 | 4 | | |
Lines changed: 0 additions & 129 deletions
This file was deleted.
0 commit comments