@semaphore-protocol/proof 2.0.1 → 2.3.0

package/README.md

@@ -59,7 +59,7 @@ yarn add @semaphore-protocol/proof
 
 ## 📜 Usage
 
-\# **generateProof**(identity: _Identity_, group: _Group_, externalNullifier: _BigNumberish_, signal: _string_, snarkArtifacts: _SnarkArtifacts_): Promise\<_SemaphoreFullProof_>
+\# **generateProof**(identity: _Identity_, group: _Group_, externalNullifier: _BigNumberish_, signal: _string_, snarkArtifacts?: _SnarkArtifacts_): Promise\<_SemaphoreFullProof_>
 
 ```typescript
 import { Identity } from "@semaphore-protocol/identity"
@@ -77,6 +77,9 @@ const fullProof = await generateProof(identity, merkleProof, externalNullifier,
     zkeyFilePath: "./semaphore.zkey",
     wasmFilePath: "./semaphore.wasm"
 })
+
+// You can also use the default zkey/wasm files (only for browsers!).
+// const fullProof = await generateProof(identity, merkleProof, externalNullifier, signal)
 ```
 
 \# **verifyProof**(verificationKey: _any_, fullProof: _FullProof_): Promise\<_boolean_>

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 2.0.1
+ * @version 2.3.0
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -8,6 +8,7 @@
 */
 import { poseidon } from 'circomlibjs';
 import { groth16 } from 'snarkjs';
+import { isHexString } from '@ethersproject/bytes';
 import { keccak256 } from '@ethersproject/solidity';
 import { formatBytes32String } from '@ethersproject/strings';
 
