Semaphore data

A library for querying Semaphore smart contract.

🛠 Install

npm or yarn

Install the @semaphore-protocol/data package with npm:

npm i @semaphore-protocol/data
Copy

or yarn:

yarn add @semaphore-protocol/data
Copy

📜 Usage

For detailed information on the functions provided by @semaphore-protocol/data, please refer to the TypeDoc documentation.

Creating and Managing Subgraphs

Initialize a Semaphore Subgraph instance

import { SemaphoreSubgraph } from "@semaphore-protocol/data"

const semaphoreSubgraph = new SemaphoreSubgraph()

// or:
const semaphoreSubgraphOnArbitrum = new SemaphoreSubgraph("arbitrum")

// or:
const customSubgraph = new SemaphoreSubgraph(
    "https://api.studio.thegraph.com/query/14377/<your-subgraph>/<your-version>"
)
Copy

With your SemaphoreSubgraph, you can:

Query Group IDs

const groupIds = await semaphoreSubgraph.getGroupIds()
Copy

Query Group Details

const group = await semaphoreSubgraph.getGroup("42")
const { members, verifiedProofs } = await semaphoreSubgraph.getGroup("42", { members: true, verifiedProofs: true })
Copy

Query Group Members

const members = await semaphoreSubgraph.getGroupMembers("42")
Copy

Query Verified Proofs

const verifiedProofs = await semaphoreSubgraph.getGroupVerifiedProofs("42")
Copy

Check Group Membership

const isMember = await semaphoreSubgraph.isGroupMember(
    "42",
    "16948514235341957898454876473214737047419402240398321289450170535251226167324"
)
Copy

Using Ethers for Direct Blockchain Interaction

Initialize a Semaphore Ethers instance

import { SemaphoreEthers } from "@semaphore-protocol/data"

const semaphoreEthers = new SemaphoreEthers()

// or:
const semaphoreEthersOnHomestead = new SemaphoreEthers("homestead", {
    address: "semaphore-address",
    startBlock: 0
})

// or:
const localEthersInstance = new SemaphoreEthers("http://localhost:8545", {
    address: "semaphore-address"
})
Copy

With your SemaphoreEthers instance, you can:

Fetch Group IDs

const groupIds = await semaphoreEthers.getGroupIds()
Copy

Fetch Group Details

const group = await semaphoreEthers.getGroup("42")
Copy

Fetch Group Admin

const admin = await semaphoreEthers.getGroupAdmin("42")
Copy

Fetch Group Members

const members = await semaphoreEthers.getGroupMembers("42")
Copy

Fetch Validated Proofs

const verifiedProofs = await semaphoreEthers.getGroupValidatedProofs("42")
Copy

Check Group Membership

const isMember = await semaphoreEthers.isGroupMember(
    "42",
    "16948514235341957898454876473214737047419402240398321289450170535251226167324"
)
Copy

Using Viem for Direct Blockchain Interaction

Initialize a Semaphore Viem instance

import { SemaphoreViem } from "@semaphore-protocol/data"

const semaphoreViem = new SemaphoreViem()

// or:
const semaphoreViemOnSepolia = new SemaphoreViem("sepolia", {
    address: "semaphore-address",
    startBlock: 0n
})

// or:
const localViemInstance = new SemaphoreViem("http://localhost:8545", {
    address: "semaphore-address"
})
Copy

With your SemaphoreViem instance, you can:

Fetch Group IDs

const groupIds = await semaphoreViem.getGroupIds()
Copy

Fetch Group Details

const group = await semaphoreViem.getGroup("42")
Copy

Fetch Group Members

const members = await semaphoreViem.getGroupMembers("42")
Copy

Fetch Validated Proofs

const validatedProofs = await semaphoreViem.getGroupValidatedProofs("42")
Copy

Check Group Membership

const isMember = await semaphoreViem.isGroupMember(
    "42",
    "16948514235341957898454876473214737047419402240398321289450170535251226167324"
)
Copy