@semaphore-protocol/identity 2.6.0 → 3.0.0-beta.5

package/dist/index.mjs

@@ -1,16 +1,16 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 2.6.0
+ * @version 3.0.0-beta.5
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/identity}
 */
 import { BigNumber } from '@ethersproject/bignumber';
-import { poseidon } from 'circomlibjs';
-import { randomBytes } from '@ethersproject/random';
-import { sha256 as sha256$1 } from '@ethersproject/sha2';
+import { keccak256 } from '@ethersproject/keccak256';
 import { toUtf8Bytes } from '@ethersproject/strings';
+import { randomBytes } from '@ethersproject/random';
+import poseidon from 'poseidon-lite';
 
 function checkParameter(value, name, type) {
     if (typeof value !== type) {
@@ -19,14 +19,14 @@ function checkParameter(value, name, type) {
 }
 
 /**
- * Returns an hexadecimal sha256 hash of the message passed as parameter.
- * @param message The string to hash.
- * @returns The hexadecimal hash of the message.
+ * Creates a keccak256 hash of a message compatible with the SNARK scalar modulus.
+ * @param message The message to be hashed.
+ * @returns The message digest.
  */
-function sha256(message) {
-    var hash = sha256$1(toUtf8Bytes(message));
-    return hash;
-}
+function hash(message) {
+    return BigInt(keccak256(toUtf8Bytes(message))) >> BigInt(8);
+}
+
 /**
  * Generates a random big number.
  * @param numberOfBytes The number of bytes of the number.
@@ -73,9 +73,9 @@ var Identity = /** @class */ (function () {
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
         if (!isJsonArray(identityOrMessage)) {
-            var messageHash = sha256(identityOrMessage).slice(2);
-            this._trapdoor = BigNumber.from(sha256("".concat(messageHash, "identity_trapdoor"))).toBigInt();
-            this._nullifier = BigNumber.from(sha256("".concat(messageHash, "identity_nullifier"))).toBigInt();
+            var messageHash = hash(identityOrMessage);
+            this._trapdoor = hash("".concat(messageHash, "identity_trapdoor"));
+            this._nullifier = hash("".concat(messageHash, "identity_nullifier"));
             this._commitment = generateCommitment(this._nullifier, this._trapdoor);
             return;
         }
@@ -138,14 +138,6 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getCommitment = function () {
         return this._commitment;
     };
-    /**
-     * @deprecated since version 2.6.0
-     * Generates the identity commitment from trapdoor and nullifier.
-     * @returns identity commitment
-     */
-    Identity.prototype.generateCommitment = function () {
-        return poseidon([poseidon([this._nullifier, this._trapdoor])]);
-    };
     /**
      * Returns a JSON string with trapdoor and nullifier. It can be used
      * to export the identity and reuse it later.

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 2.6.0
+ * @version 3.0.0-beta.5
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -11,10 +11,14 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var bignumber = require('@ethersproject/bignumber');
-var circomlibjs = require('circomlibjs');
-var random = require('@ethersproject/random');
-var sha2 = require('@ethersproject/sha2');
+var keccak256 = require('@ethersproject/keccak256');
 var strings = require('@ethersproject/strings');
+var random = require('@ethersproject/random');
+var poseidon = require('poseidon-lite');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var poseidon__default = /*#__PURE__*/_interopDefaultLegacy(poseidon);
 
 function checkParameter(value, name, type) {
     if (typeof value !== type) {
@@ -23,14 +27,14 @@ function checkParameter(value, name, type) {
 }
 
 /**
- * Returns an hexadecimal sha256 hash of the message passed as parameter.
- * @param message The string to hash.
- * @returns The hexadecimal hash of the message.
+ * Creates a keccak256 hash of a message compatible with the SNARK scalar modulus.
+ * @param message The message to be hashed.
+ * @returns The message digest.
  */
-function sha256(message) {
-    var hash = sha2.sha256(strings.toUtf8Bytes(message));
-    return hash;
-}
+function hash(message) {
+    return BigInt(keccak256.keccak256(strings.toUtf8Bytes(message))) >> BigInt(8);
+}
+
 /**
  * Generates a random big number.
  * @param numberOfBytes The number of bytes of the number.
@@ -47,7 +51,7 @@ function genRandomNumber(numberOfBytes) {
  * @returns identity commitment
  */
 function generateCommitment(nullifier, trapdoor) {
-    return circomlibjs.poseidon([circomlibjs.poseidon([nullifier, trapdoor])]);
+    return poseidon__default["default"]([poseidon__default["default"]([nullifier, trapdoor])]);
 }
 /**
  * Checks if a string is a JSON.
@@ -77,9 +81,9 @@ var Identity = /** @class */ (function () {
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
         if (!isJsonArray(identityOrMessage)) {
-            var messageHash = sha256(identityOrMessage).slice(2);
-            this._trapdoor = bignumber.BigNumber.from(sha256("".concat(messageHash, "identity_trapdoor"))).toBigInt();
-            this._nullifier = bignumber.BigNumber.from(sha256("".concat(messageHash, "identity_nullifier"))).toBigInt();
+            var messageHash = hash(identityOrMessage);
+            this._trapdoor = hash("".concat(messageHash, "identity_trapdoor"));
+            this._nullifier = hash("".concat(messageHash, "identity_nullifier"));
             this._commitment = generateCommitment(this._nullifier, this._trapdoor);
             return;
         }
@@ -142,14 +146,6 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getCommitment = function () {
         return this._commitment;
     };
-    /**
-     * @deprecated since version 2.6.0
-     * Generates the identity commitment from trapdoor and nullifier.
-     * @returns identity commitment
-     */
-    Identity.prototype.generateCommitment = function () {
-        return circomlibjs.poseidon([circomlibjs.poseidon([this._nullifier, this._trapdoor])]);
-    };
     /**
      * Returns a JSON string with trapdoor and nullifier. It can be used
      * to export the identity and reuse it later.

package/dist/types/hash.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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: string): bigint;

package/dist/types/identity.d.ts

@@ -37,12 +37,6 @@ export default class Identity {
      * @returns The identity commitment.
      */
     getCommitment(): bigint;
-    /**
-     * @deprecated since version 2.6.0
-     * Generates the identity commitment from trapdoor and nullifier.
-     * @returns identity commitment
-     */
-    generateCommitment(): bigint;
     /**
      * Returns a JSON string with trapdoor and nullifier. It can be used
      * to export the identity and reuse it later.

package/dist/types/utils.d.ts

@@ -1,9 +1,3 @@
-/**
- * Returns an hexadecimal sha256 hash of the message passed as parameter.
- * @param message The string to hash.
- * @returns The hexadecimal hash of the message.
- */
-export declare function sha256(message: string): string;
 /**
  * Generates a random big number.
  * @param numberOfBytes The number of bytes of the number.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@semaphore-protocol/identity",
-    "version": "2.6.0",
+    "version": "3.0.0-beta.5",
     "description": "A library to create Semaphore identities.",
     "license": "MIT",
     "main": "dist/index.node.js",
@@ -36,9 +36,9 @@
     },
     "dependencies": {
         "@ethersproject/bignumber": "^5.5.0",
+        "@ethersproject/keccak256": "^5.7.0",
         "@ethersproject/random": "^5.5.1",
-        "@ethersproject/sha2": "^5.6.1",
         "@ethersproject/strings": "^5.6.1",
-        "circomlibjs": "0.0.8"
+        "poseidon-lite": "^0.0.2"
     }
 }

package/src/hash.ts

@@ -0,0 +1,11 @@
+import { keccak256 } from "@ethersproject/keccak256"
+import { toUtf8Bytes } from "@ethersproject/strings"
+
+/**
+ * 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: string): bigint {
+    return BigInt(keccak256(toUtf8Bytes(message))) >> BigInt(8)
+}

package/src/identity.test.ts

@@ -64,9 +64,7 @@ describe("Identity", () => {
 
             const trapdoor = identity.getTrapdoor()
 
-            expect(trapdoor).toBe(
-                BigInt("58952291509798197436757858062402199043831251943841934828591473955215726495831")
-            )
+            expect(trapdoor).toBe(BigInt("211007102311354422986775462856672883657031335757695461477990303178796954863"))
         })
     })
 
@@ -76,20 +74,16 @@ describe("Identity", () => {
 
             const nullifier = identity.getNullifier()
 
-            expect(nullifier).toBe(
-                BigInt("44673097405870585416457571638073245190425597599743560105244308998175651589997")
-            )
+            expect(nullifier).toBe(BigInt("10282208199720122340759039255952223220417076359839127631923809108800013776"))
         })
     })
 
     describe("# generateCommitment", () => {
         it("Should generate an identity commitment", () => {
-            const identity = new Identity("message")
-
-            const commitment = identity.generateCommitment()
+            const { commitment } = new Identity("message")
 
             expect(commitment).toBe(
-                BigInt("1720349790382552497189398984241859233944354304766757200361065203741879866188")
+                BigInt("13192222509545780880434144549342414064490325100975031303723930089730328393905")
             )
         })
     })
@@ -108,8 +102,8 @@ describe("Identity", () => {
 
             const [trapdoor, nullifier] = JSON.parse(identity.toString())
 
-            expect(BigNumber.from(`0x${trapdoor}`).toBigInt()).toBe(identity.getTrapdoor())
-            expect(BigNumber.from(`0x${nullifier}`).toBigInt()).toBe(identity.getNullifier())
+            expect(BigNumber.from(`0x${trapdoor}`).toBigInt()).toBe(identity.trapdoor)
+            expect(BigNumber.from(`0x${nullifier}`).toBigInt()).toBe(identity.nullifier)
         })
     })
 })

package/src/identity.ts

@@ -1,7 +1,7 @@
 import { BigNumber } from "@ethersproject/bignumber"
-import { poseidon } from "circomlibjs"
 import checkParameter from "./checkParameter"
-import { generateCommitment, genRandomNumber, isJsonArray, sha256 } from "./utils"
+import hash from "./hash"
+import { generateCommitment, genRandomNumber, isJsonArray } from "./utils"
 
 export default class Identity {
     private _trapdoor: bigint
@@ -24,10 +24,10 @@ export default class Identity {
         checkParameter(identityOrMessage, "identityOrMessage", "string")
 
         if (!isJsonArray(identityOrMessage)) {
-            const messageHash = sha256(identityOrMessage).slice(2)
+            const messageHash = hash(identityOrMessage)
 
-            this._trapdoor = BigNumber.from(sha256(`${messageHash}identity_trapdoor`)).toBigInt()
-            this._nullifier = BigNumber.from(sha256(`${messageHash}identity_nullifier`)).toBigInt()
+            this._trapdoor = hash(`${messageHash}identity_trapdoor`)
+            this._nullifier = hash(`${messageHash}identity_nullifier`)
             this._commitment = generateCommitment(this._nullifier, this._trapdoor)
 
             return
@@ -88,15 +88,6 @@ export default class Identity {
         return this._commitment
     }
 
-    /**
-     * @deprecated since version 2.6.0
-     * Generates the identity commitment from trapdoor and nullifier.
-     * @returns identity commitment
-     */
-    public generateCommitment(): bigint {
-        return poseidon([poseidon([this._nullifier, this._trapdoor])])
-    }
-
     /**
      * Returns a JSON string with trapdoor and nullifier. It can be used
      * to export the identity and reuse it later.

package/src/utils.ts

@@ -1,19 +1,6 @@
 import { BigNumber } from "@ethersproject/bignumber"
 import { randomBytes } from "@ethersproject/random"
-import { sha256 as _sha256 } from "@ethersproject/sha2"
-import { toUtf8Bytes } from "@ethersproject/strings"
-import { poseidon } from "circomlibjs"
-
-/**
- * Returns an hexadecimal sha256 hash of the message passed as parameter.
- * @param message The string to hash.
- * @returns The hexadecimal hash of the message.
- */
-export function sha256(message: string): string {
-    const hash = _sha256(toUtf8Bytes(message))
-
-    return hash
-}
+import poseidon from "poseidon-lite"
 
 /**
  * Generates a random big number.