@semaphore-protocol/identity 2.5.0 → 2.6.1

package/README.md

@@ -46,8 +46,8 @@
     </h4>
 </div>
 
-| This library provides a class that can be used to create identities compatible with the Semaphore [circuits](https://github.com/semaphore-protocol/semaphore/tree/main/circuits). Each identity contains two private values (_trapdoor_ and _nullifier_), and the Poseidon hash of these values (_commitment_) is used as the public identifier of the Semaphore identity. |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| This library provides a class that can be used to create identities compatible with the Semaphore [circuits](https://github.com/semaphore-protocol/semaphore/tree/main/circuits). Each identity contains two secret values: _trapdoor_ and _nullifier_, and one public value: _commitment_. The Poseidon hash of the secret values is the identity secret, and its hash is the identity commitment. |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 ## 🛠 Install
 
@@ -72,30 +72,15 @@ yarn add @semaphore-protocol/identity
 ```typescript
 import { Identity } from "@semaphore-protocol/identity"
 
-// Trapdoor and nullifier are generated randomly.
+// The identity can be generated randomly.
 const identity1 = new Identity()
 
-// Trapdoor and nullifier are generated deterministically from a secret message.
+// Deterministically from a secret message.
 const identity2 = new Identity("secret-message")
 
-// Trapdoor and nullifier are generated from an existing identity.
+// Or it can be retrieved from an existing identity.
 const identity3 = new Identity(identity1.toString())
-```
-
-\# **getTrapdoor**(): _bigint_
-
-```typescript
-const trapdoor = identity.getTrapdoor()
-```
-
-\# **getNullifier**(): _bigint_
 
-```typescript
-const nullifier = identity.getNullifier()
-```
-
-\# **generateCommitment**(): _bigint_
-
-```typescript
-const commitment = identity.generateCommitment()
+// Trapdoor, nullifier and commitment are the attributes (e.g. JS getters).
+const { trapdoor, nullifier, commitment } = identity1
 ```

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 2.5.0
+ * @version 2.6.1
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -36,6 +36,15 @@ 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 poseidon([poseidon([nullifier, trapdoor])]);
+}
 /**
  * Checks if a string is a JSON.
  * @param jsonString The JSON string.
@@ -59,6 +68,7 @@ var Identity = /** @class */ (function () {
         if (identityOrMessage === undefined) {
             this._trapdoor = genRandomNumber();
             this._nullifier = genRandomNumber();
+            this._commitment = generateCommitment(this._nullifier, this._trapdoor);
             return;
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
@@ -66,12 +76,25 @@ var Identity = /** @class */ (function () {
             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();
+            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._commitment = generateCommitment(this._nullifier, this._trapdoor);
     }
+    Object.defineProperty(Identity.prototype, "trapdoor", {
+        /**
+         * Returns the identity trapdoor.
+         * @returns The identity trapdoor.
+         */
+        get: function () {
+            return this._trapdoor;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Returns the identity trapdoor.
      * @returns The identity trapdoor.
@@ -79,6 +102,17 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getTrapdoor = function () {
         return this._trapdoor;
     };
+    Object.defineProperty(Identity.prototype, "nullifier", {
+        /**
+         * Returns the identity nullifier.
+         * @returns The identity nullifier.
+         */
+        get: function () {
+            return this._nullifier;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Returns the identity nullifier.
      * @returns The identity nullifier.
@@ -86,7 +120,26 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getNullifier = function () {
         return this._nullifier;
     };
+    Object.defineProperty(Identity.prototype, "commitment", {
+        /**
+         * Returns the identity commitment.
+         * @returns The identity commitment.
+         */
+        get: function () {
+            return this._commitment;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Returns the identity commitment.
+     * @returns The identity commitment.
+     */
+    Identity.prototype.getCommitment = function () {
+        return this._commitment;
+    };
     /**
+     * @deprecated since version 2.6.0
      * Generates the identity commitment from trapdoor and nullifier.
      * @returns identity commitment
      */

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 2.5.0
+ * @version 2.6.1
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -40,6 +40,15 @@ function genRandomNumber(numberOfBytes) {
     if (numberOfBytes === void 0) { numberOfBytes = 31; }
     return bignumber.BigNumber.from(random.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 circomlibjs.poseidon([circomlibjs.poseidon([nullifier, trapdoor])]);
+}
 /**
  * Checks if a string is a JSON.
  * @param jsonString The JSON string.
@@ -63,6 +72,7 @@ var Identity = /** @class */ (function () {
         if (identityOrMessage === undefined) {
             this._trapdoor = genRandomNumber();
             this._nullifier = genRandomNumber();
+            this._commitment = generateCommitment(this._nullifier, this._trapdoor);
             return;
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
@@ -70,12 +80,25 @@ var Identity = /** @class */ (function () {
             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();
+            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._commitment = generateCommitment(this._nullifier, this._trapdoor);
     }
+    Object.defineProperty(Identity.prototype, "trapdoor", {
+        /**
+         * Returns the identity trapdoor.
+         * @returns The identity trapdoor.
+         */
+        get: function () {
+            return this._trapdoor;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Returns the identity trapdoor.
      * @returns The identity trapdoor.
@@ -83,6 +106,17 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getTrapdoor = function () {
         return this._trapdoor;
     };
+    Object.defineProperty(Identity.prototype, "nullifier", {
+        /**
+         * Returns the identity nullifier.
+         * @returns The identity nullifier.
+         */
+        get: function () {
+            return this._nullifier;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Returns the identity nullifier.
      * @returns The identity nullifier.
@@ -90,7 +124,26 @@ var Identity = /** @class */ (function () {
     Identity.prototype.getNullifier = function () {
         return this._nullifier;
     };
+    Object.defineProperty(Identity.prototype, "commitment", {
+        /**
+         * Returns the identity commitment.
+         * @returns The identity commitment.
+         */
+        get: function () {
+            return this._commitment;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Returns the identity commitment.
+     * @returns The identity commitment.
+     */
+    Identity.prototype.getCommitment = function () {
+        return this._commitment;
+    };
     /**
+     * @deprecated since version 2.6.0
      * Generates the identity commitment from trapdoor and nullifier.
      * @returns identity commitment
      */

package/dist/types/identity.d.ts

@@ -1,22 +1,44 @@
 export default class Identity {
     private _trapdoor;
     private _nullifier;
+    private _commitment;
     /**
      * Initializes the class attributes based on the strategy passed as parameter.
      * @param identityOrMessage Additional data needed to create identity for given strategy.
      */
     constructor(identityOrMessage?: string);
+    /**
+     * Returns the identity trapdoor.
+     * @returns The identity trapdoor.
+     */
+    get trapdoor(): bigint;
     /**
      * Returns the identity trapdoor.
      * @returns The identity trapdoor.
      */
     getTrapdoor(): bigint;
+    /**
+     * Returns the identity nullifier.
+     * @returns The identity nullifier.
+     */
+    get nullifier(): bigint;
     /**
      * Returns the identity nullifier.
      * @returns The identity nullifier.
      */
     getNullifier(): bigint;
     /**
+     * Returns the identity commitment.
+     * @returns The identity commitment.
+     */
+    get commitment(): bigint;
+    /**
+     * Returns the identity commitment.
+     * @returns The identity commitment.
+     */
+    getCommitment(): bigint;
+    /**
+     * @deprecated since version 2.6.0
      * Generates the identity commitment from trapdoor and nullifier.
      * @returns identity commitment
      */

package/dist/types/utils.d.ts

@@ -10,6 +10,13 @@ export declare function sha256(message: string): string;
  * @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": "2.5.0",
+    "version": "2.6.1",
     "description": "A library to create Semaphore identities.",
     "license": "MIT",
     "main": "dist/index.node.js",

package/src/identity.test.ts

@@ -17,16 +17,17 @@ describe("Identity", () => {
             const identity1 = new Identity()
             const identity2 = new Identity()
 
-            expect(identity1.getTrapdoor()).not.toBe(identity2.getTrapdoor())
-            expect(identity1.getNullifier()).not.toBe(identity2.getNullifier())
+            expect(identity1.trapdoor).not.toBe(identity2.getTrapdoor())
+            expect(identity1.nullifier).not.toBe(identity2.getNullifier())
+            expect(identity1.commitment).not.toBe(identity2.getCommitment())
         })
 
         it("Should create deterministic identities from a message", () => {
             const identity1 = new Identity("message")
             const identity2 = new Identity("message")
 
-            expect(identity1.getTrapdoor()).toBe(identity2.getTrapdoor())
-            expect(identity1.getNullifier()).toBe(identity2.getNullifier())
+            expect(identity1.trapdoor).toBe(identity2.getTrapdoor())
+            expect(identity1.nullifier).toBe(identity2.getNullifier())
         })
 
         it("Should create deterministic identities from number/boolean messages", () => {
@@ -35,10 +36,10 @@ describe("Identity", () => {
             const identity3 = new Identity("7")
             const identity4 = new Identity("7")
 
-            expect(identity1.getTrapdoor()).toBe(identity2.getTrapdoor())
-            expect(identity1.getNullifier()).toBe(identity2.getNullifier())
-            expect(identity3.getTrapdoor()).toBe(identity4.getTrapdoor())
-            expect(identity3.getNullifier()).toBe(identity4.getNullifier())
+            expect(identity1.trapdoor).toBe(identity2.getTrapdoor())
+            expect(identity1.nullifier).toBe(identity2.getNullifier())
+            expect(identity3.trapdoor).toBe(identity4.getTrapdoor())
+            expect(identity3.nullifier).toBe(identity4.getNullifier())
         })
 
         it("Should not recreate an existing invalid identity", () => {
@@ -52,8 +53,8 @@ describe("Identity", () => {
 
             const identity2 = new Identity(identity1.toString())
 
-            expect(identity1.getTrapdoor()).toBe(identity2.getTrapdoor())
-            expect(identity1.getNullifier()).toBe(identity2.getNullifier())
+            expect(identity1.trapdoor).toBe(identity2.getTrapdoor())
+            expect(identity1.nullifier).toBe(identity2.getNullifier())
         })
     })
 

package/src/identity.ts

@@ -1,11 +1,12 @@
 import { BigNumber } from "@ethersproject/bignumber"
 import { poseidon } from "circomlibjs"
 import checkParameter from "./checkParameter"
-import { genRandomNumber, isJsonArray, sha256 } from "./utils"
+import { generateCommitment, genRandomNumber, isJsonArray, sha256 } from "./utils"
 
 export default class Identity {
     private _trapdoor: bigint
     private _nullifier: bigint
+    private _commitment: bigint
 
     /**
      * Initializes the class attributes based on the strategy passed as parameter.
@@ -15,6 +16,7 @@ export default class Identity {
         if (identityOrMessage === undefined) {
             this._trapdoor = genRandomNumber()
             this._nullifier = genRandomNumber()
+            this._commitment = generateCommitment(this._nullifier, this._trapdoor)
 
             return
         }
@@ -26,6 +28,7 @@ export default class Identity {
 
             this._trapdoor = BigNumber.from(sha256(`${messageHash}identity_trapdoor`)).toBigInt()
             this._nullifier = BigNumber.from(sha256(`${messageHash}identity_nullifier`)).toBigInt()
+            this._commitment = generateCommitment(this._nullifier, this._trapdoor)
 
             return
         }
@@ -34,6 +37,15 @@ export default class Identity {
 
         this._trapdoor = BigNumber.from(`0x${trapdoor}`).toBigInt()
         this._nullifier = BigNumber.from(`0x${nullifier}`).toBigInt()
+        this._commitment = generateCommitment(this._nullifier, this._trapdoor)
+    }
+
+    /**
+     * Returns the identity trapdoor.
+     * @returns The identity trapdoor.
+     */
+    public get trapdoor(): bigint {
+        return this._trapdoor
     }
 
     /**
@@ -44,6 +56,14 @@ export default class Identity {
         return this._trapdoor
     }
 
+    /**
+     * Returns the identity nullifier.
+     * @returns The identity nullifier.
+     */
+    public get nullifier(): bigint {
+        return this._nullifier
+    }
+
     /**
      * Returns the identity nullifier.
      * @returns The identity nullifier.
@@ -53,6 +73,23 @@ export default class Identity {
     }
 
     /**
+     * Returns the identity commitment.
+     * @returns The identity commitment.
+     */
+    public get commitment(): bigint {
+        return this._commitment
+    }
+
+    /**
+     * Returns the identity commitment.
+     * @returns The identity commitment.
+     */
+    public getCommitment(): bigint {
+        return this._commitment
+    }
+
+    /**
+     * @deprecated since version 2.6.0
      * Generates the identity commitment from trapdoor and nullifier.
      * @returns identity commitment
      */

package/src/utils.ts

@@ -2,6 +2,7 @@ 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.
@@ -23,6 +24,16 @@ 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 poseidon([poseidon([nullifier, trapdoor])])
+}
+
 /**
  * Checks if a string is a JSON.
  * @param jsonString The JSON string.