@did-btcr2/keypair 0.5.1

package/dist/esm/secret.js

@@ -0,0 +1,271 @@
+import { BIP340_SECRET_KEY_MULTIBASE_PREFIX, BIP340_SECRET_KEY_MULTIBASE_PREFIX_HASH, CURVE, SecretKeyError } from '@did-btcr2/common';
+import { sha256 } from '@noble/hashes/sha2';
+import { getRandomValues } from 'crypto';
+import { base58btc } from 'multiformats/bases/base58';
+import * as tinysecp from 'tiny-secp256k1';
+import { SchnorrKeyPair } from './pair.js';
+/**
+ * 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}
+ *
+ */
+export class SecretKey {
+    /** @type {KeyBytes} The entropy for the secret key as a byte array */
+    _bytes;
+    /** @type {bigint} The entropy for the secret key as a bigint */
+    _seed;
+    /** @type {string} The secret key as a secretKeyMultibase */
+    _multibase;
+    /**
+     * Instantiates an instance of SecretKey.
+     * @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
+     */
+    constructor(entropy) {
+        // If entropy not valid bytes or bigint seed, throw an error
+        const isBytes = entropy instanceof Uint8Array;
+        const isSecret = typeof entropy === 'bigint';
+        if (!isBytes && !isSecret) {
+            throw new SecretKeyError('Invalid entropy: must be a valid byte array (32) or bigint', 'CONSTRUCTOR_ERROR');
+        }
+        // If bytes and bytes are not length 32
+        if (isBytes && entropy.length === 32) {
+            this._bytes = entropy;
+            this._seed = SecretKey.toSecret(entropy);
+        }
+        // If secret and secret is not a valid bigint, throw error
+        if (isSecret && !(entropy < 1n || entropy >= CURVE.n)) {
+            this._bytes = SecretKey.toBytes(entropy);
+            this._seed = entropy;
+        }
+        if (!this._bytes || this._bytes.length !== 32) {
+            throw new SecretKeyError('Invalid bytes: must be a valid 32-byte secret key', 'CONSTRUCTOR_ERROR');
+        }
+        if (!this._seed || (this._seed < 1n || this._seed >= CURVE.n)) {
+            throw new SecretKeyError('Invalid seed: must must be valid bigint', 'CONSTRUCTOR_ERROR');
+        }
+        // Set the secret key multibase
+        this._multibase = this.encode();
+    }
+    /**
+     * Get the secret key entropy as a byte array.
+     * @returns {KeyBytes} The secret key bytes as a Uint8Array
+     */
+    get bytes() {
+        // Return a copy of the secret key bytes
+        const bytes = new Uint8Array(this._bytes);
+        return bytes;
+    }
+    /**
+     * Get the secret key entropy as a bigint.
+     * @returns {bigint} The secret key as a bigint
+     */
+    get seed() {
+        // Memoize the secret and return
+        const seed = BigInt(this._seed);
+        return seed;
+    }
+    /**
+     * Returns the raw secret key as a hex string.
+     * @returns {Hex} The secret key as a hex string
+     */
+    get hex() {
+        // Convert the raw secret key bytes to a hex string
+        return Buffer.from(this.bytes).toString('hex');
+    }
+    /**
+     * Encode the secret key bytes as a secretKeyMultibase string.
+     * @returns {string} The secret key in base58btc multibase format
+     */
+    get multibase() {
+        const multibase = this._multibase;
+        return multibase;
+    }
+    /**
+     * Encodes the secret key bytes to BIP340 multibase format.
+     * @returns {string} The secret key in BIP340 multibase format.
+     */
+    encode() {
+        // Convert Uint8Array bytes to an Array
+        const secretKeyBytes = this.bytes.toArray();
+        if (secretKeyBytes.length !== 32) {
+            throw new SecretKeyError('Invalid secret key: must be a valid 32-byte secret key', 'ENCODE_MULTIBASE_ERROR');
+        }
+        // Convert prefix to an array
+        const mbaseBytes = BIP340_SECRET_KEY_MULTIBASE_PREFIX.toArray();
+        // Push the secret key bytes at the end of the prefix
+        mbaseBytes.push(...secretKeyBytes);
+        // Encode the bytes in base58btc format and return
+        return base58btc.encode(mbaseBytes.toUint8Array());
+    }
+    /**
+     * Checks if this secret key is equal to another.
+     * @param {SecretKey} other The other secret key
+     * @returns {boolean} True if the private keys are equal, false otherwise
+     */
+    equals(other) {
+        // Compare the hex strings of the private keys
+        return this.hex === other.hex;
+    }
+    /**
+     * Computes the public key from the secret key bytes.
+     * @returns {KeyBytes} The computed public key
+     */
+    computePublicKey() {
+        // Derive the public key from the secret key
+        const publicKeyBytes = tinysecp.pointFromScalar(this.bytes, true);
+        // If no public key, throw error
+        if (!publicKeyBytes) {
+            throw new SecretKeyError('Invalid compute: failed to derive public key', 'COMPUTE_PUBLIC_KEY_ERROR');
+        }
+        // If public key is not compressed, throw error
+        if (publicKeyBytes.length !== 33) {
+            throw new SecretKeyError('Invalid compute: public key not compressed format', 'COMPUTE_PUBLIC_KEY_ERROR');
+        }
+        return publicKeyBytes;
+    }
+    /**
+     * Converts the secret key to a JSON object.
+     * @returns {SecretKeyObject} The secret key as a JSON object
+     */
+    json() {
+        return {
+            bytes: this.bytes.toArray(),
+            seed: this.seed.toString(),
+            hex: this.hex,
+        };
+    }
+    /**
+     * Checks if the secret key is valid.
+     * @returns {boolean} True if the secret key is valid, false otherwise
+     */
+    isValid() {
+        return tinysecp.isPrivate(this.bytes);
+    }
+    /**
+     * Checks if the public key is a valid secp256k1 point.
+     * @param {PublicKey} pk The public key to validate
+     * @returns {boolean} True if the public key is valid, false otherwise
+     */
+    isValidPair(pk) {
+        // If the public key is not valid, return false
+        if (!tinysecp.isPoint(pk.compressed)) {
+            return false;
+        }
+        // Else return true
+        return true;
+    }
+    /**
+     * Decodes the multibase string to the 34-byte secret key (2 byte prefix + 32 byte key).
+     * @param {string} multibase The multibase string to decode
+     * @returns {Bytes} The decoded secret key.
+     */
+    static decode(multibase) {
+        // Decode the public key multibase string
+        const decoded = base58btc.decode(multibase);
+        // If the public key bytes are not 35 bytes, throw an error
+        if (decoded.length !== 34) {
+            throw new SecretKeyError('Invalid argument: must be 34 byte secretKeyMultibase', 'DECODE_MULTIBASE_ERROR');
+        }
+        // Grab the prefix bytes
+        const prefix = decoded.slice(0, 2);
+        // Compute the prefix hash
+        const prefixHash = Buffer.from(sha256(prefix)).toString('hex');
+        // If the prefix hash does not equal the BIP340 prefix hash, throw an error
+        if (prefixHash !== BIP340_SECRET_KEY_MULTIBASE_PREFIX_HASH) {
+            throw new SecretKeyError(`Invalid prefix: malformed multibase prefix ${prefix}`, 'DECODE_MULTIBASE_ERROR');
+        }
+        // Return the decoded key bytes
+        return decoded;
+    }
+    /**
+     * Creates a SecretKey object from a JSON object.
+     * @param {SecretKeyObject} json The JSON object containing the secret key bytes
+     * @returns {SecretKey} A new SecretKey object
+     */
+    static fromJSON(json) {
+        return new SecretKey(new Uint8Array(json.bytes));
+    }
+    /**
+     * Converts a SecretKey or KeyBytes to a Pair.
+     * @param {KeyBytes} bytes
+     * @returns {SchnorrKeyPair} The SchnorrKeyPair object containing the public and private keys
+     * @throws {SecretKeyError} If the secret key is not valid
+     */
+    static toKeyPair(bytes) {
+        // Create a new SecretKey from the bytes
+        const secretKey = new SecretKey(bytes);
+        // Compute the public key from the secret key
+        const publicKey = secretKey.computePublicKey();
+        // Create a new Pair from the public key and secret key
+        return new SchnorrKeyPair({ publicKey, secretKey });
+    }
+    /**
+     * Convert a bigint secret to secret key bytes.
+     * @param {KeyBytes} bytes The secret key bytes
+     * @returns {bigint} The secret key bytes as a bigint secret
+     */
+    static toSecret(bytes) {
+        return bytes.reduce((acc, byte) => (acc << 8n) | BigInt(byte), 0n);
+    }
+    /**
+     * Convert a secret key bytes to a bigint secret.
+     * @param {bigint} secret The secret key secret.
+     * @returns {KeyBytes} The secret key secret as secret key bytes.
+     */
+    static toBytes(secret) {
+        // Ensure it’s a valid 32-byte value in [1, n-1] and convert bigint to Uint8Array
+        const bytes = Uint8Array.from({ length: 32 }, (_, i) => Number(secret >> BigInt(8 * (31 - i)) & BigInt(0xff)));
+        // If bytes are not a valid secp256k1 secret key, throw error
+        if (!tinysecp.isPrivate(bytes)) {
+            throw new SecretKeyError('Invalid secret key: secret out of valid range', 'SET_PRIVATE_KEY_ERROR');
+        }
+        return new Uint8Array(bytes);
+    }
+    /**
+     * Creates a new SecretKey object from a bigint secret.
+     * @param {bigint} secret The secret bigint
+     * @returns {SecretKey} A new SecretKey object
+     */
+    static fromSecret(secret) {
+        // Convert the secret bigint to a hex string
+        const hexsecret = secret.toString(16).padStart(64, '0');
+        // Convert the hex string to a Uint8Array
+        const privateKeyBytes = new Uint8Array(hexsecret.match(/.{2}/g).map(byte => parseInt(byte, 16)));
+        // Return a new SecretKey object
+        return new SecretKey(privateKeyBytes);
+    }
+    /**
+     * Generates random secret key bytes.
+     * @returns {KeyBytes} Uint8Array of 32 random bytes.
+     */
+    static random() {
+        // Generate empty 32-byte array
+        const byteArray = new Uint8Array(32);
+        // Use the getRandomValues function to fill the byteArray with random values
+        return getRandomValues(byteArray);
+    }
+    /**
+     * Creates a new SecretKey from random secret key bytes.
+     * @returns {SecretKey} A new SecretKey object
+     */
+    static generate() {
+        // Generate empty 32-byte array
+        const randomBytes = this.random();
+        // Use the getRandomValues function to fill the byteArray with random values
+        return new SecretKey(randomBytes);
+    }
+    /**
+     * Generates a public key from the given secret key bytes.
+     * @param {KeyBytes} bytes The secret key bytes
+     * @returns {KeyBytes} The computed public key bytes
+     */
+    static getPublicKey(bytes) {
+        // Create a new SecretKey from the bytes and compute the public key
+        return new SecretKey(bytes).computePublicKey();
+    }
+}
+//# sourceMappingURL=secret.js.map

