4b87223904
docs: natspec comments + docgen |
||
|---|---|---|
| .github/workflows | ||
| .husky | ||
| contracts | ||
| deploy | ||
| deployments | ||
| docs | ||
| lib | ||
| test | ||
| .env.example | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .gitmodules | ||
| .npmignore | ||
| .prettierignore | ||
| .prettierrc | ||
| .solcover.js | ||
| .solhint.json | ||
| .solhintignore | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| foundry.toml | ||
| hardhat.config.ts | ||
| package.json | ||
| tsconfig.json | ||
| yarn.lock | ||
README.md
Hardhat Project for rln-contract
Requirements
The following will need to be installed in order to use this repo. Please follow the links and instructions.
- Git
- You'll know you've done it right if you can run
git --version
- You'll know you've done it right if you can run
- Foundry / Foundryup
- This will install
forge,cast, andanvil - You can test you've installed them right by running
forge --versionand get an output like:forge 0.2.0 (92f8951 2022-08-06T00:09:32.96582Z) - To get the latest of each, just run
foundryup
- This will install
- Yarn
Compilation
yarn compile
Testing with Hardhat
yarn test:hardhat
Testing with Foundry
yarn test:foundry
Deploying
- To deploy on local node, first start the local node and then run the deploy script
yarn node
npx deploy:localhost
- To deploy to an target network (like Sepolia), use the name as mentioned in the Hardhat config file.
yarn deploy:sepolia
References
For more information, see https://hardhat.org/hardhat-runner/docs/guides/project-setup
License
Dual-licensed under MIT or Apache 2.0, refer to LICENSE-MIT or LICENSE-APACHE for more information.