@semaphore-protocol/proof 4.0.0-beta.1 → 4.0.0-beta.11

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

@@ -1,6 +1,8 @@
 import type { Group, MerkleProof } from "@semaphore-protocol/group";
 import type { Identity } from "@semaphore-protocol/identity";
-import { BigNumberish, SemaphoreProof, SnarkArtifacts } from "./types";
+import { type SnarkArtifacts } from "@zk-kit/artifacts";
+import type { BigNumberish } from "ethers";
+import type { SemaphoreProof } from "./types";
 /**
  * It generates a Semaphore proof, i.e. a zero-knowledge proof that an identity that
  * is part of a group has shared an anonymous message.
@@ -15,10 +17,10 @@ import { BigNumberish, SemaphoreProof, SnarkArtifacts } from "./types";
  * or they will be automatically fetched.
  * @param identity The Semaphore identity.
  * @param groupOrMerkleProof The Semaphore group or its Merkle proof.
- * @param scope The Semaphore scope.
  * @param message The Semaphore message.
+ * @param scope The Semaphore scope.
  * @param merkleTreeDepth The depth of the tree with which the circuit was compiled.
- * @param snarkArtifacts The SNARK artifacts.
+ * @param snarkArtifacts See {@link https://zkkit.pse.dev/interfaces/_zk_kit_utils.SnarkArtifacts.html | SnarkArtifacts}.
  * @returns The Semaphore proof ready to be verified.
  */
 export default function generateProof(identity: Identity, groupOrMerkleProof: Group | MerkleProof, message: BigNumberish | Uint8Array | string, scope: BigNumberish | Uint8Array | string, merkleTreeDepth?: number, snarkArtifacts?: SnarkArtifacts): Promise<SemaphoreProof>;

package/dist/types/hash.d.ts

@@ -1,5 +1,5 @@
+import type { BigNumberish } from "ethers";
 import { NumericString } from "snarkjs";
-import { BigNumberish } from "./types";
 /**
  * Creates a keccak256 hash of a message compatible with the SNARK scalar modulus.
  * @param message The message to be hashed.

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import { packGroth16Proof, unpackGroth16Proof } from "@zk-kit/utils";
+import { packGroth16Proof, unpackGroth16Proof } from "@zk-kit/utils/proof-packing";
 import generateProof from "./generate-proof";
 import verifyProof from "./verify-proof";
 export * from "./types";

package/dist/types/to-bigint.d.ts

@@ -1,6 +1,6 @@
-import { BigNumberish } from "./types";
+import type { BigNumberish } from "ethers";
 /**
- * Converts a bignumberish to a bigint.
+ * Converts a bignumberish or a text to a bigint.
  * @param value The value to be converted to bigint.
  * @return The value converted to bigint.
  */

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

@@ -1,24 +1,10 @@
 import type { NumericString } from "snarkjs";
-export type BigNumberish = string | number | bigint;
-export type SnarkArtifacts = {
-    wasmFilePath: string;
-    zkeyFilePath: string;
-};
+import type { PackedGroth16Proof } from "@zk-kit/utils";
 export type SemaphoreProof = {
     merkleTreeDepth: number;
     merkleTreeRoot: NumericString;
     message: NumericString;
     nullifier: NumericString;
     scope: NumericString;
-    points: PackedPoints;
+    points: PackedGroth16Proof;
 };
-export type PackedPoints = [
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString
-];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/proof",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.11",
   "description": "A library to generate and verify Semaphore proofs.",
   "type": "module",
   "license": "MIT",
@@ -40,23 +40,22 @@
   "devDependencies": {
     "@rollup/plugin-alias": "^5.1.0",
     "@rollup/plugin-json": "^6.1.0",
-    "@types/download": "^8.0.5",
-    "@types/snarkjs": "0.7.8",
-    "@types/tmp": "^0.2.6",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/snarkjs": "^0",
     "poseidon-lite": "^0.2.0",
     "rimraf": "^5.0.5",
-    "rollup": "^4.9.6",
-    "rollup-plugin-cleanup": "^3.2.1",
-    "rollup-plugin-typescript2": "^0.36.0"
+    "rollup": "^4.12.0",
+    "rollup-plugin-cleanup": "^3.2.1"
   },
   "peerDependencies": {
-    "@semaphore-protocol/group": "4.0.0-beta.1",
-    "@semaphore-protocol/identity": "4.0.0-beta.1"
+    "@semaphore-protocol/group": "4.0.0-beta.11",
+    "@semaphore-protocol/identity": "4.0.0-beta.11"
   },
   "dependencies": {
-    "@semaphore-protocol/utils": "4.0.0-beta.1",
-    "@zk-kit/utils": "0.3.0",
+    "@semaphore-protocol/utils": "4.0.0-beta.11",
+    "@zk-kit/artifacts": "^1.3.2",
+    "@zk-kit/utils": "1.0.0",
     "ethers": "6.10.0",
-    "snarkjs": "0.7.3"
+    "snarkjs": "0.7.4"
   }
 }

package/src/generate-proof.ts

@@ -1,12 +1,14 @@
 import type { Group, MerkleProof } from "@semaphore-protocol/group"
 import type { Identity } from "@semaphore-protocol/identity"
