Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 12 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
[package]
name = "semaphore-rs"
version = "0.1.0"
name = "semaphore-protocol"
version = "0.1.0-alpha.0"
edition = "2024"
description = "Semaphore Rust Implementation"
license = "MIT"
repository = "https://github.com/semaphore-protocol/semaphore-rs"
keywords = ["semaphore", "zk", "zero-knowledge", "proof", "cryptography"]
categories = ["cryptography", "zk", "semaphore"]
documentation = "https://semaphore.pse.dev/"
readme = "README.md"

[lib]
name = "semaphore"

[dependencies]
blake = "2.0.2"
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Add this to your `Cargo.toml`:

```toml
[dependencies]
semaphore-rs = "0.1"
semaphore-protocol = "0.1"
```

### 📜 Usage
Expand All @@ -84,7 +84,7 @@ semaphore-rs = "0.1"

- Generate a semaphore identity from a string
```rust
use semaphore_rs::identity::Identity;
use semaphore::identity::Identity;
let identity = Identity::new("secret".as_bytes());
```
- Get the identity commitment
Expand All @@ -101,13 +101,13 @@ semaphore-rs = "0.1"
- Generate a group member from an identity

```rust
use semaphore_rs::utils::to_element;
use semaphore::utils::to_element;
let member = to_element(*identity.commitment())
```

- Generate a semaphore group from members
```rust
use semaphore_rs::group::{Element, Group};
use semaphore::group::{Element, Group};
const MEMBER1: Element = [1; 32];
const MEMBER2: Element = [2; 32];
let group = Group::new(&[
Expand All @@ -126,8 +126,8 @@ semaphore-rs = "0.1"
- Generate a semaphore proof

```rust
use semaphore_rs::proof::GroupOrMerkleProof;
use semaphore_rs::proof::Proof;
use semaphore::proof::GroupOrMerkleProof;
use semaphore::proof::Proof;

let message = "message";
let scope = "scope";
Expand Down Expand Up @@ -161,7 +161,7 @@ semaphore-rs = "0.1"
```
- Deserialize a semaphore proof
```rust
use semaphore_rs::proof::SemaphoreProof;
use semaphore::proof::SemaphoreProof;
let proof_imported = SemaphoreProof::import(&proof_json).unwrap();
```

Expand Down
2 changes: 1 addition & 1 deletion tests/group.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ mod group {
use ark_ed_on_bn254::Fq;
use ark_ff::{BigInteger, PrimeField};
use num_bigint::BigInt;
use semaphore_rs::group::{EMPTY_ELEMENT, Element, Group};
use semaphore::group::{EMPTY_ELEMENT, Element, Group};
use std::str::FromStr;

fn str_to_element(s: &str) -> Element {
Expand Down
2 changes: 1 addition & 1 deletion tests/identity.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ mod identity {
use super::*;
use ark_ed_on_bn254::{Fq, Fr};
use ark_ff::{AdditiveGroup, BigInteger, PrimeField};
use semaphore_rs::{
use semaphore::{
baby_jubjub::EdwardsAffine,
error::SemaphoreError,
identity::{Identity, Signature},
Expand Down
Loading