Skip to content

Commit 8883861

Browse files
committed
update versions in docs
1 parent 9ea8692 commit 8883861

File tree

4 files changed

+27
-11
lines changed

4 files changed

+27
-11
lines changed

CLAUDE.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,20 @@ aztec-examples/
4646
## Development Commands
4747

4848
### Prerequisites
49+
4950
```bash
5051
# Install Aztec tools (required)
5152
bash -i <(curl -s https://install.aztec.network)
5253

5354
# Set specific version (examples may require different versions)
54-
aztec-up 2.0.3 # For recursive_verification
55+
aztec-up 3.0.0-nightly.20251026 # For recursive_verification
5556
aztec-up 2.0.2 # For starter-token
5657
```
5758

5859
### Building Contracts
5960

6061
From a contract directory containing `Nargo.toml`:
62+
6163
```bash
6264
# Compile an Aztec contract
6365
aztec-nargo compile
@@ -180,19 +182,22 @@ npm start
180182
### Aztec Contract Structure
181183

182184
Aztec contracts use the `#[aztec]` macro and define functions as either:
185+
183186
- `#[private]`: Executed client-side with zero-knowledge proofs
184187
- `#[public]`: Executed on-chain by the protocol
185188
- `#[initializer]`: Constructor-like functions for setup
186189
- `#[unconstrained]`: View functions that don't modify state
187190

188191
Key considerations:
192+
189193
- **Private functions**: Optimize for circuit size (gates), unconstrained functions don't add gates
190194
- **Public functions**: Optimize for gas cost, unconstrained functions do add cost
191195
- **Unconstrained functions**: Used for computation that doesn't need proving, must verify results in constrained context
192196

193197
### Proof Verification Pattern (recursive_verification)
194198

195199
The recursive verification example demonstrates:
200+
196201
- **Off-chain proof generation**: Noir circuits compiled and executed with Barretenberg
197202
- **On-chain verification**: Using `std::verify_proof_with_type` in Aztec contracts
198203
- **UltraHonk proving system**: Generates proofs with 457 field elements, verification keys with 115 fields
@@ -201,6 +206,7 @@ The recursive verification example demonstrates:
201206
### Token Pattern (starter-token)
202207

203208
The token example showcases:
209+
204210
- **Dual balance system**: Public and private token balances
205211
- **State management**: Using `PublicMutable` and `Map` for storage
206212
- **Access control**: Owner-based permissions for minting
@@ -209,6 +215,7 @@ The token example showcases:
209215
### Testing Pattern
210216

