victorjcarolino / awesome-noir

A curated list of awesome things related to learning and programming in Noir.

Awesome Noir

A curated list of resources for learning and programming in Noir.

Contents

• Official Resources
• Learning
  • Learning by Doing
  • Talks & Workshops
  • Blog Posts & Articles
• Get Coding
  • Dev Tools
  • Boilerplates
  • Libraries
• Projects
  • Authentication
  • Gaming
  • Governance
  • Social
• Contribute

---

Official Resources

• Docs
• GitHub
• Forum
• noir-starter repo

Learning

Learning By Doing

• [Practice Exercises] Noir-by-example
  • An introduction to Noir with a bunch of simple examples
  • Learn how to organize your Noir logic, write For Loops, and create complex package structures
• [Video Series] BattleZips-Noir (Source Code)
  • Walkthrough of building an on-chain Battleships game using zero-knowledge
  • Follow along and build your own game using Noir
• [Practice Exercises] Circuit Examples
  • Demonstration of dot products & Merkle proofs in Noir, in comparison to Circom and RISC0

Talks & Workshops

• [10 mins] Writing Circuits with Noir (Source Code)
  • Nargo setup
  • Basic Noir syntax
  • Noir interactions in TypeScript
• [20 mins] Painless Zero-Knowledge Circuitry with Noir at ETHDam
  • Introduction to Noir
  • Simple demo and test
• [20 mins] Private Value Transfer in 10 Lines (Source Code)
  • Tornado-like private asset transfer using Merkle proofs
• [25 mins] Noir as a Smart Contract Language
  • Noir as the smart contract language for the Aztec rollup
  • Noir smart contracts
• [45 mins] Outlandish Noir Stuff; Workshop at ETHCC
  • How to use Noir to build a bunch of outlandish stuff
• [1 hr] Circuit Safety and an Introduction to Noir
  • Common circuit bugs
  • Proving system vulnerabilities
  • Unconstrained functions
• [1 hr] Introduction to Noir in Spanish (Written Tutorial and Code)
• [1.5 hrs] Sudoku in Noir (Source Code)
• [2 hrs] ZK HACK III - Introduction to Noir (Souce Code)
  • Code-together: Quadratic Voting

Blog Posts & Articles

• Understanding the Technical Aspects of Aztec and Noir

Get Coding

Dev Tools

• Noir Editor - Browser IDE (Souce Code)
• VSCode Extension - Syntax highlight (Source Code)
• Vim Plugin - Syntax highlight
• Emacs Plugin - Syntax highlight (Source Code)
• hardhat-noir - Hardhat plugin (Source Code)
• Python2Noir - From Python to Noir language transpiler

Boilerplates

• nplate - Minimalist template
• noir-hardhat-template - Hardhat template
• noir-starter - Template repository containing example projects using Noir (Next.js + Hardhat, Foundry, etc.)

Libraries

• Standard Library - the Noir Standard Library
• Ethereum Storage Proof Verification - a library that contains the primitives necessary for RLP decoding (in the form of look-up table construction) and Ethereum state and storage proof verification (or verification of any trie proof involving 32-byte long keys)
• BigInt - a library that provides a custom BigUint56 data type, allowing for computations on large unsigned integers
• ECrecover - a library to verify an ECDSA signature and return the source Ethereum address
• U(int)2B(tyes) - a library for converting u8->u120s to [u8] array
• Sparse Merkle Tree Verifier - a library for verification of sparse Merkle trees
• Signed Int - a library for accessing a custom Signed Integer data type, allowing access to negative numbers on Noir
• Fraction - a library for accessing fractional number data type in Noir, allowing results that aren't whole numbers
• RSA - This repository contains an implementation of a RSA signature verify for the Noir language.
• Merkle Root - a library for calculating Merkle root from given inputs. Using the Poseidon function for hashing.

Projects

A curated list of projects powered by Noir.

Authentication

• Anonymous proof of token ownership on Aztec (for token-gated access)
  • Sequi
  • Cyclone

Gaming

• Mastermind - Mastermind in Noir
• BattleZips (Source Code) - On-chain Battleship
• Sudoku, Wordle, and Trivia - Sudoku, Wordle, and Trivia games
• ZCaptcha - A ZK version of Captcha

Governance

• MeloCafe - Anonymous on-chain voting
• Nouns Research Sprint - Anonymous voting research sprint solution with NounsDAO

Social

• FruityFriends - Various circuits (Proof of Intersection, Proof of Proximity, Proof of Proper Secret) to be used in social applications

Contribute

Propose link additions by visiting README.md and click the "pen" icon in the top right corner. Make changes to the file and follow the instructions to create a pull request.

License