Skip to content

Commit

Permalink
docs: addition around Nargo.toml search (#5943)
Browse files Browse the repository at this point in the history
  • Loading branch information
jzaki authored Apr 23, 2024
1 parent da67f18 commit d1350da
Showing 1 changed file with 11 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ aztec-nargo compile

This will output a JSON [artifact](./artifacts.md) for each contract in the project to a `target` folder containing the Noir ABI artifacts.

:::note
This command looks for `Nargo.toml` files by ascending up the parent directories, and will compile the top-most Nargo.toml file it finds.
Eg: if you are in `/hobbies/cool-game/contracts/easter-egg/`, and both `cool-game` and `easter-egg` contain a Nargo.toml file, then `aztec-compile` will be performed on `cool-game/Nargo.toml` and compile the project(s) specified within it. Eg
```
[workspace]
members = [
"contracts/easter-egg",
]
```
:::

### Typescript Interfaces

You can use the code generator to autogenerate type-safe typescript classes for each of your contracts. These classes define type-safe methods for deploying and interacting with your contract based on their artifact.
Expand Down

0 comments on commit d1350da

Please sign in to comment.