-import { requireDefined, requireNumber, requireObject, requireTypes } from "@semaphore-protocol/utils/errors"
-import { NumericString, groth16 } from "snarkjs"
-import { packGroth16Proof } from "@zk-kit/utils"
-import getSnarkArtifacts from "./get-snark-artifacts.node"
+import { MAX_DEPTH, MIN_DEPTH } from "@semaphore-protocol/utils/constants"
+import { requireDefined, requireNumber, requireObject, requireTypes } from "@zk-kit/utils/error-handlers"
+import { packGroth16Proof } from "@zk-kit/utils/proof-packing"
+import { maybeGetSnarkArtifacts, Project, type SnarkArtifacts } from "@zk-kit/artifacts"
+import type { BigNumberish } from "ethers"
+import { type NumericString, groth16 } from "snarkjs"
 import hash from "./hash"
 import toBigInt from "./to-bigint"
-import { BigNumberish, SemaphoreProof, SnarkArtifacts } from "./types"
+import type { SemaphoreProof } from "./types"
 
 /**
  * It generates a Semaphore proof, i.e. a zero-knowledge proof that an identity that
@@ -22,10 +24,10 @@ import { BigNumberish, SemaphoreProof, SnarkArtifacts } from "./types"
  * or they will be automatically fetched.
  * @param identity The Semaphore identity.
  * @param groupOrMerkleProof The Semaphore group or its Merkle proof.
- * @param scope The Semaphore scope.
  * @param message The Semaphore message.
+ * @param scope The Semaphore scope.
  * @param merkleTreeDepth The depth of the tree with which the circuit was compiled.
- * @param snarkArtifacts The SNARK artifacts.
+ * @param snarkArtifacts See {@link https://zkkit.pse.dev/interfaces/_zk_kit_utils.SnarkArtifacts.html | SnarkArtifacts}.
  * @returns The Semaphore proof ready to be verified.
  */
 export default async function generateProof(
@@ -43,8 +45,8 @@ export default async function generateProof(
 
     requireObject(identity, "identity")
     requireObject(groupOrMerkleProof, "groupOrMerkleProof")
-    requireTypes(message, "message", ["string", "bigint", "number", "uint8array"])
-    requireTypes(scope, "scope", ["string", "bigint", "number", "uint8array"])
+    requireTypes(message, "message", ["string", "bigint", "number", "Uint8Array"])
+    requireTypes(scope, "scope", ["string", "bigint", "number", "Uint8Array"])
 
     if (merkleTreeDepth) {
         requireNumber(merkleTreeDepth, "merkleTreeDepth")
@@ -73,17 +75,16 @@ export default async function generateProof(
     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")
+        if (merkleTreeDepth < MIN_DEPTH || merkleTreeDepth > MAX_DEPTH) {
+            throw new TypeError(`The tree depth must be a number between ${MIN_DEPTH} and ${MAX_DEPTH}`)
         }
     } else {
         merkleTreeDepth = merkleProofLength
     }
 
     // If the Snark artifacts are not defined they will be automatically downloaded.
-    if (!snarkArtifacts) {
-        snarkArtifacts = await getSnarkArtifacts(merkleTreeDepth)
-    }
+    snarkArtifacts ??= await maybeGetSnarkArtifacts(Project.SEMAPHORE, { parameters: [merkleTreeDepth] })
+    const { wasm, zkey } = snarkArtifacts
 
     // 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.
@@ -94,7 +95,7 @@ export default async function generateProof(
         merkleProofIndices.push((merkleProof.index >> i) & 1)
 
         if (merkleProofSiblings[i] === undefined) {
-            merkleProofSiblings[i] = "0"
+            merkleProofSiblings[i] = 0n
         }
     }
 
@@ -107,8 +108,8 @@ export default async function generateProof(
             scope: hash(scope),
             message: hash(message)
         },
-        snarkArtifacts.wasmFilePath,
-        snarkArtifacts.zkeyFilePath
+        wasm,
+        zkey
     )
 
     return {

package/src/hash.ts

@@ -1,7 +1,7 @@
+import type { BigNumberish } from "ethers"
 import { keccak256 } from "ethers/crypto"
 import { toBeHex } from "ethers/utils"
 import { NumericString } from "snarkjs"
-import { BigNumberish } from "./types"
 
 /**
  * Creates a keccak256 hash of a message compatible with the SNARK scalar modulus.

package/src/index.ts

@@ -1,4 +1,4 @@
-import { packGroth16Proof, unpackGroth16Proof } from "@zk-kit/utils"
+import { packGroth16Proof, unpackGroth16Proof } from "@zk-kit/utils/proof-packing"
 import generateProof from "./generate-proof"
 import verifyProof from "./verify-proof"
 

package/src/to-bigint.ts

@@ -1,9 +1,9 @@
+import type { BigNumberish } from "ethers"
 import { encodeBytes32String } from "ethers/abi"
 import { toBigInt as _toBigInt } from "ethers/utils"
-import { BigNumberish } from "./types"
 
 /**
- * Converts a bignumberish to a bigint.
+ * Converts a bignumberish or a text to a bigint.
  * @param value The value to be converted to bigint.
  * @return The value converted to bigint.
  */

package/src/types/index.ts

@@ -1,11 +1,5 @@
 import type { NumericString } from "snarkjs"
-
-export type BigNumberish = string | number | bigint
-
-export type SnarkArtifacts = {
-    wasmFilePath: string
-    zkeyFilePath: string
-}
+import type { PackedGroth16Proof } from "@zk-kit/utils"
 
 export type SemaphoreProof = {
     merkleTreeDepth: number
@@ -13,16 +7,5 @@ export type SemaphoreProof = {
     message: NumericString
     nullifier: NumericString
     scope: NumericString
-    points: PackedPoints
+    points: PackedGroth16Proof
 }
-
-export type PackedPoints = [
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString,
-    NumericString
-]