Skip to content

Commit 9ac500c

Browse files
committed
Update workflows and documentation to replace 'sandbox' with 'local-network'
1 parent e2fce0f commit 9ac500c

File tree

9 files changed

+45
-45
lines changed

9 files changed

+45
-45
lines changed

.github/workflows/recursive-verification-tests.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
name: Recursive Verification Tests
1818
runs-on: ubuntu-latest
1919
env:
20-
AZTEC_ENV: sandbox
20+
AZTEC_ENV: local-network
2121
AZTEC_VERSION: 3.0.0-devnet.20251212
2222

2323
steps:
@@ -46,23 +46,23 @@ jobs:
4646
- name: Update path
4747
run: echo "$HOME/.aztec/bin" >> $GITHUB_PATH
4848

49-
- name: Set Aztec version and start sandbox
49+
- name: Set Aztec version and start local network
5050
run: |
5151
aztec-up ${{ env.AZTEC_VERSION }}
5252
docker tag aztecprotocol/aztec:${{ env.AZTEC_VERSION }} aztecprotocol/aztec:latest
53-
aztec start --sandbox &
53+
aztec start --local-network &
5454
55-
- name: Wait for sandbox to be ready
55+
- name: Wait for local network to be ready
5656
run: |
57-
echo "Waiting for sandbox to start..."
57+
echo "Waiting for local network to start..."
5858
MAX_RETRIES=60
5959
for i in $(seq 1 $MAX_RETRIES); do
6060
if curl -s http://localhost:8080/status >/dev/null 2>&1; then
61-
echo "✅ Sandbox is ready!"
61+
echo "✅ Local network is ready!"
6262
break
6363
fi
6464
if [ $i -eq $MAX_RETRIES ]; then
65-
echo "❌ Sandbox failed to start after $MAX_RETRIES attempts"
65+
echo "❌ Local network failed to start after $MAX_RETRIES attempts"
6666
exit 1
6767
fi
6868
echo "Waiting... ($i/$MAX_RETRIES)"
@@ -110,7 +110,7 @@ jobs:
110110
- name: Cleanup
111111
if: always()
112112
run: |
113-
echo "Stopping Aztec sandbox..."
113+
echo "Stopping Aztec local network..."
114114
pkill -f "aztec" || true
115115
docker stop $(docker ps -q) || true
116116
docker rm $(docker ps -a -q) || true

CLAUDE.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ bun ccc # Compiles contract, post-processes, and generates TypeScript bindings
7171
### Running Local Development Environment
7272

