@exodus/bitcoin-api 4.5.0 → 4.6.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.6.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@4.2.1...@exodus/bitcoin-api@4.6.0) (2025-11-14)
+
+
+### Features
+
+
+* feat: add PSBT builder infrastructure (#6822)
+
+* feat: add PSBT parser functionality (#6823)
+
+* feat: integrate PSBT support and legacy chain index (#6819)
+
+* feat: integrate PSBT support and legacy chain index (#6819) (#6829)
+
+
+
 ## [4.5.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@4.2.1...@exodus/bitcoin-api@4.5.0) (2025-11-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "description": "Bitcoin transaction and fee monitors, RPC with the blockchain node, other networking code.",
   "type": "module",
   "main": "src/index.js",
@@ -60,5 +60,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "482aa1dda8d9273c4f1a477ffcef2310f1df9884"
+  "gitHead": "660b300377800da2edc9c250d61736b416db73d1"
 }

package/src/psbt-builder.js

@@ -1,11 +1,17 @@
-import { payments, Psbt, Transaction } from '@exodus/bitcoinjs'
+import { payments } from '@exodus/bitcoinjs'
 import { publicKeyToX } from '@exodus/crypto/secp256k1'
 import assert from 'minimalistic-assert'
 
 import { SubType, writePsbtGlobalField, writePsbtOutputField } from './psbt-proprietary-types.js'
-import { getAddressType, getPurposeXPubs, validatePurpose } from './psbt-utils.js'
-
-function canParseTx(rawTxBuffer) {
+import {
+  getAddressType,
+  getPurposeXPubs,
+  setPsbtVersionIfNotBitcoin,
+  validatePurpose,
+} from './psbt-utils.js'
+import { getMaximumFeeRate } from './tx-sign/maximum-fee-rates.js'
+
+function canParseTx(rawTxBuffer, Transaction) {
   try {
     Transaction.fromBuffer(rawTxBuffer)
     return true
@@ -70,7 +76,14 @@ function writeGlobalMetadata(psbt, metadata) {
   }
 }
 
-function createPsbtInput({ input, asset, addressPathsMap, purposeXPubs, nonWitnessTxs }) {
+function createPsbtInput({
+  input,
+  asset,
+  addressPathsMap,
+  purposeXPubs,
+  nonWitnessTxs,
+  Transaction,
+}) {
   const psbtInput = {
     hash: input.txId,
     index: input.vout,
@@ -111,7 +124,7 @@ function createPsbtInput({ input, asset, addressPathsMap, purposeXPubs, nonWitne
     )
 
     const rawTxBuffer = Buffer.from(rawTx.rawData, 'hex')
-    if (canParseTx(rawTxBuffer)) {
+    if (canParseTx(rawTxBuffer, Transaction)) {
       psbtInput.nonWitnessUtxo = rawTxBuffer
     } else {
       // bitcoinjs can’t parse a handful of edge-case transactions (Litecoin MWEB, odd
@@ -181,6 +194,8 @@ export async function createPsbtWithMetadata({
   addressPathsMap,
   metadata,
   allowedPurposes,
+  Psbt,
+  Transaction,
 }) {
   assert(inputs, 'inputs is required')
   assert(outputs, 'outputs is required')
@@ -189,8 +204,16 @@ export async function createPsbtWithMetadata({
   assert(walletAccount, 'walletAccount is required')
   assert(addressPathsMap, 'addressPathsMap is required')
   assert(metadata, 'metadata is required')
+  assert(Psbt, 'Psbt is required')
+  assert(Transaction, 'Transaction is required')
+  const psbtOptions = { network: asset.coinInfo.toBitcoinJS() }
+  const maximumFeeRate = getMaximumFeeRate(asset.name)
+  if (maximumFeeRate !== undefined) {
+    psbtOptions.maximumFeeRate = maximumFeeRate
+  }
 
-  const psbt = new Psbt({ network: asset.coinInfo.toBitcoinJS() })
+  const psbt = new Psbt(psbtOptions)
+  setPsbtVersionIfNotBitcoin(psbt, asset.name)
 
   const purposeXPubs = await getPurposeXPubs({
     assetClientInterface,
@@ -209,6 +232,7 @@ export async function createPsbtWithMetadata({
       purposeXPubs,
       nonWitnessTxs,
       allowedPurposes,
+      Transaction,
     })
     psbt.addInput(psbtInput)
   }
@@ -230,5 +254,5 @@ export async function createPsbtWithMetadata({
     writePsbtOutputField(psbt, sendOutputIndex, SubType.OutputRole, 'primary')
   }
 
-  return psbt.toBuffer()
+  return psbt
 }

package/src/psbt-parser.js

@@ -1,4 +1,3 @@
-import { Psbt, Transaction } from '@exodus/bitcoinjs'
 import { publicKeyToX } from '@exodus/crypto/secp256k1'
 import { UtxoCollection } from '@exodus/models'
 import BipPath from 'bip32-path'
@@ -11,7 +10,7 @@ import { findUnconfirmedSentRbfTxs } from './tx-utils.js'
 import { getUnconfirmedTxAncestorMap } from './unconfirmed-ancestor-data.js'
 import { getUsableUtxos, getUtxos } from './utxos-utils.js'
 
-function extractInputUtxoData(psbtInput, txInput, index) {
+function extractInputUtxoData(psbtInput, txInput, index, Transaction) {
   if (psbtInput.nonWitnessUtxo) {
     const prevTx = Transaction.fromBuffer(psbtInput.nonWitnessUtxo)
     const prevOutput = prevTx.outs[txInput.index]
@@ -34,14 +33,14 @@ function extractInputUtxoData(psbtInput, txInput, index) {
   throw new Error(`Input ${index} has no witnessUtxo or nonWitnessUtxo`)
 }
 
-function parseSingleInput({ txInput, psbtInput, index, asset, purposeXPubs }) {
+function parseSingleInput({ txInput, psbtInput, index, asset, purposeXPubs, Transaction }) {
   const input = {
     txId: Buffer.from(txInput.hash).reverse().toString('hex'),
     vout: txInput.index,
     sequence: txInput.sequence,
   }
 
-  const inputUtxoData = extractInputUtxoData(psbtInput, txInput, index)
+  const inputUtxoData = extractInputUtxoData(psbtInput, txInput, index, Transaction)
 
   input.value = inputUtxoData.value
   input.script = Buffer.from(inputUtxoData.scriptBuffer).toString('hex')
@@ -117,9 +116,15 @@ function readGlobalMetadata(psbt) {
 }
 
 function calculateFee(inputs, outputs) {
-  const inputSum = inputs.reduce((sum, input) => sum + (input.value || 0), 0)
-  const outputSum = outputs.reduce((sum, output) => sum + (output.amount || 0), 0)
-  return inputSum - outputSum
+  const inputSum = inputs.reduce((sum, input) => {
+    const value = BigInt(input.value || 0)
+    return sum + value
+  }, BigInt(0))
+  const outputSum = outputs.reduce((sum, output) => {
+    const amount = BigInt(output.amount || 0)
+    return sum + amount
+  }, BigInt(0))
+  return inputSum - outputSum // Return BigInt directly
 }
 
 function getBip32Derivation(hdkey, bip32Derivations, ignoreY) {
@@ -329,11 +334,15 @@ export async function parsePsbt({
   assetClientInterface,
   walletAccount,
   allowedPurposes,
+  Psbt,
+  Transaction,
 }) {
   assert(psbtBuffer, 'psbtBuffer is required')
   assert(asset, 'asset is required')
   assert(assetClientInterface, 'assetClientInterface is required')
   assert(walletAccount, 'walletAccount is required')
+  assert(Psbt, 'Psbt is required')
+  assert(Transaction, 'Transaction is required')
 
   const purposeXPubs = await getPurposeXPubs({
     assetClientInterface,
@@ -353,6 +362,7 @@ export async function parsePsbt({
       asset,
       purposeXPubs,
       allowedPurposes,
+      Transaction,
     })
     inputs.push(input)
   }
@@ -388,11 +398,15 @@ export async function extractTransactionContext({
   assetClientInterface,
   walletAccount,
   allowedPurposes,
+  Psbt,
+  Transaction,
 }) {
   assert(psbtBuffer, 'psbtBuffer is required')
   assert(asset, 'asset is required')
   assert(assetClientInterface, 'assetClientInterface is required')
   assert(walletAccount, 'walletAccount is required')
+  assert(Psbt, 'Psbt is required')
+  assert(Transaction, 'Transaction is required')
 
   const {
     inputs: parsedInputs,
@@ -405,6 +419,8 @@ export async function extractTransactionContext({
     assetClientInterface,
     walletAccount,
     allowedPurposes,
+    Psbt,
+    Transaction,
   })
 
   const changeOutputData = await getChangeOutputData({

package/src/psbt-utils.js

@@ -131,3 +131,7 @@ export async function withUnsafeNonSegwit({ psbt, fn, unsafe = true }) {
     cache.__UNSAFE_SIGN_NONSEGWIT = prevValue
   }
 }
+
+export function setPsbtVersionIfNotBitcoin(psbt, assetName) {
+  if (!['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)) psbt.setVersion(1)
+}

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

@@ -276,6 +276,8 @@ async function createUnsignedTx({
   sendOutputIndex,
   changeOutputIndex,
   allowedPurposes,
+  Psbt,
+  Transaction,
 }) {
   const nonWitnessTxs = await getNonWitnessTxs(asset, selectedUtxos, insightClient)
 
@@ -292,11 +294,11 @@ async function createUnsignedTx({
     },
   }
 
-  // Only attach PSBT metadata for Bitcoin transfer flows for now; support for other coins and
-  // transaction types will come later.
-  const isBitcoin = ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(asset.name)
-  if (isBitcoin) {
-    const psbtBuffer = await createPsbtWithMetadata({
+  // Create PSBT for all UTXO coins that support it
+  // Note: Some coins (like BCash) may not use PSBT in their signing flow,
+  // but creating it here allows for a unified transaction flow
+  if (Psbt) {
+    const psbt = await createPsbtWithMetadata({
       inputs,
       outputs,
       asset,
@@ -313,9 +315,11 @@ async function createUnsignedTx({
         bumpTxId,
         blockHeight,
       },
+      Psbt,
+      Transaction,
     })
 
-    result.txData.psbtBuffer = psbtBuffer
+    result.txData.psbtBuffer = psbt.toBuffer()
   }
 
   return result
@@ -347,6 +351,8 @@ const transferHandler = {
     assetClientInterface,
     changeAddressType,
     allowedPurposes,
+    Psbt,
+    Transaction,
   }) => {
     const assetName = asset.name
     const insightClient = asset.baseAsset.insightClient
@@ -483,6 +489,8 @@ const transferHandler = {
       sendOutputIndex: sendOutput ? outputs.indexOf(sendOutput) : undefined,
       changeOutputIndex: changeOutput ? outputs.indexOf(changeOutput) : undefined,
       allowedPurposes,
+      Psbt,
+      Transaction,
     })
 
     return {
@@ -516,6 +524,8 @@ export const createTxFactory =
     assetClientInterface,
     changeAddressType,
     allowedPurposes,
+    Psbt,
+    Transaction,
   }) =>
   async ({
     asset,
@@ -562,5 +572,7 @@ export const createTxFactory =
       assetClientInterface,
       changeAddressType,
       allowedPurposes,
+      Psbt,
+      Transaction,
     })
   }

package/src/tx-send/index.js

@@ -1,4 +1,5 @@
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs'
+import { Psbt as DefaultPsbt, Transaction as DefaultTransaction } from '@exodus/bitcoinjs'
 import assert from 'minimalistic-assert'
 
 import { extractTransactionContext } from '../psbt-parser.js'
@@ -110,6 +111,8 @@ const getPrepareSendTransaction = async ({
   utxosDescendingOrder,
   walletAccount,
   allowedPurposes,
+  Psbt,
+  Transaction,
 }) => {
   const createTx = createTxFactory({
     getFeeEstimator,
@@ -118,6 +121,8 @@ const getPrepareSendTransaction = async ({
     assetClientInterface,
     changeAddressType,
     allowedPurposes,
+    Psbt,
+    Transaction,
   })
 
   // Set default values for options
@@ -134,7 +139,7 @@ const getPrepareSendTransaction = async ({
   })
 }
 
-function toTransactionDescriptor(txContext, psbtBuffer) {
+function toTransactionDescriptor({ txContext, psbtBuffer }) {
   const {
     inputs,
     outputs,
@@ -198,8 +203,10 @@ export const createAndBroadcastTXFactory =
     assetClientInterface,
     changeAddressType,
     allowedPurposes,
+    Psbt = DefaultPsbt,
+    Transaction = DefaultTransaction,
   }) =>
-  async ({ asset, walletAccount, address, amount, options }) => {
+  async ({ asset, walletAccount, address, amount, ...options }) => {
     // Prepare transaction
     const { bumpTxId } = options
 
@@ -218,6 +225,8 @@ export const createAndBroadcastTXFactory =
       utxosDescendingOrder,
       walletAccount,
       allowedPurposes,
+      Psbt,
+      Transaction,
     })
 
     // If we already created a PSBT for Bitcoin, hydrate the full transaction
@@ -231,8 +240,10 @@ export const createAndBroadcastTXFactory =
         assetClientInterface,
         walletAccount,
         allowedPurposes,
+        Psbt,
+        Transaction,
       })
-      transactionDescriptor = toTransactionDescriptor(txContext, psbtBuffer)
+      transactionDescriptor = toTransactionDescriptor({ txContext, psbtBuffer })
       unsignedTx = transactionDescriptor.unsignedTx
       metadata = transactionDescriptor.metadata
     } else {

package/src/tx-sign/common.js

@@ -27,3 +27,12 @@ export const serializeTx = ({ tx }) => {
     })),
   }
 }
+
+export function shouldSkipFinalize(unsignedTx) {
+  const isExternalPsbt =
+    unsignedTx.txData.psbtBuffer &&
+    unsignedTx.txMeta.addressPathsMap &&
+    unsignedTx.txMeta.inputsToSign
+
+  return isExternalPsbt || unsignedTx.txMeta.returnPsbt
+}

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

@@ -1,7 +1,7 @@
 import { Psbt as DefaultPsbt, Transaction as DefaultTransaction } from '@exodus/bitcoinjs'
 import assert from 'minimalistic-assert'
 
-import { extractTransaction } from './common.js'
+import { extractTransaction, shouldSkipFinalize } from './common.js'
 import { createSignWithWallet } from './create-sign-with-wallet.js'
 import { createPrepareForSigning } from './default-prepare-for-signing.js'
 
@@ -57,11 +57,7 @@ export const signTxFactory = ({
       },
     })
 
-    const isExternalPsbt =
-      unsignedTx.txData.psbtBuffer &&
-      unsignedTx.txMeta.addressPathsMap &&
-      unsignedTx.txMeta.inputsToSign
-    const skipFinalize = isExternalPsbt || unsignedTx.txMeta.returnPsbt
+    const skipFinalize = shouldSkipFinalize(unsignedTx)
     await signWithWallet(psbt, inputsToSign, skipFinalize)
     return extractTransaction({ psbt, skipFinalize })
   }

package/src/tx-sign/default-prepare-for-signing.js

@@ -2,11 +2,8 @@ import { Psbt as DefaultPsbt, Transaction as DefaultTransaction } from '@exodus/
 import assert from 'minimalistic-assert'
 
 import { writePsbtBlockHeight } from '../psbt-proprietary-types.js'
-
-const _MAXIMUM_FEE_RATES = {
-  qtumignition: 25_000,
-  ravencoin: 1_000_000,
-}
+import { setPsbtVersionIfNotBitcoin } from '../psbt-utils.js'
+import { getMaximumFeeRate } from './maximum-fee-rates.js'
 
 /**
  * Factory function that create the prepareForSigning function for a bitcoin-like asset.
@@ -26,9 +23,19 @@ export function createPrepareForSigning({
 
   return ({ unsignedTx }) => {
     const networkInfo = coinInfo.toBitcoinJS()
+    const maximumFeeRate = getMaximumFeeRate(assetName)
+
+    const psbtOptions = { network: networkInfo }
+    if (maximumFeeRate !== undefined) {
+      psbtOptions.maximumFeeRate = maximumFeeRate
+    }
 
     if (unsignedTx.txData.psbtBuffer) {
-      return createPsbtFromBuffer({ Psbt, psbtBuffer: unsignedTx.txData.psbtBuffer, networkInfo })
+      return createPsbtFromBuffer({
+        Psbt,
+        psbtBuffer: unsignedTx.txData.psbtBuffer,
+        psbtOptions,
+      })
     }
 
     // Create PSBT based on internal Exodus data structure
@@ -41,15 +48,17 @@ export function createPrepareForSigning({
       Psbt,
       Transaction,
     })
-    if (!['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)) psbt.setVersion(1)
+    setPsbtVersionIfNotBitcoin(psbt, assetName)
 
     return psbt
   }
 }
 
 // Creates a PSBT instance from the passed transaction buffer provided by 3rd parties (e.g. dApps).
-function createPsbtFromBuffer({ Psbt, psbtBuffer, ecc, networkInfo }) {
-  return Psbt.fromBuffer(psbtBuffer, { eccLib: ecc, network: networkInfo })
+function createPsbtFromBuffer({ Psbt, psbtBuffer, ecc, psbtOptions = {} }) {
+  const fromBufferOptions = { ...psbtOptions }
+  if (ecc) fromBufferOptions.eccLib = ecc
+  return Psbt.fromBuffer(psbtBuffer, fromBufferOptions)
 }
 
 // Creates a PSBT instance from the passed inputs, outputs etc. The wallet itself provides this data.
@@ -64,11 +73,18 @@ function createPsbtFromTxData({
   Transaction,
   blockHeight,
 }) {
-  // use harcoded max fee rates for specific assets
-  // if undefined, will be set to default value by PSBT (2500)
-  const maximumFeeRate = _MAXIMUM_FEE_RATES[assetName]
+  // use hardcoded max fee rates for specific assets
+  // if undefined, the PSBT default (5000 sat/vB) is used. Passing `undefined`
+  // directly into the constructor used to clobber the default (buggy behavior),
+  // so we now only set the override when we actually have one.
+  const maximumFeeRate = getMaximumFeeRate(assetName)
+
+  const psbtOptions = { network: networkInfo }
+  if (maximumFeeRate !== undefined) {
+    psbtOptions.maximumFeeRate = maximumFeeRate
+  }
 
-  const psbt = new Psbt({ maximumFeeRate, network: networkInfo })
+  const psbt = new Psbt(psbtOptions)
 
   // If present, add blockHeight as a proprietary field
   if (blockHeight !== undefined) {

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

@@ -1,6 +1,6 @@
 import assert from 'minimalistic-assert'
 
-import { extractTransaction } from './common.js'
+import { extractTransaction, shouldSkipFinalize } from './common.js'
 import { createPrepareForSigning } from './default-prepare-for-signing.js'
 
 export const signHardwareFactory = ({ assetName, resolvePurpose, keys, coinInfo }) => {
@@ -40,11 +40,7 @@ export const signHardwareFactory = ({ assetName, resolvePurpose, keys, coinInfo
       multisigData,
     })
 
-    const isExternalPsbt =
-      unsignedTx.txData.psbtBuffer &&
-      unsignedTx.txMeta.addressPathsMap &&
-      unsignedTx.txMeta.inputsToSign
-    const skipFinalize = isExternalPsbt || unsignedTx.txMeta.returnPsbt
+    const skipFinalize = shouldSkipFinalize(unsignedTx)
     return extractTransaction({ psbt, skipFinalize })
   }
 }

package/src/tx-sign/maximum-fee-rates.js

@@ -0,0 +1,13 @@
+// We keep hardcoded fee caps here so both signing and PSBT builders reuse the
+// same per-asset overrides (e.g. Dogecoin needs a higher ceiling than the
+// bitcoinjs default). If an asset is missing, the library fallback (5000 sat/vB)
+// will apply instead.
+const MAXIMUM_FEE_RATES = {
+  dogecoin: 12_000,
+  qtumignition: 25_000,
+  ravencoin: 1_000_000,
+}
+
+export function getMaximumFeeRate(assetName) {
+  return MAXIMUM_FEE_RATES[assetName]
+}