@exodus/bitcoin-api 2.8.1 → 2.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.8.1",
+  "version": "2.9.1",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -42,5 +42,5 @@
     "@scure/btc-signer": "^1.1.0",
     "jest-when": "^3.5.1"
   },
-  "gitHead": "652eb821c1fe5b2bd561710d05fcb569d9f4a137"
+  "gitHead": "1f96673b2977e792373f9f3c4eb98c778817b2b6"
 }

package/src/account-state.js

@@ -6,12 +6,16 @@ export function createAccountState({ asset, ordinalsEnabled = false, brc20Enable
   })
   const defaults = {
     utxos: empty,
+    mem: {
+      unconfirmedTxAncestor: {},
+    },
   }
 
   if (ordinalsEnabled) {
     defaults.ordinalsUtxos = empty
     defaults.knownBalanceUtxoIds = []
     defaults.mustAvoidUtxoIds = []
+    defaults.additionalInscriptions = []
   }
 
   if (brc20Enabled) {

package/src/fee/can-bump-tx.js

@@ -4,6 +4,7 @@ import { findUnconfirmedSentRbfTxs } from '../tx-utils'
 import { getUsableUtxos, getUtxos } from '../utxos-utils'
 
 import { BumpType } from '@exodus/bitcoin-lib'
+import { getUnconfirmedTxAncestorMap } from '../unconfirmed-ancestor-data'
 
 export const ASSET_NAMES = ['bitcoin', 'bitcoinregtest', 'bitcointestnet']
 
@@ -51,13 +52,14 @@ const _canBumpTx = ({
   }
 
   const utxos = getUtxos({ accountState, asset })
-
+  const unconfirmedTxAncestor = getUnconfirmedTxAncestorMap({ accountState })
   const usableUtxos = getUsableUtxos({
     asset,
     utxos,
     feeData,
     txSet,
     allowUnconfirmedRbfEnabledUtxos,
+    unconfirmedTxAncestor,
   })
   if (usableUtxos.value.isZero) return { errorMessage: 'insufficient funds' }
 
@@ -86,6 +88,7 @@ const _canBumpTx = ({
       receiveAddress: null,
       getFeeEstimator,
       allowUnconfirmedRbfEnabledUtxos,
+      unconfirmedTxAncestor,
     })
     if (replaceTx) return { bumpType: BumpType.RBF, bumpFee: fee.sub(replaceTx.feeAmount) }
   }
@@ -98,6 +101,7 @@ const _canBumpTx = ({
     getFeeEstimator,
     mustSpendUtxos: changeUtxos,
     allowUnconfirmedRbfEnabledUtxos,
+    unconfirmedTxAncestor,
   })
 
   return fee ? { bumpType: BumpType.CPFP } : { errorMessage: 'insufficient funds' }

package/src/fee/fee-utils.js

@@ -5,7 +5,7 @@ import assert from 'minimalistic-assert'
 
 export const isHex = (s) => typeof s === 'string' && /[0-9a-f]*/.test(s.toLowerCase())
 
-export function getExtraFee({ asset, inputs, feePerKB }) {
+export function getExtraFee({ asset, inputs, feePerKB, unconfirmedTxAncestor }) {
   let extraFee = 0
   // Add extra fee to unconfirmed bitcoin utxos to allow transaction to CPFP ancestors
   if (
@@ -18,7 +18,12 @@ export function getExtraFee({ asset, inputs, feePerKB }) {
     )
     const txIds = new Set(utxos.map(({ txId }) => txId))
     for (const txId of txIds) {
-      extraFee += resolveExtraFeeOfTx({ assetName: asset.name, feeRate, txId })
+      extraFee += resolveExtraFeeOfTx({
+        assetName: asset.name,
+        feeRate,
+        txId,
+        unconfirmedTxAncestor,
+      })
     }
     extraFee = Math.ceil(extraFee)
   }
@@ -26,9 +31,13 @@ export function getExtraFee({ asset, inputs, feePerKB }) {
 }
 
 export default function createDefaultFeeEstimator(getSize) {
-  return (asset, feePerKB, options) => {
-    return ({ inputs = options.inputs, outputs = options.outputs } = {}) => {
-      const extraFee = getExtraFee({ asset, inputs, feePerKB })
+  return (asset, feePerKB, options = {}) => {
+    return ({
+      inputs = options.inputs,
+      outputs = options.outputs,
+      unconfirmedTxAncestor = options.unconfirmedTxAncestor,
+    } = {}) => {
+      const extraFee = getExtraFee({ asset, inputs, feePerKB, unconfirmedTxAncestor })
       // Yes, it's suppose to be '1000' and not '1024'
       // https://bitcoin.stackexchange.com/questions/24000/a-fee-is-added-per-kilobyte-of-data-that-means-1000-bytes-or-1024
       const size = getSize(asset, inputs, outputs, options)

package/src/fee/get-fee-resolver.js

@@ -3,6 +3,7 @@ import { getUtxosData } from './utxo-selector'
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
 import { getUsableUtxos, getUtxos } from '../utxos-utils'
 import { canBumpTx } from './can-bump-tx'
+import { getUnconfirmedTxAncestorMap } from '../unconfirmed-ancestor-data'
 
 export class GetFeeResolver {
   #getFeeEstimator
@@ -10,7 +11,8 @@ export class GetFeeResolver {
 
   constructor({ getFeeEstimator, allowUnconfirmedRbfEnabledUtxos }) {
     assert(getFeeEstimator, 'getFeeEstimator must be provided')
-    this.#getFeeEstimator = (asset, { feePerKB }) => getFeeEstimator(asset, feePerKB)
+    this.#getFeeEstimator = (asset, { feePerKB, ...options }) =>
+      getFeeEstimator(asset, feePerKB, options)
     this.#allowUnconfirmedRbfEnabledUtxos = allowUnconfirmedRbfEnabledUtxos
   }
 
@@ -92,12 +94,14 @@ export class GetFeeResolver {
     assert(txSet, 'txSet must be provided')
 
     const utxos = getUtxos({ accountState, asset })
+    const unconfirmedTxAncestor = getUnconfirmedTxAncestorMap({ accountState })
 
     const usableUtxos = getUsableUtxos({
       asset,
       utxos,
       feeData,
       txSet,
+      unconfirmedTxAncestor,
     })
     const replaceableTxs = findUnconfirmedSentRbfTxs(txSet)
 
@@ -113,6 +117,7 @@ export class GetFeeResolver {
       isSendAll: isSendAll,
       getFeeEstimator: this.#getFeeEstimator,
       allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
+      unconfirmedTxAncestor,
     })
   }
 

package/src/fee/utxo-selector.js

@@ -29,6 +29,7 @@ export const selectUtxos = ({
   disableReplacement = false,
   mustSpendUtxos,
   allowUnconfirmedRbfEnabledUtxos,
+  unconfirmedTxAncestor,
   inscriptionIds, // for each inscription transfer, we need to calculate one more input and one more output
 }) => {
   const resolvedReceiveAddresses = getBestReceiveAddresses({
@@ -52,7 +53,7 @@ export const selectUtxos = ({
     ? 'P2WPKH'
     : 'P2PKH'
 
-  const feeEstimator = getFeeEstimator(asset, { feePerKB: feeRate })
+  const feeEstimator = getFeeEstimator(asset, { feePerKB: feeRate, unconfirmedTxAncestor })
   const { currency } = asset
   if (!amount) amount = currency.ZERO
 
@@ -78,7 +79,7 @@ export const selectUtxos = ({
         feePerKB = feeRate
       }
 
-      const replaceFeeEstimator = getFeeEstimator(asset, { feePerKB })
+      const replaceFeeEstimator = getFeeEstimator(asset, { feePerKB, unconfirmedTxAncestor })
       // how to avoid replace tx inputs when inputs are ordinals? !!!!
       const inputs = UtxoCollection.fromJSON(tx.data.inputs, { currency })
       const outputs = isSendAll
@@ -118,7 +119,10 @@ export const selectUtxos = ({
 
           // Add a new UTXO and recalculate the fee
           additionalUtxos = additionalUtxos.addUtxo(confirmedUtxosArray.shift())
-          fee = replaceFeeEstimator({ inputs: inputs.union(additionalUtxos), outputs })
+          fee = replaceFeeEstimator({
+            inputs: inputs.union(additionalUtxos),
+            outputs,
+          })
         }
       }
       if (isSendAll || replaceTxAmount.add(additionalUtxos.value).gte(amount.add(fee))) {
@@ -224,6 +228,7 @@ export const getUtxosData = ({
   mustSpendUtxos,
   allowUnconfirmedRbfEnabledUtxos,
   inscriptionIds,
+  unconfirmedTxAncestor,
 }) => {
   const { selectedUtxos, replaceTx, fee } = selectUtxos({
     asset,
@@ -237,6 +242,7 @@ export const getUtxosData = ({
     disableReplacement,
     mustSpendUtxos,
     allowUnconfirmedRbfEnabledUtxos,
+    unconfirmedTxAncestor,
     inscriptionIds,
   })
 
@@ -252,7 +258,14 @@ export const getUtxosData = ({
   const spendableBalance = spendableUtxos.value
 
   const extraFee = selectedUtxos
-    ? asset.currency.baseUnit(getExtraFee({ asset, inputs: selectedUtxos, feePerKB: feeRate }))
+    ? asset.currency.baseUnit(
+        getExtraFee({
+          asset,
+          inputs: selectedUtxos,
+          feePerKB: feeRate,
+          unconfirmedTxAncestor,
+        })
+      )
     : asset.currency.ZERO
 
   const availableBalance = spendableBalance.sub(resolvedFee).clampLowerZero()

package/src/tx-log/bitcoin-monitor-scanner.js

@@ -603,6 +603,7 @@ export class BitcoinMonitorScanner {
           ordinalAddress,
           knownBalanceUtxoIds: latestAccountState.knownBalanceUtxoIds,
           mustAvoidUtxoIds: latestAccountState.mustAvoidUtxoIds,
+          additionalInscriptions: latestAccountState.additionalInscriptions,
         })
       : {}
 
@@ -674,6 +675,7 @@ export class BitcoinMonitorScanner {
       ordinalAddress: ordinalAddress,
       knownBalanceUtxoIds: latestAccountState.knownBalanceUtxoIds,
       mustAvoidUtxoIds: latestAccountState.mustAvoidUtxoIds,
+      additionalInscriptions: latestAccountState.additionalInscriptions,
     })
 
     return {

package/src/tx-log/bitcoin-monitor.js

@@ -3,7 +3,7 @@ import { isEmpty, isEqual, pickBy } from 'lodash'
 
 import { BaseMonitor } from '@exodus/asset-lib'
 import InsightWSClient from '../insight-api-client/ws'
-import { updateUnconfirmedAncestorData } from '../unconfirmed-ancestor-data'
+import { resolveUnconfirmedAncestorData } from '../unconfirmed-ancestor-data'
 import { BitcoinMonitorScanner } from './bitcoin-monitor-scanner'
 import { normalizeInsightConfig, toWSUrl } from '../insight-api-client/util'
 import ms from 'ms'
@@ -153,32 +153,35 @@ export class Monitor extends BaseMonitor {
         walletAccount,
       })
 
+      const newData = {}
       if (utxos || ordinalsUtxos) {
-        await aci.updateAccountState({
-          assetName,
-          walletAccount,
-          newData: pickBy(
+        Object.assign(
+          newData,
+          pickBy(
             {
               utxos,
               ordinalsUtxos,
             },
             Boolean
-          ),
-        })
+          )
+        )
       }
 
       if (txsToUpdate.length) {
-        const accountState = await aci.getAccountState({ assetName, walletAccount })
         await this.updateTxLog({ assetName, walletAccount, logItems: txsToUpdate })
-        if (['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)) {
-          updateUnconfirmedAncestorData({
-            asset,
-            walletAccount,
-            accountState,
+        if (utxos && ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)) {
+          const unconfirmedTxAncestor = await resolveUnconfirmedAncestorData({
+            utxos,
             insightClient: this.#insightClient,
           })
+          newData.mem = { unconfirmedTxAncestor }
         }
       }
+      await aci.updateAccountState({
+        assetName,
+        walletAccount,
+        newData,
+      })
     }
   }
 
@@ -228,20 +231,19 @@ export class Monitor extends BaseMonitor {
       walletAccount,
       refresh,
     })
-    const accountState = await aci.getAccountState({ assetName, walletAccount })
 
+    const newData = {}
     if (utxos || ordinalsUtxos)
-      await aci.updateAccountState({
-        assetName,
-        walletAccount,
-        newData: pickBy(
+      Object.assign(
+        newData,
+        pickBy(
           {
             utxos,
             ordinalsUtxos,
           },
           Boolean
-        ),
-      })
+        )
+      )
 
     if (!isEmpty(changedUnusedAddressIndexes)) {
       // Only for mobile atm, browser and hydra calculates from the latest txLogs
@@ -264,14 +266,19 @@ export class Monitor extends BaseMonitor {
     }
 
     // Move to after tick
-    if (['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)) {
-      updateUnconfirmedAncestorData({
-        asset: this.asset,
-        walletAccount,
-        accountState,
+    if (utxos && ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)) {
+      const unconfirmedTxAncestor = await resolveUnconfirmedAncestorData({
+        utxos,
         insightClient: this.#insightClient,
       })
+      newData.mem = { unconfirmedTxAncestor }
     }
+
+    await aci.updateAccountState({
+      assetName,
+      walletAccount,
+      newData,
+    })
   }
 
   #logWsStatus = (message, ...args) => {

package/src/tx-send/index.js

@@ -22,6 +22,7 @@ import {
 } from '../utxos-utils'
 
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
+import { getUnconfirmedTxAncestorMap } from '../unconfirmed-ancestor-data'
 
 const ASSETS_SUPPORTED_BIP_174 = [
   'bitcoin',
@@ -209,11 +210,13 @@ export const createAndBroadcastTXFactory = ({
   const insightClient = asset.baseAsset.insightClient
   const currency = asset.currency
   const feeData = await assetClientInterface.getFeeConfig({ assetName })
+  const unconfirmedTxAncestor = getUnconfirmedTxAncestorMap({ accountState })
   const usableUtxos = getUsableUtxos({
     asset,
     utxos: getUtxos({ accountState, asset }),
     feeData,
     txSet,
+    unconfirmedTxAncestor,
   })
 
   let replaceableTxs = findUnconfirmedSentRbfTxs(txSet)
@@ -257,9 +260,10 @@ export const createAndBroadcastTXFactory = ({
     feeRate: customFee || feeRate,
     receiveAddress: receiveAddress,
     isSendAll: resolvedIsSendAll,
-    getFeeEstimator: (asset, { feePerKB }) => getFeeEstimator(asset, feePerKB),
+    getFeeEstimator: (asset, { feePerKB, ...options }) => getFeeEstimator(asset, feePerKB, options),
     mustSpendUtxos: utxosToBump,
     allowUnconfirmedRbfEnabledUtxos,
+    unconfirmedTxAncestor,
     inscriptionIds,
   })
 

package/src/tx-utils.js

@@ -11,14 +11,18 @@ export const findUnconfirmedSentRbfTxs = (txSet) =>
       tx.data.inputs
   )
 
-export const findLargeUnconfirmedTxs = ({ assetName, txSet, feeRate, maxFee }) =>
+export const findLargeUnconfirmedTxs = ({ txSet, feeRate, maxFee, unconfirmedTxAncestor }) =>
   !txSet
     ? new Set()
     : new Set(
         Array.from(txSet)
           .filter((tx) => {
             if (!tx.pending) return false
-            const extraFee = resolveExtraFeeOfTx({ assetName, feeRate, txId: tx.txId })
+            const extraFee = resolveExtraFeeOfTx({
+              feeRate,
+              txId: tx.txId,
+              unconfirmedTxAncestor,
+            })
             return extraFee && extraFee > maxFee
           })
           .map((tx) => tx.txId)

package/src/unconfirmed-ancestor-data.js

@@ -1,46 +1,32 @@
-import { getUtxos } from './utxos-utils'
+import assert from 'minimalistic-assert'
 
-const dataMap = new Map()
-
-export async function updateUnconfirmedAncestorData({
-  asset,
-  walletAccount,
-  accountState,
-  insightClient,
-}) {
-  for (const [txId, stored] of dataMap) {
-    if (stored.walletAccount === walletAccount && stored.assetName === asset.name)
-      dataMap.delete(txId)
-  }
-
-  const utxos = getUtxos({ accountState, asset })
-    .toArray()
-    .filter((data) => {
-      return !data.confirmations || data.confirmations <= 0
-    })
-  const txIds = new Set(utxos.map(({ txId }) => txId))
+export async function resolveUnconfirmedAncestorData({ utxos, insightClient }) {
+  assert(utxos, 'utxos is required')
+  assert(insightClient, 'insightClient is required')
+  const dataMap = Object.create(null)
+  const unconfirmedUtxos = utxos.toArray().filter((data) => {
+    return !data.confirmations || data.confirmations <= 0
+  })
+  const txIds = new Set(unconfirmedUtxos.map(({ txId }) => txId))
   for (const txId of txIds) {
     try {
       const { size, fees } = await insightClient.fetchUnconfirmedAncestorData(txId)
       if (size !== 0) {
-        dataMap.set(txId, { assetName: asset.name, walletAccount, size, fees })
+        dataMap[txId] = { size, fees }
       }
     } catch (e) {
       console.warn(e)
     }
   }
+  return dataMap
 }
 
-function getUnconfirmedAncestorData({ txId, assetName }) {
-  const stored = dataMap.get(txId)
-  if (stored?.assetName === assetName) {
-    return { size: stored.size, fees: stored.fees }
-  }
-  return undefined
+export function getUnconfirmedTxAncestorMap({ accountState }) {
+  return accountState?.mem?.unconfirmedTxAncestor || Object.create(null)
 }
 
-export function resolveExtraFeeOfTx({ assetName, feeRate, txId }) {
-  const data = getUnconfirmedAncestorData({ assetName, txId })
+export function resolveExtraFeeOfTx({ feeRate, txId, unconfirmedTxAncestor }) {
+  const data = unconfirmedTxAncestor?.[txId]
   if (!data) return 0
   const { fees, size } = data
   // Get the difference in fee rate between ancestors and current estimate

package/src/utxos-utils.js

@@ -122,17 +122,54 @@ function isOrdinalUtxo({
   return hasOrdinals
 }
 
+export function mergeAdditionalInscriptions({ allUtxos, additionalInscriptions }) {
+  return UtxoCollection.fromArray(
+    allUtxos.toArray().map((utxo) => {
+      const inscriptions = additionalInscriptions
+        .filter((additionalInscription) => {
+          const forUtxo =
+            additionalInscription.vout === utxo.vout && additionalInscription.txId === utxo.txId
+          if (forUtxo) {
+            // avoid duplicated
+            return !utxo.inscriptions?.find(
+              (existingInscription) =>
+                existingInscription.inscriptionId === additionalInscription.inscriptionId
+            )
+          }
+          return forUtxo
+        })
+        .map((additionalInscription) => ({
+          inscriptionId: additionalInscription.inscriptionId,
+          offset: additionalInscription.offset || 0,
+        }))
+      if (inscriptions.length) {
+        utxo.inscriptions = [...(utxo.inscriptions || []), ...inscriptions]
+      }
+      return utxo
+    }),
+    {
+      currency: allUtxos.currency,
+    }
+  )
+}
+
 export function partitionUtxos({
   allUtxos,
   ordinalsEnabled,
   knownBalanceUtxoIds,
   ordinalAddress,
   mustAvoidUtxoIds,
+  additionalInscriptions,
 }) {
   assert(allUtxos, 'allUtxos is required')
   if (ordinalsEnabled) assert(ordinalAddress, 'ordinalAddress is required')
+
+  const expandedAllUtxos = ordinalsEnabled
+    ? mergeAdditionalInscriptions({ allUtxos, additionalInscriptions })
+    : allUtxos
+
   return {
-    utxos: allUtxos.filter(
+    utxos: expandedAllUtxos.filter(
       (utxo) =>
         !isOrdinalUtxo({
           utxo,
@@ -142,7 +179,7 @@ export function partitionUtxos({
           mustAvoidUtxoIds,
         })
     ),
-    ordinalsUtxos: allUtxos.filter((utxo) =>
+    ordinalsUtxos: expandedAllUtxos.filter((utxo) =>
       isOrdinalUtxo({
         utxo,
         ordinalsEnabled,
@@ -178,7 +215,7 @@ function filterDustUtxos({ utxos, feeData }) {
   return utxos
 }
 
-export function getUsableUtxos({ asset, utxos, feeData, txSet }) {
+export function getUsableUtxos({ asset, utxos, feeData, txSet, unconfirmedTxAncestor }) {
   assert(asset, 'asset is required')
   assert(utxos, 'utxos is required')
   assert(feeData, 'feeData is required')
@@ -191,10 +228,10 @@ export function getUsableUtxos({ asset, utxos, feeData, txSet }) {
   assert(typeof maxFee === 'number' && !Number.isNaN(maxFee), 'maxFee must be a number')
 
   const largeUnconfirmedTxs = findLargeUnconfirmedTxs({
-    assetName: asset.name,
     txSet,
     feeRate,
     maxFee,
+    unconfirmedTxAncestor,
   })
   const confirmedAndSmallUtxos =
     largeUnconfirmedTxs.size === 0