@semaphore-protocol/identity 4.0.0-alpha.8 → 4.0.0-beta

package/README.md

@@ -18,7 +18,7 @@
     <a href="https://npmjs.org/package/@semaphore-protocol/identity">
         <img alt="Downloads" src="https://img.shields.io/npm/dm/@semaphore-protocol/identity.svg?style=flat-square" />
     </a>
-    <a href="https://js.semaphore.pse.dev/identity">
+    <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_identity">
         <img alt="Documentation typedoc" src="https://img.shields.io/badge/docs-typedoc-744C7C?style=flat-square">
     </a>
     <a href="https://eslint.org/">
@@ -70,6 +70,8 @@ yarn add @semaphore-protocol/identity
 
 ## 📜 Usage
 
+For more information on the functions provided by `@semaphore-protocol/identity`, please refer to the [TypeDoc documentation](https://js.semaphore.pse.dev/modules/_semaphore_protocol_identity).
+
 \# **new Identity**(privateKey?: _BigNumberish_): _Identity_
 
 ```typescript
@@ -93,19 +95,6 @@ const identity = new Identity()
 const signature = identity.signMessage(message)
 ```
 
-\# **identity.verifySignature**(message: _BigNumberish_, signature: _Signature_): _boolean_
-
-```typescript
-import { Identity } from "@semaphore-protocol/identity"
-
-const message = "message"
-const identity = new Identity()
-
-const signature = identity.signMessage(message)
-
-identity.verifySignature(message, signature)
-```
-
 \# **Identity.verifySignature**(message: _BigNumberish_, signature: _Signature_, publicKey: _Point_): _boolean_
 
 ```typescript

package/dist/index.browser.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 4.0.0-alpha.8
+ * @version 4.0.0-beta
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -914,10 +914,29 @@ function randomNumber() {
     return bytesToBigint(bytes);
 }
 
+/**
+ * The Semaphore identity is essentially an {@link https://www.rfc-editor.org/rfc/rfc8032 | EdDSA}
+ * public/private key pair. The {@link https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/eddsa-poseidon | EdDSA implementation}
+ * in this library uses {@link https://eips.ethereum.org/EIPS/eip-2494 | Baby Jubjub} for public key generation
+ * and {@link https://www.poseidon-hash.info | Poseidon} for signatures.
+ * In addition, the commitment, i.e. the hash of the public key, is used to represent
+ * Semaphore identities in groups, adding an additional layer of privacy and security.
+ */
 var Identity = /** @class */ (function () {
     /**
-     * Initializes the class attributes based on the parameters.
-     * @param privateKey The secret value used to generate an EdDSA public key.
+     * Initializes the class attributes based on a given private key.
+     * If the private key is not passed as a parameter, a random key is generated.
+     * The constructor calculates the secret scalar and public key from the private key,
+     * and computes a commitment of the public key using a hash function (Poseidon).
+     *
+     * @example
+     * // Generates an identity.
+     * const { privateKey, publicKey, commitment } = new Identity("private-key")
+     * @example
+     * // Generates an identity with a random private key.
+     * const { privateKey, publicKey, commitment } = new Identity()
+     *
+     * @param privateKey The private key used to derive the public key.
      */
     function Identity(privateKey) {
         if (privateKey === void 0) { privateKey = randomNumber().toString(); }
@@ -929,7 +948,7 @@ var Identity = /** @class */ (function () {
     Object.defineProperty(Identity.prototype, "privateKey", {
         /**
          * Returns the private key.
-         * @returns The private key.
+         * @returns The private key as a {@link https://zkkit.pse.dev/types/_zk_kit_utils.BigNumberish.html | BigNumberish}.
          */
         get: function () {
             return this._privateKey;
@@ -940,7 +959,7 @@ var Identity = /** @class */ (function () {
     Object.defineProperty(Identity.prototype, "secretScalar", {
         /**
          * Returns the secret scalar.
-         * @returns The secret scalar.
+         * @returns The secret scalar as a string.
          */
         get: function () {
             return this._secretScalar;
@@ -950,8 +969,8 @@ var Identity = /** @class */ (function () {
     });
     Object.defineProperty(Identity.prototype, "publicKey", {
         /**
-         * Returns the public key.
-         * @returns The public key.
+         * Returns the public key as a Baby Jubjub {@link https://zkkit.pse.dev/types/_zk_kit_baby_jubjub.Point.html | Point}.
+         * @returns The public key as a point.
          */
         get: function () {
             return this._publicKey;
@@ -961,8 +980,8 @@ var Identity = /** @class */ (function () {
     });
     Object.defineProperty(Identity.prototype, "commitment", {
         /**
-         * Returns the identity commitment.
-         * @returns The identity commitment.
+         * Returns the commitment hash of the public key.
+         * @returns The commitment as a string.
          */
         get: function () {
             return this._commitment;
@@ -970,12 +989,37 @@ var Identity = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Generates a signature for a given message using the private key.
+     * This method demonstrates how to sign a message and could be used
+     * for authentication or data integrity.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     *
+     * @param message The message to be signed.
+     * @returns A {@link https://zkkit.pse.dev/types/_zk_kit_eddsa_poseidon.Signature.html | Signature} object containing the signature components.
+     */
     Identity.prototype.signMessage = function (message) {
         return signMessage(this.privateKey, message);
     };
-    Identity.prototype.verifySignature = function (message, signature) {
-        return verifySignature(message, signature, this._publicKey);
-    };
+    /**
+     * Verifies a signature against a given message and public key.
+     * This static method allows for the verification of signatures without needing
+     * an instance of the Identity class. It's useful for cases where you only have
+     * the public key, the message and a signature, and need to verify if they match.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     * Identity.verifySignature("message", signature, identity.publicKey)
+     *
+     * @param message The message that was signed.
+     * @param signature The signature to verify.
+     * @param publicKey The public key to use for verification.
+     * @returns A boolean indicating whether the signature is valid.
+     */
     Identity.verifySignature = function (message, signature, publicKey) {
         return verifySignature(message, signature, publicKey);
     };

package/dist/index.node.cjs

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 4.0.0-alpha.8
+ * @version 4.0.0-beta
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -118,10 +118,29 @@ function randomNumber() {
     return BigInt(hex);
 }
 
+/**
+ * The Semaphore identity is essentially an {@link https://www.rfc-editor.org/rfc/rfc8032 | EdDSA}
+ * public/private key pair. The {@link https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/eddsa-poseidon | EdDSA implementation}
+ * in this library uses {@link https://eips.ethereum.org/EIPS/eip-2494 | Baby Jubjub} for public key generation
+ * and {@link https://www.poseidon-hash.info | Poseidon} for signatures.
+ * In addition, the commitment, i.e. the hash of the public key, is used to represent
+ * Semaphore identities in groups, adding an additional layer of privacy and security.
+ */
 var Identity = /** @class */ (function () {
     /**
-     * Initializes the class attributes based on the parameters.
-     * @param privateKey The secret value used to generate an EdDSA public key.
+     * Initializes the class attributes based on a given private key.
+     * If the private key is not passed as a parameter, a random key is generated.
+     * The constructor calculates the secret scalar and public key from the private key,
+     * and computes a commitment of the public key using a hash function (Poseidon).
+     *
+     * @example
+     * // Generates an identity.
+     * const { privateKey, publicKey, commitment } = new Identity("private-key")
+     * @example
+     * // Generates an identity with a random private key.
+     * const { privateKey, publicKey, commitment } = new Identity()
+     *
+     * @param privateKey The private key used to derive the public key.
      */
     function Identity(privateKey) {
         if (privateKey === void 0) { privateKey = randomNumber().toString(); }
@@ -133,7 +152,7 @@ var Identity = /** @class */ (function () {
     Object.defineProperty(Identity.prototype, "privateKey", {
         /**
          * Returns the private key.
-         * @returns The private key.
+         * @returns The private key as a {@link https://zkkit.pse.dev/types/_zk_kit_utils.BigNumberish.html | BigNumberish}.
          */
         get: function () {
             return this._privateKey;
@@ -144,7 +163,7 @@ var Identity = /** @class */ (function () {
     Object.defineProperty(Identity.prototype, "secretScalar", {
         /**
          * Returns the secret scalar.
-         * @returns The secret scalar.
+         * @returns The secret scalar as a string.
          */
         get: function () {
             return this._secretScalar;
@@ -154,8 +173,8 @@ var Identity = /** @class */ (function () {
     });
     Object.defineProperty(Identity.prototype, "publicKey", {
         /**
-         * Returns the public key.
-         * @returns The public key.
+         * Returns the public key as a Baby Jubjub {@link https://zkkit.pse.dev/types/_zk_kit_baby_jubjub.Point.html | Point}.
+         * @returns The public key as a point.
          */
         get: function () {
             return this._publicKey;
@@ -165,8 +184,8 @@ var Identity = /** @class */ (function () {
     });
     Object.defineProperty(Identity.prototype, "commitment", {
         /**
-         * Returns the identity commitment.
-         * @returns The identity commitment.
+         * Returns the commitment hash of the public key.
+         * @returns The commitment as a string.
          */
         get: function () {
             return this._commitment;
@@ -174,12 +193,37 @@ var Identity = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Generates a signature for a given message using the private key.
+     * This method demonstrates how to sign a message and could be used
+     * for authentication or data integrity.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     *
+     * @param message The message to be signed.
+     * @returns A {@link https://zkkit.pse.dev/types/_zk_kit_eddsa_poseidon.Signature.html | Signature} object containing the signature components.
+     */
     Identity.prototype.signMessage = function (message) {
         return eddsaPoseidon.signMessage(this.privateKey, message);
     };
-    Identity.prototype.verifySignature = function (message, signature) {
-        return eddsaPoseidon.verifySignature(message, signature, this._publicKey);
-    };
+    /**
+     * Verifies a signature against a given message and public key.
+     * This static method allows for the verification of signatures without needing
+     * an instance of the Identity class. It's useful for cases where you only have
+     * the public key, the message and a signature, and need to verify if they match.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     * Identity.verifySignature("message", signature, identity.publicKey)
+     *
+     * @param message The message that was signed.
+     * @param signature The signature to verify.
+     * @param publicKey The public key to use for verification.
+     * @returns A boolean indicating whether the signature is valid.
+     */
     Identity.verifySignature = function (message, signature, publicKey) {
         return eddsaPoseidon.verifySignature(message, signature, publicKey);
     };

package/dist/index.node.js

@@ -1,6 +1,6 @@
 /**
  * @module @semaphore-protocol/identity
- * @version 4.0.0-alpha.8
+ * @version 4.0.0-beta
  * @file A library to create Semaphore identities.
  * @copyright Ethereum Foundation 2024
  * @license MIT
@@ -116,10 +116,29 @@ function randomNumber() {
     return BigInt(hex);
 }
 
+/**
+ * The Semaphore identity is essentially an {@link https://www.rfc-editor.org/rfc/rfc8032 | EdDSA}
+ * public/private key pair. The {@link https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/eddsa-poseidon | EdDSA implementation}
+ * in this library uses {@link https://eips.ethereum.org/EIPS/eip-2494 | Baby Jubjub} for public key generation
+ * and {@link https://www.poseidon-hash.info | Poseidon} for signatures.
+ * In addition, the commitment, i.e. the hash of the public key, is used to represent
+ * Semaphore identities in groups, adding an additional layer of privacy and security.
+ */
 var Identity = /** @class */ (function () {
     /**
-     * Initializes the class attributes based on the parameters.
-     * @param privateKey The secret value used to generate an EdDSA public key.
+     * Initializes the class attributes based on a given private key.
+     * If the private key is not passed as a parameter, a random key is generated.
+     * The constructor calculates the secret scalar and public key from the private key,
+     * and computes a commitment of the public key using a hash function (Poseidon).
+     *
+     * @example
+     * // Generates an identity.
+     * const { privateKey, publicKey, commitment } = new Identity("private-key")
+     * @example
+     * // Generates an identity with a random private key.
+     * const { privateKey, publicKey, commitment } = new Identity()
+     *
+     * @param privateKey The private key used to derive the public key.
      */
     function Identity(privateKey) {
         if (privateKey === void 0) { privateKey = randomNumber().toString(); }
@@ -131,7 +150,7 @@ var Identity = /** @class */ (function () {
     Object.defineProperty(Identity.prototype, "privateKey", {
         /**
          * Returns the private key.
-         * @returns The private key.
+         * @returns The private key as a {@link https://zkkit.pse.dev/types/_zk_kit_utils.BigNumberish.html | BigNumberish}.
          */
         get: function () {
             return this._privateKey;
@@ -142,7 +161,7 @@ var Identity = /** @class */ (function () {
     Object.defineProperty(Identity.prototype, "secretScalar", {
         /**
          * Returns the secret scalar.
-         * @returns The secret scalar.
+         * @returns The secret scalar as a string.
          */
         get: function () {
             return this._secretScalar;
@@ -152,8 +171,8 @@ var Identity = /** @class */ (function () {
     });
     Object.defineProperty(Identity.prototype, "publicKey", {
         /**
-         * Returns the public key.
-         * @returns The public key.
+         * Returns the public key as a Baby Jubjub {@link https://zkkit.pse.dev/types/_zk_kit_baby_jubjub.Point.html | Point}.
+         * @returns The public key as a point.
          */
         get: function () {
             return this._publicKey;
@@ -163,8 +182,8 @@ var Identity = /** @class */ (function () {
     });
     Object.defineProperty(Identity.prototype, "commitment", {
         /**
-         * Returns the identity commitment.
-         * @returns The identity commitment.
+         * Returns the commitment hash of the public key.
+         * @returns The commitment as a string.
          */
         get: function () {
             return this._commitment;
@@ -172,12 +191,37 @@ var Identity = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Generates a signature for a given message using the private key.
+     * This method demonstrates how to sign a message and could be used
+     * for authentication or data integrity.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     *
+     * @param message The message to be signed.
+     * @returns A {@link https://zkkit.pse.dev/types/_zk_kit_eddsa_poseidon.Signature.html | Signature} object containing the signature components.
+     */
     Identity.prototype.signMessage = function (message) {
         return signMessage(this.privateKey, message);
     };
-    Identity.prototype.verifySignature = function (message, signature) {
-        return verifySignature(message, signature, this._publicKey);
-    };
+    /**
+     * Verifies a signature against a given message and public key.
+     * This static method allows for the verification of signatures without needing
+     * an instance of the Identity class. It's useful for cases where you only have
+     * the public key, the message and a signature, and need to verify if they match.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     * Identity.verifySignature("message", signature, identity.publicKey)
+     *
+     * @param message The message that was signed.
+     * @param signature The signature to verify.
+     * @param publicKey The public key to use for verification.
+     * @returns A boolean indicating whether the signature is valid.
+     */
     Identity.verifySignature = function (message, signature, publicKey) {
         return verifySignature(message, signature, publicKey);
     };

package/dist/types/identity.d.ts

@@ -1,35 +1,81 @@
 import { BigNumberish, Point, Signature } from "@zk-kit/eddsa-poseidon";
+/**
+ * The Semaphore identity is essentially an {@link https://www.rfc-editor.org/rfc/rfc8032 | EdDSA}
+ * public/private key pair. The {@link https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/eddsa-poseidon | EdDSA implementation}
+ * in this library uses {@link https://eips.ethereum.org/EIPS/eip-2494 | Baby Jubjub} for public key generation
+ * and {@link https://www.poseidon-hash.info | Poseidon} for signatures.
+ * In addition, the commitment, i.e. the hash of the public key, is used to represent
+ * Semaphore identities in groups, adding an additional layer of privacy and security.
+ */
 export default class Identity {
     private _privateKey;
     private _secretScalar;
     private _publicKey;
     private _commitment;
     /**
-     * Initializes the class attributes based on the parameters.
-     * @param privateKey The secret value used to generate an EdDSA public key.
+     * Initializes the class attributes based on a given private key.
+     * If the private key is not passed as a parameter, a random key is generated.
+     * The constructor calculates the secret scalar and public key from the private key,
+     * and computes a commitment of the public key using a hash function (Poseidon).
+     *
+     * @example
+     * // Generates an identity.
+     * const { privateKey, publicKey, commitment } = new Identity("private-key")
+     * @example
+     * // Generates an identity with a random private key.
+     * const { privateKey, publicKey, commitment } = new Identity()
+     *
+     * @param privateKey The private key used to derive the public key.
      */
     constructor(privateKey?: BigNumberish);
     /**
      * Returns the private key.
-     * @returns The private key.
+     * @returns The private key as a {@link https://zkkit.pse.dev/types/_zk_kit_utils.BigNumberish.html | BigNumberish}.
      */
     get privateKey(): BigNumberish;
     /**
      * Returns the secret scalar.
-     * @returns The secret scalar.
+     * @returns The secret scalar as a string.
      */
     get secretScalar(): string;
     /**
-     * Returns the public key.
-     * @returns The public key.
+     * Returns the public key as a Baby Jubjub {@link https://zkkit.pse.dev/types/_zk_kit_baby_jubjub.Point.html | Point}.
+     * @returns The public key as a point.
      */
     get publicKey(): Point<string>;
     /**
-     * Returns the identity commitment.
-     * @returns The identity commitment.
+     * Returns the commitment hash of the public key.
+     * @returns The commitment as a string.
      */
     get commitment(): string;
+    /**
+     * Generates a signature for a given message using the private key.
+     * This method demonstrates how to sign a message and could be used
+     * for authentication or data integrity.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     *
+     * @param message The message to be signed.
+     * @returns A {@link https://zkkit.pse.dev/types/_zk_kit_eddsa_poseidon.Signature.html | Signature} object containing the signature components.
+     */
     signMessage(message: BigNumberish): Signature<string>;
-    verifySignature(message: BigNumberish, signature: Signature): boolean;
+    /**
+     * Verifies a signature against a given message and public key.
+     * This static method allows for the verification of signatures without needing
+     * an instance of the Identity class. It's useful for cases where you only have
+     * the public key, the message and a signature, and need to verify if they match.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     * Identity.verifySignature("message", signature, identity.publicKey)
+     *
+     * @param message The message that was signed.
+     * @param signature The signature to verify.
+     * @param publicKey The public key to use for verification.
+     * @returns A boolean indicating whether the signature is valid.
+     */
     static verifySignature(message: BigNumberish, signature: Signature, publicKey: Point): boolean;
 }

package/package.json

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

package/src/identity.ts

@@ -10,28 +10,50 @@ import {
 import { poseidon2 } from "poseidon-lite/poseidon2"
 import { randomNumber } from "./random-number.node"
 
+/**
+ * The Semaphore identity is essentially an {@link https://www.rfc-editor.org/rfc/rfc8032 | EdDSA}
+ * public/private key pair. The {@link https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/eddsa-poseidon | EdDSA implementation}
+ * in this library uses {@link https://eips.ethereum.org/EIPS/eip-2494 | Baby Jubjub} for public key generation
+ * and {@link https://www.poseidon-hash.info | Poseidon} for signatures.
+ * In addition, the commitment, i.e. the hash of the public key, is used to represent
+ * Semaphore identities in groups, adding an additional layer of privacy and security.
+ */
 export default class Identity {
+    // The EdDSA private key, passed as a parameter or generated randomly.
     private _privateKey: BigNumberish
+    // The secret scalar derived from the private key.
+    // It is used in circuits to derive the public key.
     private _secretScalar: string
+    // The EdDSA public key, derived from the private key.
     private _publicKey: Point<string>
+    // The identity commitment used as a public value in Semaphore groups.
     private _commitment: string
 
     /**
-     * Initializes the class attributes based on the parameters.
-     * @param privateKey The secret value used to generate an EdDSA public key.
+     * Initializes the class attributes based on a given private key.
+     * If the private key is not passed as a parameter, a random key is generated.
+     * The constructor calculates the secret scalar and public key from the private key,
+     * and computes a commitment of the public key using a hash function (Poseidon).
+     *
+     * @example
+     * // Generates an identity.
+     * const { privateKey, publicKey, commitment } = new Identity("private-key")
+     * @example
+     * // Generates an identity with a random private key.
+     * const { privateKey, publicKey, commitment } = new Identity()
+     *
+     * @param privateKey The private key used to derive the public key.
      */
     constructor(privateKey: BigNumberish = randomNumber().toString()) {
         this._privateKey = privateKey
         this._secretScalar = deriveSecretScalar(privateKey)
-
         this._publicKey = derivePublicKey(privateKey)
-
         this._commitment = poseidon2(this._publicKey).toString()
     }
 
     /**
      * Returns the private key.
-     * @returns The private key.
+     * @returns The private key as a {@link https://zkkit.pse.dev/types/_zk_kit_utils.BigNumberish.html | BigNumberish}.
      */
     public get privateKey(): BigNumberish {
         return this._privateKey
@@ -39,36 +61,60 @@ export default class Identity {
 
     /**
      * Returns the secret scalar.
-     * @returns The secret scalar.
+     * @returns The secret scalar as a string.
      */
     public get secretScalar(): string {
         return this._secretScalar
     }
 
     /**
-     * Returns the public key.
-     * @returns The public key.
+     * Returns the public key as a Baby Jubjub {@link https://zkkit.pse.dev/types/_zk_kit_baby_jubjub.Point.html | Point}.
+     * @returns The public key as a point.
      */
     public get publicKey(): Point<string> {
         return this._publicKey
     }
 
     /**
-     * Returns the identity commitment.
-     * @returns The identity commitment.
+     * Returns the commitment hash of the public key.
+     * @returns The commitment as a string.
      */
     public get commitment(): string {
         return this._commitment
     }
 
+    /**
+     * Generates a signature for a given message using the private key.
+     * This method demonstrates how to sign a message and could be used
+     * for authentication or data integrity.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     *
+     * @param message The message to be signed.
+     * @returns A {@link https://zkkit.pse.dev/types/_zk_kit_eddsa_poseidon.Signature.html | Signature} object containing the signature components.
+     */
     public signMessage(message: BigNumberish): Signature<string> {
         return signMessage(this.privateKey, message)
     }
 
-    public verifySignature(message: BigNumberish, signature: Signature): boolean {
-        return verifySignature(message, signature, this._publicKey)
-    }
-
+    /**
+     * Verifies a signature against a given message and public key.
+     * This static method allows for the verification of signatures without needing
+     * an instance of the Identity class. It's useful for cases where you only have
+     * the public key, the message and a signature, and need to verify if they match.
+     *
+     * @example
+     * const identity = new Identity()
+     * const signature = identity.signMessage("message")
+     * Identity.verifySignature("message", signature, identity.publicKey)
+     *
+     * @param message The message that was signed.
+     * @param signature The signature to verify.
+     * @param publicKey The public key to use for verification.
+     * @returns A boolean indicating whether the signature is valid.
+     */
     static verifySignature(message: BigNumberish, signature: Signature, publicKey: Point): boolean {
         return verifySignature(message, signature, publicKey)
     }