@semaphore-protocol/proof 3.15.1 → 4.0.0-alpha

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Ethereum Foundation
+Copyright (c) 2024 Ethereum Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -72,9 +72,10 @@ yarn add @semaphore-protocol/identity @semaphore-protocol/group @semaphore-proto
 
 \# **generateProof**(
 identity: _Identity_,
-group: _Group_ | _MerkleProof_,
-externalNullifier: _BytesLike | Hexable | number | bigint_,
-signal: _BytesLike | Hexable | number | bigint_,
+group: _Group_,
+message: _BytesLike | Hexable | number | bigint_,
+scope: _BytesLike | Hexable | number | bigint_,
+merkleTreeDepth: _number_,
 snarkArtifacts?: _SnarkArtifacts_
 ): Promise\<_SemaphoreProof_>
 
@@ -86,39 +87,28 @@ import { utils } from "ethers"
 
 const identity = new Identity()
 const group = new Group()
-const externalNullifier = utils.formatBytes32String("Topic")
-const signal = utils.formatBytes32String("Hello world")
 
-group.addMembers([...identityCommitments, identity.generateCommitment()])
-
-const fullProof = await generateProof(identity, group, externalNullifier, signal, {
-    zkeyFilePath: "./semaphore.zkey",
-    wasmFilePath: "./semaphore.wasm"
-})
+const scope = utils.formatBytes32String("Topic")
+const message = utils.formatBytes32String("Hello world")
 
-// You can also use the default zkey/wasm files (it only works from browsers!).
-// const fullProof = await generateProof(identity, group, externalNullifier, signal)
-```
+group.addMembers([...identityCommitments, identity.generateCommitment()])
 
-\# **verifyProof**(semaphoreProof: _SemaphoreProof_, treeDepth: _number_): Promise\<_boolean_>
+const fullProof1 = await generateProof(identity, group, message, scope)
 
-```typescript
-import { verifyProof } from "@semaphore-protocol/proof"
+// You can also specify the maximum tree depth supported by the proof.
+const fullProof2 = await generateProof(identity, group, message, scope, 20)
 
-await verifyProof(fullProof, 20)
+// You can also specify the default zkey/wasm files.
+const fullProof3 = await generateProof(identity, group, message, scope, 20, {
+    wasmFilePath: "./semaphore.wasm",
+    zkeyFilePath: "./semaphore.zkey"
+})
 ```
 
-\# **calculateNullifierHash**(
-identityNullifier: _bigint | number | string_,
-externalNullifier: \__BytesLike | Hexable | number | bigint_
-): bigint
+\# **verifyProof**(semaphoreProof: _SemaphoreProof_): Promise\<_boolean_>
 
 ```typescript
-import { Identity } from "@semaphore-protocol/identity"
-import { calculateNullifierHash } from "@semaphore-protocol/proof"
-
-const identity = new Identity()
-const externalNullifier = utils.formatBytes32String("Topic")
+import { verifyProof } from "@semaphore-protocol/proof"
 
-const nullifierHash = calculateNullifierHash(identity.nullifier, externalNullifier)
+await verifyProof(fullProof)
 ```