Skip to content

Commit b02bf7d

Browse files
authored
chore(docs): Add 2.0.2 testnet docs, remove old versions and replace references to 1.2.0 (#17129)
adds the latest testnet release version
2 parents 94a215f + 0587107 commit b02bf7d

File tree

270 files changed

+39478
-126
lines changed

Some content is hidden

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

270 files changed

+39478
-126
lines changed

docs/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Uses Docusaurus versioning with:
6767
- `versioned_docs/version-X.X.X/` contains historical versions
6868
- `versioned_sidebars/` contains version-specific sidebar configurations
6969
- Macros (`#include_code`, `#include_aztec_version`, etc.) only work in source `docs/` folder, not in versioned copies
70-
- Version dropdown shows: `Next`, `alpha-testnet`, and latest sandbox release versions
70+
- Version dropdown shows: `Next`, `testnet`, and latest sandbox release versions
7171

7272
## Documentation Review Standards
7373

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The .md files in the `docs/` directory are the docs. See the [Docusaurus website
2424

2525
Aztec Docs are versioned. Every version known is literally a copy of the website, and is in `versioned_docs` (sidebars are in `versioned_sidebars`). Seems silly but it's not, it allows you to hot-fix previous versions.
2626

27-
When you look at the published docs site, you will see three versions in the version dropdown: `Next`, `alpha-testnet`, and the latest sandbox release e.g. `v0.86.0`. Updating the files in the `docs` folder will update the next version (which is not currently published, but will be when the next release is cut), updating the files in `versioned_docs/version-v0.87.8` folder will update the `0.87.8` version. Note that you cannot use the macros (`#include_aztec_version` and `#include_code`) in the `versioned_docs` folder, since those docs have already been processed and built. Instead, just drop the code snippets, version numbers or links directly in the docs as you'd like them to be rendered.
27+
When you look at the published docs site, you will see three versions in the version dropdown: `Next`, `testnet`, and the latest sandbox release e.g. `v0.86.0`. Updating the files in the `docs` folder will update the next version (which is not currently published, but will be when the next release is cut), updating the files in `versioned_docs/version-v0.87.8` folder will update the `0.87.8` version. Note that you cannot use the macros (`#include_aztec_version` and `#include_code`) in the `versioned_docs` folder, since those docs have already been processed and built. Instead, just drop the code snippets, version numbers or links directly in the docs as you'd like them to be rendered.
2828

2929
The way docs builds work is the following:
3030

docs/docs/developers/guides/getting_started_on_testnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Set the required environment variables:
6464

6565
```bash
6666
export NODE_URL=https://aztec-alpha-testnet-fullnode.zkv.xyz
67-
export SPONSORED_FPC_ADDRESS=0x19b5539ca1b104d4c3705de94e4555c9630def411f025e023a13189d0c56f8f2
67+
export SPONSORED_FPC_ADDRESS=0x299f255076aa461e4e94a843f0275303470a6b8ebe7cb44a471c66711151e529
6868
```
6969

7070
### Step 2: Create and deploy an account

docs/docs/developers/reference/environment_reference/cli_reference.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Options:
7676

7777
#### Network Options
7878

79-
- `--network <value>`: Network to run Aztec on, e.g. `alpha-testnet`. By default connects to sandbox (local network)
79+
- `--network <value>`: Network to run Aztec on, e.g. `testnet`. By default connects to sandbox (local network)
8080

8181
#### API Options
8282

@@ -122,10 +122,10 @@ Options:
122122

123123
##### Example Usage
124124

125-
Here is an example of how to start a node that connects to the alpha-testnet.
125+
Here is an example of how to start a node that connects to the testnet.
126126

127127
```bash
128-
aztec-up alpha-testnet
128+
aztec-up latest
129129

130130
export DATA_DIRECTORY=/any/directory/to/store/node/data
131131
export BLOB_SINK_URL=<blob-sink-url>

docs/docs/developers/reference/environment_reference/cli_wallet_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ To connect to the testnet, pass the `AZTEC_NODE_URL` to the wallet with the `--n
163163

164164
```bash
165165
export AZTEC_NODE_URL=<testnet-ip-address>
166-
export SPONSORED_FPC_ADDRESS=0x19b5539ca1b104d4c3705de94e4555c9630def411f025e023a13189d0c56f8f2
166+
export SPONSORED_FPC_ADDRESS=0x299f255076aa461e4e94a843f0275303470a6b8ebe7cb44a471c66711151e529
167167
# Register a new account
168168
aztec-wallet create-account --register-only -a main -n $AZTEC_NODE_URL
169169
aztec-wallet register-contract $SPONSORED_FPC_ADDRESS SponsoredFPC --from main -n $AZTEC_NODE_URL --salt 0 -a sponsoredfpc

docs/docs/the_aztec_network/guides/run_nodes/how_to_run_prover.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ services:
207207
- --prover-node
208208
- --archiver
209209
- --network
210-
- alpha-testnet
210+
- testnet
211211
depends_on:
212212
prover-broker:
213213
condition: service_started
@@ -237,7 +237,7 @@ services:
237237
- start
238238
- --prover-broker
239239
- --network
240-
- alpha-testnet
240+
- testnet
241241
environment:
242242
DATA_DIRECTORY: /var/lib/data
243243
ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
@@ -255,7 +255,7 @@ services:
255255
- start
256256
- --prover-agent
257257
- --network
258-
- alpha-testnet
258+
- testnet
259259
environment:
260260
PROVER_AGENT_COUNT: ${PROVER_AGENT_COUNT}
261261
PROVER_AGENT_POLL_INTERVAL_MS: ${PROVER_AGENT_POLL_INTERVAL_MS}

docs/docs/the_aztec_network/guides/run_nodes/how_to_run_sequencer.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ Furthermore, as this guide uses Docker compose, you will need to install it. Ple
5555

5656
Finally, this guide requires you to have endpoints of an L1 node stack of an execution and consensus client. If you do not have one set up, you can see a good guide on how to do that [here at Eth Docker](https://ethdocker.com/Usage/QuickStart).
5757

58-
5958
## Configure the sequencer
6059

6160
There are a few important things to note when setting up a sequencer. This guide will guide you in setting up and running a sequencer with a standard setup using Docker compose with a .env file.
@@ -162,39 +161,39 @@ Now that you have done all the setup, create a Docker compose file named `compos
162161
163162
```yaml
164163
services:
165-
aztec-sequencer:
166-
image: "aztecprotocol/aztec:1.2.1"
167-
container_name: "aztec-sequencer"
168-
ports:
169-
- ${AZTEC_PORT}:${AZTEC_PORT}
170-
- ${P2P_PORT}:${P2P_PORT}
171-
- ${P2P_PORT}:${P2P_PORT}/udp
172-
volumes:
173-
- ${DATA_DIRECTORY}:/var/lib/data
174-
- ${KEY_STORE_DIRECTORY}:/var/lib/keystore
175-
environment:
176-
KEY_STORE_DIRECTORY: /var/lib/keystore
177-
DATA_DIRECTORY: /var/lib/data
178-
LOG_LEVEL: ${LOG_LEVEL}
179-
ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
180-
L1_CONSENSUS_HOST_URLS: ${L1_CONSENSUS_HOST_URLS}
181-
P2P_IP: ${P2P_IP}
182-
P2P_PORT: ${P2P_PORT}
183-
AZTEC_PORT: ${AZTEC_PORT}
184-
entrypoint: node /usr/src/yarn-project/aztec/dest/bin/index.js
185-
command: >-
186-
start
187-
--network alpha-testnet
188-
--node
189-
--archiver
190-
--sequencer
191-
networks:
192-
- aztec
193-
restart: always
164+
aztec-sequencer:
165+
image: "aztecprotocol/aztec:latest"
166+
container_name: "aztec-sequencer"
167+
ports:
168+
- ${AZTEC_PORT}:${AZTEC_PORT}
169+
- ${P2P_PORT}:${P2P_PORT}
170+
- ${P2P_PORT}:${P2P_PORT}/udp
171+
volumes:
172+
- ${DATA_DIRECTORY}:/var/lib/data
173+
- ${KEY_STORE_DIRECTORY}:/var/lib/keystore
174+
environment:
175+
KEY_STORE_DIRECTORY: /var/lib/keystore
176+
DATA_DIRECTORY: /var/lib/data
177+
LOG_LEVEL: ${LOG_LEVEL}
178+
ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
179+
L1_CONSENSUS_HOST_URLS: ${L1_CONSENSUS_HOST_URLS}
180+
P2P_IP: ${P2P_IP}
181+
P2P_PORT: ${P2P_PORT}
182+
AZTEC_PORT: ${AZTEC_PORT}
183+
entrypoint: node /usr/src/yarn-project/aztec/dest/bin/index.js
184+
command: >-
185+
start
186+
--network testnet
187+
--node
188+
--archiver
189+
--sequencer
190+
networks:
191+
- aztec
192+
restart: always
194193

195194
networks:
196-
aztec:
197-
name: aztec
195+
aztec:
196+
name: aztec
198197
```
199198
200199
Please note that we are setting only the necessary configuration for running this sequencer. The full list of settings and flags can be explored here at the [cli reference](../../reference/cli_reference.md). A lot of these options are preset to defaults by the `--network` flag above. This downloads defaults for the specified network and applies them to the node.

docs/docs/the_aztec_network/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ echo 'export PATH="$HOME/.aztec/bin:$PATH"' >> ~/.bashrc
6868
source ~/.bashrc
6969
```
7070

71-
The next step is to install the correct version of aztec that is running on testnet. The correct version of the aztec network currently is `1.2.0`. If that is not the version that was installed in the previous step, please run this to ensure the correct version is installed.
71+
The next step is to install the correct version of aztec that is running on testnet. The correct version of the aztec network currently is #include_testnet_version. If that is not the version that was installed in the previous step, please run this to ensure the correct version is installed.
7272

7373
```console
74-
aztec-up 1.2.0
74+
aztec-up #include_testnet_version
7575
```
7676

7777
The user can confirm that they are running on the correct version with:

docs/docs/the_aztec_network/reference/operator_faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Here is a list of common issues node operators may face. If you don't find your
1616

1717
If it is regarding a beacon call, it has failed to the beacon rpc call. If it is regarding the execution endpoint, then it is likely just reporting.
1818

19-
## Update aztec alpha-testnet version
19+
## Update aztec testnet version
2020

21-
To make sure you're using the latest version, run: `aztec-up alpha-testnet`, then restart your node.
21+
To make sure you're using the latest version, run: `aztec-up latest`, then restart your node.
2222

2323
## "rpc rate", "quota limit"
2424

docs/docs/the_aztec_network/reference/reacting_to_upgrades.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This is a guide for sequencer operators to understand how to react to protocol u
1111
To signal for governance upgrades, sequencers must set their `GOVERNANCE_PROPOSER_PAYLOAD` on their sequencer node to the address of a `payload`. This will register their signal with the GovernanceProposer contract.
1212

1313
:::info
14-
the `payload` is a contract on L1 that specifies the address of the new rollup contract to be upgraded to. The payloads to be voted on during alpha-testnet will be communicated to sequencers on the forum and on community channels like discord.
14+
the `payload` is a contract on L1 that specifies the address of the new rollup contract to be upgraded to. The payloads to be voted on during testnet will be communicated to sequencers on the forum and on community channels like discord.
1515
:::
1616

1717
This signalling phase will pass once `N` sequencers in a round of `M` L2 blocks have signalled for the same payload. Once the quorum is met, anyone can call the `executeProposal(roundNumber)` function on the Governance Proposer contract to advance the upgrade into the next stage.

0 commit comments

Comments
 (0)