Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Connor <[email protected]>
  • Loading branch information
spalladino and iAmMichaelConnor authored Aug 16, 2023
1 parent 1533b34 commit f366cb3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/docs/dev_docs/contracts/compiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can re-run `noirup -v aztec` whenever you want to update to the latest versi

## Compile using the CLI

To compile using the Aztec CLI, first install it:
To compile a contract using the Aztec CLI, first install it:

`npm install -g @aztec/cli`

Expand All @@ -29,7 +29,7 @@ aztec-cli compile ./src/noir

This will output a JSON artifact for each contract in the project to a `target` folder containing their [ABI](./abi.md), which you can use for deploying or interacting with your contracts.

### Typescript
### Typescript Interfaces

You can use the compiler 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 ABI.

Expand Down Expand Up @@ -113,7 +113,7 @@ impl PrivateTokenContractInterface {
At the moment, the compiler generates these interfaces from already compiled ABIs, and not from source code. This means that you should not import a generated interface from within the same project as its source contract, or you risk circular references.
:::

## Access the compiler using nodejs
## Compile using nodejs

You can also programmatically access the compiler via the `@aztec/noir-compiler` package. To do this, install the package into your nodejs project:

Expand Down

0 comments on commit f366cb3

Please sign in to comment.