vacp2p
/
rln-contract
mirror of https://github.com/vacp2p/rln-contract.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
RLN contract
81 Commits 13 Branches 0 Tags 7.8 MiB
Shell 90.2%
Python 9.8%
Go to file
rymnc 443cbfc9c4
incl: certora spec 		2023-12-05 14:37:05 +05:30
.github fix: ci, add pnpm to github action 2023-12-05 14:33:35 +05:30
.husky docs: natspec, docgen 2023-03-30 12:24:58 +05:30
certora incl: certora spec 2023-12-05 14:37:05 +05:30
deployments chore: add deployments 2023-12-04 16:36:18 +05:30
lib fix: make tests compile with forge-std@1.6.0 2023-08-08 20:45:12 +02:00
script fix: sol versions, solhintignore 2023-12-04 17:48:15 +05:30
src fix: sol versions, solhintignore 2023-12-04 17:48:15 +05:30
test fix: sol versions, solhintignore 2023-12-04 17:48:15 +05:30
.editorconfig chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
.env.example chore: add deployments 2023-12-04 16:36:18 +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
.gas-snapshot chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
.gitattributes chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
.gitignore chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
.gitmodules chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
.npmignore Initializing Repository 2022-06-23 15:36:10 +02:00
.prettierignore chore: add deployments to .prettierignore 2023-12-05 14:20:31 +05:30
.prettierrc Initializing Repository 2022-06-23 15:36:10 +02:00
.prettierrc.yml chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
.solcover.js feat: integrate plugins from rln-interep-contract 2023-03-29 11:58:09 +05:30
.solhint.json chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
.solhintignore fix: sol versions, solhintignore 2023-12-04 17:48:15 +05:30
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
LICENSE.md chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
PROPERTIES.md chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
README.md fix: sol versions, solhintignore 2023-12-04 17:48:15 +05:30
codecov.yml chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
foundry.toml chore: add deployments 2023-12-04 16:36:18 +05:30
package.json chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
pnpm-lock.yaml chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
remappings.txt chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30
slither.config.json chore: move to vacp2p/foundry-template 2023-12-04 15:14:24 +05:30

README.md

rln-contract Github Actions Foundry License: MIT

A Foundry-based project for Rate Limiting Nullifiers.

Getting Started

pnpm install # install Solhint, Prettier, and other Node.js deps
forge install # install Foundry's dependencies

If this is your first time with Foundry, check out the installation instructions.

Usage

Compilation

forge build

Format

forge fmt

Clean

Deletes the build artifacts and cache directories:

forge clean

Gas Usage

Get a gas report:

forge test --gas-report

Test

Run the tests:

forge test

Deployment

Ensure you setup the .env file with the correct values mentioned in the .env.example file.

./script/deploy.sh rln <network>

Where <network> is one of -

  • sepolia
  • polygon-zkevm

This will deploy the RLN contract, with its associated libraries to the specified network. If forge supports the network, it will also verify the contract on the block explorer.

License

This project is dual licensed under MIT and APACHE-2.0.