@did-btcr2/keypair 0.5.1

package/dist/esm/pair.js

@@ -0,0 +1,203 @@
+import { KeyPairError } from '@did-btcr2/common';
+import { PublicKey } from './public.js';
+import { SecretKey } from './secret.js';
+/**
+ * Encapsulates a PublicKey and a SecretKey object as a single Keys object.
+ * @class SchnorrKeyPair
+ * @type {SchnorrKeyPair}
+ */
+export class SchnorrKeyPair {
+    /** @type {SecretKey} The secret key object */
+    _secretKey;
+    /** @type {PublicKey} The public key object */ ;
+    _publicKey;
+    /** @type {string} The public key in multibase format */
+    _publicKeyMultibase;
+    /** @type {string} The secret key in multibase format */
+    _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 } = {}) {
+        // If no secret key or public key, throw an error
+        if (!publicKey && !secretKey) {
+            throw new KeyPairError('Argument missing: must at least provide a publicKey', 'CONSTRUCTOR_ERROR');
+        }
+        // Set the secret key
+        if (secretKey instanceof Uint8Array) {
+            this._secretKey = new SecretKey(secretKey);
+        }
+        else if (secretKey instanceof SecretKey) {
+            this._secretKey = secretKey;
+        }
+        // Set the public key
+        if (publicKey instanceof PublicKey) {
+            this._publicKey = publicKey;
+        }
+        else if (publicKey instanceof Uint8Array) {
+            this._publicKey = new PublicKey(publicKey);
+        }
+        else {
+            this._publicKey = new PublicKey(this._secretKey.computePublicKey());
+        }
+        this._publicKeyMultibase = this._publicKey.multibase.address;
+        this._secretKeyMultibase = this._secretKey ? this._secretKey.multibase : '';
+    }
+    /**
+     * Get the SecretKey.
+     * @returns {SecretKey} The SecretKey object
+     * @throws {KeyPairError} If the secret key is not available
+     */
+    get secretKey() {
+        // If the secret key is not available, throw an error
+        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()) {
+            throw new KeyPairError('Secret key is not valid', 'SECRET_KEY_ERROR');
+        }
+        // Return a copy of the secret key
+        const secretKey = this._secretKey;
+        return 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) {
+        // If the public key is not a valid pair with the secret key, throw an error
+        if (this.secretKey && !this.secretKey.isValidPair(publicKey)) {
+            throw new KeyPairError('Public key is not a valid pair with the secret key', 'PUBLIC_KEY_ERROR');
+        }
+        this._publicKey = publicKey;
+        this._publicKeyMultibase = publicKey.multibase.address;
+        this._secretKeyMultibase = this._secretKey ? this._secretKey.multibase : '';
+    }
+    /**
+     * Get the PublicKey.
+     * @returns {PublicKey} The PublicKey object
+     */
+    get publicKey() {
+        const publicKey = this._publicKey;
+        return publicKey;
+    }
+    /**
+     * Get the Keys as a raw key pair.
+     * @returns {RawKeyPair} The Keys as a raw key pair
+     */
+    get raw() {
+        return {
+            public: this.publicKey.x,
+            secret: this.secretKey ? this.secretKey.bytes : undefined
+        };
+    }
+    /**
+     * Get the Keys in multibase format.
+     * @returns {MultibaseKeys} The SecretKey in multibase format
+     */
+    get multibase() {
+        return {
+            publicKeyMultibase: this._publicKeyMultibase,
+            secretKeyMultibase: this._secretKeyMultibase,
+        };
+    }
+    /**
+     * JSON representation of a Keys.
+     * @returns {SchnorrKeyPairObject} The Keys as a JSON object
+     */
+    json() {
+        return {
+            secretKey: this.secretKey.json(),
+            publicKey: this.publicKey.json()
+        };
+    }
+    /**
+     * 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) {
+        const secretKey = SecretKey.fromJSON(keys.secretKey);
+        const publicKey = PublicKey.fromJSON(keys.publicKey);
+        return new SchnorrKeyPair({ secretKey, publicKey });
+    }
+    /**
+     * 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) {
+        // If the secret key is a SecretKey object, get the raw bytes else use the bytes
+        const bytes = data instanceof SecretKey ? 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');
+        }
+        // If pk Uint8Array, construct SecretKey object else use the object
+        const secretKey = data instanceof Uint8Array ? new SecretKey(data) : data;
+        // Compute the public key from the secret key
+        const publicKey = secretKey.computePublicKey();
+        // Return a new Keys object
+        return new SchnorrKeyPair({ secretKey, publicKey });
+    }
+    /**
+     * 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) {
+        const secretKey = SecretKey.fromSecret(secret);
+        const publicKey = secretKey.computePublicKey();
+        return new SchnorrKeyPair({ secretKey, publicKey });
+    }
+    /**
+     * 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) {
+        return Buffer.from(keyBytes).toString('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, otherKeys) {
+        // Deconstruct the public keys from the key pairs
+        const pk = keys.publicKey;
+        const otherPk = otherKeys.publicKey;
+        // If publicKeys present, use to compare as hex strings.
+        if (pk && otherPk) {
+            return pk.hex === otherPk.hex;
+        }
+        // Deconstruct the private keys from the key pairs
+        const sk = keys.secretKey;
+        const otherSk = otherKeys.secretKey;
+        if (sk && otherSk) {
+            // Get the public key hex strings for both key pair publicKeys
+            return sk.hex === otherSk.hex;
+        }
+        throw new KeyPairError('Cannot compare invalid key pair(s)', 'KEYPAIR_EQUALS_ERROR');
+    }
+    /**
+     * Static method to generate a new random SchnorrKeyPair instance.
+     * @returns {SchnorrKeyPair} A new SecretKey object.
+     */
+    static generate() {
+        // Generate random secret key bytes
+        const skBytes = SecretKey.random();
+        // Construct a new SecretKey object
+        const secretKey = new SecretKey(skBytes);
+        // Compute the public key from the secret key
+        const publicKey = secretKey.computePublicKey();
+        // Return a new Keys object
+        return new SchnorrKeyPair({ secretKey, publicKey });
+    }
+}
+//# sourceMappingURL=pair.js.map

