@big-whale-labs/seal-hub-verifier-template
v0.1.3
Published
SealHub verifier template
Downloads
4
Keywords
Readme
SealHub verifier template
Circom template to be used to verify a SealHub commitment.
Usage
- Clone the repository with
git clone [email protected]:BigWhaleLabs/seal-hub-verifier-template.git
- Install the dependencies with
yarn
- Add environment variables to your
.env
file - Check out
yarn generate-inputs
script to get 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 - 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
Environment variables
| 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.
Available scripts
yarn build
— compiles the contracts' ts interfaces to thetypechain
directoryyarn compile
- compiles the circom circuit, creates proof, verifies proof, exports verifier as a solidity file, exports artifacts to thepublic
directoryyarn test
— runs the test suiteyarn deploy
— deploys the contract to the networkyarn eth-lint
— runs the linter for the solidity contractsyarn lint
— runs all the lintersyarn prettify
— prettifies the code in th projectyarn release
— relases thetypechain
directory to NPMyarn download-ptau
— downloads the correct ptau file