@@ -80,21 +81,35 @@ function __generator(thisArg, body) {
  * @returns The signal hash.
  */
 function genSignalHash(signal) {
-    return BigInt(keccak256(["bytes32"], [formatBytes32String(signal)])) >> BigInt(8);
+    if (!isHexString(signal, 32)) {
+        signal = formatBytes32String(signal);
+    }
+    return BigInt(keccak256(["bytes32"], [signal])) >> BigInt(8);
 }
 
-function generateProof(identity, group, externalNullifier, signal, snarkArtifacts) {
+function generateProof(identity, groupOrMerkleProof, externalNullifier, signal, snarkArtifacts) {
     return __awaiter(this, void 0, void 0, function () {
-        var commitment, index, merkleProof, _a, proof, publicSignals;
+        var commitment, merkleProof, index, _a, proof, publicSignals;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
                     commitment = identity.generateCommitment();
-                    index = group.indexOf(commitment);
-                    if (index === -1) {
-                        throw new Error("The identity is not part of the group");
+                    if ("depth" in groupOrMerkleProof) {
+                        index = groupOrMerkleProof.indexOf(commitment);
+                        if (index === -1) {
+                            throw new Error("The identity is not part of the group");
+                        }
+                        merkleProof = groupOrMerkleProof.generateProofOfMembership(index);
+                    }
+                    else {
+                        merkleProof = groupOrMerkleProof;
+                    }
+                    if (!snarkArtifacts) {
+                        snarkArtifacts = {
+                            wasmFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(merkleProof.siblings.length, "/semaphore.wasm"),
+                            zkeyFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(merkleProof.siblings.length, "/semaphore.zkey")
+                        };
                     }
-                    merkleProof = group.generateProofOfMembership(index);
                     return [4 /*yield*/, groth16.fullProve({
                             identityTrapdoor: identity.getTrapdoor(),
                             identityNullifier: identity.getNullifier(),

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 2.0.1
+ * @version 2.3.0
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -12,6 +12,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var circomlibjs = require('circomlibjs');
 var snarkjs = require('snarkjs');
+var bytes = require('@ethersproject/bytes');
 var solidity = require('@ethersproject/solidity');
 var strings = require('@ethersproject/strings');
 
@@ -84,21 +85,35 @@ function __generator(thisArg, body) {
  * @returns The signal hash.
  */
 function genSignalHash(signal) {
-    return BigInt(solidity.keccak256(["bytes32"], [strings.formatBytes32String(signal)])) >> BigInt(8);
+    if (!bytes.isHexString(signal, 32)) {
+        signal = strings.formatBytes32String(signal);
+    }
+    return BigInt(solidity.keccak256(["bytes32"], [signal])) >> BigInt(8);
 }
 
-function generateProof(identity, group, externalNullifier, signal, snarkArtifacts) {
+function generateProof(identity, groupOrMerkleProof, externalNullifier, signal, snarkArtifacts) {
     return __awaiter(this, void 0, void 0, function () {
-        var commitment, index, merkleProof, _a, proof, publicSignals;
+        var commitment, merkleProof, index, _a, proof, publicSignals;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
                     commitment = identity.generateCommitment();
-                    index = group.indexOf(commitment);
-                    if (index === -1) {
-                        throw new Error("The identity is not part of the group");
+                    if ("depth" in groupOrMerkleProof) {
+                        index = groupOrMerkleProof.indexOf(commitment);
+                        if (index === -1) {
+                            throw new Error("The identity is not part of the group");
+                        }
+                        merkleProof = groupOrMerkleProof.generateProofOfMembership(index);
+                    }
+                    else {
+                        merkleProof = groupOrMerkleProof;
+                    }
+                    if (!snarkArtifacts) {
+                        snarkArtifacts = {
+                            wasmFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(merkleProof.siblings.length, "/semaphore.wasm"),
+                            zkeyFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(merkleProof.siblings.length, "/semaphore.zkey")
+                        };
                     }
-                    merkleProof = group.generateProofOfMembership(index);
                     return [4 /*yield*/, snarkjs.groth16.fullProve({
                             identityTrapdoor: identity.getTrapdoor(),
                             identityNullifier: identity.getNullifier(),

package/dist/types/generateProof.d.ts

@@ -1,4 +1,5 @@
-import type { Identity } from "@semaphore-protocol/identity";
 import { Group } from "@semaphore-protocol/group";
+import type { Identity } from "@semaphore-protocol/identity";
+import { MerkleProof } from "@zk-kit/incremental-merkle-tree";
 import { BigNumberish, FullProof, SnarkArtifacts } from "./types";
-export default function generateProof(identity: Identity, group: Group, externalNullifier: BigNumberish, signal: string, snarkArtifacts: SnarkArtifacts): Promise<FullProof>;
+export default function generateProof(identity: Identity, groupOrMerkleProof: Group | MerkleProof, externalNullifier: BigNumberish, signal: string, snarkArtifacts?: SnarkArtifacts): Promise<FullProof>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@semaphore-protocol/proof",
-    "version": "2.0.1",
+    "version": "2.3.0",
     "description": "A library to generate and verify Semaphore proofs.",
     "license": "MIT",
     "main": "dist/index.node.js",
@@ -34,11 +34,12 @@
         "typedoc": "^0.22.11"
     },
     "dependencies": {
-        "@ethersproject/bytes": "^5.5.0",
+        "@ethersproject/bytes": "^5.7.0",
         "@ethersproject/solidity": "^5.5.0",
         "@ethersproject/strings": "^5.5.0",
         "@semaphore-protocol/group": "2.0.0",
         "@semaphore-protocol/identity": "2.0.0",
+        "@zk-kit/incremental-merkle-tree": "0.4.3",
         "circomlibjs": "0.0.8",
         "snarkjs": "^0.4.13"
     }

package/src/generateProof.ts

@@ -1,24 +1,39 @@
-import type { Identity } from "@semaphore-protocol/identity"
 import { Group } from "@semaphore-protocol/group"
+import type { Identity } from "@semaphore-protocol/identity"
+import { MerkleProof } from "@zk-kit/incremental-merkle-tree"
 import { groth16 } from "snarkjs"
 import generateSignalHash from "./generateSignalHash"
 import { BigNumberish, FullProof, SnarkArtifacts } from "./types"
 
 export default async function generateProof(
     identity: Identity,
-    group: Group,
+    groupOrMerkleProof: Group | MerkleProof,
     externalNullifier: BigNumberish,
     signal: string,
-    snarkArtifacts: SnarkArtifacts
+    snarkArtifacts?: SnarkArtifacts
 ): Promise<FullProof> {
     const commitment = identity.generateCommitment()
-    const index = group.indexOf(commitment)
 
-    if (index === -1) {
-        throw new Error("The identity is not part of the group")
+    let merkleProof: MerkleProof
+
+    if ("depth" in groupOrMerkleProof) {
+        const index = groupOrMerkleProof.indexOf(commitment)
+
+        if (index === -1) {
+            throw new Error("The identity is not part of the group")
+        }
+
+        merkleProof = groupOrMerkleProof.generateProofOfMembership(index)
+    } else {
+        merkleProof = groupOrMerkleProof
     }
 
-    const merkleProof = group.generateProofOfMembership(index)
+    if (!snarkArtifacts) {
+        snarkArtifacts = {
+            wasmFilePath: `https://www.trusted-setup-pse.org/semaphore/${merkleProof.siblings.length}/semaphore.wasm`,
+            zkeyFilePath: `https://www.trusted-setup-pse.org/semaphore/${merkleProof.siblings.length}/semaphore.zkey`
+        }
+    }
 
     const { proof, publicSignals } = await groth16.fullProve(
         {

package/src/generateSignalHash.ts

@@ -1,3 +1,4 @@
+import { isHexString } from "@ethersproject/bytes"
 import { keccak256 } from "@ethersproject/solidity"
 import { formatBytes32String } from "@ethersproject/strings"
 
@@ -7,5 +8,9 @@ import { formatBytes32String } from "@ethersproject/strings"
  * @returns The signal hash.
  */
 export default function genSignalHash(signal: string): bigint {
-    return BigInt(keccak256(["bytes32"], [formatBytes32String(signal)])) >> BigInt(8)
+    if (!isHexString(signal, 32)) {
+        signal = formatBytes32String(signal)
+    }
+
+    return BigInt(keccak256(["bytes32"], [signal])) >> BigInt(8)
 }

package/src/index.test.ts

@@ -1,3 +1,4 @@
+import { formatBytes32String } from "@ethersproject/strings"
 import { Group } from "@semaphore-protocol/group"
 import { Identity } from "@semaphore-protocol/identity"
 import download from "download"
@@ -58,7 +59,17 @@ describe("Proof", () => {
             await expect(fun).rejects.toThrow("The identity is not part of the group")
         })
 
-        it("Should generate a Semaphore proof", async () => {
+        it("Should not generate a Semaphore proof with default snark artifacts with Node.js", async () => {
+            const group = new Group(treeDepth)
+
+            group.addMembers([BigInt(1), BigInt(2), identityCommitment])
+
+            const fun = () => generateProof(identity, group, externalNullifier, signal)
+
+            await expect(fun).rejects.toThrow("ENOENT: no such file or directory")
+        })
+
+        it("Should generate a Semaphore proof passing a group as parameter", async () => {
             const group = new Group(treeDepth)
 
             group.addMembers([BigInt(1), BigInt(2), identityCommitment])
@@ -72,6 +83,21 @@ describe("Proof", () => {
             expect(fullProof.publicSignals.externalNullifier).toBe(externalNullifier)
             expect(fullProof.publicSignals.merkleRoot).toBe(group.root.toString())
         }, 20000)
+
+        it("Should generate a Semaphore proof passing a Merkle proof as parametr", async () => {
+            const group = new Group(treeDepth)
+
+            group.addMembers([BigInt(1), BigInt(2), identityCommitment])
+
+            fullProof = await generateProof(identity, group.generateProofOfMembership(2), externalNullifier, signal, {
+                wasmFilePath: `${snarkArtifactsPath}/semaphore.wasm`,
+                zkeyFilePath: `${snarkArtifactsPath}/semaphore.zkey`
+            })
+
+            expect(typeof fullProof).toBe("object")
+            expect(fullProof.publicSignals.externalNullifier).toBe(externalNullifier)
+            expect(fullProof.publicSignals.merkleRoot).toBe(group.root.toString())
+        }, 20000)
     })
 
     describe("# generateSignalHash", () => {
@@ -80,6 +106,12 @@ describe("Proof", () => {
 
             expect(signalHash.toString()).toBe(fullProof.publicSignals.signalHash)
         })
+
+        it("Should generate a valid signal hash by passing a valid hex string", async () => {
+            const signalHash = generateSignalHash(formatBytes32String(signal))
+
+            expect(signalHash.toString()).toBe(fullProof.publicSignals.signalHash)
+        })
     })
 
     describe("# generateNullifierHash", () => {