package/dist/esm/pair.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pair.js","sourceRoot":"","sources":["../../src/pair.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAEb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAyCxC;;;;GAIG;AACH,MAAM,OAAO,cAAc;IACzB,8CAA8C;IACtC,UAAU,CAAa;IAE/B,8CAA8C,CAAA,CAAC;IACvC,UAAU,CAAY;IAE9B,wDAAwD;IAChD,mBAAmB,CAAS;IAEpC,wDAAwD;IAChD,mBAAmB,CAAS;IAEpC;;;;OAIG;IACH,YAAY,EAAE,SAAS,EAAE,SAAS,KAAgB,EAAE;QAClD,iDAAiD;QACjD,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,YAAY,CAAC,qDAAqD,EAAE,mBAAmB,CAAC,CAAC;QACrG,CAAC;QAED,qBAAqB;QACrB,IAAG,SAAS,YAAY,UAAU,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;aAAM,IAAI,SAAS,YAAY,SAAS,EAAE,CAAC;YAC1C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC9B,CAAC;QAED,qBAAqB;QACrB,IAAG,SAAS,YAAY,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC9B,CAAC;aAAM,IAAI,SAAS,YAAY,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,UAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC;QAC7D,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,qDAAqD;QACrD,IAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,IAAI,YAAY,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;QACzE,CAAC;QACD,iDAAiD;QACjD,IAAG,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9B,MAAM,IAAI,YAAY,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAAC;QACxE,CAAC;QACD,kCAAkC;QAClC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS,CAAC,SAAoB;QAChC,4EAA4E;QAC5E,IAAG,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,YAAY,CAAC,oDAAoD,EAAE,kBAAkB,CAAC,CAAC;QACnG,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC;QACvD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,IAAI,GAAG;QACL,OAAO;YACL,MAAM,EAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YACzB,MAAM,EAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC3D,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO;YACL,kBAAkB,EAAI,IAAI,CAAC,mBAAmB;YAC9C,kBAAkB,EAAG,IAAI,CAAC,mBAAmB;SAC9C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,IAAI;QACT,OAAO;YACL,SAAS,EAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;YACjC,SAAS,EAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAClC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,MAAM,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,OAAO,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,IAA0B;QAErD,gFAAgF;QAChF,MAAM,KAAK,GAAG,IAAI,YAAY,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAE5D,gDAAgD;QAChD,IAAG,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,YAAY,CAAC,yCAAyC,EAAE,wBAAwB,CAAC,CAAC;QAC9F,CAAC;QAED,mEAAmE;QACnE,MAAM,SAAS,GAAG,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE1E,6CAA6C;QAC7C,MAAM,SAAS,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAE/C,2BAA2B;QAC3B,OAAO,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAc;QACrC,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,QAAkB;QACpC,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,IAAoB,EAAE,SAAyB;QAClE,iDAAiD;QACjD,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1B,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC;QAEpC,wDAAwD;QACxD,IAAG,EAAE,IAAI,OAAO,EAAE,CAAC;YACjB,OAAO,EAAE,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC;QAChC,CAAC;QAED,kDAAkD;QAClD,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1B,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC;QACpC,IAAG,EAAE,IAAI,OAAO,EAAE,CAAC;YACjB,8DAA8D;YAC9D,OAAO,EAAE,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC;QAChC,CAAC;QAED,MAAM,IAAI,YAAY,CAAC,oCAAoC,EAAE,sBAAsB,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ;QACpB,mCAAmC;QACnC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QAEnC,mCAAmC;QACnC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;QAEzC,6CAA6C;QAC7C,MAAM,SAAS,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;QAE/C,2BAA2B;QAC3B,OAAO,IAAI,cAAc,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;CACF"}

