RLN contract
Go to file
Aaryamann Challani 4b87223904
Merge pull request #18 from vacp2p/natspec-comments
docs: natspec comments + docgen
2023-03-30 17:03:20 +05:30
.github/workflows fix: workaround assumePayable 2023-03-29 17:51:48 +05:30
.husky docs: natspec, docgen 2023-03-30 12:24:58 +05:30
contracts docs: natspec, docgen 2023-03-30 12:24:58 +05:30
deploy feat: integrate plugins from rln-interep-contract 2023-03-29 11:58:09 +05:30
deployments feat: deployed to sepolia 2023-03-29 12:43:14 +05:30
docs docs: natspec, docgen 2023-03-30 12:24:58 +05:30
lib feat: foundry integration 2023-03-29 12:28:42 +05:30
test fix: workaround assumePayable 2023-03-29 17:51:48 +05:30
.env.example feat: foundry integration 2023-03-29 12:28:42 +05:30
.eslintignore Initializing Repository 2022-06-23 15:36:10 +02:00
.eslintrc.js Initializing Repository 2022-06-23 15:36:10 +02:00
.gitignore fix: use foundry reporter instead 2023-03-29 14:17:51 +05:30
.gitmodules feat: foundry integration 2023-03-29 12:28:42 +05:30
.npmignore Initializing Repository 2022-06-23 15:36:10 +02:00
.prettierignore Initializing Repository 2022-06-23 15:36:10 +02:00
.prettierrc Initializing Repository 2022-06-23 15:36:10 +02:00
.solcover.js feat: integrate plugins from rln-interep-contract 2023-03-29 11:58:09 +05:30
.solhint.json Initializing Repository 2022-06-23 15:36:10 +02:00
.solhintignore Initializing Repository 2022-06-23 15:36:10 +02:00
LICENSE-APACHE feat: integrate plugins from rln-interep-contract 2023-03-29 11:58:09 +05:30
LICENSE-MIT feat: integrate plugins from rln-interep-contract 2023-03-29 11:58:09 +05:30
README.md feat: integrate plugins from rln-interep-contract 2023-03-29 11:58:09 +05:30
foundry.toml feat: foundry integration 2023-03-29 12:28:42 +05:30
hardhat.config.ts docs: natspec, docgen 2023-03-30 12:24:58 +05:30
package.json docs: natspec, docgen 2023-03-30 12:24:58 +05:30
tsconfig.json feat: integrate plugins from rln-interep-contract 2023-03-29 11:58:09 +05:30
yarn.lock docs: natspec, docgen 2023-03-30 12:24:58 +05:30

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
  • Foundry / Foundryup
    • This will install forge, cast, and anvil
    • You can test you've installed them right by running forge --version and get an output like: forge 0.2.0 (92f8951 2022-08-06T00:09:32.96582Z)
    • To get the latest of each, just run foundryup
  • 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.