# @semaphore-protocol/data
> A library for querying Semaphore smart contract.
Latest version **4.14.3** (published 2026-07-08) · MIT license · 0 weekly downloads
## Install
```sh
npm install @semaphore-protocol/data
pnpm add @semaphore-protocol/data
yarn add @semaphore-protocol/data
bun add @semaphore-protocol/data
```
## Health
**Score 65/100 (B)** — status: active.
Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.
Warnings: low downloads.
## Facts
| | |
|---|---|
| Version | 4.14.3 |
| Published | 2026-07-08 |
| First published | 2023-03-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 146.9 KB |
| Known vulnerabilities | 0 (+29 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1085 |
| Maintainers | vplasencia, johnguilding, errmac, nicoserranop |
## Links
- npm: https://www.npmjs.com/package/@semaphore-protocol/data
- Repository: https://github.com/semaphore-protocol/semaphore
- Homepage: https://github.com/semaphore-protocol/semaphore/tree/main/packages/data
- Issues: https://github.com/semaphore-protocol/semaphore.git/issues
- npm.io page: https://npm.io/package/@semaphore-protocol/data
## Dependencies (5)
- [viem](https://npm.io/package/viem.md) 2.23.7
- [axios](https://npm.io/package/axios.md) 1.6.6
- [ethers](https://npm.io/package/ethers.md) 6.13.4
- [@zk-kit/utils](https://npm.io/package/@zk-kit/utils.md) 1.3.0
- [@semaphore-protocol/utils](https://npm.io/package/@semaphore-protocol/utils.md) 4.14.3
## Recent versions
- 4.14.3 (latest) — 2026-07-08
- 4.14.2 — 2026-01-23
- 4.14.1 — 2026-01-19
- 4.14.0 — 2025-10-27
- 4.13.2 — 2025-10-13
- 4.13.1 — 2025-09-08
- 4.13.0 — 2025-08-27
- 4.13.0-beta.1 — 2025-07-23
- 4.13.0-beta.0 — 2025-07-22
- 4.12.1 — 2025-07-21
- 4.12.0 — 2025-07-17
- 4.11.1 — 2025-05-21
- 4.11.0 — 2025-05-20
- 4.10.0 — 2025-05-06
- 4.9.2 — 2025-03-31
- … 81 more at https://npm.io/package/@semaphore-protocol/data/versions
## README
Semaphore data
A library for querying Semaphore smart contract.
| This library provides tools for querying and interacting with the [`Semaphore.sol`](https://github.com/semaphore-protocol/semaphore/blob/main/packages/contracts/contracts/Semaphore.sol) smart contract. It supports the Semaphore subgraph and direct Ethereum network connections via Ethers or Viem. Designed for use in both Node.js and browser environments, it facilitates the management of group data and verification processes within the Semaphore protocol. |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
## 🛠 Install
### npm or yarn
Install the `@semaphore-protocol/data` package with npm:
```bash
npm i @semaphore-protocol/data
```
or yarn:
```bash
yarn add @semaphore-protocol/data
```
## 📜 Usage
For detailed information on the functions provided by `@semaphore-protocol/data`, please refer to the [TypeDoc documentation](https://js.semaphore.pse.dev/modules/_semaphore_protocol_data).
### Creating and Managing Subgraphs
**Initialize a Semaphore Subgraph instance**
```typescript
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//"
)
```
With your SemaphoreSubgraph, you can:
**Query Group IDs**
```typescript
const groupIds = await semaphoreSubgraph.getGroupIds()
```
**Query Group Details**
```typescript
const group = await semaphoreSubgraph.getGroup("42")
const { members, verifiedProofs } = await semaphoreSubgraph.getGroup("42", { members: true, verifiedProofs: true })
```
**Query Group Members**
```typescript
const members = await semaphoreSubgraph.getGroupMembers("42")
```
**Query Verified Proofs**
```typescript
const verifiedProofs = await semaphoreSubgraph.getGroupVerifiedProofs("42")
```
**Check Group Membership**
```typescript
const isMember = await semaphoreSubgraph.isGroupMember(
"42",
"16948514235341957898454876473214737047419402240398321289450170535251226167324"
)
```
### Using Ethers for Direct Blockchain Interaction
**Initialize a Semaphore Ethers instance**
```typescript
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"
})
```
With your SemaphoreEthers instance, you can:
**Fetch Group IDs**
```typescript
const groupIds = await semaphoreEthers.getGroupIds()
```
**Fetch Group Details**
```typescript
const group = await semaphoreEthers.getGroup("42")
```
**Fetch Group Admin**
```typescript
const admin = await semaphoreEthers.getGroupAdmin("42")
```
**Fetch Group Members**
```typescript
const members = await semaphoreEthers.getGroupMembers("42")
```
**Fetch Validated Proofs**
```typescript
const verifiedProofs = await semaphoreEthers.getGroupValidatedProofs("42")
```
**Check Group Membership**
```typescript
const isMember = await semaphoreEthers.isGroupMember(
"42",
"16948514235341957898454876473214737047419402240398321289450170535251226167324"
)
```
### Using Viem for Direct Blockchain Interaction
**Initialize a Semaphore Viem instance**
```typescript
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"
})
```
With your SemaphoreViem instance, you can:
**Fetch Group IDs**
```typescript
const groupIds = await semaphoreViem.getGroupIds()
```
**Fetch Group Details**
```typescript
const group = await semaphoreViem.getGroup("42")
```
**Fetch Group Members**
```typescript
const members = await semaphoreViem.getGroupMembers("42")
```
**Fetch Validated Proofs**
```typescript
const validatedProofs = await semaphoreViem.getGroupValidatedProofs("42")
```
**Check Group Membership**
```typescript
const isMember = await semaphoreViem.isGroupMember(
"42",
"16948514235341957898454876473214737047419402240398321289450170535251226167324"
)
```
---
_Source: https://npm.io/package/@semaphore-protocol/data · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._