@semaphore-protocol/group 2.1.0 → 2.4.0

package/README.md

@@ -6,11 +6,11 @@
 </p>
 
 <p align="center">
-    <a href="https://github.com/semaphore-protocol/semaphore.js">
-        <img src="https://img.shields.io/badge/project-semaphore-blue.svg?style=flat-square">
+    <a href="https://github.com/semaphore-protocol">
+        <img src="https://img.shields.io/badge/project-Semaphore-blue.svg?style=flat-square">
     </a>
-    <a href="https://github.com/semaphore-protocol/semaphore.js/blob/main/packages/group/LICENSE">
-        <img alt="Github license" src="https://img.shields.io/github/license/semaphore-protocol/semaphore.js.svg?style=flat-square">
+    <a href="https://github.com/semaphore-protocol/semaphore/blob/main/LICENSE">
+        <img alt="Github license" src="https://img.shields.io/github/license/semaphore-protocol/semaphore.svg?style=flat-square">
     </a>
     <a href="https://www.npmjs.com/package/@semaphore-protocol/group">
         <img alt="NPM version" src="https://img.shields.io/npm/v/@semaphore-protocol/group?style=flat-square" />
@@ -28,12 +28,20 @@
 
 <div align="center">
     <h4>
-        <a href="https://t.me/joinchat/B-PQx1U3GtAh--Z4Fwo56A">
-            🗣️ Chat &amp; Support
+        <a href="https://github.com/semaphore-protocol/semaphore/blob/main/CONTRIBUTING.md">
+            👥 Contributing
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://github.com/semaphore-protocol/semaphore/blob/main/CODE_OF_CONDUCT.md">
+            🤝 Code of conduct
         </a>
         <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
-        <a href="https://semaphore-protocol.github.io/semaphore.js/group">
-            📘 Docs
+        <a href="https://github.com/semaphore-protocol/semaphore/contribute">
+            🔎 Issues
+        </a>
+        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
+        <a href="https://discord.gg/6mSdGHnstH">
+            🗣️ Chat &amp; Support
         </a>
     </h4>
 </div>

package/dist/index.mjs

@@ -1,10 +1,10 @@
 /**
  * @module @semaphore-protocol/group
- * @version 2.1.0
+ * @version 2.4.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.js/tree/main/packages/group}
+ * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/group}
 */
 import { IncrementalMerkleTree } from '@zk-kit/incremental-merkle-tree';
 import { poseidon } from 'circomlibjs';
@@ -92,6 +92,14 @@ var Group = /** @class */ (function () {
             this.addMember(identityCommitment);
         }
     };
+    /**
+     * Updates a member in the group.
+     * @param index Index of the member to be updated.
+     * @param identityCommitment New member value.
+     */
+    Group.prototype.updateMember = function (index, identityCommitment) {
+        this._merkleTree.update(index, identityCommitment);
+    };
     /**
      * Removes a member from the group.
      * @param index Index of the member to be removed.

package/dist/index.node.js

@@ -1,10 +1,10 @@
 /**
  * @module @semaphore-protocol/group
- * @version 2.1.0
+ * @version 2.4.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.js/tree/main/packages/group}
+ * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/group}
 */
 'use strict';
 
@@ -96,6 +96,14 @@ var Group = /** @class */ (function () {
             this.addMember(identityCommitment);
         }
     };
+    /**
+     * Updates a member in the group.
+     * @param index Index of the member to be updated.
+     * @param identityCommitment New member value.
+     */
+    Group.prototype.updateMember = function (index, identityCommitment) {
+        this._merkleTree.update(index, identityCommitment);
+    };
     /**
      * Removes a member from the group.
      * @param index Index of the member to be removed.

package/dist/types/group.d.ts

@@ -44,6 +44,12 @@ export default class Group {
      * @param identityCommitments New members.
      */
     addMembers(identityCommitments: Member[]): void;
+    /**
+     * Updates a member in the group.
+     * @param index Index of the member to be updated.
+     * @param identityCommitment New member value.
+     */
+    updateMember(index: number, identityCommitment: Member): void;
     /**
      * Removes a member from the group.
      * @param index Index of the member to be removed.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@semaphore-protocol/group",
-    "version": "2.1.0",
+    "version": "2.4.0",
     "description": "A library to create and manage Semaphore groups.",
     "license": "MIT",
     "main": "dist/index.node.js",
@@ -15,8 +15,11 @@
         "LICENSE",
         "README.md"
     ],
-    "repository": "https://github.com/semaphore-protocol/semaphore.js",
-    "homepage": "https://github.com/semaphore-protocol/semaphore.js/tree/main/packages/group",
+    "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",
@@ -32,7 +35,7 @@
         "typedoc": "^0.22.11"
     },
     "dependencies": {
-        "@zk-kit/incremental-merkle-tree": "0.4.3",
+        "@zk-kit/incremental-merkle-tree": "1.0.0",
         "circomlibjs": "0.0.8"
     }
 }

package/src/group.test.ts

@@ -58,6 +58,18 @@ describe("Group", () => {
         })
     })
 
+    describe("# updateMember", () => {
+        it("Should update a member in a group", () => {
+            const group = new Group()
+            group.addMembers([BigInt(1), BigInt(3)])
+
+            group.updateMember(0, BigInt(1))
+
+            expect(group.members).toHaveLength(2)
+            expect(group.members[0]).toBe(BigInt(1))
+        })
+    })
+
     describe("# removeMember", () => {
         it("Should remove a member from a group", () => {
             const group = new Group()

package/src/group.ts

@@ -77,6 +77,15 @@ export default class Group {
         }
     }
 
+    /**
+     * Updates a member in the group.
+     * @param index Index of the member to be updated.
+     * @param identityCommitment New member value.
+     */
+    updateMember(index: number, identityCommitment: Member) {
+        this._merkleTree.update(index, identityCommitment)
+    }
+
     /**
      * Removes a member from the group.
      * @param index Index of the member to be removed.