@semaphore-protocol/proof 0.3.3 → 2.1.0

package/README.md

@@ -38,7 +38,8 @@
     </h4>
 </div>
 
----
+| 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](https://storage.googleapis.com/trustedsetup-a86f4.appspot.com/semaphore/semaphore_top_index.html). For a complete list of ready-to-use files visit [trusted-setup-pse.org](http://www.trusted-setup-pse.org/). |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 
 ## 🛠 Install
 

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 0.3.3
+ * @version 2.1.0
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -84,6 +84,10 @@ function genSignalHash(signal) {
 }
 
 function generateProof(identity, group, externalNullifier, signal, snarkArtifacts) {
+    if (snarkArtifacts === void 0) { snarkArtifacts = {
+        wasmFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(group.depth, "/semaphore.wasm"),
+        zkeyFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(group.depth, "/semaphore.zkey")
+    }; }
     return __awaiter(this, void 0, void 0, function () {
         var commitment, index, merkleProof, _a, proof, publicSignals;
         return __generator(this, function (_b) {

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 0.3.3
+ * @version 2.1.0
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -88,6 +88,10 @@ function genSignalHash(signal) {
 }
 
 function generateProof(identity, group, externalNullifier, signal, snarkArtifacts) {
+    if (snarkArtifacts === void 0) { snarkArtifacts = {
+        wasmFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(group.depth, "/semaphore.wasm"),
+        zkeyFilePath: "https://www.trusted-setup-pse.org/semaphore/".concat(group.depth, "/semaphore.zkey")
+    }; }
     return __awaiter(this, void 0, void 0, function () {
         var commitment, index, merkleProof, _a, proof, publicSignals;
         return __generator(this, function (_b) {

package/dist/types/generateProof.d.ts

@@ -1,4 +1,4 @@
 import type { Identity } from "@semaphore-protocol/identity";
 import { Group } from "@semaphore-protocol/group";
 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, group: Group, externalNullifier: BigNumberish, signal: string, snarkArtifacts?: SnarkArtifacts): Promise<FullProof>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@semaphore-protocol/proof",
-    "version": "0.3.3",
+    "version": "2.1.0",
     "description": "A library to generate and verify Semaphore proofs.",
     "license": "MIT",
     "main": "dist/index.node.js",
@@ -37,8 +37,8 @@
         "@ethersproject/bytes": "^5.5.0",
         "@ethersproject/solidity": "^5.5.0",
         "@ethersproject/strings": "^5.5.0",
-        "@semaphore-protocol/group": "0.1.2",
-        "@semaphore-protocol/identity": "0.2.2",
+        "@semaphore-protocol/group": "2.0.0",
+        "@semaphore-protocol/identity": "2.0.0",
         "circomlibjs": "0.0.8",
         "snarkjs": "^0.4.13"
     }

package/src/generateProof.ts

@@ -9,7 +9,10 @@ export default async function generateProof(
     group: Group,
     externalNullifier: BigNumberish,
     signal: string,
-    snarkArtifacts: SnarkArtifacts
+    snarkArtifacts: SnarkArtifacts = {
+        wasmFilePath: `https://www.trusted-setup-pse.org/semaphore/${group.depth}/semaphore.wasm`,
+        zkeyFilePath: `https://www.trusted-setup-pse.org/semaphore/${group.depth}/semaphore.zkey`
+    }
 ): Promise<FullProof> {
     const commitment = identity.generateCommitment()
     const index = group.indexOf(commitment)

package/src/index.test.ts

@@ -72,6 +72,21 @@ describe("Proof", () => {
             expect(fullProof.publicSignals.externalNullifier).toBe(externalNullifier)
             expect(fullProof.publicSignals.merkleRoot).toBe(group.root.toString())
         }, 20000)
+
+        it("Should generate a Semaphore proof with default snark artifacts", async () => {
+            const group = new Group(treeDepth)
+
+            group.addMembers([BigInt(1), BigInt(2), identityCommitment])
+
+            fullProof = await generateProof(identity, group, 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", () => {