Allow Map ZKP for Ketl

Usage

Clone the repository with git clone git@github.com:BigWhaleLabs/ketl-allow-map-contract.git
Install the dependencies with yarn
Add environment variables to your .env file
Check out yarn generate-inputs script and modify it so that you get the correct inputs are generated for your circuits, then run yarn generate-inputs
Run yarn compile to compile the circom circuits, create proof, verify proof, export verifier as a solidity Verifier.sol
Run yarn test to run the test suits and make sure your circuits are robust
Use the artifacts from the public folder in snarkjs
Run yarn deploy to deploy the verifier smart contracts to blockchain
Run yarn release to publish an NPM package with typings that can later be used in any of your JS/TS projects

Check out scripts/compile-circuit.sh for complete understanding of what's going on when compiling the circuits
Feel free to increase/decrease tau factors in the pot folder as you number of constraints grows or shrinks

Name	Description
`ETHERSCAN_API_KEY`	Etherscan API key
`ETH_RPC`	Ethereum RPC URL
`CONTRACT_OWNER_PRIVATE_KEY`	Private key of the contract owner

Also check out the .env.example file for more information.

yarn build — compiles the contracts' ts interfaces to the typechain directory
yarn compile - compiles the circom circuit, creates proof, verifies proof, exports verifier as a solidity file, exports artifacts to the public directory
yarn test — runs the test suite
yarn deploy — deploys the contract to the network
yarn eth-lint — runs the linter for the solidity contracts
yarn lint — runs all the linters
yarn prettify — prettifies the code in th project
yarn release — relases the typechain directory to NPM