@semaphore-protocol/group 0.1.2 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
  <h1 align="center">
3
3
  Semaphore group
4
4
  </h1>
5
- <p align="center">A library for managing Semaphore groups.</p>
5
+ <p align="center">A library to create and manage Semaphore groups.</p>
6
6
  </p>
7
7
 
8
8
  <p align="center">
package/dist/index.mjs CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @module @semaphore-protocol/group
3
- * @version 0.1.2
4
- * @file A library for managing Semaphore groups.
3
+ * @version 2.2.0
4
+ * @file A library to create and manage Semaphore groups.
5
5
  * @copyright Ethereum Foundation 2022
6
6
  * @license MIT
7
7
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/group}
@@ -92,6 +92,14 @@ var Group = /** @class */ (function () {
92
92
  this.addMember(identityCommitment);
93
93
  }
94
94
  };
95
+ /**
96
+ * Updates a member in the group.
97
+ * @param index Index of the member to be updated.
98
+ * @param identityCommitment New member value.
99
+ */
100
+ Group.prototype.updateMember = function (index, identityCommitment) {
101
+ this._merkleTree.update(index, identityCommitment);
102
+ };
95
103
  /**
96
104
  * Removes a member from the group.
97
105
  * @param index Index of the member to be removed.
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @module @semaphore-protocol/group
3
- * @version 0.1.2
4
- * @file A library for managing Semaphore groups.
3
+ * @version 2.2.0
4
+ * @file A library to create and manage Semaphore groups.
5
5
  * @copyright Ethereum Foundation 2022
6
6
  * @license MIT
7
7
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/group}
@@ -96,6 +96,14 @@ var Group = /** @class */ (function () {
96
96
  this.addMember(identityCommitment);
97
97
  }
98
98
  };
99
+ /**
100
+ * Updates a member in the group.
101
+ * @param index Index of the member to be updated.
102
+ * @param identityCommitment New member value.
103
+ */
104
+ Group.prototype.updateMember = function (index, identityCommitment) {
105
+ this._merkleTree.update(index, identityCommitment);
106
+ };
99
107
  /**
100
108
  * Removes a member from the group.
101
109
  * @param index Index of the member to be removed.
@@ -44,6 +44,12 @@ export default class Group {
44
44
  * @param identityCommitments New members.
45
45
  */
46
46
  addMembers(identityCommitments: Member[]): void;
47
+ /**
48
+ * Updates a member in the group.
49
+ * @param index Index of the member to be updated.
50
+ * @param identityCommitment New member value.
51
+ */
52
+ updateMember(index: number, identityCommitment: Member): void;
47
53
  /**
48
54
  * Removes a member from the group.
49
55
  * @param index Index of the member to be removed.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@semaphore-protocol/group",
3
- "version": "0.1.2",
4
- "description": "A library for managing Semaphore groups.",
3
+ "version": "2.2.0",
4
+ "description": "A library to create and manage Semaphore groups.",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.node.js",
7
7
  "exports": {
@@ -32,7 +32,7 @@
32
32
  "typedoc": "^0.22.11"
33
33
  },
34
34
  "dependencies": {
35
- "@zk-kit/incremental-merkle-tree": "0.4.3",
35
+ "@zk-kit/incremental-merkle-tree": "1.0.0",
36
36
  "circomlibjs": "0.0.8"
37
37
  }
38
38
  }
package/src/group.test.ts CHANGED
@@ -58,6 +58,18 @@ describe("Group", () => {
58
58
  })
59
59
  })
60
60
 
61
+ describe("# updateMember", () => {
62
+ it("Should update a member in a group", () => {
63
+ const group = new Group()
64
+ group.addMembers([BigInt(1), BigInt(3)])
65
+
66
+ group.updateMember(0, BigInt(1))
67
+
68
+ expect(group.members).toHaveLength(2)
69
+ expect(group.members[0]).toBe(BigInt(1))
70
+ })
71
+ })
72
+
61
73
  describe("# removeMember", () => {
62
74
  it("Should remove a member from a group", () => {
63
75
  const group = new Group()
package/src/group.ts CHANGED
@@ -77,6 +77,15 @@ export default class Group {
77
77
  }
78
78
  }
79
79
 
80
+ /**
81
+ * Updates a member in the group.
82
+ * @param index Index of the member to be updated.
83
+ * @param identityCommitment New member value.
84
+ */
85
+ updateMember(index: number, identityCommitment: Member) {
86
+ this._merkleTree.update(index, identityCommitment)
87
+ }
88
+
80
89
  /**
81
90
  * Removes a member from the group.
82
91
  * @param index Index of the member to be removed.