Noir Web

May 22, 2025 · View on GitHub

A web interface for compiling, proving, and verifying Noir circuits. This project provides a simple way to interact with Noir circuits through a modern web interface.

Features

  • Dynamic circuit compilation
  • Web-based proof generation and verification
  • Real-time terminal-like feedback
  • Support for custom circuits
  • Automatic type generation for circuit inputs

Prerequisites

  • Node.js (v18 or higher)
  • pnpm
  • nargo (Noir package manager)

Installation

  1. Clone the repository:

    git clone https://github.com/gnosisguild/noir-web.git
cd noir-web

  2. Install dependencies:

    cd web && pnpm install

Usage

  1. Edit your circuit in circuits/src/main.nr to change circuit inputs or logic.
  2. Compile and update all necessary files by running: 
    pnpm run do
    This will:
    • Compile your Noir circuit
    • Automatically generate a new Prover.toml template and TypeScript types for the circuit inputs
  3. Edit the generated web/public/circuits/Prover.toml file to provide your input values.
  4. Use the web interface running at localhost:3000 to generate and verify proofs.

Note:
The web interface and setup scripts are now fully dynamic.
You do not need to manually update any frontend or script code when you change your circuit’s input structure—just follow the steps above!

Project Structure

noir-web/
├── circuits/          # Noir circuit source files
│   ├── src/
│   │   └── main.nr    # Your circuit code
│   └── Nargo.toml     # Circuit configuration
├── web/               # Next.js web application
│   ├── public/
│   │   └── circuits/  # Compiled circuits and assets
│   └── src/           # Web application source
└── scripts/           # Build and setup scripts

Development

  • pnpm dev - Start development server
  • pnpm build - Build for production
  • pnpm setup - Compile circuits and generate assets
  • pnpm do - Execute setup and dev sequentially.

License

GNU LESSER GENERAL PUBLIC LICENSE V3