Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
benesjan committed Sep 18, 2023
1 parent ceb671a commit 7faa014
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 24 deletions.
24 changes: 2 additions & 22 deletions docs/docs/dev_docs/getting_started/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,10 @@ Or if you use yarn:
yarn global add @aztec/cli
```

If you have specified a SANDBOX_VERSION environmental variable when installing the Sandbox, you will need to specify the same version when installing the CLI.
To get the version of the Sandbox you have installed start the Sandbox and look for the version in the logs.
Alternatively, if you already have a version of aztec-cli installed, you can run:

#include_code node-info yarn-project/end-to-end/src/cli_docs_sandbox.test.ts bash

To install a specific version of the CLI, run:

```bash
npm install -g @aztec/cli@YOUR_VERSION
```

or if you use yarn:

```bash
yarn global add @aztec/cli@YOUR_VERSION
```

If your version was not found look at the list of available versions on [npmjs.com](https://www.npmjs.com/package/@aztec/cli?activeTab=versions).

Verify that the correct version is installed:
Then verify that it is installed with:

```bash
aztec-cli --version
aztec-cli -h
```

## I have the Sandbox running, now what?
Expand Down
57 changes: 56 additions & 1 deletion docs/docs/dev_docs/getting_started/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,59 @@ There are 4 components whose versions need to be kept compatible:
1. Aztec Sandbox,
2. Aztec CLI,
3. Noir compiler `nargo`,
4. Noir framework for Aztec contracts `aztec.nr`.
4. Noir framework for Aztec contracts `aztec.nr`.

## Updating Aztec Sandbox
To update the sandbox to the latest version, simply run the curl command we used for installation again:
```shell
/bin/bash -c "$(curl -fsSL 'https://sandbox.aztec.network')"
```

It will download and start the latest version of sandbox.

If you would like to use a fixed version of the sandbox, you can export the `SANDBOX_VERSION` environmental variable.
If you are unsure what version to use go to [aztec-packages repository](https://github.com/AztecProtocol/aztec-packages/releases) and choose the `aztec-packages` release based on the changelog.

Then set the `SANDBOX_VERSION` environmental variable to the version you want to use. E.g.:
```shell
export SANDBOX_VERSION=v0.7.5
```

Now when you run the curl command it will use the version you specified.
To verify that it's the case check the console output of the curl command.
You should see the following line:
```
Aztec Sandbox v0.7.5 is now ready for use!
```

Alternatively you can open a new terminal and use aztec-cli to get the version.

#include_code node-info yarn-project/end-to-end/src/cli_docs_sandbox.test.ts bash

The client version should be the same as the one we chose by setting the `SANDBOX_VERSION` environmental variable.

## Updating Aztec CLI
If the latest version was used when updating the sandbox then we can simply run the following command to update the CLI:
```shell
npm install -g @aztec/cli
```

If a specific version was set for the sandbox then we need to install the CLI with the same version:
```shell
npm install -g @aztec/cli@REPLACE_WITH_SANDBOX_VERSION
```

E.g.:
```shell
npm install -g @aztec/[email protected]
```

## Updating Noir compiler
Now we need to update the Noir compiler `nargo` to the version compatible with the sandbox.
Use `aztec-cli` to get it:
#include_code node-info yarn-project/end-to-end/src/cli_docs_sandbox.test.ts bash

Then we install the `Compatible Nargo Version` with (replace `COMPATIBLE_NARGO_VERSION` with the version from the previous command):
```shell
noirup -v COMPATIBLE_NARGO_VERSION
```
3 changes: 2 additions & 1 deletion yarn-project/end-to-end/src/cli_docs_sandbox.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Node Info:
Version: 1
Chain Id: 31337
Rollup Address: 0xcf7ed3acca5a467e9e704c703e8d87f634fb0fc9
Client: [email protected]
Client: [email protected]
Compatible Nargo Version: 0.11.1-aztec.0
// docs:end:node-info
`;

Expand Down

0 comments on commit 7faa014

Please sign in to comment.