ZKFlex NFT (built from tornado-core)

This is a decentralized application that allows users to mint wealth-flex NFTs without revealing their identity.

Application type

zkDAO

Overview

AnonyFlex enables users to flex their wealth with privacy. Users deposit 100 ETH (ONE) into the mixer in exchange of which they get a credit note (secret note) to mint wealth-flex NFTs. Any wallet presenting a valid credit note will be able to mint a flex NFT club token (FNC). FNC tokens are non transferable making deposits to the mixer a must for users. User balances are redeemable almost immediately (after 2 blocks) after deposit.

Use Cases

This application will serve as a DAO tool to allow decentralized organizations to authenticate users based upon their net worth without violating their privacy. According to the Messari Report, DAO tooling is an existential need right now across crypto communities and privacy has always been a major concern in the blockchain space. A major problem when joining blockchain communities is privacy. On the one hand, it is important for a community to know the newcomers' merits. On the other hand, it is important for new members to be able to protect their privacy. The problem here is how can a new member prove their merits without revealing their identity.

In this project we realize one aspect of new members' merit, i.e., net worth, with full privacy guarantees

Contracts

Harmony Mainnent

Hasher: 0x334CD66ed692520788B83eC18d5F649caFF5176d

Verifier: 0x354F18AfC2668781ef864E7A7169ac304b6E0994

Flex Club: 0x9133A9c9Fe6cA8BDd14BbA719250aA20F8A4fEe4

Flex NFT (ERC721): 0x3B31ECf60636a2EEAc47797Be7Afa67D0C0e6B21

Harmony Testnet

Hasher: ``

Verifier: ``

Flex Club: 0x49ab8Ec181dD5357b9Fc19d9AB4Adbd7DE121256

Flex NFT (ERC721): 0xdAffcb3EAD9479e408134AF1c2533C5299c8c4b7

Frontend(s)

https://mr-ma.github.io/zkflex-website/

Requirements

1. node v16.15.0
2. npm install -g npx
3. npm install -g browserify@17.0.0

Usage

You can see example usage in cli.js, it works both in the console and in the browser.

1. npm install
2. cp .env.example .env
3. npm run build - this may take 10 minutes or more
4. npx ganache-cli -e 20000000
5. npm run test - optionally runs tests. It may fail on the first try, just run it again.

Frontend (Website)

1. browserify src/cli.js -o frontend/index.js --exclude worker_threads
2. cd frontend
3. vim config.json
4. Input your config, address of contracts, flex amount, and genesis block

{
    "flexclub_address": "0x849fBDb3A5ab97095a1BdEd618FE578D5d159de3",
    "flexnft_address": "0xEB49f2D00c72F02485E1031c0e8bf76f107A3a67",
    "eth_amount": "100000000000000000000",
    "genesis_block": 24808523
}

1. npx http-server

CLI

./cli.js deposit ETH 0.1 --rpc http://127.0.0.1:8545

Your note: flexclub-eth-0.1-42-0xf73dd6833ccbcc046c44228c8e2aa312bf49e08389dadc7c65e6a73239867b7ef49c705c4db227e2fadd8489a494b6880bdcb6016047e019d1abec1c7652 FlexClub ETH balance is 8.9 Sender account ETH balance is 1004873.470619891361352542 Submitting deposit transaction FlexClub ETH balance is 9 Sender account ETH balance is 1004873.361652048361352542

./cli.js withdraw flexclub-eth-0.1-42-0xf73dd6833ccbcc046c44228c8e2aa312bf49e08389dadc7c65e6a73239867b7ef49c705c4db227e2fadd8489a494b6880bdcb6016047e019d1abec1c7652 0x8589427373D6D84E98730D7795D8f6f8731FDA16 --rpc http://127.0.0.1:8545

Getting current state from FlexClub contract Generating SNARK proof Proof time: 9117.051ms Transaction submitted Transaction mined in block 17036120 Done

Deploy ETH FlexClub

1. cp .env.example .env
2. Tune all necessary params
3. npx truffle migrate --network harmonyTest --reset --f 2 --to 4

Credits

Special thanks to Tornado Cash team for open sourcing their repository.

Minimal demo example

1. npm i
2. ganache-cli -d
3. npm run download
4. npm run build:contract
5. cp .env.example .env
6. npm run migrate:dev
7. node minimal-demo.js

Run tests/coverage

Prepare test environment:

   yarn install
   yarn download
   cp .env.example .env
   npx ganache-cli > /dev/null &
   npm run migrate:dev

Run tests:

   yarn test

Run coverage:

   yarn coverage

Emulate MPC trusted setup ceremony

cargo install zkutil
npx circom circuits/withdraw.circom -o build/circuits/withdraw.json
zkutil setup -c build/circuits/withdraw.json -p build/circuits/withdraw.params
zkutil export-keys -c build/circuits/withdraw.json -p build/circuits/withdraw.params -r build/circuits/withdraw_proving_key.json -v build/circuits/withdraw_verification_key.json
zkutil generate-verifier -p build/circuits/withdraw.params -v build/circuits/Verifier.sol
sed -i -e 's/pragma solidity \^0.6.0/pragma solidity 0.5.17/g' ./build/circuits/Verifier.sol