@did-btcr2/keypair 0.7.2 → 0.9.0

package/dist/types/public.d.ts

@@ -99,10 +99,10 @@ export declare class CompressedSecp256k1PublicKey implements PublicKey {
     #private;
     /**
      * Creates a CompressedSecp256k1PublicKey instance.
-     * @param {Hex} pk The public key byte array.
+     * @param {Hex} initialBytes The public key byte array.
      * @throws {PublicKeyError} if the byte length is not 32 (x-only) or 33 (compressed)
      */
-    constructor(pk: Hex);
+    constructor(initialBytes: Hex);
     /**
      * Get the compressed public key.
      * @returns {KeyBytes} The 33-byte compressed public key (0x02 or 0x03, x).
@@ -158,13 +158,6 @@ export declare class CompressedSecp256k1PublicKey implements PublicKey {
      * @returns {KeyBytes} The BIP-340 (x-only) representation of the public key.
      */
     bip340(): KeyBytes;
-    /**
-     * Returns the point of the public key.
-     * @param {Hex} pk The public key in hex (Uint8Array or string) format.
-     * @returns {Point} The point of the public key.
-     * @throws {PublicKeyError} If the public key is not a valid hex string or byte array.
-     */
-    static point(pk: Hex): Point;
     /**
      * Decodes the multibase string to the 35-byte corresponding public key (2 byte prefix + 32 byte public key).
      * @returns {KeyBytes} The decoded public key: prefix and public key bytes
@@ -195,18 +188,6 @@ export declare class CompressedSecp256k1PublicKey implements PublicKey {
      * @returns {PublicKeyObject} The CompressedSecp256k1PublicKey as a JSON object.
      */
     json(): PublicKeyObject;
-    /**
-     * Creates a CompressedSecp256k1PublicKey object from a JSON representation.
-     * @param {PublicKeyObject} json The JSON object to initialize the CompressedSecp256k1PublicKey.
-     * @returns {CompressedSecp256k1PublicKey} The initialized CompressedSecp256k1PublicKey object.
-     */
-    static fromJSON(json: PublicKeyObject): CompressedSecp256k1PublicKey;
-    /**
-     * Computes the deterministic public key for a given secret key.
-     * @param {Secp256k1SecretKey | KeyBytes} sk The Secp256k1SecretKey object or the secret key bytes
-     * @returns {CompressedSecp256k1PublicKey} A new CompressedSecp256k1PublicKey object
-     */
-    static fromSecretKey(sk: Secp256k1SecretKey | KeyBytes): CompressedSecp256k1PublicKey;
     /**
      * Computes modular exponentiation: (base^exp) % mod.
      * Used for computing modular square roots.
@@ -230,4 +211,29 @@ export declare class CompressedSecp256k1PublicKey implements PublicKey {
      * @returns {Uint8Array} 65-byte uncompressed public key (starts with `0x04`)
      */
     liftX(): Uint8Array;
+    /**
+     * Static method to validate a public key.
+     * @param {Hex} pk The public key in hex (Uint8Array or string) format.
+     * @returns {boolean} True if the public key is valid, false otherwise.
+     */
+    static isValid(pk: Hex): boolean;
+    /**
+     * Returns the point of the public key.
+     * @param {Hex} pk The public key in hex (Uint8Array or string) format.
+     * @returns {Point} The point of the public key.
+     * @throws {PublicKeyError} If the public key is not a valid hex string or byte array.
+     */
+    static point(pk: Hex): Point;
+    /**
+     * Creates a CompressedSecp256k1PublicKey object from a JSON representation.
+     * @param {PublicKeyObject} json The JSON object to initialize the CompressedSecp256k1PublicKey.
+     * @returns {CompressedSecp256k1PublicKey} The initialized CompressedSecp256k1PublicKey object.
+     */
+    static fromJSON(json: PublicKeyObject): CompressedSecp256k1PublicKey;
+    /**
+     * Computes the deterministic public key for a given secret key.
+     * @param {Secp256k1SecretKey | KeyBytes} sk The Secp256k1SecretKey object or the secret key bytes
+     * @returns {CompressedSecp256k1PublicKey} A new CompressedSecp256k1PublicKey object
+     */
+    static fromSecretKey(sk: Secp256k1SecretKey | KeyBytes): CompressedSecp256k1PublicKey;
 }

