@exodus/hw-ledger 2.2.6 → 2.3.1

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.3.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.3.0...@exodus/hw-ledger@2.3.1) (2024-02-13)
+
+### Bug Fixes
+
+- add dummy inputs when signing psbt on ledger ([#5680](https://github.com/ExodusMovement/exodus-hydra/issues/5680)) ([b11c6c6](https://github.com/ExodusMovement/exodus-hydra/commit/b11c6c67db196d7b970ded3228e7482ff1881c57))
+
+## [2.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.2.6...@exodus/hw-ledger@2.3.0) (2024-02-08)
+
+### Features
+
+- add bip322 message support to Ledger ([#5641](https://github.com/ExodusMovement/exodus-hydra/issues/5641)) ([b89dd27](https://github.com/ExodusMovement/exodus-hydra/commit/b89dd27435e8894f9a4ad3a10c88c0f7d165f9a0))
+
 ## [2.2.6](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@2.2.5...@exodus/hw-ledger@2.2.6) (2024-01-31)
 
 ### Bug Fixes

package/lib/module/assets/bitcoin.js

@@ -1,8 +1,10 @@
 import bs58 from 'bs58';
 import { AppClient, PsbtV2 } from '@exodus/ledger-bitcoin';
+import { BIP322 } from '@exodus/bip322-js';
 import { splitBip44DerivationPath } from './utils';
 import assert from 'minimalistic-assert';
-import { assertPsbtOnlyHasAllowedDerivationPaths, tagPsbtWithDerivationPaths, getWalletPolicy, derivationPathsToWalletPolicy, } from './utils/psbt';
+import { assertPsbtOnlyHasAllowedDerivationPaths, tagPsbtWithDerivationPaths, getWalletPolicy, derivationPathsToWalletPolicy, addDummyInputs, } from './utils/psbt';
+import { buildBip322PSBT } from './utils/bip322';
 async function createHandler(transport) {
     const app = new AppClient(transport);
     const getAddress = async (params) => {
@@ -32,6 +34,7 @@ async function createHandler(transport) {
             });
         }
         tagPsbtWithDerivationPaths(psbt, fpr, derivationPathToPublicKeyMap);
+        addDummyInputs(psbt);
         assertPsbtOnlyHasAllowedDerivationPaths(psbt, fpr, params.derivationPaths);
         const signatures = [];
         const walletPolicies = await derivationPathsToWalletPolicy(fpr, app, params.derivationPaths);
@@ -48,9 +51,48 @@ async function createHandler(transport) {
         return result;
     };
     const signMessage = async (params) => {
-        assert(Buffer.isBuffer(params.message.rawMessage), 'rawMessage must be buffer');
-        const signedMessageHex = await app.signMessage(params.message.rawMessage, params.derivationPath);
-        return Buffer.from(signedMessageHex, 'base64');
+        if (params.message.rawMessage) {
+            assert(Buffer.isBuffer(params.message.rawMessage), 'rawMessage must be buffer');
+            const signedMessageHex = await app.signMessage(params.message.rawMessage, params.derivationPath);
+            return Buffer.from(signedMessageHex, 'base64');
+        }
+        if (params.message.bip322Message) {
+            const { message, address } = params.message.bip322Message;
+            const { derivationPath } = params;
+            assert(Buffer.isBuffer(message), 'bip322Message.message must be buffer');
+            assert(typeof address === 'string', 'bip322Message.address must be string');
+            const [purpose, coin, account] = splitBip44DerivationPath(derivationPath);
+            const fpr = await app.getMasterFingerprint();
+            const xpub = await app.getExtendedPubkey(`m/${purpose}/${coin}/${account}`);
+            const walletPolicy = getWalletPolicy(fpr, xpub, purpose, coin, account);
+            const psbtBip322 = buildBip322PSBT(message.toString(), address);
+            const psbt = new PsbtV2();
+            psbt.deserialize(psbtBip322.toBuffer());
+            const derivationPathToPublicKeyMap = {
+                [derivationPath]: await getPublicKey({
+                    assetName: 'bitcoin',
+                    derivationPath,
+                }),
+            };
+            tagPsbtWithDerivationPaths(psbt, fpr, derivationPathToPublicKeyMap);
+            const signatures = await app.signPsbt(psbt.serialize(), walletPolicy, null);
+            const signature = signatures[0][1];
+            const isTaprootSig = signature.pubkey.length === 32;
+            if (isTaprootSig) {
+                psbtBip322.updateInput(0, {
+                    tapKeySig: signature.signature,
+                });
+            }
+            else {
+                psbtBip322.updateInput(0, {
+                    partialSig: [signature],
+                });
+            }
+            psbtBip322.finalizeAllInputs();
+            const encodedWitness = BIP322.encodeWitness(psbtBip322);
+            return Buffer.from(encodedWitness, 'base64');
+        }
+        throw new Error('rawMessage or bip322Message must be defined');
     };
     return {
         getAddress,

package/lib/module/assets/utils/bip322.d.ts

@@ -0,0 +1,2 @@
+import * as bitcoin from '@exodus/bitcoinjs-lib';
+export declare function buildBip322PSBT(message: string, address: string): bitcoin.Psbt;

package/lib/module/assets/utils/bip322.js

@@ -0,0 +1,29 @@
+import * as bitcoin from '@exodus/bitcoinjs-lib';
+import { BIP322, Address } from '@exodus/bip322-js';
+export function buildBip322PSBT(message, address) {
+    const scriptPubKey = Address.convertAdressToScriptPubkey(address);
+    const toSpendTx = BIP322.buildToSpendTx(message, scriptPubKey);
+    const toSpendTxId = toSpendTx.getId();
+    if (Address.isP2SH(address)) {
+        throw new Error('Unable to sign BIP-322 message for unimplemented address type.');
+    }
+    else if (Address.isP2WPKH(address) || Address.isP2TR(address)) {
+        return buildToSignNativeSegwitOrTaproot(toSpendTxId, scriptPubKey);
+    }
+    throw new Error('Unable to sign BIP-322 message for unsupported address type.');
+}
+function buildToSignNativeSegwitOrTaproot(toSpendTxId, scriptPubKey) {
+    return new bitcoin.Psbt()
+        .setVersion(0)
+        .setLocktime(0)
+        .addInput({
+        hash: toSpendTxId,
+        index: 0,
+        sequence: 0,
+        witnessUtxo: { value: 0, script: scriptPubKey },
+    })
+        .addOutput({
+        value: 0,
+        script: Buffer.from([bitcoin.opcodes.OP_RETURN]),
+    });
+}

package/lib/module/assets/utils/psbt.d.ts

@@ -4,3 +4,4 @@ export declare function assertPsbtOnlyHasAllowedDerivationPaths(psbt: PsbtV2, ma
 export declare function tagPsbtWithDerivationPaths(psbt: PsbtV2, masterFingerprint: string, derivationPathToPublicKeyMap: Record<string, Buffer>): void;
 export declare const getWalletPolicy: (fpr: string, xpub: string, purpose: string, coin: string, account: string) => DefaultWalletPolicy;
 export declare function derivationPathsToWalletPolicy(fpr: string, app: any, derivationPaths: string[]): Promise<WalletPolicy[]>;
+export declare function addDummyInputs(psbt: PsbtV2): void;

package/lib/module/assets/utils/psbt.js

@@ -119,3 +119,40 @@ export async function derivationPathsToWalletPolicy(fpr, app, derivationPaths) {
     }
     return walletPolicies;
 }
+function canModifyInputs(psbt) {
+    const SIGHASH_ALL = 0x01;
+    const SIGHASH_NONE = 0x02;
+    const SIGHASH_SINGLE = 0x03;
+    for (let i = 0; i < psbt.getGlobalInputCount(); i++) {
+        if ([SIGHASH_ALL, SIGHASH_NONE, SIGHASH_SINGLE, undefined].includes(psbt.getInputSighashType(i))) {
+            return false;
+        }
+    }
+    return true;
+}
+export function addDummyInputs(psbt) {
+    const canAddDummy = canModifyInputs(psbt);
+    if (!canAddDummy) {
+        return;
+    }
+    let outputAmount = 0;
+    for (let i = 0; i < psbt.getGlobalOutputCount(); i++) {
+        outputAmount += psbt.getOutputAmount(i);
+    }
+    let inputAmount = 0;
+    for (let i = 0; i < psbt.getGlobalInputCount(); i++) {
+        const witnessUtxo = psbt.getInputWitnessUtxo(i);
+        if (witnessUtxo) {
+            inputAmount += witnessUtxo.amount;
+        }
+    }
+    if (outputAmount > inputAmount) {
+        const newInputIndex = psbt.getGlobalInputCount();
+        const amount = outputAmount - inputAmount;
+        psbt.setGlobalInputCount(newInputIndex + 1);
+        const FIRST_BITCOIN_TXID = '4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b';
+        psbt.setInputPreviousTxId(newInputIndex, Buffer.from(FIRST_BITCOIN_TXID, 'hex'));
+        psbt.setInputOutputIndex(newInputIndex, 0);
+        psbt.setInputWitnessUtxo(newInputIndex, amount, Buffer.from('01', 'hex'));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hw-ledger",
-  "version": "2.2.6",
+  "version": "2.3.1",
   "description": "The ledger module",
   "author": "Exodus Movement Inc.",
   "repository": {
@@ -30,6 +30,7 @@
     "prepublishOnly": "yarn run -T build --scope @exodus/hw-ledger"
   },
   "dependencies": {
+    "@exodus/bip322-js": "^1.1.0-exodus.4",
     "@exodus/bitcoinjs-lib": "^6.1.5-exodus.0",
     "@exodus/ethersproject-transactions": "^5.4.2-exodus.0",
     "@exodus/hw-common": "^2.0.0",
@@ -67,5 +68,5 @@
     "ts-jest": "^29.0.3",
     "typescript": "^4.7.3"
   },
-  "gitHead": "e4a97ba8123768d13a5f73b03d2ff87d1845ba19"
+  "gitHead": "fac836c7ae4dbf64c3df293db1fb34b632400a02"
 }