211217
Tests use the Testing Execution Environment (TXE):
218+
212219
```noir
213220
use dep::aztec::test::helpers::test_environment::TestEnvironment;
214221
@@ -229,19 +236,21 @@ unconstrained fn test_function() {
229236
### Aztec Contract Dependencies
230237

231238
Aztec contracts specify dependencies in `Nargo.toml`:
239+
232240
```toml
233241
[dependencies]
234242
aztec = { git = "https://github.com/AztecProtocol/aztec-packages/", tag = "vX.X.X", directory = "noir-projects/aztec-nr/aztec" }
235243
easy_private_state = { git = "https://github.com/AztecProtocol/aztec-packages/", tag = "vX.X.X", directory = "noir-projects/aztec-nr/easy-private-state" }
236244
```
237245

238246
**Version Compatibility**: Different examples may use different Aztec versions:
239-
- `recursive_verification`: v2.0.3
240-
- `starter-token`: v2.0.2
247+
248+
- `recursive_verification`: v3.0.0-nightly.20251026
241249

242250
### JavaScript/TypeScript Dependencies
243251

244252
TypeScript projects use:
253+
245254
- `@aztec/aztec.js`: Aztec SDK for contract deployment and interaction
246255
- `@aztec/accounts`: Account management for Aztec
247256
- `@aztec/bb.js`: Barretenberg backend for proof generation (recursive_verification)
@@ -261,11 +270,13 @@ The repository includes GitHub Actions workflows for automated testing:
261270
### recursive-verification-tests.yml
262271

263272
Runs on:
273+
264274
- Push to main branch
265275
- Pull requests modifying `recursive_verification/**`
266276
- Manual workflow dispatch
267277

268278
Steps:
279+
269280
1. Sets up Node.js (v22) and Bun
270281
2. Installs Aztec CLI
271282
3. Starts Aztec sandbox
@@ -277,18 +288,23 @@ Steps:
277288
## Common Issues and Solutions
278289

279290
### Issue: "Cannot find module './contract/artifacts/'"
291+
280292
**Solution**: Run `bun ccc` or `aztec-nargo compile` to generate contract artifacts
281293

282294
### Issue: "Failed to connect to PXE"
295+
283296
**Solution**: Ensure Aztec sandbox is running with `aztec start --sandbox`
284297

285298
### Issue: "Proof verification failed"
299+
286300
**Solution**: Regenerate proof data after circuit changes with `bun data`
287301

288302
### Issue: Memory issues during proof generation
303+
289304
**Solution**: Close other applications or use a machine with more RAM (8GB+ recommended)
290305

291306
### Issue: Version compatibility errors
307+
292308
**Solution**: Check the Aztec version required for each example and set with `aztec-up <version>`
293309

294310
## Best Practices
@@ -297,4 +313,4 @@ Steps:
297313
2. **Testing**: Run tests locally before pushing changes
298314
3. **Documentation**: Update READMEs when modifying examples
299315
4. **Clean Builds**: When encountering issues, try removing `target/`, `artifacts/`, and `node_modules/` directories
300-
5. **Sandbox Management**: Always ensure sandbox is running when deploying/testing contracts
316+
5. **Sandbox Management**: Always ensure sandbox is running when deploying/testing contracts

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can find additional examples in the Aztec monorepo [docs examples folder](ht
1616

1717
### 1. [Recursive Verification](./recursive_verification)
1818

19-
**Aztec Version**: 2.0.3
19+
**Aztec Version**: 3.0.0-nightly.20251026
2020

2121
Demonstrates how to verify Noir circuit proofs within Aztec smart contracts using the UltraHonk proving system. This example showcases:
2222

@@ -43,7 +43,7 @@ Demonstrates how to verify Noir circuit proofs within Aztec smart contracts usin
4343
bash -i <(curl -s https://install.aztec.network)
4444

4545
# Set specific Aztec version (if needed)
46-
aztec-up 2.0.3
46+
aztec-up 3.0.0-nightly.20251026
4747
```
4848

4949
### Run the Examples

recursive_verification/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
This is an Aztec-Noir project that demonstrates proof verification in Aztec contracts. It uses Aztec version 2.0.3 to verify Noir proofs within smart contracts on the Aztec network.
7+
This is an Aztec-Noir project that demonstrates proof verification in Aztec contracts. It uses Aztec version 3.0.0-nightly.20251026 to verify Noir proofs within smart contracts on the Aztec network.
88

99
The project consists of:
1010
- A Noir circuit (`hello_circuit`) that proves x ≠ y

recursive_verification/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ This project implements:
1111
- **Proof Generation**: Scripts to generate UltraHonk proofs using Barretenberg
1212
- **On-chain Verification**: Deployment and interaction scripts for proof verification on Aztec
1313

14-
**Aztec Version**: `2.0.3`
14+
**Aztec Version**: `3.0.0-nightly.20251026`
1515

1616
## Prerequisites
1717

1818
- [Bun](https://bun.sh/) runtime (v1.0 or higher)
19-
- [Aztec CLI](https://docs.aztec.network/getting_started/quickstart) (version 2.0.3)
19+
- [Aztec CLI](https://docs.aztec.network/getting_started/quickstart) (version 3.0.0-nightly.20251026)
2020
- Linux/macOS (Windows users can use WSL2)
2121
- 8GB+ RAM recommended for proof generation
2222

@@ -61,7 +61,7 @@ bash -i <(curl -s https://install.aztec.network)
6161
### Set Aztec to the correct version:
6262

6363
```bash
64-
aztec-up 2.0.3
64+
aztec-up 3.0.0-nightly.20251026
6565
```
6666

6767
This ensures compatibility with the contract dependencies.
@@ -153,7 +153,7 @@ For a fresh setup, run these commands in order:
153153
bun install
154154

155155
# 2. Setup Aztec
156-
aztec-up 2.0.3
156+
aztec-up 3.0.0-nightly.20251026
157157

158158
# 3. Compile circuit
159159
cd circuit && aztec-nargo compile && cd ..

0 commit comments

Comments
 (0)