package/dist/types/public.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,EAEL,GAAG,EACH,QAAQ,EACR,eAAe,EAEf,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,CAAC,EAAE,QAAQ,CAAC;IACZ,CAAC,EAAE,QAAQ,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,UAAU,EAAE,QAAQ,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,QAAQ,CAAC;IAEvB;;;OAGG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,CAAC,EAAE,QAAQ,CAAC;IAEZ;;;OAGG;IACH,CAAC,EAAE,QAAQ,CAAC;IAEZ;;;OAGG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;;OAGG;IACH,MAAM,IAAI,QAAQ,CAAC;IAEnB;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,4BAA4B,GAAG,OAAO,CAAC;IAErD;;;OAGG;IACH,IAAI,IAAI,eAAe,CAAC;CACzB;AAED;;;;;;GAMG;AACH,qBAAa,4BAA6B,YAAW,SAAS;;IAW5D;;;;OAIG;gBACS,EAAE,EAAE,GAAG;IA4BnB;;;OAGG;IACH,IAAI,UAAU,IAAI,QAAQ,CAGzB;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,QAAQ,CAG3B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,QAAQ,CAGpB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,IAAI,GAAG,IAAI,CASxB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;OAGG;IACH,IAAI,CAAC,IAAI,QAAQ,CAGhB;IAED;;;OAGG;IACH,IAAI,CAAC,IAAI,QAAQ,CAGhB;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,eAAe,CAG/B;IAED;;;OAGG;IACH,IAAI,GAAG,IAAI,MAAM,CAGhB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,KAAK,CAKjB;IAED;;;OAGG;IACI,MAAM,IAAI,QAAQ;IAIzB;;;;;OAKG;WACW,KAAK,CAAC,EAAE,EAAE,GAAG,GAAG,KAAK;IAoBnC;;;OAGG;IACI,MAAM,IAAI,QAAQ;IA8BzB;;;OAGG;IACI,MAAM,IAAI,MAAM;IAsBvB;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO;IAY3E;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,4BAA4B,GAAG,OAAO;IAI3D;;;OAGG;IACI,IAAI,IAAI,eAAe;IAY9B;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,4BAA4B;IAK3E;;;;OAIG;WACW,aAAa,CAAC,EAAE,EAAE,kBAAkB,GAAG,QAAQ,GAAG,4BAA4B;IAkB5F;;;;;;;OAOG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAU7D;;;;;;OAMG;IACI,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;OAIG;IACI,KAAK,IAAI,UAAU;CAwB3B"}
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,EAEL,GAAG,EACH,QAAQ,EACR,eAAe,EAEf,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,CAAC,EAAE,QAAQ,CAAC;IACZ,CAAC,EAAE,QAAQ,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,UAAU,EAAE,QAAQ,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,QAAQ,CAAC;IAEvB;;;OAGG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,CAAC,EAAE,QAAQ,CAAC;IAEZ;;;OAGG;IACH,CAAC,EAAE,QAAQ,CAAC;IAEZ;;;OAGG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;;OAGG;IACH,MAAM,IAAI,QAAQ,CAAC;IAEnB;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,4BAA4B,GAAG,OAAO,CAAC;IAErD;;;OAGG;IACH,IAAI,IAAI,eAAe,CAAC;CACzB;AAED;;;;;;GAMG;AACH,qBAAa,4BAA6B,YAAW,SAAS;;IAW5D;;;;OAIG;gBACS,YAAY,EAAE,GAAG;IA6B7B;;;OAGG;IACH,IAAI,UAAU,IAAI,QAAQ,CAGzB;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,QAAQ,CAG3B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,QAAQ,CAGpB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,IAAI,GAAG,IAAI,CASxB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;OAGG;IACH,IAAI,CAAC,IAAI,QAAQ,CAGhB;IAED;;;OAGG;IACH,IAAI,CAAC,IAAI,QAAQ,CAGhB;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,eAAe,CAG/B;IAED;;;OAGG;IACH,IAAI,GAAG,IAAI,MAAM,CAGhB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,KAAK,CAKjB;IAED;;;OAGG;IACH,MAAM,IAAI,QAAQ;IAIlB;;;OAGG;IACH,MAAM,IAAI,QAAQ;IA8BlB;;;OAGG;IACH,MAAM,IAAI,MAAM;IAsBhB;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO;IAYpE;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,4BAA4B,GAAG,OAAO;IAIpD;;;OAGG;IACH,IAAI,IAAI,eAAe;IAYvB;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAUtD;;;;;;OAMG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAIrC;;;;OAIG;IACH,KAAK,IAAI,UAAU;IAyBnB;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO;IAShC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,GAAG,KAAK;IAoB5B;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,4BAA4B;IAKpE;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,kBAAkB,GAAG,QAAQ,GAAG,4BAA4B;CAiBtF"}

