https://github.com/kendricktan/hello-world-zk-dapp

A simple but practical (zero knowledge) hello world project, built for Ethereum
https://github.com/kendricktan/hello-world-zk-dapp

Last synced: 14 days ago
JSON representation

A simple but practical (zero knowledge) hello world project, built for Ethereum

• Host: GitHub
• URL: https://github.com/kendricktan/hello-world-zk-dapp
• Owner: kendricktan
• License: mit
• Created: 2020-02-01T19:16:53.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-04T16:07:18.000Z (almost 5 years ago)
• Last Synced: 2024-04-14T11:32:49.381Z (7 months ago)
• Language: JavaScript
• Size: 271 KB
• Stars: 71
• Watchers: 5
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hello-world-zk-dapp

A simple but practical (zero knowledge) hello world project, tested on `ganache-cli`.

## What does it do?

Simply put, the zero-knowledge dapp is responsible to verify if a user belongs to a certain group, without revealing any more additional information (i.e. who the user is).

# Getting Started

```bash

git clone https://github.com/kendricktan/hello-world-zk-dapp.git

cd hello-world-zk-dapp

npm install

# Linux/Mac

# Note: Only tested on node:12.14.1

# This starts up a ganache-cli process,

# compiles the zk-snark circuits,

# deploys the smart contracts

# and finally generate some proofs to verify

# if the user is part of the group or not

npm run start

# Docker

docker build . -t zkdapp

docker run zkdapp

```

# Project Structure

```bash

packages

  ├── circuits    # Zero knowledge circuits

  ├── contracts   # Smart contract logic

  └── scripts     # Scripts to interact with the deploy contracts

```