@semaphore-protocol/group 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,13 +1,13 @@
 /**
  * @module @semaphore-protocol/group
- * @version 3.0.0
+ * @version 3.2.0
  * @file A library to create and manage Semaphore groups.
  * @copyright Ethereum Foundation 2022
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/group}
 */
 import { IncrementalMerkleTree } from '@zk-kit/incremental-merkle-tree';
-import poseidon from 'poseidon-lite';
+import { poseidon2 } from 'poseidon-lite/poseidon2';
 import { BigNumber } from '@ethersproject/bignumber';
 import { zeroPad } from '@ethersproject/bytes';
 import { keccak256 } from '@ethersproject/keccak256';
@@ -26,16 +26,28 @@ function hash(message) {
 var Group = /** @class */ (function () {
     /**
      * Initializes the group with the group id and the tree depth.
-     * @param groupId Group identifier.
+     * @param id Group identifier.
      * @param treeDepth Tree depth.
      */
-    function Group(groupId, treeDepth) {
+    function Group(id, treeDepth) {
         if (treeDepth === void 0) { treeDepth = 20; }
         if (treeDepth < 16 || treeDepth > 32) {
             throw new Error("The tree depth must be between 16 and 32");
         }
-        this.merkleTree = new IncrementalMerkleTree(poseidon, treeDepth, hash(groupId), 2);
+        this._id = id;
+        this.merkleTree = new IncrementalMerkleTree(poseidon2, treeDepth, hash(id), 2);
     }
+    Object.defineProperty(Group.prototype, "id", {
+        /**
+         * Returns the id of the group.
+         * @returns Group id.
+         */
+        get: function () {
+            return this._id;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(Group.prototype, "root", {
         /**
          * Returns the root hash of the tree.

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/group
- * @version 3.0.0
+ * @version 3.2.0
  * @file A library to create and manage Semaphore groups.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -11,15 +11,11 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var incrementalMerkleTree = require('@zk-kit/incremental-merkle-tree');
-var poseidon = require('poseidon-lite');
+var poseidon2 = require('poseidon-lite/poseidon2');
 var bignumber = require('@ethersproject/bignumber');
 var bytes = require('@ethersproject/bytes');
 var keccak256 = require('@ethersproject/keccak256');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var poseidon__default = /*#__PURE__*/_interopDefaultLegacy(poseidon);
-
 /**
  * Creates a keccak256 hash of a message compatible with the SNARK scalar modulus.
  * @param message The message to be hashed.
@@ -34,16 +30,28 @@ function hash(message) {
 var Group = /** @class */ (function () {
     /**
      * Initializes the group with the group id and the tree depth.
-     * @param groupId Group identifier.
+     * @param id Group identifier.
      * @param treeDepth Tree depth.
      */
-    function Group(groupId, treeDepth) {
+    function Group(id, treeDepth) {
         if (treeDepth === void 0) { treeDepth = 20; }
         if (treeDepth < 16 || treeDepth > 32) {
             throw new Error("The tree depth must be between 16 and 32");
         }
-        this.merkleTree = new incrementalMerkleTree.IncrementalMerkleTree(poseidon__default["default"], treeDepth, hash(groupId), 2);
+        this._id = id;
+        this.merkleTree = new incrementalMerkleTree.IncrementalMerkleTree(poseidon2.poseidon2, treeDepth, hash(id), 2);
     }
+    Object.defineProperty(Group.prototype, "id", {
+        /**
+         * Returns the id of the group.
+         * @returns Group id.
+         */
+        get: function () {
+            return this._id;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(Group.prototype, "root", {
         /**
          * Returns the root hash of the tree.

package/dist/types/group.d.ts

@@ -1,18 +1,24 @@
 import { IncrementalMerkleTree, MerkleProof } from "@zk-kit/incremental-merkle-tree";
-import { Member } from "./types";
+import { BigNumberish } from "./types";
 export default class Group {
+    private _id;
     merkleTree: IncrementalMerkleTree;
     /**
      * Initializes the group with the group id and the tree depth.
-     * @param groupId Group identifier.
+     * @param id Group identifier.
      * @param treeDepth Tree depth.
      */
-    constructor(groupId: Member, treeDepth?: number);
+    constructor(id: BigNumberish, treeDepth?: number);
+    /**
+     * Returns the id of the group.
+     * @returns Group id.
+     */
+    get id(): BigNumberish;
     /**
      * Returns the root hash of the tree.
      * @returns Root hash.
      */
-    get root(): Member;
+    get root(): BigNumberish;
     /**
      * Returns the depth of the tree.
      * @returns Tree depth.
@@ -22,34 +28,34 @@ export default class Group {
      * Returns the zero value of the tree.
      * @returns Tree zero value.
      */
-    get zeroValue(): Member;
+    get zeroValue(): BigNumberish;
     /**
      * Returns the members (i.e. identity commitments) of the group.
      * @returns List of members.
      */
-    get members(): Member[];
+    get members(): BigNumberish[];
     /**
      * Returns the index of a member. If the member does not exist it returns -1.
      * @param member Group member.
      * @returns Index of the member.
      */
-    indexOf(member: Member): number;
+    indexOf(member: BigNumberish): number;
     /**
      * Adds a new member to the group.
      * @param member New member.
      */
-    addMember(member: Member): void;
+    addMember(member: BigNumberish): void;
     /**
      * Adds new members to the group.
      * @param members New members.
      */
-    addMembers(members: Member[]): void;
+    addMembers(members: BigNumberish[]): void;
     /**
      * Updates a member in the group.
      * @param index Index of the member to be updated.
      * @param member New member value.
      */
-    updateMember(index: number, member: Member): void;
+    updateMember(index: number, member: BigNumberish): void;
     /**
      * Removes a member from the group.
      * @param index Index of the member to be removed.

package/dist/types/types/index.d.ts

@@ -1 +1 @@
-export type Member = string | number | bigint;
+export type BigNumberish = string | number | bigint;

package/package.json

@@ -1,44 +1,44 @@
 {
-    "name": "@semaphore-protocol/group",
-    "version": "3.0.0",
-    "description": "A library to create and manage Semaphore groups.",
-    "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/group",
-    "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/group"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "devDependencies": {
-        "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-typescript2": "^0.31.2",
-        "typedoc": "^0.22.11"
-    },
-    "dependencies": {
-        "@ethersproject/bignumber": "^5.7.0",
-        "@ethersproject/bytes": "^5.7.0",
-        "@ethersproject/keccak256": "^5.7.0",
-        "@zk-kit/incremental-merkle-tree": "1.0.0",
-        "poseidon-lite": "^0.0.2"
-    }
-}
+  "name": "@semaphore-protocol/group",
+  "version": "3.2.0",
+  "description": "A library to create and manage Semaphore groups.",
+  "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/group",
+  "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/group"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-typescript2": "^0.31.2",
+    "typedoc": "^0.22.11"
+  },
+  "dependencies": {
+    "@ethersproject/bignumber": "^5.7.0",
+    "@ethersproject/bytes": "^5.7.0",
+    "@ethersproject/keccak256": "^5.7.0",
+    "@zk-kit/incremental-merkle-tree": "1.0.0",
+    "poseidon-lite": "^0.1.0"
+  }
+}

package/src/group.test.ts

@@ -6,6 +6,7 @@ describe("Group", () => {
         it("Should create a group", () => {
             const group = new Group(1)
 
+            expect(group.id).toBe(1)
             expect(group.root.toString()).toContain("103543")
             expect(group.depth).toBe(20)
             expect(group.zeroValue).toBe(hash(1))

package/src/group.ts

@@ -1,29 +1,40 @@
 import { IncrementalMerkleTree, MerkleProof } from "@zk-kit/incremental-merkle-tree"
-import poseidon from "poseidon-lite"
+import { poseidon2 } from "poseidon-lite/poseidon2"
 import hash from "./hash"
-import { Member } from "./types"
+import { BigNumberish } from "./types"
 
 export default class Group {
+    private _id: BigNumberish
+
     merkleTree: IncrementalMerkleTree
 
     /**
      * Initializes the group with the group id and the tree depth.
-     * @param groupId Group identifier.
+     * @param id Group identifier.
      * @param treeDepth Tree depth.
      */
-    constructor(groupId: Member, treeDepth = 20) {
+    constructor(id: BigNumberish, treeDepth = 20) {
         if (treeDepth < 16 || treeDepth > 32) {
             throw new Error("The tree depth must be between 16 and 32")
         }
 
-        this.merkleTree = new IncrementalMerkleTree(poseidon, treeDepth, hash(groupId), 2)
+        this._id = id
+        this.merkleTree = new IncrementalMerkleTree(poseidon2, treeDepth, hash(id), 2)
+    }
+
+    /**
+     * Returns the id of the group.
+     * @returns Group id.
+     */
+    get id(): BigNumberish {
+        return this._id
     }
 
     /**
      * Returns the root hash of the tree.
      * @returns Root hash.
      */
-    get root(): Member {
+    get root(): BigNumberish {
         return this.merkleTree.root
     }
 
@@ -39,7 +50,7 @@ export default class Group {
      * Returns the zero value of the tree.
      * @returns Tree zero value.
      */
-    get zeroValue(): Member {
+    get zeroValue(): BigNumberish {
         return this.merkleTree.zeroes[0]
     }
 
@@ -47,7 +58,7 @@ export default class Group {
      * Returns the members (i.e. identity commitments) of the group.
      * @returns List of members.
      */
-    get members(): Member[] {
+    get members(): BigNumberish[] {
         return this.merkleTree.leaves
     }
 
@@ -56,7 +67,7 @@ export default class Group {
      * @param member Group member.
      * @returns Index of the member.
      */
-    indexOf(member: Member): number {
+    indexOf(member: BigNumberish): number {
         return this.merkleTree.indexOf(member)
     }
 
@@ -64,7 +75,7 @@ export default class Group {
      * Adds a new member to the group.
      * @param member New member.
      */
-    addMember(member: Member) {
+    addMember(member: BigNumberish) {
         this.merkleTree.insert(BigInt(member))
     }
 
@@ -72,7 +83,7 @@ export default class Group {
      * Adds new members to the group.
      * @param members New members.
      */
-    addMembers(members: Member[]) {
+    addMembers(members: BigNumberish[]) {
         for (const member of members) {
             this.addMember(member)
         }
@@ -83,7 +94,7 @@ export default class Group {
      * @param index Index of the member to be updated.
      * @param member New member value.
      */
-    updateMember(index: number, member: Member) {
+    updateMember(index: number, member: BigNumberish) {
         this.merkleTree.update(index, member)
     }
 

package/src/types/index.ts

@@ -1 +1 @@
-export type Member = string | number | bigint
+export type BigNumberish = string | number | bigint