Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions docs/docs/developers/docs/aztec-cli/cli_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 testing environment server and runs `nargo test` with the appropriate oracle resolver.

```bash
aztec test [options]
```

Options:

- `-e, --env <key=value>`: 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmmm, not convinced about this. Is this auto-generated?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes it is auto-generated 🙂, but based on my understanding it is correct. @charlielye cofirming this the expected aztec test behavior?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


## Contract interaction

Expand Down Expand Up @@ -496,7 +490,7 @@ Options:
Generates a flamegraph of the gate counts of a private function call.

```bash
[SERVE=1] aztec flamegraph <artifact_path> <function_name>
aztec flamegraph <artifact_path> <function_name>
```

### codegen
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/developers/docs/tutorials/local_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand 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

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developers/getting_started_on_devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
29 changes: 13 additions & 16 deletions docs/docs/developers/getting_started_on_local_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- <General.node_ver />
- 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:

Expand All @@ -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:

Expand Down Expand Up @@ -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.

Expand Down
9 changes: 3 additions & 6 deletions docs/src/components/Snippets/general_snippets.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ export const General = {
<p>
To use Aztec's suite of tools you'll need to:
<ul>
<li>
<a href="https://docs.docker.com/engine/install/">Get docker</a>{" "}
(engine or desktop)
</li>
<li>Have Node.js v20.15 or later installed</li>
<li>
Run <code>bash -i &lt;(curl -s https://install.aztec.network)</code>
</li>
Expand Down Expand Up @@ -51,8 +48,8 @@ export const General = {

AztecLocalNetwork: () => (
<p>
<b>Aztec's Local network</b> - runs a set of Aztec tools for convenient local
development, it includes: an Ethereum node, an Aztec node, and PXE.
<b>Aztec's Local network</b> - runs a set of Aztec tools for convenient
local development, it includes: an Ethereum node, an Aztec node, and PXE.
</p>
),

Expand Down
Loading