package/dist/esm/secret.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret.js","sourceRoot":"","sources":["../../src/secret.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kCAAkC,EAClC,uCAAuC,EAEvC,KAAK,EAIL,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAuD3C;;;;;;;GAOG;AACH,MAAM,OAAO,SAAS;IACpB,sEAAsE;IAC9D,MAAM,CAAY;IAE1B,gEAAgE;IACxD,KAAK,CAAU;IAEvB,4DAA4D;IACpD,UAAU,CAAS;IAE3B;;;;OAIG;IACH,YAAY,OAAgB;QAC1B,4DAA4D;QAC5D,MAAM,OAAO,GAAG,OAAO,YAAY,UAAU,CAAC;QAC9C,MAAM,QAAQ,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC;QAC7C,IAAG,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzB,MAAM,IAAI,cAAc,CACtB,4DAA4D,EAC5D,mBAAmB,CACpB,CAAC;QACJ,CAAC;QAED,uCAAuC;QACvC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;YACtB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC;QAED,0DAA0D;QAC1D,IAAI,QAAQ,IAAI,CAAC,CAAC,OAAO,GAAG,EAAE,IAAI,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QACvB,CAAC;QAED,IAAG,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC7C,MAAM,IAAI,cAAc,CACtB,mDAAmD,EACnD,mBAAmB,CACpB,CAAC;QACJ,CAAC;QAED,IAAG,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,MAAM,IAAI,cAAc,CACtB,yCAAyC,EACzC,mBAAmB,CACpB,CAAC;QACJ,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,wCAAwC;QACxC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAO,CAAC,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,gCAAgC;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAM,CAAW,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI,GAAG;QACL,mDAAmD;QACnD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAGD;;;OAGG;IACH,IAAI,SAAS;QACX,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,uCAAuC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QAE5C,IAAG,cAAc,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,cAAc,CACtB,wDAAwD,EACxD,wBAAwB,CACzB,CAAC;QACJ,CAAC;QACD,6BAA6B;QAC7B,MAAM,UAAU,GAAG,kCAAkC,CAAC,OAAO,EAAE,CAAC;QAEhE,qDAAqD;QACrD,UAAU,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAEnC,kDAAkD;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAgB;QAC5B,8CAA8C;QAC9C,OAAO,IAAI,CAAC,GAAG,KAAK,KAAK,CAAC,GAAG,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,gBAAgB;QACrB,4CAA4C;QAC5C,MAAM,cAAc,GAAG,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAElE,gCAAgC;QAChC,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,cAAc,CACtB,8CAA8C,EAC9C,0BAA0B,CAC3B,CAAC;QACJ,CAAC;QAED,+CAA+C;QAC/C,IAAG,cAAc,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,cAAc,CACtB,mDAAmD,EACnD,0BAA0B,CAC3B,CAAC;QACJ,CAAC;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,IAAI;QACT,OAAO;YACL,KAAK,EAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YAC5B,IAAI,EAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC5B,GAAG,EAAK,IAAI,CAAC,GAAG;SACjB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,OAAO,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,EAAa;QAC9B,+CAA+C;QAC/C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;YACrC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mBAAmB;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,SAAiB;QACpC,yCAAyC;QACzC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAE5C,2DAA2D;QAC3D,IAAG,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,cAAc,CACtB,sDAAsD,EACtD,wBAAwB,CACzB,CAAC;QACJ,CAAC;QAED,wBAAwB;QACxB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAEnC,0BAA0B;QAC1B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE/D,2EAA2E;QAC3E,IAAI,UAAU,KAAK,uCAAuC,EAAE,CAAC;YAC3D,MAAM,IAAI,cAAc,CACtB,8CAA8C,MAAM,EAAE,EACtD,wBAAwB,CACzB,CAAC;QACJ,CAAC;QAED,+BAA+B;QAC/B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAqB;QAC1C,OAAO,IAAI,SAAS,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,KAAe;QACrC,wCAAwC;QACxC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;QAEvC,6CAA6C;QAC7C,MAAM,SAAS,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAE/C,uDAAuD;QACvD,OAAO,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAe;QACpC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,MAAc;QAClC,iFAAiF;QACjF,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAC3B,EAAE,MAAM,EAAE,EAAE,EAAE,EACd,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAChE,CAAC;QAEF,6DAA6D;QAC7D,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,cAAc,CACtB,+CAA+C,EAC/C,uBAAuB,CACxB,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAc;QACrC,4CAA4C;QAC5C,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACxD,yCAAyC;QACzC,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAClG,gCAAgC;QAChC,OAAO,IAAI,SAAS,CAAC,eAAe,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM;QAClB,+BAA+B;QAC/B,MAAM,SAAS,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;QAErC,4EAA4E;QAC5E,OAAO,eAAe,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAGD;;;OAGG;IACI,MAAM,CAAC,QAAQ;QACpB,+BAA+B;QAC/B,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAElC,4EAA4E;QAC5E,OAAO,IAAI,SAAS,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,KAAe;QACxC,mEAAmE;QACnE,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE,CAAC;IACjD,CAAC;CACF"}

