🦀 Rust support library for semaphore
Go to file
Oskar Thoren 20ff3e34d5
Fix README link
Without this the build fails for me:

```
error: couldn't read src/../Readme.md: No such file or directory (os error 2)
 --> src/lib.rs:1:10
  |
1 | #![doc = include_str!("../Readme.md")]
  |          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```
2022-03-17 19:56:36 +08:00
semaphore@5186a940ff added semaphore submodule 2022-03-06 19:12:39 +01:00
src Fix README link 2022-03-17 19:56:36 +08:00
.gitignore Merge branch 'main' into remco/ci 2022-03-11 10:59:55 -08:00
.gitmodules added semaphore submodule 2022-03-06 19:12:39 +01:00
Cargo.toml Embed circuit 2022-03-11 16:01:52 -08:00
README.md Fix example 2022-03-11 16:13:18 -08:00
criterion.rs Add benchmark 2022-02-28 19:44:30 -08:00
cspell.json Fix clippies 2022-03-11 16:11:06 -08:00
mit-license.md Update crate info 2022-02-01 12:17:05 -08:00
rustfmt.toml Add formating rules 2022-02-01 11:40:49 -08:00

README.md

🦀 semaphore-rs

Rust support library for using semaphore. It's mostly a Rust rewrite of zk-kit, but just focuses on semaphore (for now) and still covers a much smaller scope. It's using ark-circom under the hood for generating the groth16 proofs.

Usage

Add this line to your cargo.toml:

semaphore = { git = "https://github.com/worldcoin/semaphore-rs" }

Building semaphore circuits

  1. Check out submodule (if not done before already): git submodule update --init --recursive
  2. Install semaphore dependencies cd semaphore && npm install
  3. Compile circuits npm exec ts-node ./scripts/compile-circuits.ts
  4. You'll find the zkey and wasm file in semaphore/build/snark

Example

Example as in src/lib.rs, run with cargo test.

use semaphore::{identity::Identity, hash::Hash, poseidon_tree::PoseidonTree,
    protocol::* };
use num_bigint::BigInt;

// generate identity
let id = Identity::new(b"secret");

// generate merkle tree
const LEAF: Hash = Hash::from_bytes_be([0u8; 32]);

let mut tree = PoseidonTree::new(21, LEAF);
tree.set(0, id.commitment().into());

let merkle_proof = tree.proof(0).expect("proof should exist");
let root = tree.root();

// change signal and external_nullifier here
let signal = b"xxx";
let external_nullifier = b"appId";

let external_nullifier_hash = hash_external_nullifier(external_nullifier);
let nullifier_hash = generate_nullifier_hash(&id, external_nullifier_hash);

let proof = generate_proof(&id, &merkle_proof, external_nullifier, signal).unwrap();
let success = verify_proof(root.into(), nullifier_hash, signal, external_nullifier, &proof).unwrap();

assert!(success);