https://github.com/critesjosh/scaffold-aztec

https://github.com/critesjosh/scaffold-aztec

Last synced: about 7 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/critesjosh/scaffold-aztec
• Owner: critesjosh
• Created: 2024-11-07T22:06:06.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-08T15:55:03.000Z (about 2 months ago)
• Last Synced: 2024-11-08T16:44:27.760Z (about 2 months ago)
• Language: Rust
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Scaffold-Aztec

This repo is meant to be a starting point for learning about Aztec contracts and testing.

## Getting Started

Use node version 18.

[Start your codespace from the codespace dropdown](https://docs.github.com/en/codespaces/getting-started/quickstart).

Get the sandbox, aztec-cli and other tooling with this command:

```bash

bash -i <(curl -s https://install.aztec.network)

```

Modify the toolkit version to match the version (`x.x.x`) specified in Nargo.toml with:

```

aztec-up x.x.x

```

or update to the latest version with:

```bash

aztec-up

```

Start the sandbox with:

```bash

aztec start --sandbox

```

## Install packages

```bash

yarn

```

## Compile

```bash

yarn compile

```

## Codegen

Generate the contract artifact json and typescript interface

```bash

yarn codegen

```

## Test

Make sure the sandbox is running before running tests.

```bash

aztec start --sandbox

```

Then test with:

```bash

yarn test

```

Testing will run the Typescript tests defined in `index.test.ts` file in the `./src/test` directory, as well as the [Aztec Testing eXecution Environment (TXE)](https://docs.aztec.network/guides/developer_guides/smart_contracts/testing_contracts/testing) tests defined in [`first.nr`](./src/test/first.nr) (and imported at the top of the contract file with `mod test;`).

## Error resolution

### Update Nodejs and Noir dependencies

```bash

yarn update

```

### Update Contract

Get the contract code from the monorepo. The script will look at the versions defined in `./Nargo.toml` and fetch that version of the code from the monorepo.

```bash

yarn update

```

You can specify a different version with:

```bash

VERSION=0.x.x yarn update

```

You may need to update permissions with:

```bash

chmod +x update_contract.sh

```