@semaphore-protocol/proof 4.0.0-alpha.5 → 4.0.0-alpha.7

package/README.md

@@ -73,8 +73,8 @@ yarn add @semaphore-protocol/identity @semaphore-protocol/group @semaphore-proto
 \# **generateProof**(
 identity: _Identity_,
 group: _Group_,
-message: _BytesLike | Hexable | number | bigint_,
-scope: _BytesLike | Hexable | number | bigint_,
+message: _BigNumberish_ | _Uint8Array_ | string,
+scope: _BigNumberish_ | _Uint8Array_ | string,
 merkleTreeDepth: _number_,
 snarkArtifacts?: _SnarkArtifacts_
 ): Promise\<_SemaphoreProof_>
@@ -83,23 +83,23 @@ snarkArtifacts?: _SnarkArtifacts_
 import { Identity } from "@semaphore-protocol/identity"
 import { Group } from "@semaphore-protocol/group"
 import { generateProof } from "@semaphore-protocol/proof"
-import { utils } from "ethers"
 
-const identity = new Identity()
-const group = new Group()
+const identity1 = new Identity()
+const identity2 = new Identity()
+const identity3 = new Identity()
 
-const scope = utils.formatBytes32String("Topic")
-const message = utils.formatBytes32String("Hello world")
+const group = new Group([identity1.commitment, identity2.commitment, identity3.commitment])
 
-group.addMembers([...identityCommitments, identity.generateCommitment()])
+const message = "Hello world"
+const scope = "Semaphore"
 
-const proof1 = await generateProof(identity, group, message, scope)
+const proof1 = await generateProof(identity1, group, message, scope)
 
 // You can also specify the maximum tree depth supported by the proof.
-const proof2 = await generateProof(identity, group, message, scope, 20)
+const proof2 = await generateProof(identity2, group, message, scope, 20)
 
 // You can also specify the default zkey/wasm files.
