sfyr111 / zkp-app-boilerplate

Build your zkp app with typescript, hardhat, circom, and snarkjs!

Zk app boilerplate

Pre requisites

• Install rust and circom2

Getting started

1. Clone or fork this template repository.

   git clone https://github.com/wanseob/zkp-app-boilerplate

2. Install packages

   yarn

3. Build: this compiles the circuits and exports artifacts. Then compiles the contracts and generate typescript clients.

   yarn build

4. Run a demo app using a localhost private network.

   yarn demo

Run tests

1. Test contracts

   yarn workspace contracts test

2. Test your circuits

   yarn workspace circuits test

3. Test your app

   yarn workspace app test

Example: EdDSA signature rollup

Let's compress EdDSA signatures into one zk proof! Go to tutorial!

To check the complete codes, visit the tutorial branch.