Skip to content

Commit

Permalink
feat(docs): update sandbox commands, add reference, fix tutorials (#7580
Browse files Browse the repository at this point in the history
)

Please read [contributing guidelines](CONTRIBUTING.md) and remove this
line.

---------

Co-authored-by: Gregorio Juliana <[email protected]>
  • Loading branch information
catmcgee and Thunkar authored Jul 24, 2024
1 parent ade373b commit 4f07290
Show file tree
Hide file tree
Showing 10 changed files with 398 additions and 34 deletions.
8 changes: 3 additions & 5 deletions docs/docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,14 @@ bash -i <(curl -s install.aztec.network)

This will install the following tools:

- **aztec** - launches various infrastructure subsystems (sequencer, prover, pxe, etc).
- **aztec** - launches various infrastructure subsystems (full sandbox, sequencer, prover, pxe, etc) and provides utility commands to interact with the network
- **aztec-nargo** - aztec's build of nargo, the noir compiler toolchain.
- **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.

Once these have been installed, to start the sandbox, run:

```bash
aztec-sandbox
aztec start --sandbox
```

### Have fun
Expand Down Expand Up @@ -63,7 +61,7 @@ If you wish to run components of the Aztec network stack separately, you can use
aztec start --node [nodeOptions] --pxe [pxeOptions] --archiver [archiverOptions] --sequencer [sequencerOptions] --prover [proverOptions] ----p2p-bootstrap [p2pOptions]
```
Starting the aztec node alongside a PXE, sequencer or archiver, will attach the components to the node.Eg if you want to run a PXE separately to a node, you can [read this guide](./aztec/concepts/pxe/index.md)/
Starting the aztec node alongside a PXE, sequencer or archiver, will attach the components to the node. Eg if you want to run a PXE separately to a node, you can [read this guide](./aztec/concepts/pxe/index.md).
## Update the sandbox
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/guides/local_env/versions-updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Inside your project run:

```shell
cd your/aztec/project
aztec-builder update . --contract src/contract1 --contract src/contract2
aztec update . --contract src/contract1 --contract src/contract2
```

The sandbox must be running for the update command to work. Make sure it is [installed and running](../../reference/sandbox_reference/sandbox-reference.md).
Expand All @@ -104,16 +104,16 @@ There are four components whose versions need to be kept compatible:
3. `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-builder update`.
But you need to update your Aztec.nr version manually or using `aztec update`.

## Updating Aztec.nr packages

### Automatic update

`aztec-builder` will update your Aztec.nr packages to the appropriate version with the `aztec-builder update` command. Run this command from the root of your project and pass the paths to the folders containing the Nargo.toml files for your projects like so:
You can update your Aztec.nr packages to the appropriate version with the `aztec update` command. Run this command from the root of your project and pass the paths to the folders containing the Nargo.toml files for your projects like so:

```shell
aztec-builder update . --contract src/contract1 --contract src/contract2
aztec update . --contract src/contract1 --contract src/contract2
```

### Manual update
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ members = [
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.

```bash
aztec-builder codegen ./aztec-nargo/output/target/path -o src/artifacts
aztec codegen ./aztec-nargo/output/target/path -o src/artifacts
```

Below is typescript code generated from the [Token](https://github.com/AztecProtocol/aztec-packages/blob/master/noir-projects/noir-contracts/contracts/token_contract/src/main.nr) contract:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/smart_contracts/how_to_deploy_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ aztec-nargo compile
Generate the typescript class:

```bash
aztec-builder codegen ./aztec-nargo/output/target/path -o src/artifacts
aztec codegen ./aztec-nargo/output/target/path -o src/artifacts
```

This would create a typescript file like `Example.ts` in `./src/artifacts`. Read more on the [compiling page](how_to_compile_contract.md).
Expand Down
Loading

0 comments on commit 4f07290

Please sign in to comment.