7373
```bash
74-
# Start Aztec sandbox (node + PXE)
75-
aztec start --sandbox
74+
# Start Aztec local network (node + PXE)
75+
aztec start --local-network
7676

7777
# Start without PXE (when using aztec-wallet)
78-
NO_PXE=true aztec start --sandbox
78+
NO_PXE=true aztec start --local-network
7979

8080
# Import test accounts to aztec-wallet
8181
aztec-wallet import-test-accounts
@@ -148,8 +148,8 @@ bun ccc # Runs: aztec-nargo compile && aztec-postprocess-contract && aztec code
148148
# 4. Generate proof data (UltraHonk proof, verification key, public inputs)
149149
bun data # Creates data.json with proof for x=1, y=2
150150

151-
# 5. Start Aztec sandbox (in separate terminal)
152-
aztec start --sandbox
151+
# 5. Start Aztec local network (in separate terminal)
152+
aztec start --local-network
153153

154154
# 6. Deploy contract and verify proof on-chain
155155
bun recursion # Deploys ValueNotEqual contract and verifies proof
@@ -261,7 +261,7 @@ TypeScript projects use:
261261

262262
- **Node.js/npm**: For starter-token TypeScript examples (v20+)
263263
- **Bun**: Required for recursive_verification example (faster alternative to Node.js)
264-
- **Docker**: Required for running Aztec sandbox
264+
- **Docker**: Required for running Aztec local network
265265
- **Memory**: 8GB+ RAM recommended for proof generation
266266

267267
## CI/CD
@@ -280,7 +280,7 @@ Steps:
280280

281281
1. Sets up Node.js (v22) and Bun
282282
2. Installs Aztec CLI
283-
3. Starts Aztec sandbox
283+
3. Starts Aztec local network
284284
4. Compiles circuits and contracts
285285
5. Generates proof data
286286
6. Runs integration tests
@@ -294,7 +294,7 @@ Steps:
294294

295295
### Issue: "Failed to connect to PXE"
296296

297-
**Solution**: Ensure Aztec sandbox is running with `aztec start --sandbox`
297+
**Solution**: Ensure Aztec local network is running with `aztec start --local-network`
298298

299299
### Issue: "Proof verification failed"
300300

@@ -314,4 +314,4 @@ Steps:
314314
2. **Testing**: Run tests locally before pushing changes
315315
3. **Documentation**: Update READMEs when modifying examples
316316
4. **Clean Builds**: When encountering issues, try removing `target/`, `artifacts/`, and `node_modules/` directories
317-
5. **Sandbox Management**: Always ensure sandbox is running when deploying/testing contracts
317+
5. **Local Network Management**: Always ensure local network is running when deploying/testing contracts

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ aztec-up 3.0.0-devnet.4
5555
aztec-nargo compile
5656

5757
# Start local Aztec network
58-
aztec start --sandbox
58+
aztec start --local-network
5959

6060
# Run tests with Testing Execution Environment (TXE)
6161
aztec test

recursive_verification/CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ bun install
2323
# Install/update Aztec tools
2424
aztec-up
2525

26-
# Start Aztec Sandbox (required for contract deployment)
27-
aztec start --sandbox
26+
# Start Aztec local network (required for contract deployment)
27+
aztec start --local-network
2828
```
2929

3030
### Circuit Development
@@ -105,4 +105,4 @@ bun recursion
105105
## Testing
106106

107107
- Circuit tests: Use `nargo test` in the circuit directory
108-
- Contract verification: Run the full flow with `bun recursion` after starting the sandbox
108+
- Contract verification: Run the full flow with `bun recursion` after starting the local network

recursive_verification/EXPLAINER.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ flowchart TB
5050
end
5151
5252
subgraph "6. Aztec Network"
53-
SANDBOX[Aztec Sandbox<br/>localhost:8080]
53+
LOCAL_NETWORK[Aztec Local Network<br/>localhost:8080]
5454
PXE[Private Execution<br/>Environment]
55-
SANDBOX --> PXE
56-
CONTRACT -->|Deployed to| SANDBOX
55+
LOCAL_NETWORK --> PXE
56+
CONTRACT -->|Deployed to| LOCAL_NETWORK
5757
end
5858
5959
style NC fill:#e1f5fe
6060
style CONTRACT fill:#c8e6c9
6161
style PROOF_DATA fill:#fff9c4
62-
style SANDBOX fill:#f3e5f5
62+
style LOCAL_NETWORK fill:#f3e5f5
6363
```
6464

6565
### Data Flow Sequence
@@ -70,7 +70,7 @@ sequenceDiagram
7070
participant Circuit as Noir Circuit
7171
participant BB as Barretenberg
7272
participant Contract as Aztec Contract
73-
participant Sandbox as Aztec Sandbox
73+
participant LocalNet as Aztec Local Network
7474
7575
Dev->>Circuit: 1. Define proof logic (x ≠ y)
7676
Dev->>Circuit: 2. Compile circuit
@@ -81,10 +81,10 @@ sequenceDiagram
8181
BB->>Dev: Return proof, VK, public inputs
8282
8383
Dev->>Contract: 4. Compile smart contract
84-
Dev->>Sandbox: 5. Start local network
84+
Dev->>LocalNet: 5. Start local network
8585
86-
Dev->>Sandbox: 6. Deploy contract
87-
Sandbox-->>Dev: Contract address
86+
Dev->>LocalNet: 6. Deploy contract
87+
LocalNet-->>Dev: Contract address
8888
8989
Dev->>Contract: 7. Call increment() with proof
9090
Contract->>Contract: Verify proof on-chain

recursive_verification/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,15 @@ This runs `scripts/generate_data.ts` which:
112112

113113
## Deploy and Verify On-Chain
114114

115-
### 1. Start Aztec Sandbox
115+
### 1. Start Aztec Local Network
116116

117117
Start the local Aztec network:
118118

119119
```bash
120-
aztec start --sandbox
120+
aztec start --local-network
121121
```
122122

123-
Keep this running in a separate terminal. The sandbox runs at `http://localhost:8080`.
123+
Keep this running in a separate terminal. The local network runs at `http://localhost:8080`.
124124

