@semaphore-protocol/proof 3.15.2 → 4.0.0-alpha.1

package/dist/types/generate-proof.d.ts

@@ -0,0 +1,15 @@
+import { BytesLike, Hexable } from "@ethersproject/bytes";
+import type { Group, MerkleProof } from "@semaphore-protocol/group";
+import type { Identity } from "@semaphore-protocol/identity";
+import { SemaphoreProof, SnarkArtifacts } from "./types";
+/**
+ * Generates a Semaphore proof.
+ * @param identity The Semaphore identity.
+ * @param groupOrMerkleProof The Semaphore group or its Merkle proof.
+ * @param scope The external nullifier.
+ * @param message The Semaphore signal.
+ * @param merkleTreeDepth The depth of the tree with which the circuit was compiled.
+ * @param snarkArtifacts The SNARK artifacts.
+ * @returns The Semaphore proof ready to be verified.
+ */
+export default function generateProof(identity: Identity, groupOrMerkleProof: Group | MerkleProof, message: BytesLike | Hexable | number | bigint, scope: BytesLike | Hexable | number | bigint, merkleTreeDepth?: number, snarkArtifacts?: SnarkArtifacts): Promise<SemaphoreProof>;

package/dist/types/get-snark-artifacts.browser.d.ts

@@ -0,0 +1,2 @@
+import { SnarkArtifacts } from "./types";
+export default function getSnarkArtifacts(treeDepth: number): Promise<SnarkArtifacts>;

package/dist/types/get-snark-artifacts.node.d.ts

@@ -0,0 +1,2 @@
+import { SnarkArtifacts } from "./types";
+export default function getSnarkArtifacts(treeDepth: number): Promise<SnarkArtifacts>;

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
-import calculateNullifierHash from "./calculateNullifierHash";
-import generateProof from "./generateProof";
-import verifyProof from "./verifyProof";
-export { MerkleProof } from "@zk-kit/incremental-merkle-tree";
+import generateProof from "./generate-proof";
+import getSnarkArtifacts from "./get-snark-artifacts.node";
+import packPoints from "./pack-points";
+import unpackPoints from "./unpack-points";
+import verifyProof from "./verify-proof";
 export * from "./types";
-export { generateProof, verifyProof, calculateNullifierHash };
+export { generateProof, getSnarkArtifacts, packPoints, unpackPoints, verifyProof };

package/dist/types/pack-points.d.ts

@@ -0,0 +1,8 @@
+import { Groth16Proof } from "snarkjs";
+import { PackedPoints } from "./types";
+/**
+ * Packs the Groth16 proof points into a format compatible with Semaphore.
+ * @param proof The proof points generated with SnarkJS.
+ * @returns The proof points compatible with Semaphore.
+ */
+export default function packPoints(proof: Groth16Proof): PackedPoints;

package/dist/types/types/index.d.ts

@@ -1,16 +1,18 @@
 import type { NumericString } from "snarkjs";
+export type BigNumberish = string | number | bigint;
 export type SnarkArtifacts = {
     wasmFilePath: string;
     zkeyFilePath: string;
 };
 export type SemaphoreProof = {
+    merkleTreeDepth: number;
     merkleTreeRoot: NumericString;
-    signal: NumericString;
-    nullifierHash: NumericString;
-    externalNullifier: NumericString;
-    proof: PackedProof;
+    message: NumericString;
+    nullifier: NumericString;
+    scope: NumericString;
+    points: PackedPoints;
 };
-export type PackedProof = [
+export type PackedPoints = [
     NumericString,
     NumericString,
     NumericString,

package/dist/types/unpack-points.d.ts

@@ -0,0 +1,8 @@
+import { Groth16Proof } from "snarkjs";
+import { PackedPoints } from "./types";
+/**
+ * Unpacks the Groth16 proof points into their original form.
+ * @param proof The proof points compatible with Semaphore.
+ * @returns The proof points compatible with SnarkJS.
+ */
+export default function unpackPoints(proof: PackedPoints): Groth16Proof;

package/dist/types/verify-proof.d.ts

@@ -0,0 +1,8 @@
+import { SemaphoreProof } from "./types";
+/**
+ * Verifies a Semaphore proof.
+ * @param fullProof The SnarkJS Semaphore proof.
+ * @param treeDepth The depth of the tree.
+ * @returns True if the proof is valid, false otherwise.
+ */
+export default function verifyProof({ merkleTreeDepth, merkleTreeRoot, nullifier, message, scope, points }: SemaphoreProof): Promise<boolean>;

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@semaphore-protocol/proof",
-  "version": "3.15.2",
+  "version": "4.0.0-alpha.1",
   "description": "A library to generate and verify Semaphore proofs.",
   "license": "MIT",
   "main": "dist/index.node.js",
   "exports": {
-    "import": "./dist/index.node.mjs",
-    "require": "./dist/index.node.js",
+    "node": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.js"
+    },
+    "browser": "./dist/index.browser.mjs",
+    "default": "./dist/index.browser.mjs",
     "types": "./dist/types/index.d.ts"
   },
   "types": "dist/types/index.d.ts",
@@ -22,17 +26,20 @@
     "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
   },
   "scripts": {
-    "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
-    "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
+    "build": "rimraf dist && yarn build:browser && yarn build:node",
+    "build:browser": "rollup -c rollup.browser.config.ts --configPlugin typescript",
+    "build:node": "rollup -c rollup.node.config.ts --configPlugin typescript",
     "prepublishOnly": "yarn build"
   },
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^24.1.0",
+    "@ethersproject/strings": "^5.7.0",
+    "@rollup/plugin-alias": "^5.1.0",
     "@rollup/plugin-json": "^5.0.1",
