@semaphore-protocol/identity 0.2.0 → 2.0.0

package/README.md

@@ -2,7 +2,7 @@
     <h1 align="center">
         Semaphore identity
     </h1>
-    <p align="center">A library for managing Semaphore identities.</p>
+    <p align="center">A library to create Semaphore identities.</p>
 </p>
 
 <p align="center">
@@ -38,7 +38,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. |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 ## 🛠 Install
 

package/dist/index.mjs

@@ -1,7 +1,7 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 0.2.0
- * @file A library for managing Semaphore identities.
+ * @version 2.0.0
+ * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/proof}
@@ -9,7 +9,8 @@
 import { BigNumber } from '@ethersproject/bignumber';
 import { poseidon } from 'circomlibjs';
 import { randomBytes } from '@ethersproject/random';
-import _sha256 from 'crypto-js/sha256';
+import { sha256 as sha256$1 } from '@ethersproject/sha2';
+import { toUtf8Bytes } from '@ethersproject/strings';
 
 function checkParameter(value, name, type) {
     if (typeof value !== type) {
@@ -23,8 +24,8 @@ function checkParameter(value, name, type) {
  * @returns The hexadecimal hash of the message.
  */
 function sha256(message) {
-    var hash = _sha256(message);
-    return hash.toString();
+    var hash = sha256$1(toUtf8Bytes(message));
+    return hash;
 }
 /**
  * Generates a random big number.
@@ -40,14 +41,13 @@ function genRandomNumber(numberOfBytes) {
  * @param jsonString The JSON string.
  * @returns True or false.
  */
-function isJson(jsonString) {
+function isJsonArray(jsonString) {
     try {
-        JSON.parse(jsonString);
+        return Array.isArray(JSON.parse(jsonString));
     }
     catch (error) {
         return false;
     }
-    return true;
 }
 
 var Identity = /** @class */ (function () {
@@ -62,10 +62,10 @@ var Identity = /** @class */ (function () {
             return;
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
-        if (!isJson(identityOrMessage)) {
-            var messageHash = sha256(identityOrMessage);
-            this._trapdoor = BigNumber.from("0x".concat(sha256("".concat(messageHash, "identity_trapdoor")))).toBigInt();
-            this._nullifier = BigNumber.from("0x".concat(sha256("".concat(messageHash, "identity_nullifier")))).toBigInt();
+        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();
             return;
         }
         var _a = JSON.parse(identityOrMessage), trapdoor = _a[0], nullifier = _a[1];

package/dist/index.node.js

@@ -1,7 +1,7 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 0.2.0
- * @file A library for managing Semaphore identities.
+ * @version 2.0.0
+ * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2022
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/proof}
@@ -13,11 +13,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var bignumber = require('@ethersproject/bignumber');
 var circomlibjs = require('circomlibjs');
 var random = require('@ethersproject/random');
-var _sha256 = require('crypto-js/sha256');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var _sha256__default = /*#__PURE__*/_interopDefaultLegacy(_sha256);
+var sha2 = require('@ethersproject/sha2');
+var strings = require('@ethersproject/strings');
 
 function checkParameter(value, name, type) {
     if (typeof value !== type) {
@@ -31,8 +28,8 @@ function checkParameter(value, name, type) {
  * @returns The hexadecimal hash of the message.
  */
 function sha256(message) {
-    var hash = _sha256__default["default"](message);
-    return hash.toString();
+    var hash = sha2.sha256(strings.toUtf8Bytes(message));
+    return hash;
 }
 /**
  * Generates a random big number.
@@ -48,14 +45,13 @@ function genRandomNumber(numberOfBytes) {
  * @param jsonString The JSON string.
  * @returns True or false.
  */
-function isJson(jsonString) {
+function isJsonArray(jsonString) {
     try {
-        JSON.parse(jsonString);
+        return Array.isArray(JSON.parse(jsonString));
     }
     catch (error) {
         return false;
     }
-    return true;
 }
 
 var Identity = /** @class */ (function () {
@@ -70,10 +66,10 @@ var Identity = /** @class */ (function () {
             return;
         }
         checkParameter(identityOrMessage, "identityOrMessage", "string");
-        if (!isJson(identityOrMessage)) {
-            var messageHash = sha256(identityOrMessage);
-            this._trapdoor = bignumber.BigNumber.from("0x".concat(sha256("".concat(messageHash, "identity_trapdoor")))).toBigInt();
-            this._nullifier = bignumber.BigNumber.from("0x".concat(sha256("".concat(messageHash, "identity_nullifier")))).toBigInt();
+        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();
             return;
         }
         var _a = JSON.parse(identityOrMessage), trapdoor = _a[0], nullifier = _a[1];

package/dist/types/utils.d.ts

@@ -15,4 +15,4 @@ export declare function genRandomNumber(numberOfBytes?: number): bigint;
  * @param jsonString The JSON string.
  * @returns True or false.
  */
-export declare function isJson(jsonString: string): boolean;
+export declare function isJsonArray(jsonString: string): boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@semaphore-protocol/identity",
-    "version": "0.2.0",
-    "description": "A library for managing Semaphore identities.",
+    "version": "2.0.0",
+    "description": "A library to create Semaphore identities.",
     "license": "MIT",
     "main": "dist/index.node.js",
     "exports": {
@@ -27,7 +27,6 @@
         "access": "public"
     },
     "devDependencies": {
-        "@types/crypto-js": "^4.1.1",
         "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-typescript2": "^0.31.2",
         "typedoc": "^0.22.11"
@@ -35,7 +34,8 @@
     "dependencies": {
         "@ethersproject/bignumber": "^5.5.0",
         "@ethersproject/random": "^5.5.1",
-        "circomlibjs": "0.0.8",
-        "crypto-js": "^4.1.1"
+        "@ethersproject/sha2": "^5.6.1",
+        "@ethersproject/strings": "^5.6.1",
+        "circomlibjs": "0.0.8"
     }
 }

package/src/identity.test.ts

@@ -29,6 +29,18 @@ describe("Identity", () => {
             expect(identity1.getNullifier()).toBe(identity2.getNullifier())
         })
 
+        it("Should create deterministic identities from number/boolean messages", () => {
+            const identity1 = new Identity("true")
+            const identity2 = new Identity("true")
+            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())
+        })
+
         it("Should not recreate an existing invalid identity", () => {
             const fun = () => new Identity('[true, "01323"]')
 

package/src/identity.ts

@@ -1,7 +1,7 @@
 import { BigNumber } from "@ethersproject/bignumber"
 import { poseidon } from "circomlibjs"
 import checkParameter from "./checkParameter"
-import { genRandomNumber, isJson, sha256 } from "./utils"
+import { genRandomNumber, isJsonArray, sha256 } from "./utils"
 
 export default class Identity {
     private _trapdoor: bigint
@@ -21,11 +21,11 @@ export default class Identity {
 
         checkParameter(identityOrMessage, "identityOrMessage", "string")
 
-        if (!isJson(identityOrMessage)) {
-            const messageHash = sha256(identityOrMessage)
+        if (!isJsonArray(identityOrMessage)) {
+            const messageHash = sha256(identityOrMessage).slice(2)
 
-            this._trapdoor = BigNumber.from(`0x${sha256(`${messageHash}identity_trapdoor`)}`).toBigInt()
-            this._nullifier = BigNumber.from(`0x${sha256(`${messageHash}identity_nullifier`)}`).toBigInt()
+            this._trapdoor = BigNumber.from(sha256(`${messageHash}identity_trapdoor`)).toBigInt()
+            this._nullifier = BigNumber.from(sha256(`${messageHash}identity_nullifier`)).toBigInt()
 
             return
         }

package/src/utils.ts

@@ -1,6 +1,7 @@
 import { BigNumber } from "@ethersproject/bignumber"
 import { randomBytes } from "@ethersproject/random"
-import _sha256 from "crypto-js/sha256"
+import { sha256 as _sha256 } from "@ethersproject/sha2"
+import { toUtf8Bytes } from "@ethersproject/strings"
 
 /**
  * Returns an hexadecimal sha256 hash of the message passed as parameter.
@@ -8,9 +9,9 @@ import _sha256 from "crypto-js/sha256"
  * @returns The hexadecimal hash of the message.
  */
 export function sha256(message: string): string {
-    const hash = _sha256(message)
+    const hash = _sha256(toUtf8Bytes(message))
 
-    return hash.toString()
+    return hash
 }
 
 /**
@@ -27,12 +28,10 @@ export function genRandomNumber(numberOfBytes = 31): bigint {
  * @param jsonString The JSON string.
  * @returns True or false.
  */
-export function isJson(jsonString: string) {
+export function isJsonArray(jsonString: string) {
     try {
-        JSON.parse(jsonString)
+        return Array.isArray(JSON.parse(jsonString))
     } catch (error) {
         return false
     }
-
-    return true
 }