125125
### 2. Deploy Contract and Verify Proof
126126

@@ -164,8 +164,8 @@ bun ccc
164164
# 5. Generate proof data
165165
bun data
166166

167-
# 6. Start sandbox (in a new terminal)
168-
aztec start --sandbox
167+
# 6. Start local network (in a new terminal)
168+
aztec start --local-network
169169

170170
# 7. Deploy and verify (in original terminal)
171171
bun recursion
@@ -219,7 +219,7 @@ The test suite (`tests/recursive_verification.test.ts`) includes:
219219

220220
3. **"Failed to connect to PXE"**
221221

222-
- Ensure the Aztec sandbox is running: `aztec start --sandbox`
222+
- Ensure the Aztec local network is running: `aztec start --local-network`
223223
- Check it's accessible at `http://localhost:8080`
224224

225225
4. **"Proof verification failed"**

recursive_verification/run-tests.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ echo "========================================="
77
echo "Recursive Verification Test Runner"
88
echo "========================================="
99

10-
# Check if Aztec sandbox is running
10+
# Check if Aztec local network is running
1111
echo ""
12-
echo "Checking Aztec sandbox status..."
12+
echo "Checking Aztec local network status..."
1313
if ! curl -s http://localhost:8080/status > /dev/null 2>&1; then
14-
echo "❌ Aztec sandbox is not running!"
15-
echo "Please start it with: aztec start --sandbox"
14+
echo "❌ Aztec local network is not running!"
15+
echo "Please start it with: aztec start --local-network"
1616
exit 1
1717
else
18-
echo "✅ Aztec sandbox is running"
18+
echo "✅ Aztec local network is running"
1919
fi
2020

2121
# Compile the Noir circuit

recursive_verification/scripts/run_recursion.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export const setupWallet = async (): Promise<TestWallet> => {
5959

6060
return wallet;
6161
} catch (error) {
62-
console.error("Failed to setup sandbox:", error);
62+
console.error("Failed to setup local network:", error);
6363
throw error;
6464
}
6565
};

recursive_verification/tests/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This directory contains tests for the recursive verification proof system using
44

55
## Prerequisites
66

7-
1. Ensure the Aztec sandbox is running:
7+
1. Ensure the Aztec local network is running:
88
```bash
9-
aztec start --sandbox
9+
aztec start --local-network
1010
```
1111

1212
2. Compile the contracts and generate proof data:
@@ -61,14 +61,14 @@ Each test case:
6161

6262
If tests fail:
6363

64-
1. Check the Aztec sandbox is running: `aztec status`
64+
1. Check the Aztec local network is running: `aztec status`
6565
2. Verify proof data exists: `ls ../data.json`
6666
3. Ensure contracts are compiled: `ls ../contract/artifacts/`
6767
4. Check PXE connection at http://localhost:8080
6868

6969
## Notes
7070

71-
- Tests require the Aztec sandbox to be running at `http://localhost:8080`
71+
- Tests require the Aztec local network to be running at `http://localhost:8080`
7272
- Proof verification can take 10-30 seconds depending on system resources
7373
- The test suite uses the same proof data (`data.json`) as the original script
7474
- Each test is independent and can be run in isolation

0 commit comments

Comments
 (0)