anonklub/README.md

Content	Description	Status	Live Version
circom	Circom circuits	✔️
discord-bot	Discord Verification Bot	✔️ (circom/snarkjs support only)	anonklub-discord-bot.fly.dev
contracts	Solidity contracts	✔️	Groth16Verifier AnonMinter
nullifier		📆 TO DO
pkgs/cli	Rust CLI	⏳
pkgs/merkle-tree-wasm	Merkle tree Rust crate & corresponding wasm TS package	✔️
pkgs/merkle-tree-worker	Web worker wrapper of the @anonklub/merkle-tree-wasm wasm package	✔️
pkgs/spartan-ecdsa-wasm	Spartan/Sapir circuits & corresponding wasm TS package.	✔️
pkgs/spartan-ecdsa-worker	Web worker wrapper of the @anonklub/spartan wasm package	✔️
queries/crypto_ethereum	Google bigquery-public-data.crypto_ethereum queries examples	✔️
queries/dune_analytics	Dune Analytics queries examples	✔️
queries/the_graph	The Graph queries examples	✔️
query-api	Query API server	✔️	query.anonklub.xyz
ui	User Interface (fetch anonymity sets, generate or verify membership proofs)	✔️	anonklub.xyz

Develop

TLDR

git clone https://github.com/anonklub/anonklub.git
cd anonklub
cp .envrc{.example,}
# edit .envrc
source .envrc
pnpm i
pnpm start.ui

Requirements

Environment

See .envrc.example.
Copy it in an .envrc file and source it.

cp .envrc{.example,}
# edit .envrc
source .envrc

Scripts

Check available scripts with pnpm run.
Especially, to start the ui or the query-api: pnpm start.ui or pnpm start.query-api.
Don't bother run build tasks explicitly beforehand, turbo takes care of topological dependencies between tasks).

Contribute