@exodus/bitcoin-api 2.10.1 → 2.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.10.1",
+  "version": "2.11.0",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -57,5 +57,5 @@
     "jest-when": "^3.5.1",
     "safe-buffer": "^5.2.1"
   },
-  "gitHead": "59489f1962adac06d14642120d7fe97e2a4f6d43"
+  "gitHead": "58f3aa71419faa3d2680bfbd65659cc9fcc5d223"
 }

package/src/insight-api-client/ws.js

@@ -11,7 +11,12 @@ export default class InsightWSClient extends EventEmitter {
 
   connect(addresses, opts) {
     const options = Object.assign(
-      { transports: ['websocket'], reconnectionDelayMax: 30_000, reconnectionDelay: 10_000 },
+      {
+        transports: ['websocket'],
+        reconnectionDelayMax: 30_000,
+        reconnectionDelay: 10_000,
+        extraHeaders: { 'User-Agent': 'exodus' },
+      },
       opts
     )
 

package/src/tx-send/index.js

@@ -128,16 +128,99 @@ export const getSizeAndChangeScriptFactory =
     }
   }
 
-// not ported from Exodus; but this demos signing / broadcasting
-// NOTE: this will be ripped out in the coming weeks
+/**
+ * Signs a transaction using the provided asset client interface.
+ *
+ * @async
+ * @function signTransaction
+ * @param {Object} assetClientInterface - The asset client interface to use for signing the transaction.
+ * @param {string} assetName - The name of the asset.
+ * @param {Object} unsignedTx - The unsigned transaction to sign.
+ * @param {Object} walletAccount - The wallet account to use for signing.
+ * @returns {Promise<Object>} An object containing the signed raw transaction, transaction ID, and the signed transaction.
+ * @throws {Error} Throws an error if signing the transaction fails.
+ *
+ * @example
+ * // Example usage:
+ * const { rawTx, txId, tx } = await signTransaction({assetClientInterface, assetName, unsignedTx, walletAccount});
+ * // rawTx: Buffer data representing the signed raw transaction
+ * // txId: The ID of the signed transaction
+ * // tx: An object representing the signed transaction, containing virtualSize and outs
+ * // Example returned object:
+ * {
+ *    rawTx: {
+ *        type: "Buffer",
+ *        data: [
+ *            2,
+ *            ...
+ *        ]
+ *    },
+ *    txId: "35244fba5cc46d6f3773689dce11ddba3f341149ef627c051e1a0bacd9458a1c",
+ *    tx: {
+ *        virtualSize: 110,
+ *        outs: [
+ *            {
+ *                script: "0014c06da7c31e24ba4e7a0656443e17c00572a3e9f7"
+ *            }
+ *        ]
+ *    }
+ * }
+ */
+export async function signTransaction({
+  assetClientInterface,
+  assetName,
+  unsignedTx,
+  walletAccount,
+}) {
+  const { rawTx, txId, tx } = await assetClientInterface.signTransaction({
+    assetName,
+    unsignedTx,
+    walletAccount,
+  })
+  return { rawTx, txId, tx }
+}
 
