Skip to content

Commit

Permalink
chore: document aztec-nargo in readme (#11173)
Browse files Browse the repository at this point in the history
  • Loading branch information
dbanks12 authored Jan 10, 2025
1 parent b72234e commit 927eabf
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions aztec-nargo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## `aztec-nargo`

The `aztec-nargo` utility is packaged with docker and does the following:
1. If the first argument to `aztec-nargo` is not `compile`, it just forwards args to `nargo` and exits.
1. If the first argument _is_ `compile`, it forwards args to `nargo` with some added options (like `--inliner-aggressiveness 0 --show-artifact-paths`)
3. Extracts all artifacts modified by `nargo`
4. Transpiles each artifact using the `avm-transpiler`
5. Generates verification keys for each artifact using `bb` (`barretenberg`'s binary)

Example usage: `aztec-nargo compile`

Note: uses versions of each tool from this repository (`nargo` version is from `../noir`).
2 changes: 1 addition & 1 deletion aztec-up/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ the user's `PATH` variable in their shell startup script so they can be found.

- `aztec` - The infrastructure container.
- `aztec-cli` - A command-line tool for interacting with infrastructure.
- `aztec-nargo` - A build of `nargo` from `noir` that is guaranteed to be version-aligned. Provides compiler, lsp and more.
- `aztec-nargo` - A build of `nargo` from `noir` that is guaranteed to be version-aligned. Provides compiler, lsp and more. On `aztec-nargo compile <...>`, automatically transpiles artifacts using `avm-transpiler` and generates verification keys using `bb`.
- `aztec-sandbox` - A wrapper around docker-compose that launches services needed for sandbox testing.
- `aztec-up` - A tool to upgrade the aztec toolchain to the latest, or specific versions.
- `aztec-builder` - A useful tool for projects to generate ABIs and update their dependencies.
Expand Down

0 comments on commit 927eabf

Please sign in to comment.