Skip to content

Commit ea7cd50

Browse files
authored
docs: remove mentions of noir-compiler (AztecProtocol#3702)
This PR removes references to `@aztec/noir-compiler` from the docs since it can't be installed through npm anymore (its got a `portal:` dependency on `noir_wasm`).
1 parent a4aba00 commit ea7cd50

File tree

2 files changed

+4
-32
lines changed

2 files changed

+4
-32
lines changed

docs/docs/dev_docs/contracts/compiling.md

-13
Original file line numberDiff line numberDiff line change
@@ -235,19 +235,6 @@ Read more about how to use the Aztec.nr interfaces [here](./syntax/functions.md#
235235
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.
236236
:::
237237

238-
## Compile using nodejs
239-
240-
You can also programmatically access the compiler via the `@aztec/noir-compiler` package. To do this, install the package into your nodejs project:
241-
242-
`npm install @aztec/noir-compiler`
243-
244-
The compiler exposes the following functions:
245-
246-
- `compileUsingNoirWasm`: Compiles an Aztec.nr project in the target folder using a WASM build of the compiler and returns the generated ABIs.
247-
- `compileUsingNargo`: Does the same as `compileUsingNargo` but instead of WASM it uses the `nargo` binary available on the shell `PATH`
248-
- `generateTypescriptContractInterface`: Generates a typescript class for the given contract artifact.
249-
- `generateNoirContractInterface`: Generates a Aztec.nr interface struct for the given contract artifact.
250-
251238
## Next steps
252239

253240
Once you have compiled your contracts, you can use the generated artifacts via the `Contract` class in the `aztec.js` package to deploy and interact with them, or rely on the type-safe typescript classes directly. Alternatively, use the CLI [to deploy](../../dev_docs/cli/main.md#deploying-a-token-contract) and [interact](../../dev_docs/cli/main.md#sending-a-transaction) with them.

docs/docs/dev_docs/contracts/deploying.md

+4-19
Original file line numberDiff line numberDiff line change
@@ -25,33 +25,18 @@ aztec-cli deploy /path/to/contract/artifact.json
2525
</TabItem>
2626
<TabItem value="js" label="Aztec.js">
2727

28-
Pre-requisite - Generate type-safe typescript classes for your contract when compiling using the `@aztec/noir-compiler` package. You can install the package by running `npm install @aztec/noir-compiler`.
28+
Pre-requisite - Compile the contract and generate a type-safe typescript class for it.
2929

30-
```ts
31-
import { readFileSync, writeFileSync } from "fs";
32-
import { createConsoleLogger } from "@aztec/foundation/log";
33-
import {
34-
compileUsingNoirWasm,
35-
generateTypescriptContractInterface,
36-
} from "@aztec/noir-compiler";
37-
38-
const compiled: ContractArtifact[] = await compileUsingNoirWasm(
39-
projectPathToContractFolder,
40-
{ log: createConsoleLogger() }
41-
);
42-
const abiImportPath = "../target/Example.json";
43-
writeFileSync(
44-
tsInterfaceDestFilePath,
45-
generateTypescriptContractInterface(compiled[0], abiImportPath)
46-
);
30+
```bash
31+
aztec-cli compile /path/to/contract -o target/ -ts target/
4732
```
4833

4934
This would create a typescript file like `Example.ts` in the path specified. More details in the [compiling page](./compiling.md)
5035

5136
Now you can import it to easily deploy and interact with the contract.
5237

5338
```ts
54-
import { ExampleContract } from "./Example.js";
39+
import { ExampleContract } from "./target/Example.js";
5540

5641
const tx = ExampleContract.deploy(pxe).send();
5742
await tx.wait({ interval: 0.5 });

0 commit comments

Comments
 (0)