-export const createAndBroadcastTXFactory =
+async function createUnsignedTx({
+  inputs,
+  outputs,
+  useCashAddress,
+  addressPathsMap,
+  blockHeight,
+  asset,
+  selectedUtxos,
+  insightClient,
+}) {
+  const unsignedTx = {
+    txData: {
+      inputs,
+      outputs,
+    },
+    txMeta: {
+      useCashAddress, // for trezor to show the receiver cash address
+      addressPathsMap,
+      blockHeight,
+    },
+  }
+
+  const nonWitnessTxs = await getNonWitnessTxs(asset, selectedUtxos, insightClient)
+  Object.assign(unsignedTx.txMeta, { rawTxs: nonWitnessTxs })
+  return unsignedTx
+}
+
+async function getBlockHeight({ assetName, insightClient }) {
+  return ['zcash', 'bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)
+    ? insightClient.fetchBlockHeight()
+    : 0
+}
+
+export const getPrepareSendTransaction =
   ({
+    blockHeight: providedBlockHeight,
+    ordinalsEnabled,
     getFeeEstimator,
-    getSizeAndChangeScript = getSizeAndChangeScriptFactory(), // for decred customizations
     allowUnconfirmedRbfEnabledUtxos,
-    ordinalsEnabled = false,
     utxosDescendingOrder,
+    rbfEnabled: providedRbfEnabled,
   }) =>
   async (
     { asset: maybeToken, walletAccount, address, amount: tokenAmount, options },
@@ -148,30 +231,33 @@ export const createAndBroadcastTXFactory =
       feePerKB,
       customFee,
       isSendAll,
-      isExchange,
-      isBip70,
       bumpTxId,
-      isRbfAllowed = true,
       nft,
       feeOpts,
+      isExchange,
+      isBip70,
+      isRbfAllowed,
     } = options
 
+    const asset = maybeToken.baseAsset
+    const assetName = asset.name
+    const accountState = await assetClientInterface.getAccountState({ assetName, walletAccount })
+    const feeData = await assetClientInterface.getFeeConfig({ assetName })
+    const insightClient = asset.baseAsset.insightClient
+
+    const blockHeight = providedBlockHeight || (await getBlockHeight({ assetName, insightClient }))
     const brc20 = options.brc20 || feeOpts?.brc20 // feeOpts is the only way I've found atm to pass brc20 param without changing the tx-send hydra module
 
-    const asset = maybeToken.baseAsset
+    const rbfEnabled =
+      providedRbfEnabled ||
+      (feeData.rbfEnabled && !isExchange && !isBip70 && isRbfAllowed && !nft && !brc20)
 
     const isToken = maybeToken.name !== asset.name
-
     if (isToken) {
       assert(brc20, 'brc20 is required when sending bitcoin token')
     }
 
     const amount = isToken ? asset.currency.ZERO : tokenAmount
-
-    const assetName = asset.name
-
-    const accountState = await assetClientInterface.getAccountState({ assetName, walletAccount })
-
     const inscriptionIds = nft?.tokenId ? [nft?.tokenId] : brc20 ? brc20.inscriptionIds : undefined
 
     assert(
@@ -210,9 +296,8 @@ export const createAndBroadcastTXFactory =
       ? getTransferOrdinalsUtxos({ inscriptionIds, ordinalsUtxos: currentOrdinalsUtxos })
       : undefined
 
-    const insightClient = asset.baseAsset.insightClient
     const currency = asset.currency
-    const feeData = await assetClientInterface.getFeeConfig({ assetName })
+
     const unconfirmedTxAncestor = getUnconfirmedTxAncestorMap({ accountState })
     const usableUtxos = getUsableUtxos({
       asset,
@@ -232,9 +317,6 @@ export const createAndBroadcastTXFactory =
       address = asset.address.P2SH2ToP2SH(address)
     }
 
-    const rbfEnabled =
-      feeData.rbfEnabled && !isExchange && !isBip70 && isRbfAllowed && !nft && !brc20
-
     let utxosToBump
     if (bumpTxId) {
       const bumpTx = replaceableTxs.find(({ txId }) => txId === bumpTxId)
@@ -250,7 +332,7 @@ export const createAndBroadcastTXFactory =
       }
     }
 
-    const sendAmount = bumpTxId || transferOrdinalsUtxos ? asset.currency.ZERO : amount.toDefault()
+    const sendAmount = bumpTxId || transferOrdinalsUtxos ? asset.currency.ZERO : amount
     const receiveAddress = bumpTxId ? (replaceableTxs.length > 0 ? null : 'P2WPKH') : address
     const feeRate = feeData.feePerKB
     const resolvedIsSendAll = (!rbfEnabled && feePerKB) || transferOrdinalsUtxos ? false : isSendAll
@@ -301,18 +383,13 @@ export const createAndBroadcastTXFactory =
 
     const addressPathsMap = selectedUtxos.getAddressPathsMap()
 
-    // transform UTXO object to raw
+    // Inputs and Outputs
     const inputs = shuffle(createInputs(assetName, selectedUtxos.toArray(), rbfEnabled))
+    let outputs = replaceTx
+      ? replaceTx.data.sent.map(({ address, amount }) => createOutput(assetName, address, amount))
+      : []
 
-    let outputs
-    if (replaceTx) {
-      outputs = replaceTx.data.sent.map(({ address, amount }) =>
-        createOutput(assetName, address, amount)
-      )
-    } else {
-      outputs = []
-    }
-
+    // Send output
     let sendOutput
     if (address) {
       if (transferOrdinalsUtxos) {
@@ -342,6 +419,7 @@ export const createAndBroadcastTXFactory =
       ourAddress = Address.create(legacyAddress, ourAddress.meta)
     }
 
+    // Change Output
     let changeOutput
     if (change.gte(dust)) {
       changeOutput = createOutput(assetName, ourAddress.address ?? ourAddress.toString(), change)
@@ -355,31 +433,111 @@ export const createAndBroadcastTXFactory =
     }
 
     outputs = replaceTx ? outputs : shuffle(outputs)
-    const blockHeight = ['zcash', 'bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)
-      ? await insightClient.fetchBlockHeight()
-      : 0
-
-    // desktop/mobile shared format
-    const unsignedTx = {
-      txData: {
-        inputs,
-        outputs,
-      },
-      txMeta: {
-        useCashAddress, // for trezor to show the receiver cash address
-        addressPathsMap,
-        blockHeight,
-      },
+
+    const unsignedTx = await createUnsignedTx({
+      inputs,
+      outputs,
+      useCashAddress,
+      addressPathsMap,
+      blockHeight,
+      asset,
+      selectedUtxos,
+      insightClient,
+    })
+    return {
+      amount,
+      change,
+      totalAmount,
+      currentOrdinalsUtxos,
+      inscriptionIds,
+      address,
+      ourAddress,
+      receiveAddress,
+      sendAmount,
+      fee,
+      usableUtxos,
+      selectedUtxos,
+      transferOrdinalsUtxos,
+      replaceTx,
+      sendOutput,
+      changeOutput,
+      unsignedTx,
     }
+  }
+
+// not ported from Exodus; but this demos signing / broadcasting
+// NOTE: this will be ripped out in the coming weeks
+export const createAndBroadcastTXFactory =
+  ({
+    getFeeEstimator,
+    getSizeAndChangeScript = getSizeAndChangeScriptFactory(), // for decred customizations
+    allowUnconfirmedRbfEnabledUtxos,
+    ordinalsEnabled = false,
+    utxosDescendingOrder,
+  }) =>
+  async (
+    { asset: maybeToken, walletAccount, address, amount: tokenAmount, options },
+    { assetClientInterface }
+  ) => {
+    // Prepare transaction
+    const { bumpTxId, nft, isExchange, isBip70, isRbfAllowed = true, feeOpts } = options
 
-    const nonWitnessTxs = await getNonWitnessTxs(asset, selectedUtxos, insightClient)
-    Object.assign(unsignedTx.txMeta, { rawTxs: nonWitnessTxs })
-    const { rawTx, txId, tx } = await assetClientInterface.signTransaction({
+    const asset = maybeToken.baseAsset
+    const assetName = asset.name
+    const feeData = await assetClientInterface.getFeeConfig({ assetName })
+    const accountState = await assetClientInterface.getAccountState({ assetName, walletAccount })
+    const insightClient = asset.baseAsset.insightClient
+    const isToken = maybeToken.name !== asset.name
+    const brc20 = options.brc20 || feeOpts?.brc20
+
+    const rbfEnabled =
+      feeData.rbfEnabled && !isExchange && !isBip70 && isRbfAllowed && !nft && !brc20
+
+    // blockHeight
+    const blockHeight = await getBlockHeight({ assetName, insightClient })
+
+    const transactionDescriptor = await getPrepareSendTransaction({
+      blockHeight,
+      ordinalsEnabled,
+      getFeeEstimator,
+      allowUnconfirmedRbfEnabledUtxos,
+      utxosDescendingOrder,
+      rbfEnabled,
+    })(
+      { asset: maybeToken, walletAccount, address, amount: tokenAmount, options },
+      { assetClientInterface }
+    )
+    const {
+      amount,
+      change,
+      totalAmount,
+      currentOrdinalsUtxos,
+      inscriptionIds,
+      ourAddress,
+      receiveAddress,
+      sendAmount,
+      fee,
+      usableUtxos,
+      selectedUtxos,
+      transferOrdinalsUtxos,
+      replaceTx,
+      sendOutput,
+      changeOutput,
+      unsignedTx,
+    } = transactionDescriptor
+    const outputs = unsignedTx.txData.outputs
+
+    address = transactionDescriptor.address
+
+    // Sign transaction
+    const { rawTx, txId, tx } = await signTransaction({
+      assetClientInterface,
       assetName,
       unsignedTx,
       walletAccount,
     })
 
+    // Broadcast transaction
     const broadcastTxWithRetry = retry(
       async (rawTx) => {
         try {

package/src/tx-sign/create-get-key-and-purpose.js

@@ -8,7 +8,6 @@ import secp256k1 from 'secp256k1'
 const ECPair = getECPair()
 
 export const createGetKeyAndPurpose = ({
-  keys,
   hdkeys,
   resolvePurpose,
   addressPathsMap,
@@ -22,7 +21,7 @@ export const createGetKeyAndPurpose = ({
       return getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, address)
     }
 
-    return getPrivateKeyFromHDKeys(hdkeys, addressPathsMap, keys, networkInfo, purpose, address)
+    return getPrivateKeyFromHDKeys(hdkeys, addressPathsMap, networkInfo, purpose, address)
   })
 
 function getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, address) {
@@ -33,15 +32,14 @@ function getPrivateKeyFromMap(privateKeysAddressMap, networkInfo, purpose, addre
   return { key, purpose, publicKey }
 }
 
-function getPrivateKeyFromHDKeys(hdkeys, addressPathsMap, keys, networkInfo, purpose, address) {
+function getPrivateKeyFromHDKeys(hdkeys, addressPathsMap, networkInfo, purpose, address) {
   const path = getOwnProperty(addressPathsMap, address, 'string')
   assert(hdkeys, 'hdkeys must be provided')
   assert(purpose, `purpose for address ${address} could not be resolved`)
   const hdkey = hdkeys[purpose]
   assert(hdkey, `hdkey for purpose for ${purpose} and address ${address} could not be resolved`)
   const derivedhdkey = hdkey.derive(path)
-  const privateEncoded = keys.encodePrivate(derivedhdkey.privateKey)
-  const key = ECPair.fromWIF(privateEncoded, networkInfo)
+  const key = ECPair.fromPrivateKey(derivedhdkey.privateKey, { network: networkInfo })
   const publicKey = derivedhdkey.publicKey
   return { key, publicKey, purpose }
 }

package/src/tx-sign/create-sign-with-wallet.js

@@ -1,14 +1,10 @@
 import { Transaction, payments } from '@exodus/bitcoinjs-lib'
 
-import { getECPair } from '../bitcoinjs-lib'
 import { toXOnly } from '../bitcoinjs-lib/ecc-utils'
 import { createGetKeyAndPurpose } from './create-get-key-and-purpose'
-import { toAsyncSigner, tweakSigner } from './taproot'
-
-const ECPair = getECPair()
+import { toAsyncSigner } from './taproot'
 
 export function createSignWithWallet({
-  keys,
   hdkeys,
   resolvePurpose,
   privateKeysAddressMap,
@@ -17,7 +13,6 @@ export function createSignWithWallet({
   network,
 }) {
   const getKeyAndPurpose = createGetKeyAndPurpose({
-    keys,
     hdkeys,
     resolvePurpose,
     privateKeysAddressMap,
@@ -70,8 +65,11 @@ export function createSignWithWallet({
       }
 
       // desktop / BE / mobile with bip-schnorr signing
-      const signingKey = isTaprootAddress ? tweakSigner({ signer: key, ECPair, network }) : key
-      await psbt.signInputAsync(index, toAsyncSigner({ keyPair: signingKey }), allowedSigHashTypes)
+      await psbt.signInputAsync(
+        index,
+        toAsyncSigner({ keyPair: key, isTaprootAddress, network }),
+        allowedSigHashTypes
+      )
     }
   }
 }

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

@@ -4,10 +4,9 @@ import { createPrepareForSigning } from './default-prepare-for-signing'
 import { createSignWithWallet } from './create-sign-with-wallet'
 import { extractTransaction } from './common'
 
-export const signTxFactory = ({ assetName, resolvePurpose, keys, coinInfo, network }) => {
+export const signTxFactory = ({ assetName, resolvePurpose, coinInfo, network }) => {
   assert(assetName, 'assetName is required')
   assert(resolvePurpose, 'resolvePurpose is required')
-  assert(keys, 'keys is required')
   assert(coinInfo, 'coinInfo is required')
 
   const prepareForSigning = createPrepareForSigning({
@@ -26,7 +25,6 @@ export const signTxFactory = ({ assetName, resolvePurpose, keys, coinInfo, netwo
 
     const inputsToSign = unsignedTx.txMeta.inputsToSign || unsignedTx.txData.inputs
     const signWithWallet = createSignWithWallet({
-      keys,
       hdkeys,
       resolvePurpose,
       privateKeysAddressMap,

package/src/tx-sign/taproot.js

@@ -8,7 +8,7 @@ import { getECPair } from '../bitcoinjs-lib'
 const ecc = eccFactory()
 const ECPair = getECPair()
 
-export function tweakSigner({ signer, tweakHash, network }) {
+function tweakSigner({ signer, tweakHash, network }) {
   assert(signer, 'signer is required')
 
   let privateKey = signer.privateKey
@@ -40,8 +40,13 @@ function tapTweakHash(pubKey, h) {
 /**
  * Take a sync signer and make it async.
  */
-export function toAsyncSigner({ keyPair }) {
+export function toAsyncSigner({ keyPair, isTaprootAddress, network }) {
   assert(keyPair, 'keyPair is required')
+
+  if (isTaprootAddress) {
+    keyPair = tweakSigner({ signer: keyPair, ECPair, network })
+  }
+
   // eslint-disable-next-line @exodus/mutable/no-param-reassign-prop-only
   keyPair.sign = async (h) => {
     const sig = await ecc.signAsync(h, keyPair.privateKey)