# @semaphore-protocol/proof
> A library to generate and verify Semaphore proofs.
Latest version **4.14.3** (published 2026-07-08) · MIT license · 0 weekly downloads
## Install
```sh
npm install @semaphore-protocol/proof
pnpm add @semaphore-protocol/proof
yarn add @semaphore-protocol/proof
bun add @semaphore-protocol/proof
```
## 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 | 2022-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 227.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1088 |
| Maintainers | vplasencia, johnguilding, errmac, nicoserranop |
## Links
- npm: https://www.npmjs.com/package/@semaphore-protocol/proof
- Repository: https://github.com/semaphore-protocol/semaphore
- Homepage: https://github.com/semaphore-protocol/semaphore/tree/main/packages/proof
- Issues: https://github.com/semaphore-protocol/semaphore.git/issues
- npm.io page: https://npm.io/package/@semaphore-protocol/proof
## Dependencies (5)
- [ethers](https://npm.io/package/ethers.md) 6.13.4
- [snarkjs](https://npm.io/package/snarkjs.md) 0.7.5
- [@zk-kit/utils](https://npm.io/package/@zk-kit/utils.md) 1.3.0
- [@zk-kit/artifacts](https://npm.io/package/@zk-kit/artifacts.md) 2.0.1
- [@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
- … 105 more at https://npm.io/package/@semaphore-protocol/proof/versions
## README
Semaphore proof
A library to generate and verify Semaphore proofs.
| This library provides utility functions to generate and verify Semaphore proofs compatible with the Semaphore [circuits](https://github.com/semaphore-protocol/semaphore/tree/main/circuits). Generating valid zero-knowledge proofs requires files that can only be obtained in an attested trusted-setup ceremony. |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
## 🛠 Install
### npm or yarn
Install the `@semaphore-protocol/proof` package and its peer dependencies with npm:
```bash
npm i @semaphore-protocol/identity @semaphore-protocol/group @semaphore-protocol/proof
```
or yarn:
```bash
yarn add @semaphore-protocol/identity @semaphore-protocol/group @semaphore-protocol/proof
```
## 📜 Usage
For more information on the functions provided by `@semaphore-protocol/proof`, please refer to the [TypeDoc documentation](https://js.semaphore.pse.dev/modules/_semaphore_protocol_proof).
\# **generateProof**(
identity: _Identity_,
group: _Group_,
message: _BigNumberish_ | _Uint8Array_ | string,
scope: _BigNumberish_ | _Uint8Array_ | string,
merkleTreeDepth: _number_,
snarkArtifacts?: [_SnarkArtifacts_](https://github.com/privacy-scaling-explorations/zk-kit/blob/88acdc6d8fa5f3f2a8ecd1e1a0140244b970c551/packages/utils/src/types/index.ts#L46)
): Promise\<_SemaphoreProof_>
```typescript
import { Identity } from "@semaphore-protocol/identity"
import { Group } from "@semaphore-protocol/group"
import { generateProof } from "@semaphore-protocol/proof"
const identity1 = new Identity()
const identity2 = new Identity()
const identity3 = new Identity()
const group = new Group([identity1.commitment, identity2.commitment, identity3.commitment])
const message = "Hello world"
const scope = "Semaphore"
// snarkArtifacts are not provided.
// So they will be automatically downloaded (see https://github.com/privacy-scaling-explorations/snark-artifacts).
const proof1 = await generateProof(identity1, group, message, scope)
// You can also specify the maximum tree depth supported by the proof.
const proof2 = await generateProof(identity2, group, message, scope, 20)
// You can also override our default zkey/wasm files.
const proof3 = await generateProof(identity3, group, message, scope, 20, {
wasm: "./semaphore.wasm",
zkey: "./semaphore.zkey"
})
```
\# **verifyProof**(semaphoreProof: _SemaphoreProof_): Promise\<_boolean_>
```typescript
import { verifyProof } from "@semaphore-protocol/proof"
await verifyProof(proof1)
```
## Resource management: Terminating the bn128 curve
When using the Semaphore proof library in Node.js environments, especially in tests or scripts that create and use the `bn128` curve (for example, via `getCurveFromName("bn128")` from the `ffjavascript` package), it is important to properly release resources associated with the curve after use. Failing to do so can result in leaked handles (such as `MessagePort` handles), which may prevent Node.js from exiting cleanly. This is particularly relevant when running test suites.
**How to terminate the bn128 curve:**
If you create a curve instance using `getCurveFromName("bn128")`, you should call its `terminate()` method when you are done with it. For example:
```typescript
import { getCurveFromName } from "ffjavascript"
let curve
beforeAll(async () => {
curve = await getCurveFromName("bn128")
})
afterAll(async () => {
await curve.terminate()
})
```
This ensures that all resources are properly released and Node.js can exit cleanly after your script or tests finish.
---
_Source: https://npm.io/package/@semaphore-protocol/proof · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._