@exodus/bip322-js 2.2.0 → 3.0.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/bip322-js@2.2.0...@exodus/bip322-js@3.0.0) (2025-09-10)
+
+### ⚠ BREAKING CHANGES
+
+- drop sign() in favor of signAsync() (#13794)
+
+### Features
+
+- feat!: drop sign() in favor of signAsync() (#13794)
+
 ## [2.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/bip322-js@2.1.0...@exodus/bip322-js@2.2.0) (2025-09-09)
 
 ### Features

package/dist/Signer.d.ts

@@ -1,8 +1,21 @@
 import * as bitcoin from '@exodus/bitcoinjs';
 import type { Signer as AssetSigner } from '@exodus/asset-types/src/signer';
+export declare const createSigner: (encodedKey: string | Buffer, network: bitcoin.Network) => {
+    signer: {
+        getPublicKey: () => Promise<any>;
+        sign: ({ data, signatureType, enc, tweak, extraEntropy }: {
+            data: any;
+            signatureType: any;
+            enc: any;
+            tweak: any;
+            extraEntropy?: null | undefined;
+        }) => Promise<any>;
+    };
+    compressed: any;
+};
 declare class Signer {
-    static sign(privateKeyOrWIF: string | Buffer, address: string, message: string, network?: bitcoin.Network): any;
-    static signAsync(signer: string | Buffer | AssetSigner, address: string, message: string, network?: bitcoin.Network): Promise<any>;
+    #private;
+    static signAsync(signerOrKey: string | Buffer | AssetSigner, address: string, message: string, network?: bitcoin.Network): Promise<any>;
     private static checkPubKeyCorrespondToAddress;
 }
 export default Signer;

package/dist/Signer.js

@@ -2,60 +2,66 @@ import Address from './Address.js';
 import BIP322 from './BIP322.js';
 import * as bitcoin from '@exodus/bitcoinjs';
 import * as bitcoinMessage from '@exodus/bitcoinjs/message';
-import { tiny_secp256k1_compat as ecc } from '@exodus/crypto/secp256k1';
-import { ECPairFactory } from 'ecpair';
+import * as secp256k1 from '@exodus/crypto/secp256k1';
+import { hash } from '@exodus/crypto/hash';
 import assert from 'minimalistic-assert';
-const ECPair = ECPairFactory(ecc);
-const createAsyncSigner = ({ signer, publicKey, tweak }) => {
-    return {
-        publicKey,
-        getPublicKey: () => publicKey,
-        sign: async (data) => signer.sign({ signatureType: 'ecdsa', data, enc: 'sig' }),
-        signSchnorr: async (hash) => signer.sign({
-            signatureType: 'schnorr',
-            data: hash,
-            tweak,
-        }),
+import wif from 'wif';
+export const createSigner = (encodedKey, network) => {
+    let decoded;
+    if (typeof encodedKey === 'string') {
+        decoded = wif.decode(encodedKey);
+        const version = decoded.version;
+        if (version !== network.wif)
+            throw new Error('Invalid network version');
+    }
+    else {
+        decoded = { privateKey: encodedKey, compressed: true };
+    }
+    const { privateKey, compressed } = decoded;
+    const publicKey = secp256k1.privateKeyToPublicKey({ privateKey, compressed, format: 'buffer' });
+    const tweakPrivateKey = (tweak) => secp256k1.privateKeyTweakAdd({
+        privateKey: publicKey[0] === 3 ? secp256k1.privateKeyTweakNegate({ privateKey }) : privateKey,
+        tweak,
+    });
+    const signer = {
+        getPublicKey: async () => publicKey,
+        sign: async ({ data, signatureType, enc, tweak, extraEntropy = null }) => {
+            if (signatureType === 'schnorr') {
+                return secp256k1.schnorrSign({
+                    data,
+                    privateKey: tweak ? tweakPrivateKey(tweak) : privateKey,
+                    extraEntropy,
+                    format: 'buffer',
+                });
+            }
+            assert(signatureType === 'ecdsa');
+            assert(enc === 'sig' || enc === 'sig,rec');
+            return secp256k1.ecdsaSignHash({
+                hash: data,
+                privateKey,
+                extraEntropy,
+                recovery: enc !== 'sig',
+                format: 'buffer',
+            });
+        },
     };
+    return { signer, compressed };
 };
+const createAsyncSigner = ({ signer, publicKey, tweak }) => ({
+    publicKey,
+    getPublicKey: () => publicKey,
+    sign: async (data) => signer.sign({ signatureType: 'ecdsa', data, enc: 'sig' }),
+    signSchnorr: async (hash) => signer.sign({ signatureType: 'schnorr', data: hash, tweak }),
+});
 class Signer {
-    static sign(privateKeyOrWIF, address, message, network = bitcoin.networks.bitcoin) {
-        let signer = Buffer.isBuffer(privateKeyOrWIF)
-            ? ECPair.fromPrivateKey(privateKeyOrWIF)
-            : ECPair.fromWIF(privateKeyOrWIF, network);
-        if (!this.checkPubKeyCorrespondToAddress(signer.publicKey, address)) {
-            throw new Error(`Invalid private key provided for signing message for ${address}.`);
-        }
-        if (Address.isP2PKH(address)) {
-            return bitcoinMessage.signSync(message, signer.privateKey, signer.compressed);
-        }
-        const scriptPubKey = Address.convertAdressToScriptPubkey(address);
-        const toSpendTx = BIP322.buildToSpendTx(message, scriptPubKey);
-        let toSignTx;
-        if (Address.isP2SH(address)) {
-            const redeemScript = bitcoin.payments.p2wpkh({
-                hash: bitcoin.crypto.hash160(signer.publicKey),
-                network,
-            }).output;
-            toSignTx = BIP322.buildToSignTx(toSpendTx.getId(), redeemScript, true);
-        }
-        else if (Address.isP2WPKH(address)) {
-            toSignTx = BIP322.buildToSignTx(toSpendTx.getId(), scriptPubKey);
+    static async signAsync(signerOrKey, address, message, network = bitcoin.networks.bitcoin) {
+        if (typeof signerOrKey === 'string' || Buffer.isBuffer(signerOrKey)) {
+            const { signer, compressed } = createSigner(signerOrKey, network);
+            return this.#signAsyncInternal(signer, address, message, network, compressed);
         }
-        else {
-            const internalPublicKey = signer.publicKey.subarray(1, 33);
-            signer = signer.tweak(bitcoin.crypto.taggedHash('TapTweak', signer.publicKey.subarray(1, 33)));
-            toSignTx = BIP322.buildToSignTx(toSpendTx.getId(), scriptPubKey, false, internalPublicKey);
-        }
-        const toSignTxSigned = toSignTx
-            .signAllInputs(signer, [bitcoin.Transaction.SIGHASH_ALL, bitcoin.Transaction.SIGHASH_DEFAULT])
-            .finalizeAllInputs();
-        return BIP322.encodeWitness(toSignTxSigned);
+        return this.#signAsyncInternal(signerOrKey, address, message, network, true);
     }
-    static async signAsync(signer, address, message, network = bitcoin.networks.bitcoin) {
-        if (typeof signer === 'string' || Buffer.isBuffer(signer)) {
-            return this.sign(signer, address, message, network);
-        }
+    static async #signAsyncInternal(signer, address, message, network = bitcoin.networks.bitcoin, compressed) {
         const publicKey = await signer.getPublicKey();
         assert(this.checkPubKeyCorrespondToAddress(publicKey, address), `Invalid signer for address "${address}".`);
         if (Address.isP2PKH(address)) {
@@ -69,7 +75,7 @@ class Signer {
                     });
                 },
             };
-            return bitcoinMessage.signAsync(message, asyncSigner, true);
+            return bitcoinMessage.signAsync(message, asyncSigner, compressed);
         }
         const scriptPubKey = Address.convertAdressToScriptPubkey(address);
         const toSpendTx = BIP322.buildToSpendTx(message, scriptPubKey);
@@ -77,7 +83,7 @@ class Signer {
         let tweak;
         if (Address.isP2SH(address)) {
             const redeemScript = bitcoin.payments.p2wpkh({
-                hash: bitcoin.crypto.hash160(publicKey),
+                hash: await hash('hash160', publicKey, 'buffer'),
                 network,
             }).output;
             toSignTx = BIP322.buildToSignTx(toSpendTx.getId(), redeemScript, true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bip322-js",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "A Javascript library that provides utility functions related to the BIP-322 signature scheme",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -41,6 +41,7 @@
     "bech32": "^1.1.3",
     "bs58check": "^3.0.1",
     "buffer-equals": "^1.0.3",
+    "ecpair": "^2.0.1",
     "typedoc": "^0.24.8",
     "typescript": "^5.1.3",
     "varuint-bitcoin": "^1.0.1"
@@ -49,12 +50,12 @@
     "@exodus/asset-types": "^0.3.0",
     "@exodus/bitcoinjs": "^1.4.0",
     "@exodus/crypto": "^1.0.0-rc.14",
-    "ecpair": "^2.0.1",
-    "minimalistic-assert": "^1.0.1"
+    "minimalistic-assert": "^1.0.1",
+    "wif": "^4.0.0"
   },
   "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/libraries/bip322-js",
   "bugs": {
     "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Abip322-js"
   },
-  "gitHead": "90ec3f786bb430800fae41568e71ec2b67cd9009"
+  "gitHead": "91ee7841b5a4bf6b8762aa04ba621746b86fef87"
 }