You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,17 @@
6
6
7
7
# Aztec Starter
8
8
9
-
## Sandbox
9
+
## Local Network
10
10
11
-
This repo is meant to be a starting point for learning to write Aztec contracts and tests on the Aztec sandbox (local development environment). It includes an example contract, useful commands in `package.json` and helpful scripts in `./scripts`.
11
+
This repo is meant to be a starting point for learning to write Aztec contracts and tests on the Aztec local network (local development environment). It includes an example contract, useful commands in `package.json` and helpful scripts in `./scripts`.
12
12
13
13
You can find the **Pod Racing Game contract** in `./src/main.nr`. A simple integration test is in `./src/test/e2e/index.test.ts`.
14
14
15
15
The Pod Racing contract is a two-player competitive game where players allocate points across 5 tracks over multiple rounds. The game demonstrates Aztec's private state capabilities - round choices remain private until players reveal their final scores.
16
16
17
17
## Devnet
18
18
19
-
This repo connects to a locally running Aztec Sandbox by default, but can be configured to connect to the devnet by specifying `AZTEC_ENV=devnet` in a `.env` file or by prefixing a command e.g. `AZTEC_ENV=devnet yarn deploy`.
19
+
This repo connects to a locally running Aztec local network by default, but can be configured to connect to the devnet by specifying `AZTEC_ENV=devnet` in a `.env` file or by prefixing a command e.g. `AZTEC_ENV=devnet yarn deploy`.
20
20
21
21
<divalign="center">
22
22
@@ -38,7 +38,7 @@ Use **Node.js version 22.15.0**.
38
38
39
39
[Start your codespace from the codespace dropdown](https://docs.github.com/en/codespaces/getting-started/quickstart).
40
40
41
-
Get the **sandbox, aztec-cli, and other tooling** with this command:
41
+
Get the **local network, aztec-cli, and other tooling** with this command:
aztec-up && docker pull aztecprotocol/aztec:$VERSION&& docker tag aztecprotocol/aztec:$VERSION aztecprotocol/aztec:latest
52
52
```
53
53
54
54
### Environment Configuration
55
55
56
56
This project uses JSON configuration files to manage environment-specific settings:
57
57
58
-
-`config/sandbox.json` - Configuration for local sandbox development
58
+
-`config/local-network.json` - Configuration for local network development
59
59
-`config/devnet.json` - Configuration for devnet deployment
60
60
61
-
The system automatically loads the appropriate configuration file based on the `ENV` environment variable. If `ENV` is not set, it defaults to `sandbox`.
61
+
The system automatically loads the appropriate configuration file based on the `ENV` environment variable. If `ENV` is not set, it defaults to `local-network`.
62
62
63
63
The configuration files contain network URLs, timeouts, and environment-specific settings. You can modify these files to customize your development environment.
64
64
65
-
### Running on Sandbox (Local Development)
65
+
### Running on Local Network (Local Development)
66
66
67
-
Start the sandbox with:
67
+
Start the local network with:
68
68
69
69
```bash
70
-
aztec start --sandbox
70
+
aztec start --local-network
71
71
```
72
72
73
-
Run scripts and tests with default sandbox configuration:
73
+
Run scripts and tests with default local network configuration:
:warning: Tests and scripts set up and run the Private Execution Environment (PXE) and store PXE data in the `./store` directory. If you restart the sandbox, you will need to delete the `./store` directory to avoid errors.
128
+
:warning: Tests and scripts set up and run the Private Execution Environment (PXE) and store PXE data in the `./store` directory. If you restart the local network, you will need to delete the `./store` directory to avoid errors.
129
129
130
130
## Transaction Profiling
131
131
132
-
**Make sure the sandbox is running before profiling.**
132
+
**Make sure the local network is running before profiling.**
133
133
134
134
```bash
135
-
aztec start --sandbox
135
+
aztec start --local-network
136
136
```
137
137
138
138
Then run an example contract deployment profile with:
@@ -151,10 +151,10 @@ See the [demo-wallet for an example](https://github.com/AztecProtocol/demo-walle
151
151
152
152
## π§ͺ **Test**
153
153
154
-
**Make sure the sandbox is running before running tests.**
154
+
**Make sure the local network is running before running tests.**
155
155
156
156
```bash
157
-
aztec start --sandbox
157
+
aztec start --local-network
158
158
```
159
159
160
160
Then test with:
@@ -165,7 +165,7 @@ yarn test
165
165
166
166
Testing will run the **TypeScript tests** defined in `index.test.ts` inside `./src/test/e2e`, as well as the [Aztec Testing eXecution Environment (TXE)](https://docs.aztec.network/developers/guides/smart_contracts/testing) tests defined in [`first.nr`](./src/test/first.nr) (imported in the contract file with `mod test;`).
167
167
168
-
Note: The Typescript tests spawn an instance of the sandbox to test against, and close it once the TS tests are complete.
168
+
Note: The Typescript tests spawn an instance of the local network to test against, and close it once the TS tests are complete.
169
169
170
170
---
171
171
@@ -193,7 +193,7 @@ The `./src/utils/` folder contains utility functions:
193
193
194
194
## β **Error Resolution**
195
195
196
-
:warning: Tests and scripts set up and run the Private Execution Environment (PXE) and store PXE data in the `./store` directory. If you restart the sandbox, you will need to delete the `./store` directory to avoid errors.
196
+
:warning: Tests and scripts set up and run the Private Execution Environment (PXE) and store PXE data in the `./store` directory. If you restart the local network, you will need to delete the `./store` directory to avoid errors.
0 commit comments