Skip to content

Commit b0e55bf

Browse files
committed
Refactor README and remove starter token examples
- Updated README title for consistency and improved clarity. - Added links to additional examples in the Aztec monorepo. - Removed outdated starter token examples and related files to streamline the repository. - Enhanced contributing guidelines to encourage new example submissions and documentation improvements.
1 parent 054777f commit b0e55bf

File tree

17 files changed

+12
-2211
lines changed

17 files changed

+12
-2211
lines changed

README.md

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# aztec-examples
1+
# Aztec Examples
22

33
A collection of example Aztec smart contracts and circuits written in Noir, designed for hands-on learning of the Aztec privacy-first Layer 2 blockchain.
44

55
## Overview
66

77
This repository contains practical examples demonstrating various features of Aztec's zero-knowledge smart contract platform, from basic token implementations to advanced proof verification patterns.
88

9+
You can find additional examples in the Aztec monorepo [docs examples folder](https://github.com/AztecProtocol/aztec-packages/tree/next/docs/examples), including:
10+
11+
- Counter contract example
12+
- A simple token example
13+
- An NFT bridge contract example
14+
915
## Examples
1016

1117
### 1. [Recursive Verification](./recursive_verification)
@@ -20,39 +26,14 @@ Demonstrates how to verify Noir circuit proofs within Aztec smart contracts usin
2026
- Integration between off-chain proving and on-chain verification
2127

2228
**Key features**:
29+
2330
- Circuit that proves two values are not equal (x ≠ y)
2431
- Smart contract that verifies proofs and maintains private counters
2532
- Comprehensive test suite and GitHub Actions CI/CD pipeline
2633
- TypeScript utilities for proof generation and contract deployment
2734

2835
[View README](./recursive_verification/README.md)
2936

30-
### 2. [Starter Token](./starter-token)
31-
32-
**Aztec Version**: 2.0.2
33-
34-
A beginner-friendly token contract implementation with both template and reference versions. Perfect for learning Aztec contract development from scratch.
35-
36-
**Structure**:
37-
- `start-here/`: Template implementation for hands-on learning
38-
- `reference/`: Complete working implementation with all features
39-
- `external-call-contract/`: Example of cross-contract interactions
40-
41-
**Key features**:
42-
- Public and private token balances
43-
- Minting and transfer functionality
44-
- Owner-based access control
45-
- Cross-contract communication patterns
46-
- TypeScript client integration
47-
48-
## Prerequisites
49-
50-
- [Node.js](https://nodejs.org/) (v20+)
51-
- [Bun](https://bun.sh/) runtime (for recursive_verification example)
52-
- [Aztec CLI](https://docs.aztec.network/getting_started/quickstart)
53-
- Docker (for running Aztec sandbox)
54-
- 8GB+ RAM (recommended for proof generation)
55-
5637
## Quick Start
5738

5839
### Install Aztec Tools
@@ -68,6 +49,7 @@ aztec-up 2.0.3
6849
### Run the Examples
6950

7051
#### Recursive Verification
52+
7153
```bash
7254
cd recursive_verification
7355
bun install
@@ -78,6 +60,7 @@ bun recursion # Deploy and verify proof
7860
```
7961

8062
#### Starter Token
63+
8164
```bash
8265
cd starter-token/reference
8366
# Follow the specific setup instructions in the token example
@@ -93,9 +76,6 @@ aztec-examples/
9376
│ ├── scripts/ # TypeScript utilities
9477
│ ├── tests/ # Integration test suite
9578
│ └── README.md # Detailed documentation
96-
├── starter-token/ # Token contract examples
97-
│ ├── start-here/ # Template for learning
98-
│ └── reference/ # Complete implementation
9979
└── .github/ # CI/CD workflows
10080
└── workflows/
10181
└── recursive-verification-tests.yml
@@ -154,11 +134,12 @@ bun test
154134
## Contributing
155135

156136
We welcome contributions! Please feel free to submit issues or pull requests with:
137+
157138
- New example contracts
158139
- Improvements to existing examples
159140
- Documentation enhancements
160141
- Test coverage improvements
161142

162143
## License
163144

164-
[Apache License 2.0](LICENSE)
145+
[Apache License 2.0](LICENSE)

starter-token/.gitignore

Lines changed: 0 additions & 4 deletions
This file was deleted.

starter-token/reference/contract/Nargo.toml

Lines changed: 0 additions & 9 deletions
This file was deleted.

starter-token/reference/contract/src/main.nr

Lines changed: 0 additions & 85 deletions
This file was deleted.

starter-token/reference/external-call-contract/Nargo.toml

Lines changed: 0 additions & 9 deletions
This file was deleted.

starter-token/reference/external-call-contract/src/main.nr

Lines changed: 0 additions & 16 deletions
This file was deleted.

starter-token/reference/ts/package.json

Lines changed: 0 additions & 19 deletions
This file was deleted.

starter-token/reference/ts/src/index.ts

Lines changed: 0 additions & 18 deletions
This file was deleted.

starter-token/reference/ts/tsconfig.json

Lines changed: 0 additions & 13 deletions
This file was deleted.

starter-token/start-here/contract/Nargo.toml

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)