-    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@types/download": "^8.0.5",
+    "@types/tmp": "^0.2.6",
     "poseidon-lite": "^0.2.0",
     "rimraf": "^5.0.5",
     "rollup": "^4.0.2",
@@ -40,15 +47,16 @@
     "rollup-plugin-typescript2": "^0.31.2"
   },
   "peerDependencies": {
-    "@semaphore-protocol/group": "3.15.2",
-    "@semaphore-protocol/identity": "3.15.2"
+    "@semaphore-protocol/group": "4.0.0-alpha.1",
+    "@semaphore-protocol/identity": "4.0.0-alpha.1"
   },
   "dependencies": {
-    "@ethersproject/bignumber": "^5.5.0",
-    "@ethersproject/bytes": "^5.7.0",
-    "@ethersproject/keccak256": "^5.7.0",
-    "@ethersproject/strings": "^5.5.0",
-    "@zk-kit/groth16": "0.3.0",
-    "@zk-kit/incremental-merkle-tree": "0.4.3"
+    "@ethersproject/bignumber": "5.7.0",
+    "@ethersproject/bytes": "5.7.0",
+    "@ethersproject/keccak256": "5.7.0",
+    "@types/snarkjs": "0.7.8",
+    "download": "8.0.0",
+    "snarkjs": "0.7.3",
+    "tmp": "0.2.1"
   }
 }

package/src/generate-proof.ts

@@ -0,0 +1,88 @@
+import { BigNumber } from "@ethersproject/bignumber"
+import { BytesLike, Hexable } from "@ethersproject/bytes"
+import type { Group, MerkleProof } from "@semaphore-protocol/group"
+import type { Identity } from "@semaphore-protocol/identity"
+import { NumericString, groth16 } from "snarkjs"
+import getSnarkArtifacts from "./get-snark-artifacts.node"
+import hash from "./hash"
+import packPoints from "./pack-points"
+import { SemaphoreProof, SnarkArtifacts } from "./types"
+
+/**
+ * Generates a Semaphore proof.
+ * @param identity The Semaphore identity.
+ * @param groupOrMerkleProof The Semaphore group or its Merkle proof.
+ * @param scope The external nullifier.
+ * @param message The Semaphore signal.
+ * @param merkleTreeDepth The depth of the tree with which the circuit was compiled.
+ * @param snarkArtifacts The SNARK artifacts.
+ * @returns The Semaphore proof ready to be verified.
+ */
+export default async function generateProof(
+    identity: Identity,
+    groupOrMerkleProof: Group | MerkleProof,
+    message: BytesLike | Hexable | number | bigint,
+    scope: BytesLike | Hexable | number | bigint,
+    merkleTreeDepth?: number,
+    snarkArtifacts?: SnarkArtifacts
+): Promise<SemaphoreProof> {
+    let merkleProof
+
+    if ("siblings" in groupOrMerkleProof) {
+        merkleProof = groupOrMerkleProof
+    } else {
+        const leafIndex = groupOrMerkleProof.indexOf(identity.commitment)
+        merkleProof = groupOrMerkleProof.generateMerkleProof(leafIndex)
+    }
+
+    const merkleProofLength = merkleProof.siblings.length
+
+    if (merkleTreeDepth !== undefined) {
+        if (merkleTreeDepth < 1 || merkleTreeDepth > 12) {
+            throw new TypeError("The tree depth must be a number between 1 and 12")
+        }
+    } else {
+        merkleTreeDepth = merkleProofLength
+    }
+
+    // If the Snark artifacts are not defined they will be automatically downloaded.
+    /* istanbul ignore next */
+    if (!snarkArtifacts) {
+        snarkArtifacts = await getSnarkArtifacts(merkleTreeDepth)
+    }
+
+    // The index must be converted to a list of indices, 1 for each tree level.
+    // The missing siblings can be set to 0, as they won't be used in the circuit.
+    const merkleProofIndices = []
+    const merkleProofSiblings = merkleProof.siblings
+
+    for (let i = 0; i < merkleTreeDepth; i += 1) {
+        merkleProofIndices.push((merkleProof.index >> i) & 1)
+
+        if (merkleProofSiblings[i] === undefined) {
+            merkleProofSiblings[i] = "0"
+        }
+    }
+
+    const { proof, publicSignals } = await groth16.fullProve(
+        {
+            secret: identity.secretScalar,
+            merkleProofLength,
+            merkleProofIndices,
+            merkleProofSiblings,
+            scope: hash(scope),
+            message: hash(message)
+        },
+        snarkArtifacts.wasmFilePath,
+        snarkArtifacts.zkeyFilePath
+    )
+
+    return {
+        merkleTreeDepth,
+        merkleTreeRoot: publicSignals[0],
+        nullifier: publicSignals[1],
+        message: BigNumber.from(message).toString() as NumericString,
+        scope: BigNumber.from(scope).toString() as NumericString,
+        points: packPoints(proof)
+    }
+}

