Mautjee / noir-next-hardhat-example

This repo is an example project for working with noir-lang

Noir with Next and Hardhat

This example uses Next.js as the frontend framework, and Hardhat to deploy and test.

It also features multiple files and different entry points by resolving multiple files and using the entry_point parameter to the compile function.

Getting Started

1. Install dependencies with

npm i

⚠️ The examples install specific versions of the required @noir-lang npm pacakges. Different versions are not cross compatible. Do not use yarn as it fails to grab the NPM specific versions we need. Noir is being actively developed, so the latest versions of various packages are often incompatible with each other. ⚠️

2. Write circuits in ./circuits/src.

You can read more about writing circuits in Noir on the Noir docs.

3. Create the verifier contract

Although the npm build already generates and compiles the circuits before deploying, you can manually create the Solidity verifier contract:

• natively by navigating to the .circuits/ directory and running nargo codegen-verifier. If you generate the verifier contract via this method, you may need to copy the file created at ./circuits/contract/plonk_vk.sol to the hardhat contract directory at ./contract.
• with wasm by running the genContract.ts script:

npx ts-node scripts/genContract.ts

4. Create proofs

Natively

In ./circuits:

• Compile your circuits if you haven't already with nargo compile <CIRCUIT_NAME>.
• Populate the inputs in Prover.toml
• Generate proof with nargo prove <proof_name>

With Typescript and WASM

• See an example React component in ./components/component.tsx

5. Verify proofs

Natively

In ./circuits:

• Verify proof with nargo verify <proof_name>

With Typescript and WASM

• See the example in ./components/component.tsx

6. Deploy

• Start a local development EVM at http://localhost:8545, for example with npx hardhat node.
• Copy ./.env.example to ./.env and add keys for alchemy (to act as a node) and the deployer's private key. Make sure you have funds in this account.
• Run NETWORK=localhost npm build to build the project and deploy contracts to the local development chain

You can choose any other network in hardhat.config.ts and deploy there using this NETWORK environment variable. For example, NETWORK=mumbai npm build or NETWORK=sepoia npm build. Feel free to contribute with other networks in hardhat.config.ts

Testing

There is an example test file that shows how to compile a Noir program, deploy the Solidity verifier to a test network, generate a proof and verify the proof the natively and via the published Solidity contract, all with Typescript.

You can run the tests with:

npx hardhat test

Note that these tests run against file1.nr. The compilation entry point is specified in the NoirServer class.

One of the tests is checking for a failing proof, so you will see an error printed in the console and all tests should pass (this is expected).

Estimate gas

There is a script to easily check how much gas ethers estimates a call to the verify function will cost.

npm run verify_gas