package/dist/esm/public.js

@@ -0,0 +1,283 @@
+import { BIP340_PUBLIC_KEY_MULTIBASE_PREFIX, BIP340_PUBLIC_KEY_MULTIBASE_PREFIX_HASH, CURVE, PublicKeyError } from '@did-btcr2/common';
+import { sha256 } from '@noble/hashes/sha2';
+import { base58btc } from 'multiformats/bases/base58';
+import { SecretKey } from './secret.js';
+/**
+ * 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 class PublicKey {
+    /** @type {KeyBytes} The public key bytes */
+    _bytes;
+    /** @type {MultibaseObject} The public key as a MultibaseObject */
+    _multibase = {
+        prefix: BIP340_PUBLIC_KEY_MULTIBASE_PREFIX,
+        key: [],
+        address: ''
+    };
+    /**
+     * 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) {
+        // If the byte length is not 33, throw an error
+        if (bytes.length !== 33) {
+            throw new PublicKeyError('Invalid argument: byte length must be 33 (compressed)', 'CONSTRUCTOR_ERROR', { bytes });
+        }
+        // Set the bytes
+        this._bytes = bytes;
+        // Set multibase
+        this._multibase.address = this.encode();
+        this._multibase.key = [...this._multibase.prefix, ...this.compressed];
+    }
+    /**
+     * Get the compressed public key.
+     * @returns {KeyBytes} The 33-byte compressed public key (0x02 or 0x03, x).
+     */
+    get compressed() {
+        const bytes = new Uint8Array(this._bytes);
+        return bytes;
+    }
+    ;
+    /**
+     * Get the uncompressed public key.
+     * @returns {Uint8Array} The 65-byte uncompressed public key (0x04, x, y).
+     */
+    get uncompressed() {
+        const uncompressed = this.liftX();
+        return uncompressed;
+    }
+    /**
+     * Get the parity byte of the public key.
+     * @returns {number} The parity byte of the public key.
+     */
+    get parity() {
+        const parity = this.compressed[0];
+        return parity;
+    }
+    /**
+     * Get the x-coordinate of the public key.
+     * @returns {Uint8Array} The 32-byte x-coordinate of the public key.
+     */
+    get x() {
+        const x = this.compressed.slice(1, 33);
+        return x;
+    }
+    /**
+     * Get the y-coordinate of the public key.
+     * @returns {Uint8Array} The 32-byte y-coordinate of the public key.
+     */
+    get y() {
+        const y = this.uncompressed.slice(33, 65);
+        return y;
+    }
+    /**
+     * Get the multibase public key.
+     * @returns {MultibaseObject} An object containing the multibase bytes, address and prefix.
+     */
+    get multibase() {
+        const multibase = this._multibase;
+        return multibase;
+    }
+    /**
+     * Returns the raw public key as a hex string.
+     * @returns {Hex} The public key as a hex string.
+     */
+    get hex() {
+        const hex = Buffer.from(this.compressed).toString('hex');
+        return hex;
+    }
+    /**
+     * Return the public key point.
+     * @returns {Point} The public key point.
+     */
+    get point() {
+        return {
+            x: this.x,
+            y: this.y
+        };
+    }
+    /**
+     * 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) {
+        // If the public key is a hex string, convert it to a PublicKey object and return the point
+        if (typeof pk === 'string' && /^[0-9a-fA-F]+$/.test(pk)) {
+            const publicKey = new PublicKey(Buffer.fromHex(pk));
+            return publicKey.point;
+        }
+        // If the public key is a byte array or ArrayBuffer, convert it to a PublicKey object and return the point
+        if (pk instanceof Uint8Array || ArrayBuffer.isView(pk)) {
+            const publicKey = new PublicKey(pk);
+            return publicKey.point;
+        }
+        // If the public key is neither a hex string nor a byte array, throw an error
+        throw new PublicKeyError('Invalid publicKey: must be a hex string or byte array', 'POINT_ERROR', { publicKey: pk });
+    }
+    /**
+     * 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() {
+        // Decode the public key multibase string
+        const decoded = base58btc.decode(this.multibase.address);
+        // If the public key bytes are not 35 bytes, throw an error
+        if (decoded.length !== 35) {
+            throw new PublicKeyError('Invalid argument: must be 35 byte publicKeyMultibase', '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_PUBLIC_KEY_MULTIBASE_PREFIX_HASH) {
+            throw new PublicKeyError(`Invalid prefix: malformed multibase prefix ${prefix}`, 'DECODE_MULTIBASE_ERROR');
+        }
+        // Return the decoded public key bytes
+        return decoded;
+    }
+    /**
+     * Encodes compressed secp256k1 public key from bytes to BIP340 multibase format.
+     * @returns {string} The public key encoded in base-58-btc multibase format.
+     */
+    encode() {
+        // Convert public key bytes to an array
+        const pk = this.compressed.toArray();
+        // Ensure the public key is 33-byte secp256k1 compressed public key
+        if (pk.length !== 33) {
+            throw new PublicKeyError('Invalid argument: must be 33-byte (compressed) public key', 'ENCODE_MULTIBASE_ERROR');
+        }
+        // Convert prefix to an array
+        const publicKeyMultibase = BIP340_PUBLIC_KEY_MULTIBASE_PREFIX.toArray();
+        // Push the public key bytes at the end of the prefix
+        publicKeyMultibase.push(...pk);
+        // Encode the bytes in base58btc format and return
+        return base58btc.encode(publicKeyMultibase.toUint8Array());
+    }
+    /**
+     * 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) {
+        return this.hex === other.hex;
+    }
+    /**
+     * JSON representation of a PublicKey object.
+     * @returns {PublicKeyObject} The PublicKey as a JSON object.
+     */
+    json() {
+        return {
+            hex: this.hex,
+            multibase: this.multibase,
+            point: {
+                x: this.x.toArray(),
+                y: this.y.toArray(),
+                parity: this.parity,
+            },
+        };
+    }
+    /**
+     * 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) {
+        json.x.unshift(json.parity);
+        return new PublicKey(json.x.toUint8Array());
+    }
+    /**
+     * 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) {
+        // If the private key is a PrivateKey object, get the raw bytes else use the bytes
+        const bytes = sk instanceof SecretKey ? sk.bytes : sk;
+        // Throw error if the private key is not 32 bytes
+        if (bytes.length !== 32) {
+            throw new PublicKeyError('Invalid arg: must be 32 byte private key', 'FROM_PRIVATE_KEY_ERROR');
+        }
+        // Compute the public key from the private key
+        const privateKey = sk instanceof SecretKey ? sk : new SecretKey(sk);
+        // Return a new PublicKey object
+        return new PublicKey(privateKey.computePublicKey());
+    }
+    /**
+     * 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, exp, mod) {
+        let result = 1n;
+        while (exp > 0n) {
+            if (exp & 1n)
+                result = (result * base) % mod;
+            base = (base * base) % mod;
+            exp >>= 1n;
+        }
+        return result;
+    }
+    ;
+    /**
+     * 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, p) {
+        return this.modPow(a, (p + 1n) >> 2n, p);
+    }
+    ;
+    /**
+     * 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() {
+        // Ensure x-coordinate is 32 bytes
+        if (this.x.length !== 32) {
+            throw new PublicKeyError('Invalid argument: x-coordinate length must be 32 bytes', 'LIFT_X_ERROR');
+        }
+        // Convert x from Uint8Array → BigInt
+        const x = BigInt('0x' + Buffer.from(this.x).toString('hex'));
+        if (x <= 0n || x >= CURVE.p) {
+            throw new PublicKeyError('Invalid conversion: x out of range as BigInt', 'LIFT_X_ERROR');
+        }
+        // Compute y² = x³ + 7 mod p
+        const ySquared = BigInt((x ** 3n + CURVE.b) % CURVE.p);
+        // Compute y (do not enforce parity)
+        const y = this.sqrtMod(ySquared, CURVE.p);
+        // Convert x and y to Uint8Array
+        const yBytes = Buffer.fromHex(y.toString(16).padStart(64, '0'));
+        // Return 65-byte uncompressed public key: `0x04 || x || y`
+        return new Uint8Array(Buffer.concat([Buffer.from([0x04]), Buffer.from(this.x), yBytes]));
+    }
+    ;
+    /**
+     * 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) {
+        // Ensure x-coordinate is 32 bytes
+        if (x.length !== 32) {
+            throw new PublicKeyError('Invalid argument: x-coordinate length must be 32 bytes', 'LIFT_X_ERROR');
+        }
+        // Create a PublicKey instance and lift the x-coordinate
+        const publicKey = new PublicKey(x);
+        return publicKey.x;
+    }
+}
+//# sourceMappingURL=public.js.map

package/dist/esm/public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public.js","sourceRoot":"","sources":["../../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kCAAkC,EAClC,uCAAuC,EACvC,KAAK,EAKL,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAiFxC;;;;;;GAMG;AACH,MAAM,OAAO,SAAS;IACpB,4CAA4C;IAC3B,MAAM,CAAW;IAElC,kEAAkE;IAC1D,UAAU,GAAoB;QACpC,MAAM,EAAI,kCAAkC;QAC5C,GAAG,EAAO,EAAE;QACZ,OAAO,EAAG,EAAE;KACb,CAAC;IAEF;;;;OAIG;IACH,YAAY,KAAe;QACzB,+CAA+C;QAC/C,IAAG,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,cAAc,CACtB,uDAAuD,EACvD,mBAAmB,EAAE,EAAE,KAAK,EAAE,CAC/B,CAAC;QACJ,CAAC;QACD,gBAAgB;QAChB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEpB,gBAAgB;QAChB,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;IAAA,CAAC;IAEF;;;OAGG;IACH,IAAI,YAAY;QACd,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAClC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvC,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,IAAI,GAAG;QACL,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO;YACL,CAAC,EAAG,IAAI,CAAC,CAAC;YACV,CAAC,EAAG,IAAI,CAAC,CAAC;SACX,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,EAAO;QAClB,2FAA2F;QAC3F,IAAG,OAAO,EAAE,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YACvD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;YACpD,OAAO,SAAS,CAAC,KAAK,CAAC;QACzB,CAAC;QAED,0GAA0G;QAC1G,IAAG,EAAE,YAAY,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,EAAc,CAAC,CAAC;YAChD,OAAO,SAAS,CAAC,KAAK,CAAC;QACzB,CAAC;QAED,6EAA6E;QAC7E,MAAM,IAAI,cAAc,CACtB,uDAAuD,EACvD,aAAa,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CACjC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,yCAAyC;QACzC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAEzD,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,sCAAsC;QACtC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,uCAAuC;QACvC,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAErC,mEAAmE;QACnE,IAAI,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,cAAc,CACtB,2DAA2D,EAC3D,wBAAwB,CACzB,CAAC;QACJ,CAAC;QAED,6BAA6B;QAC7B,MAAM,kBAAkB,GAAG,kCAAkC,CAAC,OAAO,EAAE,CAAC;QAExE,qDAAqD;QACrD,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAE/B,kDAAkD;QAClD,OAAO,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAgB;QAC5B,OAAO,IAAI,CAAC,GAAG,KAAK,KAAK,CAAC,GAAG,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,IAAI;QACT,OAAO;YACL,GAAG,EAAS,IAAI,CAAC,GAAG;YACpB,SAAS,EAAG,IAAI,CAAC,SAAS;YAC1B,KAAK,EAAO;gBACV,CAAC,EAAQ,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACzB,CAAC,EAAQ,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACzB,MAAM,EAAG,IAAI,CAAC,MAAM;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,IAA4B;QACjD,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,EAAwB;QAClD,kFAAkF;QAClF,MAAM,KAAK,GAAG,EAAE,YAAY,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAEtD,iDAAiD;QACjD,IAAG,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,cAAc,CAAC,0CAA0C,EAAE,wBAAwB,CAAC,CAAC;QACjG,CAAC;QAED,8CAA8C;QAC9C,MAAM,UAAU,GAAG,EAAE,YAAY,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC;QAEpE,gCAAgC;QAChC,OAAO,IAAI,SAAS,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,IAAY,EAAE,GAAW,EAAE,GAAW;QAClD,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,OAAO,GAAG,GAAG,EAAE,EAAE,CAAC;YAChB,IAAI,GAAG,GAAG,EAAE;gBAAE,MAAM,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC;YAC7C,IAAI,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC;YAC3B,GAAG,KAAK,EAAE,CAAC;QACb,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAAA,CAAC;IAEF;;;;;;OAMG;IACI,OAAO,CAAC,CAAS,EAAE,CAAS;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACI,KAAK;QACV,kCAAkC;QAClC,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,cAAc,CAAC,wDAAwD,EAAE,cAAc,CAAC,CAAC;QACrG,CAAC;QAED,qCAAqC;QACrC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,cAAc,CAAC,8CAA8C,EAAE,cAAc,CAAC,CAAC;QAC3F,CAAC;QAED,4BAA4B;QAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEvD,oCAAoC;QACpC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAE1C,gCAAgC;QAChC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;QAEhE,2DAA2D;QAC3D,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3F,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,CAAW;QAC7B,kCAAkC;QAClC,IAAI,CAAC,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACpB,MAAM,IAAI,cAAc,CAAC,wDAAwD,EAAE,cAAc,CAAC,CAAC;QACrG,CAAC;QAED,wDAAwD;QACxD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;QACnC,OAAO,SAAS,CAAC,CAAC,CAAC;IACrB,CAAC;CACF"}