AtHeartEngineer/zkp-app-boilerplate

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

TypeScriptGPL-3.0

Zk app boilerplate

Pre requisites

Install rust and circom2

Getting started

Clone or fork this template repository.

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

Install packages
```
yarn
```
Build: this compiles the circuits and exports artifacts. Then compiles the contracts and generate typescript clients.
```
yarn build
```
Run a demo app using a localhost private network.
```
yarn demo
```

Run tests

Test contracts
```
yarn workspace contracts test
```
Test your circuits
```
yarn workspace circuits test
```
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.