-const proof3 = await generateProof(identity, group, message, scope, 20, {
+const proof3 = await generateProof(identity3, group, message, scope, 20, {
     wasmFilePath: "./semaphore.wasm",
     zkeyFilePath: "./semaphore.zkey"
 })

package/dist/index.browser.js

@@ -1,15 +1,13 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 4.0.0-alpha.5
+ * @version 4.0.0-alpha.7
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2024
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/proof}
 */
-import { BigNumber } from '@ethersproject/bignumber';
 import { groth16 } from 'snarkjs';
-import { zeroPad } from '@ethersproject/bytes';
-import { keccak256 } from '@ethersproject/keccak256';
+import { keccak256, toBeHex, toBigInt as toBigInt$1, encodeBytes32String } from 'ethers';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -99,9 +97,7 @@ function getSnarkArtifacts(treeDepth) {
  * @returns The message digest.
  */
 function hash(message) {
-    message = BigNumber.from(message).toTwos(256).toHexString();
-    message = zeroPad(message, 32);
-    return (BigInt(keccak256(message)) >> BigInt(8)).toString();
+    return (BigInt(keccak256(toBeHex(message, 32))) >> BigInt(8)).toString();
 }
 
 /**
@@ -122,12 +118,24 @@ function packPoints(proof) {
     ];
 }
 
+function toBigInt(value) {
+    try {
+        return toBigInt$1(value);
+    }
+    catch (error) {
+        if (typeof value === "string") {
+            return toBigInt$1(encodeBytes32String(value));
+        }
+        throw TypeError(error.message);
+    }
+}
+
 /**
  * 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 scope The Semaphore scope.
+ * @param message The Semaphore message.
  * @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.
@@ -138,6 +146,8 @@ function generateProof(identity, groupOrMerkleProof, message, scope, merkleTreeD
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
+                    message = toBigInt(message);
+                    scope = toBigInt(scope);
                     if ("siblings" in groupOrMerkleProof) {
                         merkleProof = groupOrMerkleProof;
                     }
@@ -182,8 +192,8 @@ function generateProof(identity, groupOrMerkleProof, message, scope, merkleTreeD
                             merkleTreeDepth: merkleTreeDepth,
                             merkleTreeRoot: publicSignals[0],
                             nullifier: publicSignals[1],
-                            message: BigNumber.from(message).toString(),
-                            scope: BigNumber.from(scope).toString(),
+                            message: message.toString(),
+                            scope: scope.toString(),
                             points: packPoints(proof)
                         }];
             }

package/dist/index.node.cjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 4.0.0-alpha.5
+ * @version 4.0.0-alpha.7
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -8,13 +8,11 @@
 */
 'use strict';
 
-var bignumber = require('@ethersproject/bignumber');
 var snarkjs = require('snarkjs');
 var download = require('download');
 var fs = require('fs');
 var tmp = require('tmp');
-var bytes = require('@ethersproject/bytes');
-var keccak256 = require('@ethersproject/keccak256');
+var ethers = require('ethers');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -118,9 +116,7 @@ function getSnarkArtifacts(treeDepth) {
  * @returns The message digest.
  */
 function hash(message) {
-    message = bignumber.BigNumber.from(message).toTwos(256).toHexString();
-    message = bytes.zeroPad(message, 32);
-    return (BigInt(keccak256.keccak256(message)) >> BigInt(8)).toString();
+    return (BigInt(ethers.keccak256(ethers.toBeHex(message, 32))) >> BigInt(8)).toString();
 }
 
 /**
@@ -141,12 +137,24 @@ function packPoints(proof) {
     ];
 }
 
+function toBigInt(value) {
+    try {
+        return ethers.toBigInt(value);
+    }
+    catch (error) {
+        if (typeof value === "string") {
+            return ethers.toBigInt(ethers.encodeBytes32String(value));
+        }
+        throw TypeError(error.message);
+    }
+}
+
 /**
  * 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 scope The Semaphore scope.
+ * @param message The Semaphore message.
  * @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.
@@ -157,6 +165,8 @@ function generateProof(identity, groupOrMerkleProof, message, scope, merkleTreeD
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
+                    message = toBigInt(message);
+                    scope = toBigInt(scope);
                     if ("siblings" in groupOrMerkleProof) {
                         merkleProof = groupOrMerkleProof;
                     }
@@ -201,8 +211,8 @@ function generateProof(identity, groupOrMerkleProof, message, scope, merkleTreeD
                             merkleTreeDepth: merkleTreeDepth,
                             merkleTreeRoot: publicSignals[0],
                             nullifier: publicSignals[1],
-                            message: bignumber.BigNumber.from(message).toString(),
-                            scope: bignumber.BigNumber.from(scope).toString(),
+                            message: message.toString(),
+                            scope: scope.toString(),
                             points: packPoints(proof)
                         }];
             }

package/dist/index.node.js

@@ -1,18 +1,16 @@
 /**
  * @module @semaphore-protocol/proof
- * @version 4.0.0-alpha.5
+ * @version 4.0.0-alpha.7
  * @file A library to generate and verify Semaphore proofs.
  * @copyright Ethereum Foundation 2024
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/proof}
 */
-import { BigNumber } from '@ethersproject/bignumber';
 import { groth16 } from 'snarkjs';
 import download from 'download';
 import fs from 'fs';
 import tmp from 'tmp';
-import { zeroPad } from '@ethersproject/bytes';
-import { keccak256 } from '@ethersproject/keccak256';
+import { keccak256, toBeHex, toBigInt as toBigInt$1, encodeBytes32String } from 'ethers';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -116,9 +114,7 @@ function getSnarkArtifacts(treeDepth) {
  * @returns The message digest.
  */
 function hash(message) {
-    message = BigNumber.from(message).toTwos(256).toHexString();
-    message = zeroPad(message, 32);
-    return (BigInt(keccak256(message)) >> BigInt(8)).toString();
+    return (BigInt(keccak256(toBeHex(message, 32))) >> BigInt(8)).toString();
 }
 
 /**
@@ -139,12 +135,24 @@ function packPoints(proof) {
     ];
 }
 
+function toBigInt(value) {
+    try {
+        return toBigInt$1(value);
+    }
+    catch (error) {
+        if (typeof value === "string") {
+            return toBigInt$1(encodeBytes32String(value));
+        }
+        throw TypeError(error.message);
+    }
+}
+
 /**
  * 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 scope The Semaphore scope.
+ * @param message The Semaphore message.
  * @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.
@@ -155,6 +163,8 @@ function generateProof(identity, groupOrMerkleProof, message, scope, merkleTreeD
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
+                    message = toBigInt(message);
+                    scope = toBigInt(scope);
                     if ("siblings" in groupOrMerkleProof) {
                         merkleProof = groupOrMerkleProof;
                     }
@@ -199,8 +209,8 @@ function generateProof(identity, groupOrMerkleProof, message, scope, merkleTreeD
                             merkleTreeDepth: merkleTreeDepth,
                             merkleTreeRoot: publicSignals[0],
                             nullifier: publicSignals[1],
-                            message: BigNumber.from(message).toString(),
-                            scope: BigNumber.from(scope).toString(),
+                            message: message.toString(),
+                            scope: scope.toString(),
                             points: packPoints(proof)
                         }];
             }

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

@@ -1,15 +1,14 @@
-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";
+import { BigNumberish, 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 scope The Semaphore scope.
+ * @param message The Semaphore message.
  * @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>;
+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,8 +1,8 @@
-import { BytesLike, Hexable } from "@ethersproject/bytes";
 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.
  * @returns The message digest.
  */
-export default function hash(message: BytesLike | Hexable | number | bigint): NumericString;
+export default function hash(message: BigNumberish): NumericString;

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

@@ -0,0 +1,2 @@
+import { BigNumberish } from "./types";
+export default function toBigInt(value: BigNumberish | Uint8Array | string): bigint;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/proof",
-  "version": "4.0.0-alpha.5",
+  "version": "4.0.0-alpha.7",
   "description": "A library to generate and verify Semaphore proofs.",
   "type": "module",
   "license": "MIT",
@@ -50,15 +50,13 @@
     "rollup-plugin-typescript2": "^0.36.0"
   },
   "peerDependencies": {
-    "@semaphore-protocol/group": "4.0.0-alpha.5",
-    "@semaphore-protocol/identity": "4.0.0-alpha.5"
+    "@semaphore-protocol/group": "4.0.0-alpha.7",
+    "@semaphore-protocol/identity": "4.0.0-alpha.7"
   },
   "dependencies": {
-    "@ethersproject/bignumber": "5.7.0",
-    "@ethersproject/bytes": "5.7.0",
-    "@ethersproject/keccak256": "5.7.0",
     "@types/snarkjs": "0.7.8",
     "download": "8.0.0",
+    "ethers": "6.10.0",
     "snarkjs": "0.7.3",
     "tmp": "0.2.1"
   }

package/src/generate-proof.ts

@@ -1,19 +1,18 @@
-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"
+import { BigNumberish, SemaphoreProof, SnarkArtifacts } from "./types"
+import toBigInt from "./to-bigint"
 
 /**
  * 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 scope The Semaphore scope.
+ * @param message The Semaphore message.
  * @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.
@@ -21,11 +20,14 @@ import { SemaphoreProof, SnarkArtifacts } from "./types"
 export default async function generateProof(
     identity: Identity,
     groupOrMerkleProof: Group | MerkleProof,
-    message: BytesLike | Hexable | number | bigint,
-    scope: BytesLike | Hexable | number | bigint,
+    message: BigNumberish | Uint8Array | string,
+    scope: BigNumberish | Uint8Array | string,
     merkleTreeDepth?: number,
     snarkArtifacts?: SnarkArtifacts
 ): Promise<SemaphoreProof> {
+    message = toBigInt(message)
+    scope = toBigInt(scope)
+
     let merkleProof
 
     if ("siblings" in groupOrMerkleProof) {
@@ -81,8 +83,8 @@ export default async function generateProof(
         merkleTreeDepth,
         merkleTreeRoot: publicSignals[0],
         nullifier: publicSignals[1],
-        message: BigNumber.from(message).toString() as NumericString,
-        scope: BigNumber.from(scope).toString() as NumericString,
+        message: message.toString() as NumericString,
+        scope: scope.toString() as NumericString,
         points: packPoints(proof)
     }
 }

package/src/hash.ts

@@ -1,16 +1,12 @@
-import { BigNumber } from "@ethersproject/bignumber"
-import { BytesLike, Hexable, zeroPad } from "@ethersproject/bytes"
-import { keccak256 } from "@ethersproject/keccak256"
+import { keccak256, toBeHex } 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.
  * @returns The message digest.
  */
-export default function hash(message: BytesLike | Hexable | number | bigint): NumericString {
-    message = BigNumber.from(message).toTwos(256).toHexString()
-    message = zeroPad(message, 32)
-
-    return (BigInt(keccak256(message)) >> BigInt(8)).toString() as NumericString
+export default function hash(message: BigNumberish): NumericString {
+    return (BigInt(keccak256(toBeHex(message, 32))) >> BigInt(8)).toString()
 }

package/src/to-bigint.ts

@@ -0,0 +1,14 @@
+import { encodeBytes32String, toBigInt as _toBigInt } from "ethers"
+import { BigNumberish } from "./types"
+
+export default function toBigInt(value: BigNumberish | Uint8Array | string): bigint {
+    try {
+        return _toBigInt(value)
+    } catch (error: any) {
+        if (typeof value === "string") {
+            return _toBigInt(encodeBytes32String(value))
+        }
+
+        throw TypeError(error.message)
+    }
+}