package/src/get-snark-artifacts.browser.ts

@@ -0,0 +1,9 @@
+/* istanbul ignore file */
+import { SnarkArtifacts } from "./types"
+
+export default async function getSnarkArtifacts(treeDepth: number): Promise<SnarkArtifacts> {
+    return {
+        wasmFilePath: `https://semaphore.cedoor.dev/artifacts/${treeDepth}/semaphore.wasm`,
+        zkeyFilePath: `https://semaphore.cedoor.dev/artifacts/${treeDepth}/semaphore.zkey`
+    }
+}

package/src/get-snark-artifacts.node.ts

@@ -0,0 +1,20 @@
+/* istanbul ignore file */
+import download from "download"
+import fs from "fs"
+import tmp from "tmp"
+import { SnarkArtifacts } from "./types"
+
+export default async function getSnarkArtifacts(treeDepth: number): Promise<SnarkArtifacts> {
+    const tmpDir = "semaphore-proof"
+    const tmpPath = `${tmp.tmpdir}/${tmpDir}-${treeDepth}`
+
+    if (!fs.existsSync(tmpPath) || fs.readdirSync(tmpPath).length !== 2) {
+        await download(`https://semaphore.cedoor.dev/artifacts/${treeDepth}/semaphore.wasm`, tmpPath)
+        await download(`https://semaphore.cedoor.dev/artifacts/${treeDepth}/semaphore.zkey`, tmpPath)
+    }
+
+    return {
+        wasmFilePath: `${tmpPath}/semaphore.wasm`,
+        zkeyFilePath: `${tmpPath}/semaphore.zkey`
+    }
+}

package/src/index.ts

@@ -1,7 +1,8 @@
-import calculateNullifierHash from "./calculateNullifierHash"
-import generateProof from "./generateProof"
-import verifyProof from "./verifyProof"
+import generateProof from "./generate-proof"
+import getSnarkArtifacts from "./get-snark-artifacts.node"
+import packPoints from "./pack-points"
+import unpackPoints from "./unpack-points"
+import verifyProof from "./verify-proof"
 
-export { MerkleProof } from "@zk-kit/incremental-merkle-tree"
 export * from "./types"
-export { generateProof, verifyProof, calculateNullifierHash }
+export { generateProof, getSnarkArtifacts, packPoints, unpackPoints, verifyProof }

package/src/pack-points.ts

@@ -0,0 +1,20 @@
+import { Groth16Proof } from "snarkjs"
+import { PackedPoints } from "./types"
+
+/**
+ * Packs the Groth16 proof points into a format compatible with Semaphore.
+ * @param proof The proof points generated with SnarkJS.
+ * @returns The proof points compatible with Semaphore.
+ */
+export default function packPoints(proof: Groth16Proof): PackedPoints {
+    return [
+        proof.pi_a[0],
+        proof.pi_a[1],
+        proof.pi_b[0][1],
+        proof.pi_b[0][0],
+        proof.pi_b[1][1],
+        proof.pi_b[1][0],
+        proof.pi_c[0],
+        proof.pi_c[1]
+    ]
+}

package/src/types/index.ts

@@ -1,19 +1,22 @@
 import type { NumericString } from "snarkjs"
 
+export type BigNumberish = string | number | bigint
+
 export type SnarkArtifacts = {
     wasmFilePath: string
     zkeyFilePath: string
 }
 
 export type SemaphoreProof = {
+    merkleTreeDepth: number
     merkleTreeRoot: NumericString
-    signal: NumericString
-    nullifierHash: NumericString
-    externalNullifier: NumericString
-    proof: PackedProof
+    message: NumericString
+    nullifier: NumericString
+    scope: NumericString
+    points: PackedPoints
 }
 
-export type PackedProof = [
+export type PackedPoints = [
     NumericString,
     NumericString,
     NumericString,

package/src/unpack-points.ts

@@ -0,0 +1,20 @@
+import { Groth16Proof } from "snarkjs"
+import { PackedPoints } from "./types"
+
+/**
+ * Unpacks the Groth16 proof points into their original form.
+ * @param proof The proof points compatible with Semaphore.
+ * @returns The proof points compatible with SnarkJS.
+ */
+export default function unpackPoints(proof: PackedPoints): Groth16Proof {
+    return {
+        pi_a: [proof[0], proof[1]],
+        pi_b: [
+            [proof[3], proof[2]],
+            [proof[5], proof[4]]
+        ],
+        pi_c: [proof[6], proof[7]],
+        protocol: "groth16",
+        curve: "bn128"
+    }
+}