n4ru / hello-noir

Noir boilerplate with hardhat and foundry

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hello-noir: Hardhat x Foundry Template

Demo hosted on: https://hello-noir.netlify.app/

Step-by-Step

  1. git submodule update --init --recursive
  2. forge install
  3. npm install
  4. npm run test:full
  5. npm run deploy

The frontend repo is a submodule under ui/.


Template repository for getting started quickly with Hardhat and Foundry in one project

Github Actions

Getting Started

  • Use Foundry:
forge install
forge test
  • Use Hardhat:
npm install
npx hardhat test

Features

  • Write / run tests with either Hardhat or Foundry:
forge test
# or
npx hardhat test
  • Use Hardhat's task framework
npx hardhat example
  • Install libraries with Foundry which work with Hardhat.
forge install rari-capital/solmate # Already in this repo, just an example

Notes

Whenever you install new libraries using Foundry, make sure to update your remappings.txt file by running forge remappings > remappings.txt. This is required because we use hardhat-preprocessor and the remappings.txt file to allow Hardhat to resolve libraries you install with Foundry.

About

Noir boilerplate with hardhat and foundry

License:Apache License 2.0


Languages

Language:Solidity 95.4%Language:TypeScript 4.2%Language:Shell 0.4%Language:Roff 0.0%