@semaphore-protocol/group 3.8.0 → 3.10.0

package/README.md

@@ -74,6 +74,7 @@ yarn add @semaphore-protocol/group
 
 ```typescript
 import { Group } from "@semaphore-protocol/group"
+import { Identity } from "@semaphore-protocol/identity"
 
 // Group with max 1048576 members (20^²).
 const group1 = new Group(1)
@@ -83,6 +84,13 @@ const group2 = new Group(1, 16)
 
 // Group with max 16777216 members (24^²).
 const group3 = new Group(1, 24)
+
+// Group with a list of predefined members.
+const identity1 = new Identity()
+const identity2 = new Identity()
+const identity3 = new Identity()
+
+const group3 = new Group(1, 16, [identity1.commitment, identity2.commitment, identity3.commitment])
 ```
 
 \# **addMember**(identityCommitment: _Member_)
@@ -96,21 +104,6 @@ const commitment = identity.generateCommitment()
 group.addMember(commitment)
 ```
 
-\# **addMembers**(identityCommitments: _Member\[]_)
-
-```typescript
-let identityCommitments: bigint[]
-
-for (let i = 0; i < 10; i++) {
-    const identity = new Identity()
-    const commitment = identity.generateCommitment()
-
-    identityCommitments.push(commitment)
-}
-
-group.addMember(identityCommitments)
-```
-
 \# **removeMember**(index: _number_)
 
 ```typescript

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/group
- * @version 3.8.0
+ * @version 3.10.0
  * @file A library to create and manage Semaphore groups.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -123,14 +123,16 @@ var Group = /** @class */ (function () {
      * Initializes the group with the group id and the tree depth.
      * @param id Group identifier.
      * @param treeDepth Tree depth.
+     * @param members List of group members.
      */
-    function Group(id, treeDepth) {
+    function Group(id, treeDepth, members) {
         if (treeDepth === void 0) { treeDepth = 20; }
+        if (members === void 0) { members = []; }
         if (treeDepth < 16 || treeDepth > 32) {
             throw new Error("The tree depth must be between 16 and 32");
         }
         this._id = id;
-        this.merkleTree = new IncrementalMerkleTree(poseidon2_2, treeDepth, hash(id), 2);
+        this.merkleTree = new IncrementalMerkleTree(poseidon2_2, treeDepth, hash(id), 2, members);
     }
     Object.defineProperty(Group.prototype, "id", {
         /**
@@ -205,6 +207,7 @@ var Group = /** @class */ (function () {
     /**
      * Adds new members to the group.
      * @param members New members.
+     * @deprecated Use the new class parameter to add a list of members.
      */
     Group.prototype.addMembers = function (members) {
         for (var _i = 0, members_1 = members; _i < members_1.length; _i++) {

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/group
- * @version 3.8.0
+ * @version 3.10.0
  * @file A library to create and manage Semaphore groups.
  * @copyright Ethereum Foundation 2022
  * @license MIT
@@ -127,14 +127,16 @@ var Group = /** @class */ (function () {
      * Initializes the group with the group id and the tree depth.
      * @param id Group identifier.
      * @param treeDepth Tree depth.
+     * @param members List of group members.
      */
-    function Group(id, treeDepth) {
+    function Group(id, treeDepth, members) {
         if (treeDepth === void 0) { treeDepth = 20; }
+        if (members === void 0) { members = []; }
         if (treeDepth < 16 || treeDepth > 32) {
             throw new Error("The tree depth must be between 16 and 32");
         }
         this._id = id;
-        this.merkleTree = new incrementalMerkleTree.IncrementalMerkleTree(poseidon2_2, treeDepth, hash(id), 2);
+        this.merkleTree = new incrementalMerkleTree.IncrementalMerkleTree(poseidon2_2, treeDepth, hash(id), 2, members);
     }
     Object.defineProperty(Group.prototype, "id", {
         /**
@@ -209,6 +211,7 @@ var Group = /** @class */ (function () {
     /**
      * Adds new members to the group.
      * @param members New members.
+     * @deprecated Use the new class parameter to add a list of members.
      */
     Group.prototype.addMembers = function (members) {
         for (var _i = 0, members_1 = members; _i < members_1.length; _i++) {

package/dist/types/group.d.ts

@@ -7,8 +7,9 @@ export default class Group {
      * Initializes the group with the group id and the tree depth.
      * @param id Group identifier.
      * @param treeDepth Tree depth.
+     * @param members List of group members.
      */
-    constructor(id: BigNumberish, treeDepth?: number);
+    constructor(id: BigNumberish, treeDepth?: number, members?: BigNumberish[]);
     /**
      * Returns the id of the group.
      * @returns Group id.
@@ -48,6 +49,7 @@ export default class Group {
     /**
      * Adds new members to the group.
      * @param members New members.
+     * @deprecated Use the new class parameter to add a list of members.
      */
     addMembers(members: BigNumberish[]): void;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/group",
-  "version": "3.8.0",
+  "version": "3.10.0",
   "description": "A library to create and manage Semaphore groups.",
   "license": "MIT",
   "main": "dist/index.node.js",
@@ -41,6 +41,6 @@
     "@ethersproject/bignumber": "^5.7.0",
     "@ethersproject/bytes": "^5.7.0",
     "@ethersproject/keccak256": "^5.7.0",
-    "@zk-kit/incremental-merkle-tree": "1.0.0"
+    "@zk-kit/incremental-merkle-tree": "1.1.0"
   }
 }

package/src/group.test.ts

@@ -19,7 +19,7 @@ describe("Group", () => {
             expect(fun).toThrow("The tree depth must be between 16 and 32")
         })
 
-        it("Should create a group with different parameters", () => {
+        it("Should create a group with a different tree depth", () => {
             const group = new Group(1, 32)
 
             expect(group.root.toString()).toContain("460373")
@@ -27,6 +27,21 @@ describe("Group", () => {
             expect(group.zeroValue).toBe(hash(1))
             expect(group.members).toHaveLength(0)
         })
+
+        it("Should create a group with a list of members", () => {
+            const group = new Group(2, 20, [1, 2, 3])
+
+            const group2 = new Group(2, 20)
+
+            group2.addMember(1)
+            group2.addMember(2)
+            group2.addMember(3)
+
+            expect(group.root.toString()).toContain(group2.root.toString())
+            expect(group.depth).toBe(20)
+            expect(group.zeroValue).toBe(hash(2))
+            expect(group.members).toHaveLength(3)
+        })
     })
 
     describe("# addMember", () => {

package/src/group.ts

@@ -12,14 +12,15 @@ export default class Group {
      * Initializes the group with the group id and the tree depth.
      * @param id Group identifier.
      * @param treeDepth Tree depth.
+     * @param members List of group members.
      */
-    constructor(id: BigNumberish, treeDepth = 20) {
+    constructor(id: BigNumberish, treeDepth = 20, members: BigNumberish[] = []) {
         if (treeDepth < 16 || treeDepth > 32) {
             throw new Error("The tree depth must be between 16 and 32")
         }
 
         this._id = id
-        this.merkleTree = new IncrementalMerkleTree(poseidon2, treeDepth, hash(id), 2)
+        this.merkleTree = new IncrementalMerkleTree(poseidon2, treeDepth, hash(id), 2, members)
     }
 
     /**
@@ -82,6 +83,7 @@ export default class Group {
     /**
      * Adds new members to the group.
      * @param members New members.
+     * @deprecated Use the new class parameter to add a list of members.
      */
     addMembers(members: BigNumberish[]) {
         for (const member of members) {