package/dist/types/secret.d.ts

@@ -1,4 +1,4 @@
-import { Bytes, Entropy, Hex, KeyBytes, SecretKeyObject, SignatureBytes } from '@did-btcr2/common';
+import { Bytes, Hex, KeyBytes, SecretKeyObject, SignatureBytes } from '@did-btcr2/common';
 import { SchnorrKeyPair } from './pair.js';
 import { CompressedSecp256k1PublicKey } from './public.js';
 import { CryptoOptions } from './types.js';
@@ -58,10 +58,10 @@ export declare class Secp256k1SecretKey implements SecretKey {
     #private;
     /**
      * Instantiates an instance of Secp256k1SecretKey.
-     * @param {Entropy} entropy bytes (Uint8Array) or secret (bigint)
+     * @param {Bytes | bigint} entropy bytes (Uint8Array) or secret (bigint)
      * @throws {SecretKeyError} If entropy is not provided, not a valid 32-byte secret key or not a valid bigint seed
      */
-    constructor(entropy: Entropy);
+    constructor(entropy: Bytes | bigint);
     /**
      * Get the secret key entropy as a byte array.
      * @returns {KeyBytes} The secret key bytes as a Uint8Array
@@ -153,12 +153,18 @@ export declare class Secp256k1SecretKey implements SecretKey {
      * @returns {KeyBytes} The secret key secret as secret key bytes.
      */
     static toBytes(secret: bigint): KeyBytes;
+    /**
+     * Creates a new Secp256k1SecretKey object from random bytes.
+     * @param {KeyBytes} bytes The secret key bytes
+     * @returns {Secp256k1SecretKey} A new Secp256k1SecretKey object
+     */
+    static fromBytes(bytes: KeyBytes): Secp256k1SecretKey;
     /**
      * Creates a new Secp256k1SecretKey object from a bigint secret.
-     * @param {bigint} entropy The secret bigint
+     * @param {bigint} bint The secret bigint
      * @returns {Secp256k1SecretKey} A new Secp256k1SecretKey object
      */
-    static fromEntropy(entropy: bigint): Secp256k1SecretKey;
+    static fromBigInt(bint: bigint): Secp256k1SecretKey;
     /**
      * Generates random secret key bytes.
      * @returns {KeyBytes} Uint8Array of 32 random bytes.

package/dist/types/secret.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"secret.d.ts","sourceRoot":"","sources":["../../src/secret.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,EAEL,OAAO,EACP,GAAG,EACH,QAAQ,EAER,eAAe,EACf,cAAc,EACf,MAAM,mBAAmB,CAAC;AAK3B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAE3C;;;OAGG;IACH,gBAAgB,IAAI,4BAA4B,CAAC;IAEjD;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,IAAI,eAAe,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,YAAW,SAAS;;IAUlD;;;;OAIG;gBACS,OAAO,EAAE,OAAO;IAyC5B;;;OAGG;IACH,IAAI,KAAK,IAAI,UAAU,CAItB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAIjB;IAED;;;OAGG;IACH,IAAI,GAAG,IAAI,GAAG,CAGb;IAGD;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAGtB;IAED;;;OAGG;IACI,MAAM,IAAI,MAAM;IAoBvB;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;IAKjD;;;OAGG;IACI,gBAAgB,IAAI,4BAA4B;IAuBvD;;;OAGG;IACI,IAAI,IAAI,eAAe;IAQ9B;;;OAGG;IACI,OAAO,IAAI,OAAO;IAIzB;;;OAGG;IACI,iBAAiB,IAAI,OAAO;IAanC;;;;;;;OAOG;IACI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,cAAc;IAiB9D;;;;OAIG;WACW,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK;IA8B9C;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,kBAAkB;IAIjE;;;;;OAKG;WACW,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,cAAc;IAWxD;;;;OAIG;WACW,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAI/C;;;;OAIG;WACW,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ;IAiB/C;;;;OAIG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,kBAAkB;IAS9D;;;OAGG;WACW,MAAM,IAAI,QAAQ;IAQhC;;;OAGG;WACW,QAAQ,IAAI,kBAAkB;IAQ5C;;;;OAIG;WACW,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,4BAA4B;CAI1E"}
+{"version":3,"file":"secret.d.ts","sourceRoot":"","sources":["../../src/secret.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,EAEL,GAAG,EACH,QAAQ,EAER,eAAe,EACf,cAAc,EACf,MAAM,mBAAmB,CAAC;AAK3B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAE3C;;;OAGG;IACH,gBAAgB,IAAI,4BAA4B,CAAC;IAEjD;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAEnB;;;OAGG;IACH,IAAI,IAAI,eAAe,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,YAAW,SAAS;;IAUlD;;;;OAIG;gBACS,OAAO,EAAE,KAAK,GAAG,MAAM;IAyCnC;;;OAGG;IACH,IAAI,KAAK,IAAI,UAAU,CAItB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAIjB;IAED;;;OAGG;IACH,IAAI,GAAG,IAAI,GAAG,CAGb;IAGD;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAGtB;IAED;;;OAGG;IACI,MAAM,IAAI,MAAM;IAoBvB;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;IAKjD;;;OAGG;IACI,gBAAgB,IAAI,4BAA4B;IAuBvD;;;OAGG;IACI,IAAI,IAAI,eAAe;IAQ9B;;;OAGG;IACI,OAAO,IAAI,OAAO;IAIzB;;;OAGG;IACI,iBAAiB,IAAI,OAAO;IAanC;;;;;;;OAOG;IACI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,cAAc;IAiB9D;;;;OAIG;WACW,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK;IA8B9C;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,kBAAkB;IAIjE;;;;;OAKG;WACW,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,cAAc;IAWxD;;;;OAIG;WACW,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAI/C;;;;OAIG;WACW,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ;IAiB/C;;;;OAIG;WACW,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,kBAAkB;IAK5D;;;;OAIG;WACW,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB;IAS1D;;;OAGG;WACW,MAAM,IAAI,QAAQ;IAQhC;;;OAGG;WACW,QAAQ,IAAI,kBAAkB;IAQ5C;;;;OAIG;WACW,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,4BAA4B;CAI1E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-btcr2/keypair",
-  "version": "0.7.2",
+  "version": "0.9.0",
   "type": "module",
   "description": "JavaScript/TypeScript implementation of secp256k1 public/private key pairs with BIP340 schnorr signatures. Used by various parts of the did-btcr2-js monorepo.",
   "main": "./dist/cjs/index.js",
@@ -62,7 +62,7 @@
     "@noble/hashes": "^1.7.1",
     "multiformats": "^13.3.2",
     "tiny-secp256k1": "^2.2.3",
-    "@did-btcr2/common": "2.2.2"
+    "@did-btcr2/common": "3.1.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.20.0",

package/src/pair.ts

@@ -1,11 +1,12 @@
 import {
   Hex,
+  HexString,
   KeyBytes,
   KeyPairError,
   SchnorrKeyPairObject
 } from '@did-btcr2/common';
-import { CompressedSecp256k1PublicKey } from './public.js';
-import { Secp256k1SecretKey } from './secret.js';
+import { CompressedSecp256k1PublicKey, PublicKey } from './public.js';
+import { Secp256k1SecretKey, SecretKey } from './secret.js';
 import { HexSchnorrKeyPair, MultibaseKeys, RawSchnorrKeyPair, SchnorrKeyPairParams } from './types.js';
 
 /**
@@ -15,40 +16,41 @@ import { HexSchnorrKeyPair, MultibaseKeys, RawSchnorrKeyPair, SchnorrKeyPairPara
  */
 export interface KeyPair {
   /**
-   * @type {CompressedSecp256k1PublicKey} The public key associated with the SchnorrKeyPair (required).
+   * The public key associated with the SchnorrKeyPair (required).
    */
-  readonly publicKey: CompressedSecp256k1PublicKey;
+  readonly publicKey: PublicKey;
 
   /**
-   * @type {Secp256k1SecretKey} The secret key associated with the SchnorrKeyPair (optional).
-   * @throws {KeyPairError} If the secret key is not available.
+   * The secret key associated with the SchnorrKeyPair (optional).
    */
-  readonly secretKey?: Secp256k1SecretKey;
-
-  /**
-   * JSON representation of the SchnorrKeyPair object.
-   * @returns {SchnorrKeyPairObject} The SchnorrKeyPair as a JSON object.
-   */
-  json(): SchnorrKeyPairObject;
+  readonly secretKey?: SecretKey;
 }
 
 /**
- * Encapsulates a CompressedSecp256k1PublicKey and a Secp256k1SecretKey object as a single SchnorrKeyPair object.
+ * Encapsulates paired CompressedSecp256k1PublicKey and Secp256k1SecretKey objects as a single SchnorrKeyPair object.
  * @class SchnorrKeyPair
  * @type {SchnorrKeyPair}
  */
 export class SchnorrKeyPair implements KeyPair {
-  /** @type {Secp256k1SecretKey} The secret key object */
-  private _secretKey?: Secp256k1SecretKey;
+  /**
+   * The secret key objec
+    */
+  #secretKey?: Secp256k1SecretKey;
 
-  /** @type {CompressedSecp256k1PublicKey} The public key object */;
-  private _publicKey: CompressedSecp256k1PublicKey;
+  /**
+   * The public key object
+   */;
+  #publicKey: CompressedSecp256k1PublicKey;
 
-  /** @type {string} The public key in multibase format */
-  private _publicKeyMultibase: string;
+  /**
+   * The public key in multibase forma
+    */
+  #publicKeyMultibase: string;
 
-  /** @type {string} The secret key in multibase format */
-  private _secretKeyMultibase: string;
+  /**
+   * The secret key in multibase forma
+    */
+  #secretKeyMultibase: string;
 
   /**
    * Creates an instance of Keys. Must provide a at least a secret key.
@@ -67,22 +69,22 @@ export class SchnorrKeyPair implements KeyPair {
 
     // Set the secretKey
     if(params.secretKey instanceof Uint8Array) {
-      this._secretKey = new Secp256k1SecretKey(params.secretKey);
+      this.#secretKey = new Secp256k1SecretKey(params.secretKey);
     } else if (params.secretKey instanceof Secp256k1SecretKey) {
-      this._secretKey = params.secretKey;
+      this.#secretKey = params.secretKey;
     }
 
     // Set the publicKey
     if(params.publicKey instanceof CompressedSecp256k1PublicKey) {
-      this._publicKey = params.publicKey;
+      this.#publicKey = params.publicKey;
     } else if (params.publicKey instanceof Uint8Array) {
-      this._publicKey = new CompressedSecp256k1PublicKey(params.publicKey);
+      this.#publicKey = new CompressedSecp256k1PublicKey(params.publicKey);
     } else {
-      this._publicKey = this._secretKey!.computePublicKey();
+      this.#publicKey = this.#secretKey!.computePublicKey();
     }
 
-    this._publicKeyMultibase = this._publicKey.multibase.encoded;
-    this._secretKeyMultibase = this._secretKey ? this._secretKey.multibase : '';
+    this.#publicKeyMultibase = this.#publicKey.multibase.encoded;
+    this.#secretKeyMultibase = this.#secretKey ? this.#secretKey.multibase : '';
   }
 
   /**
@@ -92,15 +94,15 @@ export class SchnorrKeyPair implements KeyPair {
    */
   get secretKey(): Secp256k1SecretKey {
     // If the secret key is not available, throw an error
-    if(!this._secretKey) {
+    if(!this.#secretKey) {
       throw new KeyPairError('Secret key not available', 'SECRET_KEY_ERROR');
     }
     // If the secret key is not valid, throw an error
-    if(!this._secretKey.isValid()) {
+    if(!this.#secretKey.isValid()) {
       throw new KeyPairError('Secret key is not valid', 'SECRET_KEY_ERROR');
     }
     // Return a copy of the secret key
-    const secret = this._secretKey;
+    const secret = this.#secretKey;
     return secret;
   }
 
@@ -119,9 +121,9 @@ export class SchnorrKeyPair implements KeyPair {
       if(!publicKey.equals(cPk))
         throw new KeyPairError('Public key is not a valid pair with the secret key', 'PUBLIC_KEY_ERROR');
     }
-    this._publicKey = publicKey;
-    this._publicKeyMultibase = publicKey.multibase.encoded;
-    this._secretKeyMultibase = this._secretKey ? this._secretKey.multibase : '';
+    this.#publicKey = publicKey;
+    this.#publicKeyMultibase = publicKey.multibase.encoded;
+    this.#secretKeyMultibase = this.#secretKey ? this.#secretKey.multibase : '';
   }
 
   /**
@@ -129,7 +131,7 @@ export class SchnorrKeyPair implements KeyPair {
    * @returns {CompressedSecp256k1PublicKey} The CompressedSecp256k1PublicKey object
    */
   get publicKey(): CompressedSecp256k1PublicKey {
-    const publicKey = this._publicKey;
+    const publicKey = this.#publicKey;
     return publicKey;
   }
 
@@ -151,7 +153,7 @@ export class SchnorrKeyPair implements KeyPair {
   get hex(): HexSchnorrKeyPair {
     return {
       public : this.publicKey.hex,
-      secret : this._secretKey ? this.secretKey.hex : undefined
+      secret : this.#secretKey ? this.secretKey.hex : undefined
     };
   }
 
@@ -161,8 +163,8 @@ export class SchnorrKeyPair implements KeyPair {
    */
   get multibase(): MultibaseKeys {
     return {
-      publicKeyMultibase  : this._publicKeyMultibase,
-      secretKeyMultibase : this._secretKeyMultibase,
+      publicKeyMultibase : this.#publicKeyMultibase,
+      secretKeyMultibase : this.#secretKeyMultibase,
     };
   }
 
@@ -170,7 +172,7 @@ export class SchnorrKeyPair implements KeyPair {
    * JSON representation of a Keys.
    * @returns {SchnorrKeyPairObject} The Keys as a JSON object
    */
-  public json(): SchnorrKeyPairObject {
+  json(): SchnorrKeyPairObject {
     return {
       secretKey : this.secretKey.json(),
       publicKey : this.publicKey.json()
@@ -182,7 +184,7 @@ export class SchnorrKeyPair implements KeyPair {
    * @param {SchnorrKeyPairObject} keys The JSON object to initialize the Keys.
    * @returns {SchnorrKeyPair} The initialized Keys object.
    */
-  public static fromJSON(keys: SchnorrKeyPairObject): SchnorrKeyPair {
+  static fromJSON(keys: SchnorrKeyPairObject): SchnorrKeyPair {
     return new SchnorrKeyPair({
       secretKey : Secp256k1SecretKey.fromJSON(keys.secretKey),
       publicKey : CompressedSecp256k1PublicKey.fromJSON(keys.publicKey)
@@ -194,33 +196,35 @@ export class SchnorrKeyPair implements KeyPair {
    * @param {Secp256k1SecretKey | KeyBytes} data The secret key bytes
    * @returns {SchnorrKeyPair} A new SchnorrKeyPair object
    */
-  public static fromPrivateKey(data: Secp256k1SecretKey | KeyBytes): SchnorrKeyPair {
-
-    // If the secret key is a Secp256k1SecretKey object, get the raw bytes else use the bytes
-    const bytes = data instanceof Secp256k1SecretKey ? data.bytes : data;
-
-    // Throw error if the secret key is not 32 bytes
-    if(bytes.length !== 32) {
-      throw new KeyPairError('Invalid arg: must be 32 byte secret key', 'FROM_PRIVATE_KEY_ERROR');
+  static fromSecret(data: KeyBytes | HexString): SchnorrKeyPair {
+
+    // If the data is Secp256k1SecretKey object, get the raw bytes
+    // Else if data is string, convert to byte array
+    // Else must be bytes, use them
+    const secret = typeof data === 'string'
+      ? Buffer.from(data, 'hex')
+      : data;
+
+    // Check the lenth
+    if(secret.length !== 32) {
+      throw new KeyPairError('Invalid arg: must be 32 byte secret key', 'FROM_SECRET_KEY_ERROR');
     }
 
     // If pk Uint8Array, construct Secp256k1SecretKey object else use the object
-    const secret = data instanceof Uint8Array ? new Secp256k1SecretKey(data) : data;
+    const secretKey = new Secp256k1SecretKey(secret);
+    const publicKey = secretKey.computePublicKey();
 
     // Return a new Keys object
-    return new SchnorrKeyPair({
-      secretKey : data instanceof Uint8Array ? new Secp256k1SecretKey(data) : data,
-      publicKey : secret.computePublicKey()
-    });
+    return new SchnorrKeyPair({ secretKey, publicKey });
   }
 
   /**
    * Static method creates a new Keys (Secp256k1SecretKey/CompressedSecp256k1PublicKey) from bigint entropy.
-   * @param {bigint} entropy The entropy in bigint form
+   * @param {bigint} bint The entropy in bigint form
    * @returns {SchnorrKeyPair} A new SchnorrKeyPair object
    */
-  public static fromEntropy(entropy: bigint): SchnorrKeyPair {
-    const secretKey = Secp256k1SecretKey.fromEntropy(entropy);
+  static fromBigInt(bint: bigint): SchnorrKeyPair {
+    const secretKey = Secp256k1SecretKey.fromBigInt(bint);
     const publicKey = secretKey.computePublicKey();
     return new SchnorrKeyPair({ secretKey, publicKey });
   }
@@ -230,7 +234,7 @@ export class SchnorrKeyPair implements KeyPair {
    * @param {KeyBytes} keyBytes The key bytes (secret or public).
    * @returns {Hex} The key bytes as a hex string.
    */
-  public static toHex(keyBytes: KeyBytes): Hex {
+  static toHex(keyBytes: KeyBytes): Hex {
     return Buffer.from(keyBytes).toString('hex');
   }
 
@@ -240,7 +244,7 @@ export class SchnorrKeyPair implements KeyPair {
    * @param {SchnorrKeyPair} otherKp The other keys to compare.
    * @returns {boolean} True if the public key and secret key are equal, false otherwise.
    */
-  public static equals(kp: SchnorrKeyPair, otherKp: SchnorrKeyPair): boolean {
+  static equals(kp: SchnorrKeyPair, otherKp: SchnorrKeyPair): boolean {
     // Deconstruct the public keys from the key pairs
     const pk = kp.publicKey;
     const otherPk = otherKp.publicKey;
@@ -265,7 +269,7 @@ export class SchnorrKeyPair implements KeyPair {
    * Static method to generate a new random SchnorrKeyPair instance.
    * @returns {SchnorrKeyPair} A new Secp256k1SecretKey object.
    */
-  public static generate(): SchnorrKeyPair {
+  static generate(): SchnorrKeyPair {
     // Generate random secret key bytes
     const sk = Secp256k1SecretKey.random();