fix(docs): tidy up node section for testnet and assorted fixes (#17121)

Author: AztecBot

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

@@ -265,7 +265,7 @@ services:
     restart: unless-stopped
 ```
 
-**Note**: This configuration includes only essential settings. The `--network alpha-testnet` flag applies network-specific defaults. See the [CLI reference](../../reference/cli_reference.md) for all available options.
+**Note**: This configuration includes only essential settings. The `--network testnet` flag applies network-specific defaults. See the [CLI reference](../../reference/cli_reference.md) for all available options.
 
 Start the prover:
 

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

@@ -22,7 +22,9 @@ tags:
   - infrastructure
 ---
 
-This guide will go over the steps required to run a sequencer node on Aztec. It will also provide context to ensure users are comfortable with the steps they are taking.
+## Background
+
+This guide covers the steps required to run a sequencer node on Aztec. It will also provide context to ensure users are comfortable with the steps they are taking.
 
 The Aztec sequencer node is critical infrastructure responsible for ordering transactions and producing blocks.
 
@@ -55,6 +57,7 @@ Furthermore, as this guide uses Docker compose, you will need to install it. Ple
 
 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).
 
+
 ## Configure the sequencer
 
 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.
@@ -70,19 +73,19 @@ Let's start by creating a new directory called `aztec-sequencer`, with two subdi
 
 ### Define private keys / accounts
 
-A sequencer must hold and use private keys identifying it as a valid proposer or attester. This is done is by defining a keystore file.
+A sequencer must hold and use private keys identifying it as a valid proposer or attester. This is done by defining a keystore file.
 
 An example keystore file is below. Copy this file and save it as `keystore.json` into your `aztec-sequencer/keys` folder.
 
-```JSON
+```json
 {
-  schemaVersion: 1,
-  validators: [
+  "schemaVersion": 1,
+  "validators": [
     {
-      attester: ["ETH_PRIVATE_KEY_0"]
-      publisher: ["ETH_PRIVATE_KEY_1"],
-      coinbase: "ETH_ADDRESS_2",
-      feeRecipient: "AZTEC_ADDRESS_0"
+      "attester": ["ETH_PRIVATE_KEY_0"],
+      "publisher": ["ETH_PRIVATE_KEY_1"],
+      "coinbase": "ETH_ADDRESS_2",
+      "feeRecipient": "AZTEC_ADDRESS_0"
     }
   ]
 }
@@ -126,7 +129,7 @@ AZTEC_PORT=8080
 ```
 
 :::tip
-You MUST forward your ports. Your router must send UDP and TCP traffic on the port specified by `AZTEC_NODE_P2P_PORT` to your IP address on your local network.
+Forward your ports. Your router must send UDP and TCP traffic on the port specified by `P2P_PORT` to your IP address on your local network.
 
 Running the command `curl ipv4.icanhazip.com` can retrieve your public IP address for you.
 :::
@@ -200,7 +203,7 @@ Please note that we are setting only the necessary configuration for running thi
 
 Now, you can run `docker compose up` inside your `aztec-sequencer` folder to start the sequencer!
 
-To check if it is currently synced, which may take a few minutes, run this command and compare its output to any of the Aztec block explorers. (See [Aztec Scan](https://aztecscan.xyz/) or [Aztec Explorer](https://aztecexplorer.xyz/))
+To check if your sequencer is currently synced, which may take a few minutes, run this command and compare its output to any of the Aztec block explorers. (See [Aztec Scan](https://aztecscan.xyz/) or [Aztec Explorer](https://aztecexplorer.xyz/))
 
 ```sh
 curl -s -X POST -H 'Content-Type: application/json' \
@@ -212,4 +215,4 @@ http://localhost:8080 | jq -r ".result.proven.number"
 
 After setting up your node you must explicitly request to be added to the sequencer set.
 
-To complete this final step you can now head to [testnet.aztec.network](https://testnet.aztec.network) and complete the onboarding flow there utilizing zkPassport !
+To complete this final step you can now head to [testnet.aztec.network](https://testnet.aztec.network) and complete the onboarding flow there utilizing zkPassport!

docs/docs/the_aztec_network/index.md

@@ -5,6 +5,8 @@ title: Running a Full Node
 description: A guide about how to run a full node on the Aztec network.
 ---
 
+## Background
+
 This guide will go over the steps required to run a full node on Aztec with a basic setup.
 
 A full node allows users to connect and interact with the network. It provides users an interface to send and receive transactions and state updates without relying on a third party.
@@ -24,18 +26,18 @@ Minimum hardware requirements:
 
 Please note that these requirements are subject to change as the network throughput increases.
 
-Along with the above minimum hardware requirements, it is assumed that the user has access to a performant ethereum RPC endpoint. Furthermore, this guide expects the user to be using a "standard" Linux distribution like Debian / Ubuntu when following along with the steps.
+Along with the above minimum hardware requirements, it is assumed that the user has access to a performant Ethereum RPC endpoint. Furthermore, this guide expects the user to be using a "standard" Linux distribution like Debian / Ubuntu when following along with the steps.
 
-Overview
+## Overview
 
 1. Install Docker
-2. Install aztec
+2. Install Aztec
 3. Configure the node
 4. Start the node!
 
 ## Install and set up Docker
 
-Please ensure that docker is installed. If not, here is a convenient way to install it.
+Ensure Docker is installed. If not, here is a convenient way to install it.
 This uses the script at
 [https://get.docker.com/](https://get.docker.com/) to install the
 latest stable release of Docker on Linux:
@@ -45,7 +47,7 @@ curl -fsSL https://get.docker.com -o get-docker.sh
 sudo sh get-docker.sh
 ```
 
-Afterwards, the currently logged in user must be added to the docker group, so sudo is not needed to invoke docker.
+Afterwards, the currently logged in user must be added to the docker group, so `sudo` is not needed to invoke docker.
 
 ```console
 sudo groupadd docker
@@ -57,13 +59,13 @@ docker run hello-world
 
 ## Install Aztec
 
-Run these commands to grab the aztec stack and add them to path.
+Run these commands to grab the Aztec stack and add them to path.
 
 ```console
 bash -i <(curl -s https://install.aztec.network)
 # Users should check that it is installed by using
 ls ~/.aztec/bin
-# aztec, aztec-up aztec-nargo and aztec-wallet should show up here
+# aztec, aztec-up, aztec-nargo and aztec-wallet should show up here
 echo 'export PATH="$HOME/.aztec/bin:$PATH"' >> ~/.bashrc
 source ~/.bashrc
 ```
@@ -88,7 +90,7 @@ Now that the correct version of the node is installed, it needs to be configured
 mkdir aztec-node && cd ./aztec-node
 ```
 
-Next, set some required configuration options. This guide will use `custom_named` environment variables (e.g. `AZTEC_NODE_P2P_IP`) but this is not necessary; you can pass valued directly into the command without specifying them as environment variables. The external IP address of the node, and the L1 RPC endpoints must be defined when starting a node. Also, configuration defining the network version should be set, as this will let the node define the other required protocol variables, like rollup address, registry address etc. Please note that the specified RPC endpoints must support high throughput, otherwise the node will suffer degraded performance.
+Next, set some required configuration options. This guide will use `custom_named` environment variables (e.g. `AZTEC_NODE_P2P_IP`) but this is not necessary; you can pass values directly into the command without specifying them as environment variables. The external IP address of the node, and the L1 RPC endpoints must be defined when starting a node. Also, configuration defining the network version should be set, as this will let the node define the other required protocol variables, like rollup address, registry address etc. Note that the specified RPC endpoints must support high throughput, otherwise the node will suffer degraded performance.
 
 ```console
 # If the external IP of the machine the node is running on is unknown, it can be obtained by running `curl ifconfig.me`.
@@ -110,16 +112,16 @@ To verify the node is working, run these commands in another terminal window:
 
 ```console
 # Rule 1: For HTTP traffic on port 8080
-curl -X POST --data '{"method": "node_getL2Tips"}'
+curl -X POST http://localhost:8080 --data '{"method": "node_getL2Tips"}'
 # should return JSON data in the format of "{"result":{"latest":{"number":"...}}}"
 
 # Rule 2: For TCP traffic on port 40400 (set by default)
-nc -vz IP 40400
-# should return "Connection to IP 40400 port [tcp/*] succeeded!" if port open
+nc -vz [YOUR_EXTERNAL_IP] 40400
+# should return "Connection to [YOUR_EXTERNAL_IP] 40400 port [tcp/*] succeeded!" if port open
 
 # Rule 3: For UDP traffic on port 40400 (set by default)
-nc - vu IP 40400
-# should return "Connection to IP 40400 port [udp/*] succeeded!" if port open
+nc -vu [YOUR_EXTERNAL_IP] 40400
+# should return "Connection to [YOUR_EXTERNAL_IP] 40400 port [udp/*] succeeded!" if port open
 ```
 
 Congrats, the node should be up, running, and connected to the network!

docs/docs/the_aztec_network/reference/reacting_to_upgrades.md

@@ -4,8 +4,7 @@ title: Reacting to Upgrades
 description: Learn how to react to upgrades on the Aztec network.
 ---
 
-This is a guide for sequencer operators to understand how to react to protocol upgrades. To learn about how upgrades work, read the [concept section](../concepts/governance/upgrades.md).
-
+This is a guide for sequencer operators to understand how to react to protocol upgrades.
 ## Sequencers signal for governance upgrades
 
 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.

docs/sidebars.js

@@ -184,20 +184,7 @@ const sidebar = {
     {
       type: "doc",
       id: "the_aztec_network/reference/cli_reference",
-    },
-    {
-      type: "html",
-      value: '<span class="sidebar-divider" />',
-    },
-    {
-      type: "html",
-      value: '<span class="sidebar-title">Concepts</span>',
-      className: "sidebar-title",
-    },
-    {
-      type: "autogenerated",
-      dirName: "the_aztec_network/concepts",
-    },
+    }
   ],
 };
 

docs/versioned_docs/version-v1.2.0/the_aztec_network/guides/run_nodes/how_to_run_prover.md

@@ -237,7 +237,7 @@ services:
       - start
       - --prover-broker
       - --network
-      - alpha-testnet
+      - testnet
     environment:
       DATA_DIRECTORY: /var/lib/data
       ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
@@ -255,7 +255,7 @@ services:
       - start
       - --prover-agent
       - --network
-      - alpha-testnet
+      - testnet
     environment:
       PROVER_AGENT_COUNT: ${PROVER_AGENT_COUNT}
       PROVER_AGENT_POLL_INTERVAL_MS: ${PROVER_AGENT_POLL_INTERVAL_MS}
@@ -265,7 +265,7 @@ services:
     restart: unless-stopped
 ```
 
-**Note**: This configuration includes only essential settings. The `--network alpha-testnet` flag applies network-specific defaults. See the [CLI reference](../../reference/cli_reference.md) for all available options.
+**Note**: This configuration includes only essential settings. The `--network testnet` flag applies network-specific defaults. See the [CLI reference](../../reference/cli_reference.md) for all available options.
 
 Start the prover:
 

docs/versioned_docs/version-v1.2.0/the_aztec_network/guides/run_nodes/how_to_run_sequencer.md

@@ -22,7 +22,9 @@ tags:
   - infrastructure
 ---
 
-This guide will go over the steps required to run a sequencer node on Aztec. It will also provide context to ensure users are comfortable with the steps they are taking.
+## Background
+
+This guide covers the steps required to run a sequencer node on Aztec. It will also provide context to ensure users are comfortable with the steps they are taking.
 
 The Aztec sequencer node is critical infrastructure responsible for ordering transactions and producing blocks.
 
@@ -71,19 +73,19 @@ Let's start by creating a new directory called `aztec-sequencer`, with two subdi
 
 ### Define private keys / accounts
 
-A sequencer must hold and use private keys identifying it as a valid proposer or attester. This is done is by defining a keystore file.
+A sequencer must hold and use private keys identifying it as a valid proposer or attester. This is done by defining a keystore file.
 
 An example keystore file is below. Copy this file and save it as `keystore.json` into your `aztec-sequencer/keys` folder.
 
-```JSON
+```json
 {
-  schemaVersion: 1,
-  validators: [
+  "schemaVersion": 1,
+  "validators": [
     {
-      attester: ["ETH_PRIVATE_KEY_0"]
-      publisher: ["ETH_PRIVATE_KEY_1"],
-      coinbase: "ETH_ADDRESS_2",
-      feeRecipient: "AZTEC_ADDRESS_0"
+      "attester": ["ETH_PRIVATE_KEY_0"],
+      "publisher": ["ETH_PRIVATE_KEY_1"],
+      "coinbase": "ETH_ADDRESS_2",
+      "feeRecipient": "AZTEC_ADDRESS_0"
     }
   ]
 }
@@ -127,7 +129,7 @@ AZTEC_PORT=8080
 ```
 
 :::tip
-You MUST forward your ports. Your router must send UDP and TCP traffic on the port specified by `AZTEC_NODE_P2P_PORT` to your IP address on your local network.
+Forward your ports. Your router must send UDP and TCP traffic on the port specified by `P2P_PORT` to your IP address on your local network.
 
 Running the command `curl ipv4.icanhazip.com` can retrieve your public IP address for you.
 :::
@@ -162,46 +164,46 @@ Now that you have done all the setup, create a Docker compose file named `compos
 
 ```yaml
 services:
- aztec-sequencer:
-  image: "aztecprotocol/aztec:1.2.1"
-  container_name: "aztec-sequencer"
-  ports:
-    - ${AZTEC_PORT}:${AZTEC_PORT}
-    - ${P2P_PORT}:${P2P_PORT}
-    - ${P2P_PORT}:${P2P_PORT}/udp
-  volumes:
-    - ${DATA_DIRECTORY}:/var/lib/data
-    - ${KEY_STORE_DIRECTORY}:/var/lib/keystore
-  environment:
-    KEY_STORE_DIRECTORY: /var/lib/keystore
-    DATA_DIRECTORY: /var/lib/data
-    LOG_LEVEL: ${LOG_LEVEL}
-    ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
-    L1_CONSENSUS_HOST_URLS: ${L1_CONSENSUS_HOST_URLS}
-    P2P_IP: ${P2P_IP}
-    P2P_PORT: ${P2P_PORT}
-    AZTEC_PORT: ${AZTEC_PORT}
-  entrypoint: node /usr/src/yarn-project/aztec/dest/bin/index.js
-  command: >-
-    start
-    --network alpha-testnet
-    --node
-    --archiver
-    --sequencer
-  networks:
-   - aztec
-  restart: always
+  aztec-sequencer:
+    image: "aztecprotocol/aztec:latest"
+    container_name: "aztec-sequencer"
+    ports:
+      - ${AZTEC_PORT}:${AZTEC_PORT}
+      - ${P2P_PORT}:${P2P_PORT}
+      - ${P2P_PORT}:${P2P_PORT}/udp
+    volumes:
+      - ${DATA_DIRECTORY}:/var/lib/data
+      - ${KEY_STORE_DIRECTORY}:/var/lib/keystore
+    environment:
+      KEY_STORE_DIRECTORY: /var/lib/keystore
+      DATA_DIRECTORY: /var/lib/data
+      LOG_LEVEL: ${LOG_LEVEL}
+      ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
+      L1_CONSENSUS_HOST_URLS: ${L1_CONSENSUS_HOST_URLS}
+      P2P_IP: ${P2P_IP}
+      P2P_PORT: ${P2P_PORT}
+      AZTEC_PORT: ${AZTEC_PORT}
+    entrypoint: node /usr/src/yarn-project/aztec/dest/bin/index.js
+    command: >-
+      start
+      --network testnet
+      --node
+      --archiver
+      --sequencer
+    networks:
+      - aztec
+    restart: always
 
 networks:
- aztec:
-  name: aztec
+  aztec:
+    name: aztec
 ```
 
 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.
 
 Now, you can run `docker compose up` inside your `aztec-sequencer` folder to start the sequencer!
 
-To check if it is currently synced, which may take a few minutes, run this command and compare its output to any of the Aztec block explorers. (See [Aztec Scan](https://aztecscan.xyz/) or [Aztec Explorer](https://aztecexplorer.xyz/))
+To check if your sequencer is currently synced, which may take a few minutes, run this command and compare its output to any of the Aztec block explorers. (See [Aztec Scan](https://aztecscan.xyz/) or [Aztec Explorer](https://aztecexplorer.xyz/))
 
 ```sh
 curl -s -X POST -H 'Content-Type: application/json' \
@@ -213,4 +215,4 @@ http://localhost:8080 | jq -r ".result.proven.number"
 
 After setting up your node you must explicitly request to be added to the sequencer set.
 
-To complete this final step you can now head to [testnet.aztec.network](https://testnet.aztec.network) and complete the onboarding flow there utilizing zkPassport !
+To complete this final step you can now head to [testnet.aztec.network](https://testnet.aztec.network) and complete the onboarding flow there utilizing zkPassport!