@semaphore-protocol/identity 3.0.0 → 3.2.0

package/README.md

@@ -40,7 +40,7 @@
             🔎 Issues
         </a>
         <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
-        <a href="https://discord.gg/6mSdGHnstH">
+        <a href="https://semaphore.appliedzkp.org/discord">
             🗣️ Chat &amp; Support
         </a>
     </h4>

package/dist/index.mjs

@@ -1,16 +1,16 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 3.0.0
+ * @version 3.2.0
  * @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 { keccak256 } from '@ethersproject/keccak256';
-import { toUtf8Bytes } from '@ethersproject/strings';
+import hash from 'js-sha512';
 import { randomBytes } from '@ethersproject/random';
-import poseidon from 'poseidon-lite';
+import { poseidon1 } from 'poseidon-lite/poseidon1';
+import { poseidon2 } from 'poseidon-lite/poseidon2';
 
 function checkParameter(value, name, type) {
     if (typeof value !== type) {
@@ -18,15 +18,6 @@ function checkParameter(value, name, type) {
     }
 }
 
-/**
- * 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 hash(message) {
-    return BigInt(keccak256(toUtf8Bytes(message))) >> BigInt(8);
-}
-
 /**
  * Generates a random big number.
  * @param numberOfBytes The number of bytes of the number.
@@ -43,7 +34,7 @@ function genRandomNumber(numberOfBytes) {
  * @returns identity commitment
  */
 function generateCommitment(nullifier, trapdoor) {
-    return poseidon([poseidon([nullifier, trapdoor])]);
+    return poseidon1([poseidon2([nullifier, trapdoor])]);
 }
 /**
  * Checks if a string is a JSON.
@@ -73,15 +64,16 @@ var Identity = /** @class */ (function () {
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
         if (!isJsonArray(identityOrMessage)) {
-            var messageHash = hash(identityOrMessage);
-            this._trapdoor = hash("".concat(messageHash, "identity_trapdoor"));
-            this._nullifier = hash("".concat(messageHash, "identity_nullifier"));
+            var h = hash.sha512(identityOrMessage).padStart(128, "0");
+            // alt_bn128 is 253.6 bits, so we can safely use 253 bits
+            this._trapdoor = BigInt("0x".concat(h.slice(64))) >> BigInt(3);
+            this._nullifier = BigInt("0x".concat(h.slice(0, 64))) >> BigInt(3);
             this._commitment = generateCommitment(this._nullifier, this._trapdoor);
             return;
         }
         var _a = JSON.parse(identityOrMessage), trapdoor = _a[0], nullifier = _a[1];
-        this._trapdoor = BigNumber.from("0x".concat(trapdoor)).toBigInt();
-        this._nullifier = BigNumber.from("0x".concat(nullifier)).toBigInt();
+        this._trapdoor = BigNumber.from(trapdoor).toBigInt();
+        this._nullifier = BigNumber.from(nullifier).toBigInt();
         this._commitment = generateCommitment(this._nullifier, this._trapdoor);
     }
     Object.defineProperty(Identity.prototype, "trapdoor", {
@@ -144,7 +136,7 @@ var Identity = /** @class */ (function () {
      * @returns The string representation of the identity.
      */
     Identity.prototype.toString = function () {
-        return JSON.stringify([this._trapdoor.toString(16), this._nullifier.toString(16)]);
+        return JSON.stringify(["0x".concat(this._trapdoor.toString(16)), "0x".concat(this._nullifier.toString(16))]);
     };
     return Identity;
 }());

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 3.0.0
+ * @version 3.2.0
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -11,14 +11,14 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var bignumber = require('@ethersproject/bignumber');
-var keccak256 = require('@ethersproject/keccak256');
-var strings = require('@ethersproject/strings');
+var hash = require('js-sha512');
 var random = require('@ethersproject/random');
-var poseidon = require('poseidon-lite');
+var poseidon1 = require('poseidon-lite/poseidon1');
+var poseidon2 = require('poseidon-lite/poseidon2');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-var poseidon__default = /*#__PURE__*/_interopDefaultLegacy(poseidon);
+var hash__default = /*#__PURE__*/_interopDefaultLegacy(hash);
 
 function checkParameter(value, name, type) {
     if (typeof value !== type) {
@@ -26,15 +26,6 @@ function checkParameter(value, name, type) {
     }
 }
 
-/**
- * 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 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.
@@ -51,7 +42,7 @@ function genRandomNumber(numberOfBytes) {
  * @returns identity commitment
  */
 function generateCommitment(nullifier, trapdoor) {
-    return poseidon__default["default"]([poseidon__default["default"]([nullifier, trapdoor])]);
+    return poseidon1.poseidon1([poseidon2.poseidon2([nullifier, trapdoor])]);
 }
 /**
  * Checks if a string is a JSON.
@@ -81,15 +72,16 @@ var Identity = /** @class */ (function () {
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
         if (!isJsonArray(identityOrMessage)) {
-            var messageHash = hash(identityOrMessage);
-            this._trapdoor = hash("".concat(messageHash, "identity_trapdoor"));
-            this._nullifier = hash("".concat(messageHash, "identity_nullifier"));
+            var h = hash__default["default"].sha512(identityOrMessage).padStart(128, "0");
+            // alt_bn128 is 253.6 bits, so we can safely use 253 bits
+            this._trapdoor = BigInt("0x".concat(h.slice(64))) >> BigInt(3);
+            this._nullifier = BigInt("0x".concat(h.slice(0, 64))) >> BigInt(3);
             this._commitment = generateCommitment(this._nullifier, this._trapdoor);
             return;
         }
         var _a = JSON.parse(identityOrMessage), trapdoor = _a[0], nullifier = _a[1];
-        this._trapdoor = bignumber.BigNumber.from("0x".concat(trapdoor)).toBigInt();
-        this._nullifier = bignumber.BigNumber.from("0x".concat(nullifier)).toBigInt();
+        this._trapdoor = bignumber.BigNumber.from(trapdoor).toBigInt();
+        this._nullifier = bignumber.BigNumber.from(nullifier).toBigInt();
         this._commitment = generateCommitment(this._nullifier, this._trapdoor);
     }
     Object.defineProperty(Identity.prototype, "trapdoor", {
@@ -152,7 +144,7 @@ var Identity = /** @class */ (function () {
      * @returns The string representation of the identity.
      */
     Identity.prototype.toString = function () {
-        return JSON.stringify([this._trapdoor.toString(16), this._nullifier.toString(16)]);
+        return JSON.stringify(["0x".concat(this._trapdoor.toString(16)), "0x".concat(this._nullifier.toString(16))]);
     };
     return Identity;
 }());

package/package.json

@@ -1,44 +1,45 @@
 {
-    "name": "@semaphore-protocol/identity",
-    "version": "3.0.0",
-    "description": "A library to create Semaphore identities.",
-    "license": "MIT",
-    "main": "dist/index.node.js",
-    "exports": {
-        "import": "./dist/index.mjs",
-        "require": "./dist/index.node.js"
-    },
-    "types": "dist/types/index.d.ts",
-    "files": [
-        "dist/",
-        "src/",
-        "LICENSE",
-        "README.md"
-    ],
-    "repository": "https://github.com/semaphore-protocol/semaphore",
-    "homepage": "https://github.com/semaphore-protocol/semaphore/tree/main/packages/identity",
-    "bugs": {
-        "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",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/identity"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "devDependencies": {
-        "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-typescript2": "^0.31.2",
-        "typedoc": "^0.22.11"
-    },
-    "dependencies": {
-        "@ethersproject/bignumber": "^5.5.0",
-        "@ethersproject/keccak256": "^5.7.0",
-        "@ethersproject/random": "^5.5.1",
-        "@ethersproject/strings": "^5.6.1",
-        "poseidon-lite": "0.0.2"
-    }
-}
+  "name": "@semaphore-protocol/identity",
+  "version": "3.2.0",
+  "description": "A library to create Semaphore identities.",
+  "license": "MIT",
+  "main": "dist/index.node.js",
+  "exports": {
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.node.js"
+  },
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist/",
+    "src/",
+    "LICENSE",
+    "README.md"
+  ],
+  "repository": "https://github.com/semaphore-protocol/semaphore",
+  "homepage": "https://github.com/semaphore-protocol/semaphore/tree/main/packages/identity",
+  "bugs": {
+    "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",
+    "prepublishOnly": "yarn build",
+    "docs": "typedoc src/index.ts --out ../../docs/identity"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-typescript2": "^0.31.2",
+    "typedoc": "^0.22.11"
+  },
+  "dependencies": {
+    "@ethersproject/bignumber": "^5.5.0",
+    "@ethersproject/keccak256": "^5.7.0",
+    "@ethersproject/random": "^5.5.1",
+    "@ethersproject/strings": "^5.6.1",
+    "js-sha512": "^0.8.0",
+    "poseidon-lite": "^0.1.0"
+  }
+}

package/src/identity.test.ts

@@ -45,7 +45,7 @@ describe("Identity", () => {
         it("Should not recreate an existing invalid identity", () => {
             const fun = () => new Identity('[true, "01323"]')
 
-            expect(fun).toThrow("invalid BigNumber string")
+            expect(fun).toThrow("invalid BigNumber value")
         })
 
         it("Should recreate an existing identity", () => {
@@ -64,7 +64,9 @@ describe("Identity", () => {
 
             const trapdoor = identity.getTrapdoor()
 
-            expect(trapdoor).toBe(BigInt("211007102311354422986775462856672883657031335757695461477990303178796954863"))
+            expect(trapdoor.toString()).toBe(
+                "11566083507498623434013707198824105161167204201250008419741119866456392774309"
+            )
         })
     })
 
@@ -74,7 +76,9 @@ describe("Identity", () => {
 
             const nullifier = identity.getNullifier()
 
-            expect(nullifier).toBe(BigInt("10282208199720122340759039255952223220417076359839127631923809108800013776"))
+            expect(nullifier.toString()).toBe(
+                "14070056666392584007908120012103355272369511035580155843212703537125048345255"
+            )
         })
     })
 
@@ -82,8 +86,8 @@ describe("Identity", () => {
         it("Should generate an identity commitment", () => {
             const { commitment } = new Identity("message")
 
-            expect(commitment).toBe(
-                BigInt("13192222509545780880434144549342414064490325100975031303723930089730328393905")
+            expect(commitment.toString()).toBe(
+                "19361462367798001240039467285882167157718016385695743307694056771074972404368"
             )
         })
     })
@@ -102,8 +106,8 @@ describe("Identity", () => {
 
             const [trapdoor, nullifier] = JSON.parse(identity.toString())
 
-            expect(BigNumber.from(`0x${trapdoor}`).toBigInt()).toBe(identity.trapdoor)
-            expect(BigNumber.from(`0x${nullifier}`).toBigInt()).toBe(identity.nullifier)
+            expect(BigNumber.from(trapdoor).toBigInt()).toBe(identity.trapdoor)
+            expect(BigNumber.from(nullifier).toBigInt()).toBe(identity.nullifier)
         })
     })
 })

package/src/identity.ts

@@ -1,6 +1,6 @@
 import { BigNumber } from "@ethersproject/bignumber"
+import hash from "js-sha512"
 import checkParameter from "./checkParameter"
-import hash from "./hash"
 import { generateCommitment, genRandomNumber, isJsonArray } from "./utils"
 
 export default class Identity {
@@ -24,10 +24,10 @@ export default class Identity {
         checkParameter(identityOrMessage, "identityOrMessage", "string")
 
         if (!isJsonArray(identityOrMessage)) {
-            const messageHash = hash(identityOrMessage)
-
-            this._trapdoor = hash(`${messageHash}identity_trapdoor`)
-            this._nullifier = hash(`${messageHash}identity_nullifier`)
+            const h = hash.sha512(identityOrMessage).padStart(128, "0")
+            // alt_bn128 is 253.6 bits, so we can safely use 253 bits
+            this._trapdoor = BigInt(`0x${h.slice(64)}`) >> BigInt(3)
+            this._nullifier = BigInt(`0x${h.slice(0, 64)}`) >> BigInt(3)
             this._commitment = generateCommitment(this._nullifier, this._trapdoor)
 
             return
@@ -35,8 +35,8 @@ export default class Identity {
 
         const [trapdoor, nullifier] = JSON.parse(identityOrMessage)
 
-        this._trapdoor = BigNumber.from(`0x${trapdoor}`).toBigInt()
-        this._nullifier = BigNumber.from(`0x${nullifier}`).toBigInt()
+        this._trapdoor = BigNumber.from(trapdoor).toBigInt()
+        this._nullifier = BigNumber.from(nullifier).toBigInt()
         this._commitment = generateCommitment(this._nullifier, this._trapdoor)
     }
 
@@ -94,6 +94,6 @@ export default class Identity {
      * @returns The string representation of the identity.
      */
     public toString(): string {
-        return JSON.stringify([this._trapdoor.toString(16), this._nullifier.toString(16)])
+        return JSON.stringify([`0x${this._trapdoor.toString(16)}`, `0x${this._nullifier.toString(16)}`])
     }
 }

package/src/utils.ts

@@ -1,6 +1,7 @@
 import { BigNumber } from "@ethersproject/bignumber"
 import { randomBytes } from "@ethersproject/random"
-import poseidon from "poseidon-lite"
+import { poseidon1 } from "poseidon-lite/poseidon1"
+import { poseidon2 } from "poseidon-lite/poseidon2"
 
 /**
  * Generates a random big number.
@@ -18,7 +19,7 @@ export function genRandomNumber(numberOfBytes = 31): bigint {
  * @returns identity commitment
  */
 export function generateCommitment(nullifier: bigint, trapdoor: bigint): bigint {
-    return poseidon([poseidon([nullifier, trapdoor])])
+    return poseidon1([poseidon2([nullifier, trapdoor])])
 }
 
 /**

package/dist/types/hash.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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/src/hash.ts

@@ -1,11 +0,0 @@
-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)
-}