73 | );
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/vite-hardhat/hardhat.config.cts:
--------------------------------------------------------------------------------
1 | import '@nomicfoundation/hardhat-toolbox-viem';
2 | import '@nomicfoundation/hardhat-viem';
3 | import '@nomicfoundation/hardhat-chai-matchers';
4 | import 'hardhat-noirenberg';
5 |
6 | import { writeFileSync } from 'fs';
7 | import { Chain } from 'viem';
8 | import { task, vars } from 'hardhat/config';
9 | import { HardhatUserConfig } from 'hardhat/types/config';
10 | import fs from 'fs';
11 | import { resolve } from 'path';
12 |
13 | const config: HardhatUserConfig = {
14 | solidity: {
15 | version: '0.8.28',
16 | settings: {
17 | optimizer: { enabled: true, runs: 5000 },
18 | },
19 | },
20 | defaultNetwork: 'localhost',
21 | networks: {
22 | localhost: {
23 | url: 'http://127.0.0.1:8545',
24 | chainId: 31337,
25 | accounts: vars.has('localhost')
26 | ? [vars.get('localhost')]
27 | : ['0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80'],
28 | },
29 | scrollSepolia: {
30 | url: 'https://sepolia-rpc.scroll.io',
31 | accounts: vars.has('scrollSepolia') ? [vars.get('scrollSepolia')] : [],
32 | },
33 | holesky: {
34 | url: 'https://holesky.drpc.org',
35 | accounts: vars.has('holesky') ? [vars.get('holesky')] : [],
36 | },
37 | },
38 | paths: {
39 | root: 'packages',
40 | tests: 'tests',
41 | },
42 | };
43 |
44 | task('deploy', 'Deploys a verifier contract')
45 | .addOptionalPositionalParam('provingSystem')
46 | .setAction(async (taskArgs, hre) => {
47 | const contractsDir = resolve('packages', 'contracts');
48 | if (fs.existsSync(contractsDir)) fs.rmdirSync(contractsDir, { recursive: true });
49 |
50 | hre.config.noirenberg = { provingSystem: taskArgs.provingSystem || 'UltraPlonk' };
51 | await hre.run('compile');
52 |
53 | let verifier;
54 | if (taskArgs.provingSystem === 'UltraHonk') {
55 | verifier = await hre.viem.deployContract('HonkVerifier');
56 | } else {
57 | verifier = await hre.viem.deployContract('UltraVerifier');
58 | }
59 |
60 | const networkConfig = (await import(`viem/chains`))[hre.network.name] as Chain;
61 | const config = {
62 | name: hre.network.name,
63 | address: verifier.address,
64 | networkConfig: {
65 | ...networkConfig,
66 | id: hre.network.config.chainId,
67 | },
68 | };
69 |
70 | console.log(
71 | `Attached to address ${verifier.address} at network ${hre.network.name} with chainId ${networkConfig.id}...`,
72 | );
73 | writeFileSync('deployment.json', JSON.stringify(config), { flag: 'w' });
74 | });
75 |
76 | export default config;
77 |
--------------------------------------------------------------------------------
/vite-hardhat/README.md:
--------------------------------------------------------------------------------
1 | # Noir with Vite and Hardhat
2 |
3 | [](https://app.netlify.com/sites/noir-vite-hardhat/deploys)
4 |
5 | This example uses [Vite](https://vite.dev/) as the frontend framework, and
6 | [Hardhat](https://hardhat.org/) to deploy and test.
7 |
8 | ## Getting Started
9 |
10 | Want to get started in a pinch? Start your project in a free Github Codespace!
11 |
12 | [](https://codespaces.new/noir-lang/noir-starter/tree/main)
13 |
14 | ## Locally
15 |
16 | 1. Install your favorite package manager. We'll use [bun](https://bun.sh/docs/installation) but feel
17 | free to use `yarn` or others:
18 |
19 | ```bash
20 | curl -fsSL https://bun.sh/install | bash
21 | ```
22 |
23 | 2. Install dependencies:
24 |
25 | ```bash
26 | bun i
27 | ```
28 |
29 | 3. Run a node
30 |
31 | ```bash
32 | bunx hardhat node
33 | ```
34 |
35 | 4. Deploy the verifier contract (UltraPlonk)
36 |
37 | ```bash
38 | bun run deploy
39 | ```
40 |
41 | 5. Run the dev environment
42 |
43 | ```bash
44 | bun dev
45 | ```
46 |
47 | ### Testing
48 |
49 | You can run the [example test file](./test/index.test.ts) with
50 |
51 | ```bash
52 | bun run test
53 | ```
54 |
55 | This test shows the basic usage of Noir in a TypeScript Node.js environment. It also starts its own network and deploys the verifier contract.
56 |
57 | If you want to test only `UltraHonk`, you can run:
58 |
59 | ```bash
60 | bun run test:uh
61 | ```
62 |
63 | ### Deploying on other networks
64 |
65 | The default scripting targets a local environment. For convenience, we added some configurations for
66 | deployment on various other networks. You can see the existing list by running:
67 |
68 | ```bash
69 | bunx hardhat vars setup
70 | ```
71 |
72 | If you want to deploy on any of them, just pass in a private key, for example for the holesky
73 | network:
74 |
75 | ```bash
76 | bunx hardhat vars set holesky
77 | ```
78 |
79 | You can then deploy on that network by passing the `--network` flag. For example:
80 |
81 | ```bash
82 | bunx hardhat deploy --network holesky # deploys on holesky
83 | ```
84 |
85 | Feel free to add more networks, as long as they're supported by `wagmi`
86 | ([list here](https://wagmi.sh/react/api/chains#available-chains)). Just make sure you:
87 |
88 | - Have funds in these accounts
89 | - Add their configuration in the `networks` property in `hardhat.config.cts`
90 | - Use the name that wagmi expects (for example `ethereum` won't work, as `wagmi` calls it `mainnet`)
91 |
--------------------------------------------------------------------------------
/with-foundry/README.md:
--------------------------------------------------------------------------------
1 | # Noir with Foundry
2 |
3 | This example uses Foundry to deploy and test a verifier.
4 |
5 | ## Getting Started
6 |
7 | Want to get started in a pinch? Start your project in a free Github Codespace!
8 |
9 | [](https://codespaces.new/noir-lang/noir-starter)
10 |
11 | In the meantime, follow these simple steps to work on your own machine:
12 |
13 | Install [noirup](https://noir-lang.org/docs/getting_started/noir_installation) with
14 |
15 | 1. Install [noirup](https://noir-lang.org/docs/getting_started/noir_installation):
16 |
17 | ```bash
18 | curl -L https://raw.githubusercontent.com/noir-lang/noirup/main/install | bash
19 | ```
20 |
21 | 2. Install Nargo:
22 |
23 | ```bash
24 | noirup
25 | ```
26 |
27 | 3. Install foundryup and follow the instructions on screen. You should then have all the foundry
28 | tools like `forge`, `cast`, `anvil` and `chisel`.
29 |
30 | ```bash
31 | curl -L https://foundry.paradigm.xyz | bash
32 | ```
33 |
34 | 4. Install foundry dependencies by running `forge install 0xnonso/foundry-noir-helper --no-commit`.
35 |
36 | 5. Install `bbup`, the tool for managing Barretenberg versions, by following the instructions
37 | [here](https://github.com/AztecProtocol/aztec-packages/blob/master/barretenberg/bbup/README.md#installation).
38 |
39 | 6. Then run `bbup`.
40 |
41 | ## Generate verifier contract and proof
42 |
43 | ### Contract
44 |
45 | The deployment assumes a verifier contract has been generated by nargo. In order to do this, run:
46 |
47 | ```bash
48 | cd circuits
49 | nargo compile
50 | bb write_vk -b ./target/with_foundry.json
51 | bb contract
52 | ```
53 |
54 | A file named `contract.sol` should appear in the `circuits/target` folder.
55 |
56 | ### Test with Foundry
57 |
58 | We're ready to test with Foundry. There's a basic test inside the `test` folder that deploys the
59 | verifier contract, the `Starter` contract and two bytes32 arrays correspondent to good and bad
60 | solutions to your circuit.
61 |
62 | By running the following command, forge will compile the contract with 5000 rounds of optimization
63 | and the London EVM version. **You need to use these optimizer settings to suppress the "stack too
64 | deep" error on the solc compiler**. Then it will run the test, expecting it to pass with correct
65 | inputs, and fail with wrong inputs:
66 |
67 | ```bash
68 | forge test --optimize --optimizer-runs 5000 --evm-version cancun
69 | ```
70 |
71 | #### Testing On-chain
72 |
73 | You can test that the Noir Solidity verifier contract works on a given chain by running the
74 | `Verify.s.sol` script against the appropriate RPC endpoint.
75 |
76 | ```bash
77 | forge script script/Verify.s.sol --rpc-url $RPC_ENDPOINT --broadcast
78 | ```
79 |
80 | If that doesn't work, you can add the network to Metamask and deploy and test via
81 | [Remix](https://remix.ethereum.org/).
82 |
83 | Note that some EVM network infrastructure may behave differently and this script may fail for
84 | reasons unrelated to the compatibility of the verifier contract.
85 |
86 | ### Deploy with Foundry
87 |
88 | This template also has a script to help you deploy on your own network. But for that you need to run
89 | your own node or, alternatively, deploy on a testnet.
90 |
91 | #### (Option 1) Run a local node
92 |
93 | If you want to deploy locally, run a node by opening a terminal and running
94 |
95 | ```bash
96 | anvil
97 | ```
98 |
99 | This should start a local node listening on `http://localhost:8545`. It will also give you many
100 | private keys.
101 |
102 | Edit your `.env` file to look like:
103 |
104 | ```
105 | ANVIL_RPC=http://localhost:8545
106 | LOCALHOST_PRIVATE_KEY=
107 | ```
108 |
109 | #### (Option 2) Prepare for testnet
110 |
111 | Pick a testnet like Sepolia or Goerli. Generate a private key and use a faucet (like
112 | [this one for Sepolia](https://sepoliafaucet.com/)) to get some coins in there.
113 |
114 | Edit your `.env` file to look like:
115 |
116 | ```env
117 | SEPOLIA_RPC=https://rpc2.sepolia.org
118 | LOCALHOST_PRIVATE_KEY=
119 | ```
120 |
121 | #### Run the deploy script
122 |
123 | You need to source your `.env` file before deploying. Do that with:
124 |
125 | ```bash
126 | source .env
127 | ```
128 |
129 | Then run the deployment with:
130 |
131 | ```bash
132 | forge script script/Starter.s.sol --rpc-url $ANVIL_RPC --broadcast --verify
133 | ```
134 |
135 | Replace `$ANVIL_RPC` with the testnet RPC, if you're deploying on a testnet.
136 |
137 | ## Developing on this template
138 |
139 | This template doesn't include settings you may need to deal with syntax highlighting and
140 | IDE-specific settings (i.e. VScode). Please follow the instructions on the
141 | [Foundry book](https://book.getfoundry.sh/config/vscode) to set that up.
142 |
143 | It's **highly recommended** you get familiar with [Foundry](https://book.getfoundry.sh) before
144 | developing on this template.
145 |
--------------------------------------------------------------------------------