ZK-Groups contracts

Zk-groups smart contracts to manage off-chain groups and verify their zero-knowledge proofs.

👥 Contributing   |   🤝 Code of conduct   |   🔎 Issues   |   🗣️ Chat & Support

---

🛠 Install

npm or yarn

Install the @zk-groups/contracts package with npm:

npm i @zk-groups/contracts

or yarn:

yarn add @zk-groups/contracts

📜 Usage

Compile contracts

Compile the smart contracts with Hardhat:

yarn compile

Testing

Run Mocha to test the contracts:

yarn test

You can also generate a test coverage report:

yarn test:coverage

Or a test gas report:

yarn test:report-gas

Deploy contracts

Deploy a zk-groups contract:

yarn deploy:zkgroups
# or
yarn deploy:zkgroups-semaphore

If you want to deploy contracts on Goerli or Arbitrum, remember to provide a valid private key and an Infura API in your .env file.