From 3ff22b26a62328d876f4502977e5f9bcac4e7388 Mon Sep 17 00:00:00 2001 From: Josh Crites Date: Mon, 1 Dec 2025 14:28:21 -0500 Subject: [PATCH 1/3] Update documentation to reflect changes in Aztec toolchain and prerequisites --- .../docs/aztec-cli/cli_reference.md | 18 ++---------- .../docs/tutorials/local_network.md | 16 +++++----- .../developers/getting_started_on_devnet.md | 2 +- .../getting_started_on_local_network.md | 29 +++++++++---------- .../components/Snippets/general_snippets.js | 9 ++---- 5 files changed, 27 insertions(+), 47 deletions(-) diff --git a/docs/docs/developers/docs/aztec-cli/cli_reference.md b/docs/docs/developers/docs/aztec-cli/cli_reference.md index f83116a7fcf6..260078f7130e 100644 --- a/docs/docs/developers/docs/aztec-cli/cli_reference.md +++ b/docs/docs/developers/docs/aztec-cli/cli_reference.md @@ -383,19 +383,13 @@ aztec start --network testnet --l1-rpc-urls https://example.com --l1-consensus-h ### Test -Runs tests written in contracts. +Runs tests written in contracts. This command starts a TXE (Test eXecution Environment) server and runs `nargo test` with the appropriate oracle resolver. ```bash aztec test [options] ``` -Options: - -- `-e, --env `: Set environment variables (can be used multiple times). -- `--no-tty`: Run the container without a TTY. -- `--rm`: Automatically remove the container when it exits. -- `-i, --interactive`: Keep STDIN open even if not attached. -- `-t, --tty`: Allocate a pseudo-TTY. +Options passed after `aztec test` are forwarded to `nargo test`. See `nargo test --help` for available options. ## Contract interaction @@ -491,14 +485,6 @@ Options: ## Development and Debugging Tools -### flamegraph - -Generates a flamegraph of the gate counts of a private function call. - -```bash -[SERVE=1] aztec flamegraph -``` - ### codegen Validates and generates an Aztec Contract ABI from Noir ABI. diff --git a/docs/docs/developers/docs/tutorials/local_network.md b/docs/docs/developers/docs/tutorials/local_network.md index 73161df78bc5..9427a4352fbe 100644 --- a/docs/docs/developers/docs/tutorials/local_network.md +++ b/docs/docs/developers/docs/tutorials/local_network.md @@ -20,7 +20,7 @@ On this page you will find ## Versions -Aztec tools (local network, nargo), dependencies (Aztec.nr), and sample contracts are constantly being improved. +Aztec tools (`aztec`, `nargo`, `bb`), dependencies (Aztec.nr), and sample contracts are constantly being improved. When developing and referring to example .nr files/snippets, it is helpful to verify the versions of different components (below), and if required keep them in lock-step by [updating](#updating). ### Dependency versions @@ -54,8 +54,8 @@ diff ~/nargo/github.com/AztecProtocol/v0.23.0/yarn-project/noir-contracts/contra ### Language server version -The [Noir LSP](../aztec-nr/installation.md) uses your local version of `aztec`, and thus also `aztec compile`. -The path of the former (once installed) can be seen by hovering over "Nargo" in the bottom status bar of VS Code, and the latter via the `which aztec` command. +The [Noir LSP](../aztec-nr/installation.md) uses your local version of `nargo`. +The path can be seen by hovering over "Nargo" in the bottom status bar of VS Code, or via the `which nargo` command. :::caution For Aztec contract files, this should be `aztec` and for noir-only files this should be `nargo`. Mismatching tools and file types will generate misleading syntax and compiler errors. @@ -71,7 +71,7 @@ This can present confusion when opening older contracts (and dependencies) writt ### Steps to keep up to date -1. Update the Aztec local network to the latest version (includes `aztec` command, pxe, etc): +1. Update the Aztec toolchain to the latest version (includes `aztec`, `aztec-wallet`, `nargo`, `bb`): ```shell aztec-up @@ -102,13 +102,13 @@ Follow [updating Aztec.nr packages](#updating-aztecnr-packages) and [updating Ja --- -There are four components whose versions need to be kept compatible: +There are two main components whose versions need to be kept compatible: -1. Aztec local network (includes the `aztec` command) +1. Aztec toolchain (`aztec`, `aztec-wallet`, `nargo`, `bb`) 2. `Aztec.nr`, the Noir framework for writing Aztec contracts -First three are packaged together in docker and are kept compatible by running `aztec-up`. -But you need to update your Aztec.nr version manually or using `aztec update`. +The toolchain components are kept compatible by running `aztec-up`. +You need to update your Aztec.nr version manually or using `aztec update`. ## Updating Aztec.nr packages diff --git a/docs/docs/developers/getting_started_on_devnet.md b/docs/docs/developers/getting_started_on_devnet.md index 096dee4c1c3e..f71f8785e979 100644 --- a/docs/docs/developers/getting_started_on_devnet.md +++ b/docs/docs/developers/getting_started_on_devnet.md @@ -37,7 +37,7 @@ If you're new to Aztec and want to understand local development first, check out Before working with devnet, ensure you have: -1. [Docker](https://docs.docker.com/get-started/get-docker/) installed +1. Node.js v20.15 or later installed 2. Aztec CLI installed: ```sh diff --git a/docs/docs/developers/getting_started_on_local_network.md b/docs/docs/developers/getting_started_on_local_network.md index a91916a9644c..b4df8d99b59d 100644 --- a/docs/docs/developers/getting_started_on_local_network.md +++ b/docs/docs/developers/getting_started_on_local_network.md @@ -19,26 +19,17 @@ What's included in the local network: - A set of test accounts with some test tokens to pay fees - Development tools to compile contracts and interact with the network (`aztec` and `aztec-wallet`) -All of this comes packaged in a Docker container to make it easy to install and run. - This guide will teach you how to install the Aztec local network, run it using the Aztec CLI, and interact with contracts using the wallet CLI. To jump right into the testnet instead, click the `Testnet` tab. ## Prerequisites import { General, Fees } from '@site/src/components/Snippets/general_snippets'; -You need two global dependencies on your machine: +You need one global dependency on your machine: - -- Docker (visit [this page of the Docker docs](https://docs.docker.com/get-docker/) on how to install it) - -## Install and run the local network - -### Start Docker -Docker needs to be running in order to install the local network. Find instructions on the [Docker website](https://docs.docker.com/get-started/). - -### Install the local network +## Install the Aztec toolchain Run: @@ -48,11 +39,17 @@ bash -i <(curl -s https://install.aztec.network) This will install the following tools: -- **aztec** - compiles and tests aztec contracts and launches various infrastructure subsystems (full local network, sequencer, prover, pxe, etc) and provides utility commands to interact with the network -- **aztec-up** - a tool to upgrade the aztec toolchain to the latest, or specific versions. -- **aztec-wallet** - a tool for interacting with the aztec network +- **nargo** - the Noir compiler, compatible with the installed Aztec version +- **bb** - the Barretenberg proving backend +- **aztec** - compiles and tests Aztec contracts and launches various infrastructure subsystems (full local network, sequencer, prover, pxe, etc) and provides utility commands to interact with the network +- **aztec-up** - a tool to upgrade the Aztec toolchain to the latest, or specific versions +- **aztec-wallet** - a CLI wallet for interacting with the Aztec network + +:::warning +If you already have `nargo` or `bb` installed, running the installer will overwrite them with the versions compatible with Aztec. You can use `noirup` to switch versions if needed for other projects. +::: -### Start the local network +## Start the local network Once these have been installed, to start the local network, run: @@ -84,7 +81,7 @@ You'll know the local network is ready to go when you see something like this: [INFO] Aztec Server listening on port 8080 ``` -### Codespaces +## Codespaces If you do not want to run the local network locally, or if your machine is unsupported (eg Windows), it is possible to run it within a GitHub Codespace. diff --git a/docs/src/components/Snippets/general_snippets.js b/docs/src/components/Snippets/general_snippets.js index b4befd7da88a..0b8be24bfc34 100644 --- a/docs/src/components/Snippets/general_snippets.js +++ b/docs/src/components/Snippets/general_snippets.js @@ -14,10 +14,7 @@ export const General = {

