@semaphore-protocol/identity 3.4.0 → 3.6.0-1

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 3.4.0
+ * @version 3.6.0-1
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -8,14 +8,8 @@
 */
 import { BigNumber } from '@ethersproject/bignumber';
 import hash from 'js-sha512';
-import { randomBytes } from '@ethersproject/random';
 import require$$1 from 'crypto';
-
-function checkParameter(value, name, type) {
-    if (typeof value !== type) {
-        throw new TypeError("Parameter '".concat(name, "' is not a ").concat(type));
-    }
-}
+import { randomBytes } from '@ethersproject/random';
 
 var poseidon1$1 = {};
 
@@ -1079,6 +1073,12 @@ function poseidon2(inputs) {
   return (0, _slow.default)(inputs, c);
 }
 
+function checkParameter(value, name, type) {
+    if (typeof value !== type) {
+        throw new TypeError("Parameter '".concat(name, "' is not a ").concat(type));
+    }
+}
+
 /**
  * Generates a random big number.
  * @param numberOfBytes The number of bytes of the number.
@@ -1088,15 +1088,6 @@ function genRandomNumber(numberOfBytes) {
     if (numberOfBytes === void 0) { numberOfBytes = 31; }
     return BigNumber.from(randomBytes(numberOfBytes)).toBigInt();
 }
-/**
- * Generates the identity commitment from trapdoor and nullifier.
- * @param nullifier The identity nullifier.
- * @param trapdoor The identity trapdoor.
- * @returns identity commitment
- */
-function generateCommitment(nullifier, trapdoor) {
-    return poseidon1_2([poseidon2_2([nullifier, trapdoor])]);
-}
 /**
  * Checks if a string is a JSON.
  * @param jsonString The JSON string.
@@ -1120,22 +1111,25 @@ var Identity = /** @class */ (function () {
         if (identityOrMessage === undefined) {
             this._trapdoor = genRandomNumber();
             this._nullifier = genRandomNumber();
-            this._commitment = generateCommitment(this._nullifier, this._trapdoor);
+            this._secret = poseidon2_2([this._nullifier, this._trapdoor]);
+            this._commitment = poseidon1_2([this._secret]);
             return;
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
         if (!isJsonArray(identityOrMessage)) {
             var h = hash.sha512(identityOrMessage).padStart(128, "0");
-            // alt_bn128 is 253.6 bits, so we can safely use 253 bits
+            // 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);
+            this._secret = poseidon2_2([this._nullifier, this._trapdoor]);
+            this._commitment = poseidon1_2([this._secret]);
             return;
         }
         var _a = JSON.parse(identityOrMessage), trapdoor = _a[0], nullifier = _a[1];
         this._trapdoor = BigNumber.from(trapdoor).toBigInt();
         this._nullifier = BigNumber.from(nullifier).toBigInt();
-        this._commitment = generateCommitment(this._nullifier, this._trapdoor);
+        this._secret = poseidon2_2([this._nullifier, this._trapdoor]);
+        this._commitment = poseidon1_2([this._secret]);
     }
     Object.defineProperty(Identity.prototype, "trapdoor", {
         /**
@@ -1173,6 +1167,24 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getNullifier = function () {
         return this._nullifier;
     };
+    Object.defineProperty(Identity.prototype, "secret", {
+        /**
+         * Returns the identity secret.
+         * @returns The identity secret.
+         */
+        get: function () {
+            return this._secret;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Returns the identity secret.
+     * @returns The identity secret.
+     */
+    Identity.prototype.getSecret = function () {
+        return this._secret;
+    };
     Object.defineProperty(Identity.prototype, "commitment", {
         /**
          * Returns the identity commitment.

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 3.4.0
+ * @version 3.6.0-1
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -12,20 +12,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var bignumber = require('@ethersproject/bignumber');
 var hash = require('js-sha512');
-var random$1 = require('@ethersproject/random');
 var require$$1 = require('crypto');
+var random$1 = require('@ethersproject/random');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var hash__default = /*#__PURE__*/_interopDefaultLegacy(hash);
 var require$$1__default = /*#__PURE__*/_interopDefaultLegacy(require$$1);
 
-function checkParameter(value, name, type) {
-    if (typeof value !== type) {
-        throw new TypeError("Parameter '".concat(name, "' is not a ").concat(type));
-    }
-}
-
 var poseidon1$1 = {};
 
 var scalar = {};
@@ -1088,6 +1082,12 @@ function poseidon2(inputs) {
   return (0, _slow.default)(inputs, c);
 }
 
+function checkParameter(value, name, type) {
+    if (typeof value !== type) {
+        throw new TypeError("Parameter '".concat(name, "' is not a ").concat(type));
+    }
+}
+
 /**
  * Generates a random big number.
  * @param numberOfBytes The number of bytes of the number.
@@ -1097,15 +1097,6 @@ function genRandomNumber(numberOfBytes) {
     if (numberOfBytes === void 0) { numberOfBytes = 31; }
     return bignumber.BigNumber.from(random$1.randomBytes(numberOfBytes)).toBigInt();
 }
-/**
- * Generates the identity commitment from trapdoor and nullifier.
- * @param nullifier The identity nullifier.
- * @param trapdoor The identity trapdoor.
- * @returns identity commitment
- */
-function generateCommitment(nullifier, trapdoor) {
-    return poseidon1_2([poseidon2_2([nullifier, trapdoor])]);
-}
 /**
  * Checks if a string is a JSON.
  * @param jsonString The JSON string.
@@ -1129,22 +1120,25 @@ var Identity = /** @class */ (function () {
         if (identityOrMessage === undefined) {
             this._trapdoor = genRandomNumber();
             this._nullifier = genRandomNumber();
-            this._commitment = generateCommitment(this._nullifier, this._trapdoor);
+            this._secret = poseidon2_2([this._nullifier, this._trapdoor]);
+            this._commitment = poseidon1_2([this._secret]);
             return;
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
         if (!isJsonArray(identityOrMessage)) {
             var h = hash__default["default"].sha512(identityOrMessage).padStart(128, "0");
-            // alt_bn128 is 253.6 bits, so we can safely use 253 bits
+            // 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);
+            this._secret = poseidon2_2([this._nullifier, this._trapdoor]);
+            this._commitment = poseidon1_2([this._secret]);
             return;
         }
         var _a = JSON.parse(identityOrMessage), trapdoor = _a[0], nullifier = _a[1];
         this._trapdoor = bignumber.BigNumber.from(trapdoor).toBigInt();
         this._nullifier = bignumber.BigNumber.from(nullifier).toBigInt();
-        this._commitment = generateCommitment(this._nullifier, this._trapdoor);
+        this._secret = poseidon2_2([this._nullifier, this._trapdoor]);
+        this._commitment = poseidon1_2([this._secret]);
     }
     Object.defineProperty(Identity.prototype, "trapdoor", {
         /**
@@ -1182,6 +1176,24 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getNullifier = function () {
         return this._nullifier;
     };
+    Object.defineProperty(Identity.prototype, "secret", {
+        /**
+         * Returns the identity secret.
+         * @returns The identity secret.
+         */
+        get: function () {
+            return this._secret;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Returns the identity secret.
+     * @returns The identity secret.
+     */
+    Identity.prototype.getSecret = function () {
+        return this._secret;
+    };
     Object.defineProperty(Identity.prototype, "commitment", {
         /**
          * Returns the identity commitment.

package/dist/types/identity.d.ts

@@ -1,6 +1,7 @@
 export default class Identity {
     private _trapdoor;
     private _nullifier;
+    private _secret;
     private _commitment;
     /**
      * Initializes the class attributes based on the strategy passed as parameter.
@@ -27,6 +28,16 @@ export default class Identity {
      * @returns The identity nullifier.
      */
     getNullifier(): bigint;
+    /**
+     * Returns the identity secret.
+     * @returns The identity secret.
+     */
+    get secret(): bigint;
+    /**
+     * Returns the identity secret.
+     * @returns The identity secret.
+     */
+    getSecret(): bigint;
     /**
      * Returns the identity commitment.
      * @returns The identity commitment.

package/dist/types/utils.d.ts

@@ -4,13 +4,6 @@
  * @returns The generated random number.
  */
 export declare function genRandomNumber(numberOfBytes?: number): bigint;
-/**
- * Generates the identity commitment from trapdoor and nullifier.
- * @param nullifier The identity nullifier.
- * @param trapdoor The identity trapdoor.
- * @returns identity commitment
- */
-export declare function generateCommitment(nullifier: bigint, trapdoor: bigint): bigint;
 /**
  * Checks if a string is a JSON.
  * @param jsonString The JSON string.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/identity",
-  "version": "3.4.0",
+  "version": "3.6.0-1",
   "description": "A library to create Semaphore identities.",
   "license": "MIT",
   "main": "dist/index.node.js",
@@ -43,5 +43,6 @@
     "@ethersproject/random": "^5.5.1",
     "@ethersproject/strings": "^5.6.1",
     "js-sha512": "^0.8.0"
-  }
+  },
+  "stableVersion": "3.5.0"
 }

package/src/identity.test.ts

@@ -19,6 +19,7 @@ describe("Identity", () => {
 
             expect(identity1.trapdoor).not.toBe(identity2.getTrapdoor())
             expect(identity1.nullifier).not.toBe(identity2.getNullifier())
+            expect(identity1.secret).not.toBe(identity2.getSecret())
             expect(identity1.commitment).not.toBe(identity2.getCommitment())
         })
 
@@ -82,8 +83,18 @@ describe("Identity", () => {
         })
     })
 
-    describe("# generateCommitment", () => {
-        it("Should generate an identity commitment", () => {
+    describe("# getSecret", () => {
+        it("Should return an identity secret", () => {
+            const { secret } = new Identity("message")
+
+            expect(secret.toString()).toBe(
+                "17452394798940441025978193762953691632066258438336130543532009665042636950194"
+            )
+        })
+    })
+
+    describe("# getCommitment", () => {
+        it("Should return an identity commitment", () => {
             const { commitment } = new Identity("message")
 
             expect(commitment.toString()).toBe(

package/src/identity.ts

@@ -1,11 +1,14 @@
 import { BigNumber } from "@ethersproject/bignumber"
 import hash from "js-sha512"
+import { poseidon1 } from "poseidon-lite/poseidon1"
+import { poseidon2 } from "poseidon-lite/poseidon2"
 import checkParameter from "./checkParameter"
-import { generateCommitment, genRandomNumber, isJsonArray } from "./utils"
+import { genRandomNumber, isJsonArray } from "./utils"
 
 export default class Identity {
     private _trapdoor: bigint
     private _nullifier: bigint
+    private _secret: bigint
     private _commitment: bigint
 
     /**
@@ -16,7 +19,8 @@ export default class Identity {
         if (identityOrMessage === undefined) {
             this._trapdoor = genRandomNumber()
             this._nullifier = genRandomNumber()
-            this._commitment = generateCommitment(this._nullifier, this._trapdoor)
+            this._secret = poseidon2([this._nullifier, this._trapdoor])
+            this._commitment = poseidon1([this._secret])
 
             return
         }
@@ -25,10 +29,11 @@ export default class Identity {
 
         if (!isJsonArray(identityOrMessage)) {
             const h = hash.sha512(identityOrMessage).padStart(128, "0")
-            // alt_bn128 is 253.6 bits, so we can safely use 253 bits
+            // 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)
+            this._secret = poseidon2([this._nullifier, this._trapdoor])
+            this._commitment = poseidon1([this._secret])
 
             return
         }
@@ -37,7 +42,8 @@ export default class Identity {
 
         this._trapdoor = BigNumber.from(trapdoor).toBigInt()
         this._nullifier = BigNumber.from(nullifier).toBigInt()
-        this._commitment = generateCommitment(this._nullifier, this._trapdoor)
+        this._secret = poseidon2([this._nullifier, this._trapdoor])
+        this._commitment = poseidon1([this._secret])
     }
 
     /**
@@ -72,6 +78,22 @@ export default class Identity {
         return this._nullifier
     }
 
+    /**
+     * Returns the identity secret.
+     * @returns The identity secret.
+     */
+    public get secret(): bigint {
+        return this._secret
+    }
+
+    /**
+     * Returns the identity secret.
+     * @returns The identity secret.
+     */
+    public getSecret(): bigint {
+        return this._secret
+    }
+
     /**
      * Returns the identity commitment.
      * @returns The identity commitment.

package/src/utils.ts

@@ -1,7 +1,5 @@
 import { BigNumber } from "@ethersproject/bignumber"
 import { randomBytes } from "@ethersproject/random"
-import { poseidon1 } from "poseidon-lite/poseidon1"
-import { poseidon2 } from "poseidon-lite/poseidon2"
 
 /**
  * Generates a random big number.
@@ -12,16 +10,6 @@ export function genRandomNumber(numberOfBytes = 31): bigint {
     return BigNumber.from(randomBytes(numberOfBytes)).toBigInt()
 }
 
-/**
- * Generates the identity commitment from trapdoor and nullifier.
- * @param nullifier The identity nullifier.
- * @param trapdoor The identity trapdoor.
- * @returns identity commitment
- */
-export function generateCommitment(nullifier: bigint, trapdoor: bigint): bigint {
-    return poseidon1([poseidon2([nullifier, trapdoor])])
-}
-
 /**
  * Checks if a string is a JSON.
  * @param jsonString The JSON string.