@did-btcr2/keypair 0.5.1 → 0.6.0

package/dist/types/public.d.ts

@@ -1,69 +1,84 @@
 import { Hex, KeyBytes, Maybe, MultibaseObject, PublicKeyObject } from '@did-btcr2/common';
-import { SecretKey } from './secret.js';
+import { Secp256k1SecretKey } from './secret.js';
 export interface Point {
     x: KeyBytes;
     y: KeyBytes;
 }
 /**
- * Interface for the PublicKey class.
- * @interface IPublicKey
- * @type {IPublicKey}
+ * General PublicKey Interface used by CompressedSecp256k1PublicKey.
+ * @interface PublicKey
+ * @type {PublicKey}
  */
-export interface IPublicKey {
+export interface PublicKey {
+    /**
+     * Compressed public key getter.
+     * @readonly @type {KeyBytes} The 33 byte compressed public key [parity, x-coord].
+     */
+    compressed: KeyBytes;
     /**
      * Uncompressed public key getter.
      * @readonly @type {KeyBytes} The 65 byte uncompressed public key [0x04, x-coord, y-coord].
      */
     uncompressed: KeyBytes;
     /**
-     * Compressed public key getter.
-     * @readonly @type {KeyBytes} The 33 byte compressed public key [parity, x-coord].
+     * X-only public key getter.
+     * @readonly @type {KeyBytes} The 32 byte x-only public key [x-coord].
      */
-    compressed: KeyBytes;
+    xOnly: KeyBytes;
     /**
-     * PublicKey parity getter.
+     * CompressedSecp256k1PublicKey parity getter.
      * @readonly @type {number} The 1 byte parity (0x02 if even, 0x03 if odd).
      */
     parity: number;
     /**
-     * PublicKey x-coordinate getter.
+     * CompressedSecp256k1PublicKey isEven getter.
+     * @readonly @type {boolean} True if the public key is even, false if odd.
+     */
+    isEven: boolean;
+    /**
+     * CompressedSecp256k1PublicKey x-coordinate getter.
      * @readonly @type {KeyBytes} The 32 byte x-coordinate of the public key.
      */
     x: KeyBytes;
     /**
-     * PublicKey y-coordinate getter.
+     * CompressedSecp256k1PublicKey y-coordinate getter.
      * @readonly @type {KeyBytes} The 32 byte y-coordinate of the public key.
      */
     y: KeyBytes;
     /**
-     * PublicKey multibase getter.
+     * CompressedSecp256k1PublicKey multibase getter.
      * @readonly @returns {MultibaseObject} The public key as MultibaseObject as a address string, key and prefix bytes.
      */
     multibase: MultibaseObject;
     /**
-     * PublicKey hex string getter.
+     * CompressedSecp256k1PublicKey hex string getter.
      * @readonly @type {Hex} The public key as a hex string.
      */
     hex: Hex;
+    /**
+     * CompressedSecp256k1PublicKey point getter.
+     * @readonly @type {Point} The public key as a point (x, y).
+     */
+    point: Point;
     /**
      * Decode the base58btc multibase string to the compressed public key prefixed with 0x02.
      * @returns {KeyBytes} The public key as a 33-byte compressed public key with header.
      */
     decode(): KeyBytes;
     /**
-     * Encode the PublicKey as an x-only base58btc multibase public key.
+     * Encode the CompressedSecp256k1PublicKey as an x-only base58btc multibase public key.
      * @returns {string} The public key formatted a base58btc multibase string.
      */
     encode(): string;
     /**
-     * PublicKey key equality check. Checks if `this` public key is equal to `other` public key.
-     * @param {PublicKey} other The public key to compare.
+     * CompressedSecp256k1PublicKey key equality check. Checks if `this` public key is equal to `other` public key.
+     * @param {CompressedSecp256k1PublicKey} other The public key to compare.
      * @returns {boolean} True if the public keys are equal.
      */
-    equals(other: PublicKey): boolean;
+    equals(other: CompressedSecp256k1PublicKey): boolean;
     /**
-     * JSON representation of a PublicKey object.
-     * @returns {PublicKeyObject} The PublicKey as a JSON object.
+     * JSON representation of a CompressedSecp256k1PublicKey object.
+     * @returns {PublicKeyObject} The CompressedSecp256k1PublicKey as a JSON object.
      */
     json(): PublicKeyObject;
 }
@@ -71,16 +86,16 @@ export interface IPublicKey {
  * Encapsulates a secp256k1 public key compliant to BIP-340 BIP schnorr signature scheme.
  * Provides get methods for different formats (compressed, x-only, multibase).
  * Provides helpers methods for comparison and serialization.
- * @class PublicKey
- * @type {PublicKey}
+ * @class CompressedSecp256k1PublicKey
+ * @type {CompressedSecp256k1PublicKey}
  */
-export declare class PublicKey implements PublicKey {
+export declare class CompressedSecp256k1PublicKey implements PublicKey {
     /** @type {KeyBytes} The public key bytes */
     private readonly _bytes;
     /** @type {MultibaseObject} The public key as a MultibaseObject */
     private _multibase;
     /**
-     * Creates a PublicKey instance.
+     * Creates a CompressedSecp256k1PublicKey instance.
      * @param {KeyBytes} bytes The public key byte array.
      * @throws {PublicKeyError} if the byte length is not 32 (x-only) or 33 (compressed)
      */
@@ -96,10 +111,19 @@ export declare class PublicKey implements PublicKey {
      */
     get uncompressed(): KeyBytes;
     /**
-     * Get the parity byte of the public key.
-     * @returns {number} The parity byte of the public key.
+     * X-only (32-byte) view of the public key per BIP-340.
+     */
+    get xOnly(): KeyBytes;
+    /**
+     * Parity of the SEC compressed public key.
+     * @returns {0 | 1} The parity of the public key. 0 = even (0x02), 1 = odd (0x03).
+     */
+    get parity(): 0 | 1;
+    /**
+     * Whether the SEC compressed public key has even Y.
+     * @returns {boolean} True if the public key has even Y.
      */
-    get parity(): number;
+    get isEven(): boolean;
     /**
      * Get the x-coordinate of the public key.
      * @returns {Uint8Array} The 32-byte x-coordinate of the public key.
@@ -125,6 +149,11 @@ export declare class PublicKey implements PublicKey {
      * @returns {Point} The public key point.
      */
     get point(): Point;
+    /**
+     * Returns the BIP-340 (x-only) representation of this key.
+     * @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.
@@ -144,27 +173,27 @@ export declare class PublicKey implements PublicKey {
     encode(): string;
     /**
      * Compares this public key to another public key.
-     * @param {PublicKey} other The other public key to compare
+     * @param {CompressedSecp256k1PublicKey} other The other public key to compare
      * @returns {boolean} True if the public keys are equal, false otherwise.
      */
-    equals(other: PublicKey): boolean;
+    equals(other: CompressedSecp256k1PublicKey): boolean;
     /**
-     * JSON representation of a PublicKey object.
-     * @returns {PublicKeyObject} The PublicKey as a JSON object.
+     * JSON representation of a CompressedSecp256k1PublicKey object.
+     * @returns {PublicKeyObject} The CompressedSecp256k1PublicKey as a JSON object.
      */
     json(): PublicKeyObject;
     /**
-     * Creates a PublicKey object from a JSON representation.
-     * @param {PublicKeyObject} json The JSON object to initialize the PublicKey.
-     * @returns {PublicKey} The initialized PublicKey object.
+     * 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: Maybe<PublicKeyObject>): PublicKey;
+    static fromJSON(json: Maybe<PublicKeyObject>): CompressedSecp256k1PublicKey;
     /**
-     * Computes the deterministic public key for a given private key.
-     * @param {PrivateKey | KeyBytes} sk The PrivateKey object or the private key bytes
-     * @returns {PublicKey} A new PublicKey object
+     * 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: SecretKey | KeyBytes): PublicKey;
+    static fromSecretKey(sk: Secp256k1SecretKey | KeyBytes): CompressedSecp256k1PublicKey;
     /**
      * Computes modular exponentiation: (base^exp) % mod.
      * Used for computing modular square roots.
@@ -188,10 +217,4 @@ export declare class PublicKey implements PublicKey {
      * @returns {Uint8Array} 65-byte uncompressed public key (starts with `0x04`)
      */
     liftX(): Uint8Array;
-    /**
-     * Static version of liftX method.
-     * @param {KeyBytes} x The 32-byte x-coordinate to lift.
-     * @returns {Uint8Array} The 65-byte uncompressed public key (0x04, x, y).
-     */
-    static xOnly(x: KeyBytes): Uint8Array;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,GAAG,EACH,QAAQ,EACR,KAAK,EACL,eAAe,EAEf,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,WAAW,KAAK;IACpB,CAAC,EAAE,QAAQ,CAAC;IACZ,CAAC,EAAE,QAAQ,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,YAAY,EAAE,QAAQ,CAAC;IAEvB;;;OAGG;IACH,UAAU,EAAE,QAAQ,CAAC;IAErB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;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,MAAM,IAAI,QAAQ,CAAC;IAEnB;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IAElC;;;OAGG;IACH,IAAI,IAAI,eAAe,CAAC;CACzB;AAED;;;;;;GAMG;AACH,qBAAa,SAAU,YAAW,SAAS;IACzC,4CAA4C;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAElC,kEAAkE;IAClE,OAAO,CAAC,UAAU,CAIhB;IAEF;;;;OAIG;gBACS,KAAK,EAAE,QAAQ;IAgB3B;;;OAGG;IACH,IAAI,UAAU,IAAI,QAAQ,CAGzB;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,QAAQ,CAG3B;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAGnB;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,GAAG,CAGb;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,KAAK,CAKjB;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,GAAG,KAAK;IAoB5B;;;OAGG;IACI,MAAM,IAAI,QAAQ;IA8BzB;;;OAGG;IACI,MAAM,IAAI,MAAM;IAsBvB;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAIxC;;;OAGG;IACI,IAAI,IAAI,eAAe;IAY9B;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS;IAK/D;;;;OAIG;WACW,aAAa,CAAC,EAAE,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS;IAgBhE;;;;;;;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;IAyB1B;;;;OAIG;WACW,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,UAAU;CAU7C"}
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,GAAG,EACH,QAAQ,EACR,KAAK,EACL,eAAe,EAEf,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD,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;IAC5D,4CAA4C;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAElC,kEAAkE;IAClE,OAAO,CAAC,UAAU,CAIhB;IAEF;;;;OAIG;gBACS,KAAK,EAAE,QAAQ;IAwB3B;;;OAGG;IACH,IAAI,UAAU,IAAI,QAAQ,CAGzB;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,QAAQ,CAG3B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,QAAQ,CAEpB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,CAElB;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,GAAG,CAGb;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,KAAK,CAKjB;IAED;;;OAGG;IACI,MAAM,IAAI,QAAQ;IAIzB;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,GAAG,KAAK;IAoB5B;;;OAGG;IACI,MAAM,IAAI,QAAQ;IA8BzB;;;OAGG;IACI,MAAM,IAAI,MAAM;IAsBvB;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,4BAA4B,GAAG,OAAO;IAI3D;;;OAGG;IACI,IAAI,IAAI,eAAe;IAY9B;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,4BAA4B;IAKlF;;;;OAIG;WACW,aAAa,CAAC,EAAE,EAAE,kBAAkB,GAAG,QAAQ,GAAG,4BAA4B;IAgB5F;;;;;;;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"}

package/dist/types/secret.d.ts

@@ -1,12 +1,12 @@
 import { Bytes, Entropy, Hex, KeyBytes, SecretKeyObject } from '@did-btcr2/common';
 import { SchnorrKeyPair } from './pair.js';
-import { PublicKey } from './public.js';
+import { CompressedSecp256k1PublicKey } from './public.js';
 /**
- * Interface for the SecretKey class.
- * @interface ISecretKey
- * @type {ISecretKey}
+ * General SecretKey interface for the Secp256k1SecretKey class.
+ * @interface SecretKey
+ * @type {SecretKey}
  */
-export interface ISecretKey {
+export interface SecretKey {
     /**
      * Get the secret key bytes.
      * @readonly @type {KeyBytes} The secret key bytes.
@@ -25,13 +25,13 @@ export interface ISecretKey {
     hex: Hex;
     /**
      * Checks if this secret key is equal to another secret key.
-     *
+     * @param {Secp256k1SecretKey} other The other secret key to compare.
      * @returns {boolean} True if the private keys are equal.
      */
-    equals(other: SecretKey): boolean;
+    equals(other: Secp256k1SecretKey): boolean;
     /**
      * Uses the secret key to compute the corresponding public key.
-     * @returns {KeyBytes} A new PublicKey object.
+     * @returns {KeyBytes} The computed public key bytes.
      */
     computePublicKey(): KeyBytes;
     /**
@@ -40,8 +40,8 @@ export interface ISecretKey {
      */
     isValid(): boolean;
     /**
-     * JSON representation of a SecretKey object.
-     * @returns {SecretKeyObject} The SecretKey as a JSON object.
+     * JSON representation of a Secp256k1SecretKey object.
+     * @returns {SecretKeyObject} The Secp256k1SecretKey as a JSON object.
      */
     json(): SecretKeyObject;
 }
@@ -49,11 +49,11 @@ export interface ISecretKey {
  * Encapsulates a secp256k1 secret key
  * Provides get methods for different formats (raw, secret, point).
  * Provides helpers methods for comparison, serialization and publicKey generation.
- * @class SecretKey
- * @type {SecretKey}
- *
+ * @class Secp256k1SecretKey
+ * @type {Secp256k1SecretKey}
+ * @implements {SecretKey}
  */
-export declare class SecretKey implements ISecretKey {
+export declare class Secp256k1SecretKey implements SecretKey {
     /** @type {KeyBytes} The entropy for the secret key as a byte array */
     private _bytes?;
     /** @type {bigint} The entropy for the secret key as a bigint */
@@ -61,7 +61,7 @@ export declare class SecretKey implements ISecretKey {
     /** @type {string} The secret key as a secretKeyMultibase */
     private _multibase;
     /**
-     * Instantiates an instance of SecretKey.
+     * Instantiates an instance of Secp256k1SecretKey.
      * @param {Entropy} 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
      */
@@ -93,10 +93,10 @@ export declare class SecretKey implements ISecretKey {
     encode(): string;
     /**
      * Checks if this secret key is equal to another.
-     * @param {SecretKey} other The other secret key
+     * @param {Secp256k1SecretKey} other The other secret key
      * @returns {boolean} True if the private keys are equal, false otherwise
      */
-    equals(other: SecretKey): boolean;
+    equals(other: Secp256k1SecretKey): boolean;
     /**
      * Computes the public key from the secret key bytes.
      * @returns {KeyBytes} The computed public key
@@ -114,10 +114,10 @@ export declare class SecretKey implements ISecretKey {
     isValid(): boolean;
     /**
      * Checks if the public key is a valid secp256k1 point.
-     * @param {PublicKey} pk The public key to validate
+     * @param {CompressedSecp256k1PublicKey} pk The public key to validate
      * @returns {boolean} True if the public key is valid, false otherwise
      */
-    isValidPair(pk: PublicKey): boolean;
+    hasValidPublicKey(pk: CompressedSecp256k1PublicKey): boolean;
     /**
      * Decodes the multibase string to the 34-byte secret key (2 byte prefix + 32 byte key).
      * @param {string} multibase The multibase string to decode
@@ -125,14 +125,14 @@ export declare class SecretKey implements ISecretKey {
      */
     static decode(multibase: string): Bytes;
     /**
-     * Creates a SecretKey object from a JSON object.
+     * Creates a Secp256k1SecretKey object from a JSON object.
      * @param {SecretKeyObject} json The JSON object containing the secret key bytes
-     * @returns {SecretKey} A new SecretKey object
+     * @returns {Secp256k1SecretKey} A new Secp256k1SecretKey object
      */
-    static fromJSON(json: SecretKeyObject): SecretKey;
+    static fromJSON(json: SecretKeyObject): Secp256k1SecretKey;
     /**
-     * Converts a SecretKey or KeyBytes to a Pair.
-     * @param {KeyBytes} bytes
+     * Converts a Secp256k1SecretKey or KeyBytes to a SchnorrKeyPair.
+     * @param {KeyBytes} bytes The secret key bytes
      * @returns {SchnorrKeyPair} The SchnorrKeyPair object containing the public and private keys
      * @throws {SecretKeyError} If the secret key is not valid
      */
@@ -150,21 +150,21 @@ export declare class SecretKey implements ISecretKey {
      */
     static toBytes(secret: bigint): KeyBytes;
     /**
-     * Creates a new SecretKey object from a bigint secret.
-     * @param {bigint} secret The secret bigint
-     * @returns {SecretKey} A new SecretKey object
+     * Creates a new Secp256k1SecretKey object from a bigint secret.
+     * @param {bigint} entropy The secret bigint
+     * @returns {Secp256k1SecretKey} A new Secp256k1SecretKey object
      */
-    static fromSecret(secret: bigint): SecretKey;
+    static fromEntropy(entropy: bigint): Secp256k1SecretKey;
     /**
      * Generates random secret key bytes.
      * @returns {KeyBytes} Uint8Array of 32 random bytes.
      */
     static random(): KeyBytes;
     /**
-     * Creates a new SecretKey from random secret key bytes.
-     * @returns {SecretKey} A new SecretKey object
+     * Creates a new Secp256k1SecretKey from random secret key bytes.
+     * @returns {Secp256k1SecretKey} A new Secp256k1SecretKey object
      */
-    static generate(): SecretKey;
+    static generate(): Secp256k1SecretKey;
     /**
      * Generates a public key from the given secret key bytes.
      * @param {KeyBytes} bytes The secret key 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,EAChB,MAAM,mBAAmB,CAAC;AAK3B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;;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,SAAS,GAAG,OAAO,CAAC;IAElC;;;OAGG;IACH,gBAAgB,IAAI,QAAQ,CAAC;IAE7B;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAGnB;;;OAGG;IACH,IAAI,IAAI,eAAe,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,SAAU,YAAW,UAAU;IAC1C,sEAAsE;IACtE,OAAO,CAAC,MAAM,CAAC,CAAW;IAE1B,gEAAgE;IAChE,OAAO,CAAC,KAAK,CAAC,CAAS;IAEvB,4DAA4D;IAC5D,OAAO,CAAC,UAAU,CAAS;IAE3B;;;;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,SAAS,GAAG,OAAO;IAKxC;;;OAGG;IACI,gBAAgB,IAAI,QAAQ;IAuBnC;;;OAGG;IACI,IAAI,IAAI,eAAe;IAQ9B;;;OAGG;IACI,OAAO,IAAI,OAAO;IAIzB;;;;OAIG;IACI,WAAW,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IAU1C;;;;OAIG;WACW,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK;IA8B9C;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,SAAS;IAIxD;;;;;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,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IASnD;;;OAGG;WACW,MAAM,IAAI,QAAQ;IAShC;;;OAGG;WACW,QAAQ,IAAI,SAAS;IAQnC;;;;OAIG;WACW,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ;CAItD"}
+{"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,EAChB,MAAM,mBAAmB,CAAC;AAK3B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAE3D;;;;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,QAAQ,CAAC;IAE7B;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAGnB;;;OAGG;IACH,IAAI,IAAI,eAAe,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,YAAW,SAAS;IAClD,sEAAsE;IACtE,OAAO,CAAC,MAAM,CAAC,CAAW;IAE1B,gEAAgE;IAChE,OAAO,CAAC,KAAK,CAAC,CAAS;IAEvB,4DAA4D;IAC5D,OAAO,CAAC,UAAU,CAAS;IAE3B;;;;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,QAAQ;IAuBnC;;;OAGG;IACI,IAAI,IAAI,eAAe;IAQ9B;;;OAGG;IACI,OAAO,IAAI,OAAO;IAIzB;;;;OAIG;IACI,iBAAiB,CAAC,EAAE,EAAE,4BAA4B,GAAG,OAAO;IAanE;;;;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;IAShC;;;OAGG;WACW,QAAQ,IAAI,kBAAkB;IAQ5C;;;;OAIG;WACW,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ;CAItD"}

package/dist/types/types.d.ts

@@ -0,0 +1,16 @@
+import { KeyBytes } from '@did-btcr2/common';
+import { CompressedSecp256k1PublicKey } from './public.js';
+import { Secp256k1SecretKey } from './secret.js';
+export type RawSchnorrKeyPair = {
+    public: KeyBytes;
+    secret?: KeyBytes;
+};
+/** Params for the {@link SchnorrKeyPair} constructor */
+export interface SchnorrKeyPairParams {
+    secretKey?: Secp256k1SecretKey | KeyBytes;
+    publicKey?: CompressedSecp256k1PublicKey | KeyBytes;
+}
+export interface MultibaseKeys {
+    publicKeyMultibase: string;
+    secretKeyMultibase: string;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,CAAC,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,wDAAwD;AACxD,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,kBAAkB,GAAG,QAAQ,CAAC;IAC1C,SAAS,CAAC,EAAE,4BAA4B,GAAG,QAAQ,CAAC;CACrD;AAED,MAAM,WAAW,aAAa;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAA;CAC3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-btcr2/keypair",
-  "version": "0.5.1",
+  "version": "0.6.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.0.0"
+    "@did-btcr2/common": "2.2.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.20.0",
@@ -104,8 +104,7 @@
     "build:esm": "rimraf dist/esm dist/types && pnpm tsc -p tsconfig.json",
     "build:cjs": "rimraf dist/cjs && tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
     "build:tests": "pnpm tsc -p tests/tsconfig.json",
-    "build:docs": "typedoc --options typedoc.json",
-    "build:all": "pnpm build && pnpm build:tests && pnpm build:docs",
+    "build:all": "pnpm build && pnpm build:tests",
     "release": "pnpm build && pnpm pack && mv *.tgz ../../release/key-pair",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './pair.js';
 export * from './secret.js';
-export * from './public.js';
+export * from './public.js';
+export * from './types.js';