package/dist/types/index.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC"}

package/dist/types/pair.d.ts

@@ -0,0 +1,126 @@
+import { Hex, KeyBytes, SchnorrKeyPairObject } from '@did-btcr2/common';
+import { PublicKey } from './public.js';
+import { SecretKey } from './secret.js';
+/**
+ * Interface for KeyPair class.
+ * @interface KeyPair
+ * @type {KeyPair}
+ */
+export interface KeyPair {
+    /**
+     * @type {PublicKey} The PublicKey associated with the SchnorrKeyPair (required).
+     */
+    readonly publicKey: PublicKey;
+    /**
+     * @type {SecretKey} The SecretKey associated with the SchnorrKeyPair (optional).
+     * @throws {KeyPairError} If the secret key is not available.
+     */
+    readonly secretKey?: SecretKey;
+    /**
+     * JSON representation of the SchnorrKeyPair object.
+     * @returns {SchnorrKeyPairObject} The SchnorrKeyPair as a JSON object.
+     */
+    json(): SchnorrKeyPairObject;
+}
+type RawKeyPair = {
+    public: KeyBytes;
+    secret?: KeyBytes;
+};
+/** Params for the {@link SchnorrKeyPair} constructor */
+interface KeyParams {
+    secretKey?: SecretKey | KeyBytes;
+    publicKey?: PublicKey | KeyBytes;
+}
+interface MultibaseKeys {
+    publicKeyMultibase: string;
+    secretKeyMultibase: string;
+}
+/**
+ * Encapsulates a PublicKey and a SecretKey object as a single Keys object.
+ * @class SchnorrKeyPair
+ * @type {SchnorrKeyPair}
+ */
+export declare class SchnorrKeyPair implements KeyPair {
+    /** @type {SecretKey} The secret key object */
+    private _secretKey?;
+    private _publicKey;
+    /** @type {string} The public key in multibase format */
+    private _publicKeyMultibase;
+    /** @type {string} The secret key in multibase format */
+    private _secretKeyMultibase;
+    /**
+     * Creates an instance of Keys. Must provide a at least a secret key.
+     * Can optionally provide both a private and public key, but must be a valid pair.
+     * @param {SecretKey} secretKey The secret key object
+     */
+    constructor({ secretKey, publicKey }?: KeyParams);
+    /**
+     * Get the SecretKey.
+     * @returns {SecretKey} The SecretKey object
+     * @throws {KeyPairError} If the secret key is not available
+     */
+    get secretKey(): SecretKey;
+    /**
+     * Set the PublicKey.
+     * @param {PublicKey} publicKey The PublicKey object
+     * @throws {KeyPairError} If the public key is not a valid pair with the secret key.
+     */
+    set publicKey(publicKey: PublicKey);
+    /**
+     * Get the PublicKey.
+     * @returns {PublicKey} The PublicKey object
+     */
+    get publicKey(): PublicKey;
+    /**
+     * Get the Keys as a raw key pair.
+     * @returns {RawKeyPair} The Keys as a raw key pair
+     */
+    get raw(): RawKeyPair;
+    /**
+     * Get the Keys in multibase format.
+     * @returns {MultibaseKeys} The SecretKey in multibase format
+     */
+    get multibase(): MultibaseKeys;
+    /**
+     * JSON representation of a Keys.
+     * @returns {SchnorrKeyPairObject} The Keys as a JSON object
+     */
+    json(): SchnorrKeyPairObject;
+    /**
+     * Static method creates a new Keys from a JSON object.
+     * @param {SchnorrKeyPairObject} keys The JSON object to initialize the Keys.
+     * @returns {SchnorrKeyPair} The initialized Keys object.
+     */
+    static fromJSON(keys: SchnorrKeyPairObject): SchnorrKeyPair;
+    /**
+     * Static method creates a new SchnorrKeyPair from a SecretKey object or secret key bytes.
+     * @param {SecretKey | KeyBytes} data The secret key bytes
+     * @returns {SchnorrKeyPair} A new SchnorrKeyPair object
+     */
+    static fromPrivateKey(data: SecretKey | KeyBytes): SchnorrKeyPair;
+    /**
+     * Static method creates a new Keys (SecretKey/PublicKey) bigint secret.
+     * @param {bigint} secret The secret key secret
+     * @returns {Keys} A new Keys object
+     */
+    static fromSecret(secret: bigint): SchnorrKeyPair;
+    /**
+     * Converts key bytes to a hex string.
+     * @param {KeyBytes} keyBytes The key bytes (private or public).
+     * @returns {Hex} The key bytes as a hex string.
+     */
+    static toHex(keyBytes: KeyBytes): Hex;
+    /**
+     * Compares two Keys objects for equality.
+     * @param {SchnorrKeyPair} keys The main keys.
+     * @param {SchnorrKeyPair} otherKeys The other keys to compare.
+     * @returns {boolean} True if the public key and secret key are equal, false otherwise.
+     */
+    static equals(keys: SchnorrKeyPair, otherKeys: SchnorrKeyPair): boolean;
+    /**
+     * Static method to generate a new random SchnorrKeyPair instance.
+     * @returns {SchnorrKeyPair} A new SecretKey object.
+     */
+    static generate(): SchnorrKeyPair;
+}
+export {};

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

