Skip to content

README.md

Latest commit

 

History

History
54 lines (33 loc) · 2.45 KB

README.md

File metadata and controls

54 lines (33 loc) · 2.45 KB

CS 595 Zero‑Knowledge Labs

Hands‑on labs and homework assignments that teach modern zero‑knowledge proof engineering with Noir, Barretenberg, and Solidity—runnable in a single click via GitHub Codespaces or locally with Docker.

What’s inside?

Each lab/homework ships with its own detailed README—start there for step‑by‑step instructions.

Lab / Homework Learning goal Tech highlights
lab1 Build a hello‑world circuit, generate a proof, auto‑generate a Solidity verifier, and deploy on Ethereum with Remix Noir, nargo, Barretenberg CLI
lab2 Develop more involved circuits using Merkle trees: prove a credit‑score > 500 and verify Merkle inclusion Pedersen hash, custom TypeScript Merkle‑tree tooling
hw6 Implement a Tornado‑style mixer (“Whirlwind”) with privacy‑preserving deposit & withdrawal Dual Noir circuits → Solidity verifiers, mixer smart contract

A pre‑configured .devcontainer/ supplies Noir, VS Code extensions, pinned Barretenberg binaries, and a post‑create sanity check.

Quick‑start / Installation

1 · GitHub Codespaces (zero setup)

  1. Fork this repository.
  2. Click Code → Codespaces → Create codespace on main.
  3. Wait ~2 minutes while the container builds.
  4. Open a terminal inside VS Code and dive in — nargo and bb are already on your PATH.

2 · Local Docker container

If you have Docker Desktop installed:

# Clone the repo
git clone https://github.com/<your‑handle>/CS595Lab.git
cd CS595Lab

# Build the image defined in .devcontainer/Dockerfile
docker build -f .devcontainer/Dockerfile -t cs595lab .

# Start an interactive shell with the repo mounted at /workspace
docker run --rm -it -v "$PWD":/workspace cs595lab bash

Tip: In VS Code you can also select “Dev Containers: Open Folder in Container…” to reuse the same Dockerfile and devcontainer.json.

License

This project is released under the MIT License.