# @semaphore-protocol/group
> A library to create and manage Semaphore groups.
Latest version **4.14.3** (published 2026-07-08) · MIT license · 0 weekly downloads
## Install
```sh
npm install @semaphore-protocol/group
pnpm add @semaphore-protocol/group
yarn add @semaphore-protocol/group
bun add @semaphore-protocol/group
```
## 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-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 26.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1086 |
| Maintainers | vplasencia, johnguilding, errmac, nicoserranop |
## Links
- npm: https://www.npmjs.com/package/@semaphore-protocol/group
- Repository: https://github.com/semaphore-protocol/semaphore
- Homepage: https://github.com/semaphore-protocol/semaphore/tree/main/packages/group
- Issues: https://github.com/semaphore-protocol/semaphore.git/issues
- npm.io page: https://npm.io/package/@semaphore-protocol/group
## Dependencies (3)
- [@zk-kit/utils](https://npm.io/package/@zk-kit/utils.md) 1.3.0
- [poseidon-lite](https://npm.io/package/poseidon-lite.md) 0.3.0
- [@zk-kit/lean-imt](https://npm.io/package/@zk-kit/lean-imt.md) 2.2.5
## 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
- … 97 more at https://npm.io/package/@semaphore-protocol/group/versions
## README
Semaphore group
A library to create and manage Semaphore groups.
| This library is an abstraction of the LeanIMT data structure (part of [`@zk-kit/imt`](https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/imt)). The main goal is to make it easier to create offchain groups, which are also used to generate Semaphore proofs. Semaphore groups are actually Merkle trees, and the group members are tree leaves. |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
## 🛠 Install
### npm or yarn
Install the `@semaphore-protocol/group` package with npm:
```bash
npm i @semaphore-protocol/group
```
or yarn:
```bash
yarn add @semaphore-protocol/group
```
## 📜 Usage
For more information on the functions provided by `@semaphore-protocol/group`, please refer to the [TypeDoc documentation](https://js.semaphore.pse.dev/modules/_semaphore_protocol_group).
\# **new Group**(members: _BigNumberish[]_ = []): _Group_
```typescript
import { Group } from "@semaphore-protocol/group"
import { Identity } from "@semaphore-protocol/identity"
const group1 = new Group()
const identity1 = new Identity()
const identity2 = new Identity()
const group2 = new Group([identity1.commitment, identity2.commitment])
```
\# **addMember**(member: _BigNumberish_)
```typescript
import { Group } from "@semaphore-protocol/group"
import { Identity } from "@semaphore-protocol/identity"
const group = new Group()
const { commitment } = new Identity()
group.addMember(commitment)
// 12989101133047504182892154686643420754368236204022364847543591045056549053997n
console.log(group.members[0])
```
\# **addMembers**(members: _BigNumberish[]_)
```typescript
import { Group } from "@semaphore-protocol/group"
import { Identity } from "@semaphore-protocol/identity"
const group = new Group()
const identity1 = new Identity()
const identity2 = new Identity()
group.addMembers([identity1.commitment, identity2.commitment])
```
\# **updateMember**(index: _number_, member: _BigNumberish_)
```typescript
import { Group } from "@semaphore-protocol/group"
const group = new Group([1n, 3n])
group.updateMember(0, 2)
console.log(group.members[0]) // "2n"
```
\# **removeMember**(index: _number_)
```typescript
import { Group } from "@semaphore-protocol/group"
const group = new Group([1n, 3n])
group.removeMember(0)
console.log(group.members[0]) // 0n
```
\# **indexOf**(member: _BigNumberish_): _number_
```typescript
import { Group } from "@semaphore-protocol/group"
const group = new Group([1n])
const index = group.indexOf(1)
console.log(index) // 0
```
\# **generateMerkleProof**(index: _number_): _MerkleProof_
```typescript
import { Group } from "@semaphore-protocol/group"
const group = new Group([1n, 3n])
const proof = group.generateMerkleProof(0)
console.log(proof)
/*
{
index: 0,
leaf: '1',
root: '21106761926285267690763443010820487107972411248208546226053195422384279971821',
siblings: [ '3' ]
}
*/
```
\# **export**(): _string_
```typescript
import { Group } from "@semaphore-protocol/group"
const group = new Group([1n, 2n, 3n])
const exportedGroup = group.export()
console.log(exportedGroup)
/*
[["1","2","3"],["7853200120776062878684798364095072458815029376092732009249414926327459813530","3"],["13816780880028945690020260331303642730075999758909899334839547418969502592169"]]
*/
```
\# **import**(exportedGroup: _string_): _Group_
```typescript
import { Group } from "@semaphore-protocol/group"
const group1 = new Group([1n, 2n, 3n])
const exportedGroup = group.export()
const group2 = Group.import(exportedGroup)
assert(group1.root === group2.root)
```
---
_Source: https://npm.io/package/@semaphore-protocol/group · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._