Skip to content
/ zk-template Public template

Minimalistic zk-dApps template for Hardhat

License

Notifications You must be signed in to change notification settings

vasemkin/zk-template

Repository files navigation

EVM zk-dApps Template

Overview

This project is a zk-dApps template designed for use with Hardhat, an Ethereum development environment. It provides a starting point for building decentralized applications (dApps) with a focus on zero-knowledge proofs (zk-proofs).

Features

  • Smart contract development in Solidity
  • Integration with Hardhat for Ethereum development
  • Support for zk-proofs using Circom
  • TypeScript and Shell scripts for seamless dApp development

Getting Started

  1. Clone the repository:
    git clone https://github.com/vasemkin/zk-template.git
  2. Install dependencies:
    pnpm install
  3. The pnpm installation should triger the preparation script. If this did not happen, run:
    pnpm prepare
  4. Check that it works:
    pnpm test

Usage

  • Write your circuits in circuits/ folder
  • Modify the build script shell/prepare.sh
  • Modify the src/zk.ts utilties according to your public signals

Acknowledgements

Utility functions are adapted from tornado and zk-merkle-tree repositories.

About

Minimalistic zk-dApps template for Hardhat

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published