To use Aztec's suite of tools you'll need to:

    -
  • - Get docker{" "} - (engine or desktop) -
    • +
  • Have Node.js v20.15 or later installed
  • Run bash -i <(curl -s https://install.aztec.network)
    • @@ -51,8 +48,8 @@ export const General = { AztecLocalNetwork: () => (

    - Aztec's Local network - runs a set of Aztec tools for convenient local - development, it includes: an Ethereum node, an Aztec node, and PXE. + Aztec's Local network - runs a set of Aztec tools for convenient + local development, it includes: an Ethereum node, an Aztec node, and PXE.

    ), From 7e36448cab0f461a97dd19d8a3ea282b5f4cf7c1 Mon Sep 17 00:00:00 2001 From: Josh Crites Date: Mon, 1 Dec 2025 14:39:11 -0500 Subject: [PATCH 2/3] rm txe reference --- docs/docs/developers/docs/aztec-cli/cli_reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/developers/docs/aztec-cli/cli_reference.md b/docs/docs/developers/docs/aztec-cli/cli_reference.md index 260078f7130e..2bc2d18e6f7f 100644 --- a/docs/docs/developers/docs/aztec-cli/cli_reference.md +++ b/docs/docs/developers/docs/aztec-cli/cli_reference.md @@ -383,7 +383,7 @@ aztec start --network testnet --l1-rpc-urls https://example.com --l1-consensus-h ### Test -Runs tests written in contracts. This command starts a TXE (Test eXecution Environment) server and runs `nargo test` with the appropriate oracle resolver. +Runs tests written in contracts. This command starts a testing environment server and runs `nargo test` with the appropriate oracle resolver. ```bash aztec test [options] From 227515679e059188cbd846a9539b121682a90fc3 Mon Sep 17 00:00:00 2001 From: Charlie Lye <5764343+charlielye@users.noreply.github.com> Date: Thu, 4 Dec 2025 17:23:03 +0000 Subject: [PATCH 3/3] flamegraph --- docs/docs/developers/docs/aztec-cli/cli_reference.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docs/developers/docs/aztec-cli/cli_reference.md b/docs/docs/developers/docs/aztec-cli/cli_reference.md index 2bc2d18e6f7f..0ed4be0e52e3 100644 --- a/docs/docs/developers/docs/aztec-cli/cli_reference.md +++ b/docs/docs/developers/docs/aztec-cli/cli_reference.md @@ -485,6 +485,14 @@ Options: ## Development and Debugging Tools +### flamegraph + +Generates a flamegraph of the gate counts of a private function call. + +```bash +aztec flamegraph +``` + ### codegen Validates and generates an Aztec Contract ABI from Noir ABI.