Skip to content

Commit 70b0f8a

Browse files
committed
docs: update readme files
1 parent ae75743 commit 70b0f8a

File tree

2 files changed

+30
-26
lines changed

2 files changed

+30
-26
lines changed

packages/group/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,20 @@ group.addMember(commitment)
100100
console.log(group.members[0])
101101
```
102102

103+
\# **addMembers**(members: _BigNumberish[]_)
104+
105+
```typescript
106+
import { Group } from "@semaphore-protocol/group"
107+
import { Identity } from "@semaphore-protocol/identity"
108+
109+
const group = new Group()
110+
111+
const identity1 = new Identity()
112+
const identity2 = new Identity()
113+
114+
group.addMembers([identity1.commitment, identity2.commitment])
115+
```
116+
103117
\# **updateMember**(index: _number_, member: _BigNumberish_)
104118

105119
```typescript

packages/proof/README.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@ yarn add @semaphore-protocol/identity @semaphore-protocol/group @semaphore-proto
7272

7373
\# **generateProof**(
7474
identity: _Identity_,
75-
group: _Group_ | _MerkleProof_,
76-
externalNullifier: _BytesLike | Hexable | number | bigint_,
77-
signal: _BytesLike | Hexable | number | bigint_,
75+
group: _Group_,
76+
message: _BytesLike | Hexable | number | bigint_,
77+
scope: _BytesLike | Hexable | number | bigint_,
78+
treeDepth: _number_,
7879
snarkArtifacts?: _SnarkArtifacts_
7980
): Promise\<_SemaphoreProof_>
8081

@@ -86,18 +87,22 @@ import { utils } from "ethers"
8687

8788
const identity = new Identity()
8889
const group = new Group()
89-
const externalNullifier = utils.formatBytes32String("Topic")
90-
const signal = utils.formatBytes32String("Hello world")
90+
91+
const scope = utils.formatBytes32String("Topic")
92+
const message = utils.formatBytes32String("Hello world")
9193

9294
group.addMembers([...identityCommitments, identity.generateCommitment()])
9395

94-
const fullProof = await generateProof(identity, group, externalNullifier, signal, {
95-
zkeyFilePath: "./semaphore.zkey",
96-
wasmFilePath: "./semaphore.wasm"
97-
})
96+
const fullProof1 = await generateProof(identity, group, message, scope)
97+
98+
// You can also specify the maximum shaft depth supported by the proof.
99+
const fullProof2 = await generateProof(identity, group, message, scope, 20)
98100

99-
// You can also use the default zkey/wasm files (it only works from browsers!).
100-
// const fullProof = await generateProof(identity, group, externalNullifier, signal)
101+
// You can also specify the default zkey/wasm files.
102+
const fullProof3 = await generateProof(identity, group, message, scope, 20, {
103+
wasmFilePath: "./semaphore.wasm",
104+
zkeyFilePath: "./semaphore.zkey"
105+
})
101106
```
102107

103108
\# **verifyProof**(semaphoreProof: _SemaphoreProof_, treeDepth: _number_): Promise\<_boolean_>
@@ -107,18 +112,3 @@ import { verifyProof } from "@semaphore-protocol/proof"
107112

108113
await verifyProof(fullProof, 20)
109114
```
110-
111-
\# **calculateNullifierHash**(
112-
identityNullifier: _bigint | number | string_,
113-
externalNullifier: \__BytesLike | Hexable | number | bigint_
114-
): bigint
115-
116-
```typescript
117-
import { Identity } from "@semaphore-protocol/identity"
118-
import { calculateNullifierHash } from "@semaphore-protocol/proof"
119-
120-
const identity = new Identity()
121-
const externalNullifier = utils.formatBytes32String("Topic")
122-
123-
const nullifierHash = calculateNullifierHash(identity.nullifier, externalNullifier)
124-
```

0 commit comments

Comments
 (0)