@exodus/bip322-js 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/bip322-js@2.0.2...@exodus/bip322-js@2.1.0) (2025-04-01)
+
+### Features
+
+- feat: support async signing with external signer (#11913)
+
 ## [2.0.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/bip322-js@2.0.1...@exodus/bip322-js@2.0.2) (2025-01-07)
 
 **Note:** Version bump only for package @exodus/bip322-js

package/dist/Signer.d.ts

@@ -1,6 +1,8 @@
 import * as bitcoin from '@exodus/bitcoinjs';
+import type { Signer as AssetSigner } from '@exodus/asset-types/src/signer';
 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 checkPubKeyCorrespondToAddress;
 }
 export default Signer;

package/dist/Signer.js

@@ -2,6 +2,19 @@ import Address from './Address.js';
 import BIP322 from './BIP322.js';
 import * as bitcoin from '@exodus/bitcoinjs';
 import * as bitcoinMessage from '@exodus/bitcoinjs/message';
+import assert from 'minimalistic-assert';
+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,
+        }),
+    };
+};
 class Signer {
     static sign(privateKeyOrWIF, address, message, network = bitcoin.networks.bitcoin) {
         const ECPair = bitcoin.ECPair;
@@ -37,6 +50,51 @@ class Signer {
             .finalizeAllInputs();
         return BIP322.encodeWitness(toSignTxSigned);
     }
+    static async signAsync(signer, address, message, network = bitcoin.networks.bitcoin) {
+        if (typeof signer === 'string' || Buffer.isBuffer(signer)) {
+            return this.sign(signer, address, message, network);
+        }
+        const publicKey = await signer.getPublicKey();
+        assert(this.checkPubKeyCorrespondToAddress(publicKey, address), `Invalid signer for address "${address}".`);
+        if (Address.isP2PKH(address)) {
+            const asyncSigner = {
+                sign(hash, extraEntropy) {
+                    return signer.sign({
+                        signatureType: 'ecdsa',
+                        data: hash,
+                        extraEntropy,
+                        enc: 'sig,rec',
+                    });
+                },
+            };
+            return bitcoinMessage.signAsync(message, asyncSigner, true);
+        }
+        const scriptPubKey = Address.convertAdressToScriptPubkey(address);
+        const toSpendTx = BIP322.buildToSpendTx(message, scriptPubKey);
+        let toSignTx;
+        let tweak;
+        if (Address.isP2SH(address)) {
+            const redeemScript = bitcoin.payments.p2wpkh({
+                hash: bitcoin.crypto.hash160(publicKey),
+                network,
+            }).output;
+            toSignTx = BIP322.buildToSignTx(toSpendTx.getId(), redeemScript, true);
+        }
+        else if (Address.isP2WPKH(address)) {
+            toSignTx = BIP322.buildToSignTx(toSpendTx.getId(), scriptPubKey);
+        }
+        else {
+            const internalPublicKey = publicKey.subarray(1, 33);
+            tweak = bitcoin.crypto.taggedHash('TapTweak', publicKey.subarray(1, 33));
+            toSignTx = BIP322.buildToSignTx(toSpendTx.getId(), scriptPubKey, false, internalPublicKey);
+        }
+        const asyncSigner = createAsyncSigner({ signer, publicKey, tweak });
+        await toSignTx.signAllInputsAsync(asyncSigner, [
+            bitcoin.Transaction.SIGHASH_ALL,
+            bitcoin.Transaction.SIGHASH_DEFAULT,
+        ]);
+        return BIP322.encodeWitness(toSignTx.finalizeAllInputs());
+    }
     static checkPubKeyCorrespondToAddress(publicKey, claimedAddress) {
         let derivedAddresses;
         if (Address.isP2PKH(claimedAddress)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bip322-js",
-  "version": "2.0.2",
+  "version": "2.1.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",
@@ -37,18 +37,21 @@
   "devDependencies": {
     "@exodus/bitcoinerlab-secp256k1": "^1.0.5-exodus.1",
     "@exodus/secp256k1": "^4.0.2-exodus.0",
+    "@types/minimalistic-assert": "^1.0.1",
     "@types/node": "^20.2.5",
     "bitcoinjs-message": "^2.2.0",
     "typedoc": "^0.24.8",
     "typescript": "^5.1.3"
   },
   "dependencies": {
+    "@exodus/asset-types": "^0.3.0",
     "@exodus/bitcoinjs": "^1.4.0",
-    "@exodus/crypto": "^1.0.0-rc.14"
+    "@exodus/crypto": "^1.0.0-rc.14",
+    "minimalistic-assert": "^1.0.1"
   },
   "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": "9e9c803014c2e0072df754f6360fdde825af92c7"
+  "gitHead": "33473ee0dad8187b01d3f0bee0c04f30b60608d7"
 }