@semaphore-protocol/identity 4.3.1 → 4.4.0

package/dist/index.cjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 4.3.1
+ * @version 4.4.0
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -126,6 +126,21 @@ class Identity {
     static verifySignature(message, signature, publicKey) {
         return eddsaPoseidon.verifySignature(message, signature, publicKey);
     }
+    /**
+     * Generates the commitment from the given public key.
+     * This static method is particularly useful after signature verification,
+     * as it allows retrieval of the corresponding commitment associated with the public key.
+     *
+     * @example
+     * const identity = new Identity()
+     * Identity.generateCommitment(identity.publicKey)
+     *
+     * @param publicKey The public key to generate the commitment.
+     * @returns The Semaphore identity commitment.
+     */
+    static generateCommitment(publicKey) {
+        return poseidon2.poseidon2(publicKey);
+    }
 }
 
 exports.Identity = Identity;

package/dist/index.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 4.3.1
+ * @version 4.4.0
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -124,6 +124,21 @@ class Identity {
     static verifySignature(message, signature, publicKey) {
         return verifySignature(message, signature, publicKey);
     }
+    /**
+     * Generates the commitment from the given public key.
+     * This static method is particularly useful after signature verification,
+     * as it allows retrieval of the corresponding commitment associated with the public key.
+     *
+     * @example
+     * const identity = new Identity()
+     * Identity.generateCommitment(identity.publicKey)
+     *
+     * @param publicKey The public key to generate the commitment.
+     * @returns The Semaphore identity commitment.
+     */
+    static generateCommitment(publicKey) {
+        return poseidon2(publicKey);
+    }
 }
 
 export { Identity };

package/dist/types/index.d.ts

@@ -94,4 +94,17 @@ export declare class Identity {
      * @returns A boolean indicating whether the signature is valid.
      */
     static verifySignature(message: BigNumberish, signature: Signature, publicKey: Point): boolean;
+    /**
+     * Generates the commitment from the given public key.
+     * This static method is particularly useful after signature verification,
+     * as it allows retrieval of the corresponding commitment associated with the public key.
+     *
+     * @example
+     * const identity = new Identity()
+     * Identity.generateCommitment(identity.publicKey)
+     *
+     * @param publicKey The public key to generate the commitment.
+     * @returns The Semaphore identity commitment.
+     */
+    static generateCommitment(publicKey: Point): bigint;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semaphore-protocol/identity",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "description": "A library to create Semaphore identities.",
   "type": "module",
   "license": "MIT",

package/src/index.ts

@@ -138,4 +138,20 @@ export class Identity {
     static verifySignature(message: BigNumberish, signature: Signature, publicKey: Point): boolean {
         return verifySignature(message, signature, publicKey)
     }
+
+    /**
+     * Generates the commitment from the given public key.
+     * This static method is particularly useful after signature verification,
+     * as it allows retrieval of the corresponding commitment associated with the public key.
+     *
+     * @example
+     * const identity = new Identity()
+     * Identity.generateCommitment(identity.publicKey)
+     *
+     * @param publicKey The public key to generate the commitment.
+     * @returns The Semaphore identity commitment.
+     */
+    static generateCommitment(publicKey: Point): bigint {
+        return poseidon2(publicKey)
+    }
 }