@exodus/bitcoin-api 2.23.0 → 2.24.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.24.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.23.0...@exodus/bitcoin-api@2.24.0) (2024-09-13)
+
+
+### Features
+
+* **BTC:** add multisig data to hardware wallet signing ([#3633](https://github.com/ExodusMovement/assets/issues/3633)) ([90293e9](https://github.com/ExodusMovement/assets/commit/90293e9b80799556df1c595558b1544c5a081d7b))
+
+
+### Bug Fixes
+
+* **BTC:** allow internal pubkey and sort xonly for multisig ([#3634](https://github.com/ExodusMovement/assets/issues/3634)) ([808bf65](https://github.com/ExodusMovement/assets/commit/808bf65f05576e2758bb32ad5654143577db7c38))
+
+
+
 ## [2.23.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.22.1...@exodus/bitcoin-api@2.23.0) (2024-09-11)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.23.0",
+  "version": "2.24.0",
   "description": "Exodus bitcoin-api",
   "type": "module",
   "main": "src/index.js",
@@ -61,5 +61,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "e9a0341b6e59b226e46b0e802ea1240c55724f68"
+  "gitHead": "ba34f68e632d17fdd80cc50358792f449e92180a"
 }

package/src/multisig-address.js

@@ -5,14 +5,14 @@ import { toXOnly } from './bitcoinjs-lib/ecc-utils.js'
 
 // Key to use when key path spending is disabled https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki#constructing-and-spending-taproot-outputs
 const DUMMY_TAPROOT_PUBKEY = Buffer.from(
-  '50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0',
+  '0250929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0',
   'hex'
 )
 
 // Leaf version for BIP342 is 0xc0 or 192 https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki#specification
 const LEAF_VERSION_TAPSCRIPT = 192
 
-// Limit multisig keys to 20 for now
+// Limit multisig keys to 16 for now
 const MAX_PUBKEYS = 20
 
 export const createEncodeMultisigContract =
@@ -21,7 +21,14 @@ export const createEncodeMultisigContract =
     network = bitcoinjsLib.Network.bitcoin,
     ecc = defaultEcc,
   }) =>
-  (publicKeys, { threshold = publicKeys.length, version = 0 } = Object.create(null)) => {
+  (
+    publicKeys,
+    {
+      threshold = publicKeys.length,
+      version = 0,
+      internalPubkey = DUMMY_TAPROOT_PUBKEY,
+    } = Object.create(null)
+  ) => {
     if (
       !Array.isArray(publicKeys) ||
       publicKeys.some((k) => !Buffer.isBuffer(k) || !ecc.isPointCompressed(k))
@@ -57,7 +64,7 @@ export const createEncodeMultisigContract =
     }
 
     // Sort according to BIP67 https://github.com/bitcoin/bips/blob/master/bip-0067.mediawiki
-    publicKeys.sort((a, b) => Buffer.compare(a, b))
+    publicKeys.sort((a, b) => Buffer.compare(toXOnly(a), toXOnly(b)))
 
     // Create multisig redeem script https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki#cite_note-5
     const OPS = bitcoinjsLib.script.OPS
@@ -74,7 +81,7 @@ export const createEncodeMultisigContract =
     const output = bitcoinjsLib.script.compile(chunks)
 
     return bitcoinjsLib.payments.p2tr({
-      internalPubkey: DUMMY_TAPROOT_PUBKEY,
+      internalPubkey: toXOnly(internalPubkey),
       scriptTree: { output },
       redeem: { output, redeemVersion: LEAF_VERSION_TAPSCRIPT },
       network,

package/src/tx-sign/default-sign-hardware.js

@@ -20,7 +20,7 @@ export const signHardwareFactory = ({ assetName, resolvePurpose, keys, coinInfo
     resolvePurpose,
   })
 
-  return async ({ unsignedTx, hardwareDevice, accountIndex }) => {
+  return async ({ unsignedTx, hardwareDevice, accountIndex, multisigData }) => {
     assert(unsignedTx, 'unsignedTx is required')
     assert(hardwareDevice, 'hardwareDevice is required')
     assert(Number.isInteger(accountIndex), 'accountIndex must be integer')
@@ -37,35 +37,65 @@ export const signHardwareFactory = ({ assetName, resolvePurpose, keys, coinInfo
       addressPathsMap,
       hardwareDevice,
       accountIndex,
+      multisigData,
     })
 
-    const skipFinalize = !!unsignedTx.txData.psbtBuffer
+    const skipFinalize = !!unsignedTx.txData.psbtBuffer || unsignedTx.txMeta.returnPsbt
     return extractTransaction({ psbt, skipFinalize })
   }
 }
 
 function createSignWithHardwareWallet({ assetName, resolvePurpose }) {
-  return async ({ psbt, inputsToSign, addressPathsMap, accountIndex, hardwareDevice }) => {
-    const derivationPaths = getDerivationPaths({ resolvePurpose, addressPathsMap, accountIndex })
+  return async ({
+    psbt,
+    inputsToSign,
+    addressPathsMap,
+    accountIndex,
+    hardwareDevice,
+    multisigData,
+  }) => {
+    const derivationPathsMap = getDerivationPathsMap({
+      resolvePurpose,
+      addressPathsMap,
+      accountIndex,
+    })
     const signatures = await hardwareDevice.signTransaction({
       assetName,
       signableTransaction: psbt.toBuffer(),
-      derivationPaths,
+      derivationPaths: Object.values(derivationPathsMap),
+      derivationPathsMap,
+      multisigData,
     })
 
-    applySignatures(psbt, signatures, inputsToSign)
+    if (multisigData) {
+      applyMultisigSignatures(psbt, signatures)
+    } else {
+      applySignatures(psbt, signatures, inputsToSign)
+    }
   }
 }
 
-function getDerivationPaths({ resolvePurpose, accountIndex, addressPathsMap }) {
-  const derivationPaths = []
+function getDerivationPathsMap({ resolvePurpose, accountIndex, addressPathsMap }) {
+  const derivationPathsMap = {}
   for (const [address, path] of Object.entries(addressPathsMap)) {
     const purpose = resolvePurpose(address)
     const derivationPath = `m/${purpose}'/0'/${accountIndex}'/${path.slice(2)}` // TODO: coinindex
-    derivationPaths.push(derivationPath)
+    derivationPathsMap[address] = derivationPath
   }
 
-  return derivationPaths
+  return derivationPathsMap
+}
+
+function applyMultisigSignatures(psbt, signatures) {
+  for (const signature of signatures) {
+    const input = psbt.data.inputs[signature.inputIndex]
+    if (!input.tapScriptSig) input.tapScriptSig = []
+    input.tapScriptSig.push({
+      pubkey: signature.publicKey,
+      signature: signature.signature,
+      leafHash: signature.tapleafHash,
+    })
+  }
 }
 
 export function applySignatures(psbt, signatures, inputsToSign) {