@@ -0,0 +1 @@
+{"version":3,"file":"pair.d.ts","sourceRoot":"","sources":["../../src/pair.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,QAAQ,EAER,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAE/B;;;OAGG;IACH,IAAI,IAAI,oBAAoB,CAAC;CAC9B;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,CAAC,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,wDAAwD;AACxD,UAAU,SAAS;IACjB,SAAS,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CAClC;AAED,UAAU,aAAa;IACrB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AACD;;;;GAIG;AACH,qBAAa,cAAe,YAAW,OAAO;IAC5C,8CAA8C;IAC9C,OAAO,CAAC,UAAU,CAAC,CAAY;IAG/B,OAAO,CAAC,UAAU,CAAY;IAE9B,wDAAwD;IACxD,OAAO,CAAC,mBAAmB,CAAS;IAEpC,wDAAwD;IACxD,OAAO,CAAC,mBAAmB,CAAS;IAEpC;;;;OAIG;gBACS,EAAE,SAAS,EAAE,SAAS,EAAE,GAAE,SAAc;IA0BpD;;;;OAIG;IACH,IAAI,SAAS,IAAI,SAAS,CAYzB;IAED;;;;OAIG;IACH,IAAI,SAAS,CAAC,SAAS,EAAE,SAAS,EAQjC;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,CAGzB;IAED;;;OAGG;IACH,IAAI,GAAG,IAAI,UAAU,CAKpB;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,aAAa,CAK7B;IAED;;;OAGG;IACI,IAAI,IAAI,oBAAoB;IAOnC;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,oBAAoB,GAAG,cAAc;IAMlE;;;;OAIG;WACW,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,QAAQ,GAAG,cAAc;IAoBxE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc;IAMxD;;;;OAIG;WACW,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,GAAG;IAI5C;;;;;OAKG;WACW,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO;IAqB9E;;;OAGG;WACW,QAAQ,IAAI,cAAc;CAazC"}

package/dist/types/public.d.ts

@@ -0,0 +1,197 @@
+import { Hex, KeyBytes, Maybe, MultibaseObject, PublicKeyObject } from '@did-btcr2/common';
+import { SecretKey } from './secret.js';
+export interface Point {
+    x: KeyBytes;
+    y: KeyBytes;
+}
+/**
+ * Interface for the PublicKey class.
+ * @interface IPublicKey
+ * @type {IPublicKey}
+ */
+export interface IPublicKey {
+    /**
+     * 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].
+     */
+    compressed: KeyBytes;
+    /**
+     * PublicKey parity getter.
+     * @readonly @type {number} The 1 byte parity (0x02 if even, 0x03 if odd).
+     */
+    parity: number;
+    /**
+     * PublicKey x-coordinate getter.
+     * @readonly @type {KeyBytes} The 32 byte x-coordinate of the public key.
+     */
+    x: KeyBytes;
+    /**
+     * PublicKey y-coordinate getter.
+     * @readonly @type {KeyBytes} The 32 byte y-coordinate of the public key.
+     */
+    y: KeyBytes;
+    /**
+     * PublicKey multibase getter.
+     * @readonly @returns {MultibaseObject} The public key as MultibaseObject as a address string, key and prefix bytes.
+     */
+    multibase: MultibaseObject;
+    /**
+     * PublicKey hex string getter.
+     * @readonly @type {Hex} The public key as a hex string.
+     */
+    hex: Hex;
+    /**
+     * 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.
+     * @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.
+     * @returns {boolean} True if the public keys are equal.
+     */
+    equals(other: PublicKey): boolean;
+    /**
+     * JSON representation of a PublicKey object.
+     * @returns {PublicKeyObject} The PublicKey as a JSON object.
+     */
+    json(): PublicKeyObject;
+}
+/**
+ * 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}
+ */
+export declare class PublicKey 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.
+     * @param {KeyBytes} bytes The public key byte array.
+     * @throws {PublicKeyError} if the byte length is not 32 (x-only) or 33 (compressed)
+     */
+    constructor(bytes: KeyBytes);
+    /**
+     * Get the compressed public key.
+     * @returns {KeyBytes} The 33-byte compressed public key (0x02 or 0x03, x).
+     */
+    get compressed(): KeyBytes;
+    /**
+     * Get the uncompressed public key.
+     * @returns {Uint8Array} The 65-byte uncompressed public key (0x04, x, y).
+     */
+    get uncompressed(): KeyBytes;
+    /**
+     * Get the parity byte of the public key.
+     * @returns {number} The parity byte of the public key.
+     */
+    get parity(): number;
+    /**
+     * Get the x-coordinate of the public key.
+     * @returns {Uint8Array} The 32-byte x-coordinate of the public key.
+     */
+    get x(): KeyBytes;
+    /**
+     * Get the y-coordinate of the public key.
+     * @returns {Uint8Array} The 32-byte y-coordinate of the public key.
+     */
+    get y(): KeyBytes;
+    /**
+     * Get the multibase public key.
+     * @returns {MultibaseObject} An object containing the multibase bytes, address and prefix.
+     */
+    get multibase(): MultibaseObject;
+    /**
+     * Returns the raw public key as a hex string.
+     * @returns {Hex} The public key as a hex string.
+     */
+    get hex(): Hex;
+    /**
+     * Return the public key point.
+     * @returns {Point} The public key point.
+     */
+    get point(): Point;
+    /**
+     * 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
+     */
+    decode(): KeyBytes;
+    /**
+     * Encodes compressed secp256k1 public key from bytes to BIP340 multibase format.
+     * @returns {string} The public key encoded in base-58-btc multibase format.
+     */
+    encode(): string;
+    /**
+     * Compares this public key to another public key.
+     * @param {PublicKey} other The other public key to compare
+     * @returns {boolean} True if the public keys are equal, false otherwise.
+     */
+    equals(other: PublicKey): boolean;
+    /**
+     * JSON representation of a PublicKey object.
+     * @returns {PublicKeyObject} The PublicKey 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.
+     */
+    static fromJSON(json: Maybe<PublicKeyObject>): PublicKey;
+    /**
+     * 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
+     */
+    static fromSecretKey(sk: SecretKey | KeyBytes): PublicKey;
+    /**
+     * Computes modular exponentiation: (base^exp) % mod.
+     * Used for computing modular square roots.
+     * @param {bigint} base The base value
+     * @param {bigint} exp The exponent value
+     * @param {bigint} mod The modulus value
+     * @returns {bigint} The result of the modular exponentiation
+     */
+    modPow(base: bigint, exp: bigint, mod: bigint): bigint;
+    /**
+     * Computes `sqrt(a) mod p` using Tonelli-Shanks algorithm.
+     * This finds `y` such that `y^2 ≡ a mod p`.
+     * @param {bigint} a The value to find the square root of
+     * @param {bigint} p The prime modulus
+     * @returns {bigint} The square root of `a` mod `p`
+     */
+    sqrtMod(a: bigint, p: bigint): bigint;
+    /**
+     * Lifts a 32-byte x-only coordinate into a full secp256k1 point (x, y).
+     * @param xBytes 32-byte x-coordinate
+     * @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

@@ -0,0 +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"}