@exodus/bitcoin-api 2.6.8-hiro.0 → 2.6.8-hiro.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.6.8-hiro.0",
+  "version": "2.6.8-hiro.2",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [

package/src/account-state.js

@@ -10,6 +10,7 @@ export function createAccountState({ asset, ordinalsEnabled = false, brc20Enable
 
   if (ordinalsEnabled) {
     defaults.ordinalsUtxos = empty
+    defaults.knownBalanceUtxoIds = []
   }
 
   if (brc20Enabled) {

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

@@ -533,16 +533,6 @@ export class BitcoinMonitorScanner {
     // Keep new utxos when they intersect with the stored utxos.
     utxoCol = utxoCol.union(currentStoredUtxos).difference(utxosToRemoveCol)
 
-    if (this.#ordinalsEnabled) {
-      // copy ordinalsChange over
-      utxoCol.toArray().forEach((utxo) => {
-        const storedUtxo = currentStoredUtxos
-          .toArray()
-          .find((u2) => u2.txid === utxos.txid && u2.vout === utxo.vout)
-        utxo.ordinalsChange = storedUtxo?.ordinalsChange
-      })
-    }
-
     for (let tx of Object.values(unconfirmedTxsToCheck)) {
       existingTxs.push({ ...tx, dropped: true }) // TODO: this will decrease the chain index, it shouldn't be an issue considering the gap limit
       utxoCol = utxoCol.difference(utxoCol.getTxIdUtxos(tx.txId))
@@ -581,6 +571,7 @@ export class BitcoinMonitorScanner {
           allUtxos: utxoCol,
           ordinalsEnabled: this.#ordinalsEnabled,
           ordinalAddress,
+          knownBalanceUtxoIds: accountState.knownBalanceUtxoIds,
         })
       : {}
 
@@ -642,6 +633,7 @@ export class BitcoinMonitorScanner {
       allUtxos: txConfirmedUtxos,
       ordinalsEnabled: this.#ordinalsEnabled,
       ordinalAddress: await this.getOrdinalAddress({ walletAccount }),
+      knownBalanceUtxoIds: accountState.knownBalanceUtxoIds,
     })
 
     return {

package/src/tx-send/index.js

@@ -428,6 +428,8 @@ export const createAndBroadcastTXFactory = ({
 
   const { script, size } = getSizeAndChangeScript({ assetName, tx, rawTx, changeUtxoIndex, txId })
 
+  // for ordinals, used to allow users spending change utxos even when unconfirmed and ordinals are unknown
+  const knownBalanceUtxoIds = accountState.knownBalanceUtxoIds || []
   let remainingUtxos = usableUtxos.difference(selectedUtxos)
   if (changeUtxoIndex !== -1) {
     const address = Address.create(ourAddress.address, ourAddress.meta)
@@ -439,8 +441,9 @@ export const createAndBroadcastTXFactory = ({
       value: change,
       confirmations: 0,
       rbfEnabled,
-      ordinalsChange: ordinalsEnabled ? true : undefined,
     }
+
+    knownBalanceUtxoIds.push(`${changeUtxo.txId}:${changeUtxo.vout}`.toLowerCase())
     remainingUtxos = remainingUtxos.addUtxo(changeUtxo)
   }
   if (replaceTx) {
@@ -449,7 +452,7 @@ export const createAndBroadcastTXFactory = ({
 
   const remainingOrdinalsUtxos = transferOrdinalsUtxos
     ? currentOrdinalsUtxos.difference(transferOrdinalsUtxos)
-    : undefined
+    : currentOrdinalsUtxos
 
   await assetClientInterface.updateAccountState({
     assetName,
@@ -457,6 +460,7 @@ export const createAndBroadcastTXFactory = ({
     newData: {
       utxos: remainingUtxos,
       ordinalsUtxos: remainingOrdinalsUtxos,
+      knownBalanceUtxoIds,
     },
   })
 

package/src/utxos-utils.js

@@ -69,12 +69,14 @@ export function getValidInscriptions({ utxo }) {
   )
 }
 
-function isOrdinalUtxo({ utxo, ordinalsEnabled }) {
+function isOrdinalUtxo({ utxo, ordinalsEnabled, knownBalanceUtxoIds }) {
   if (!ordinalsEnabled) {
     return false
   }
 
-  if (utxo.ordinalsChange && !utxo.inscriptionsIndexed) {
+  const utxoId = `${utxo.txId}:${utxo.vout}`.toLowerCase()
+
+  if (knownBalanceUtxoIds?.includes(utxoId) && !utxo.inscriptionsIndexed) {
     return false // this allows users see and spend change balance after sending before hiro confirmation
   }
 
@@ -86,13 +88,16 @@ function isOrdinalUtxo({ utxo, ordinalsEnabled }) {
   return validInscriptions.length > 0
 }
 
-export function partitionUtxos({ allUtxos, ordinalsEnabled }) {
-  assert(allUtxos, 'allUtxos is required')
+export function partitionUtxos({ allUtxos, ordinalsEnabled, knownBalanceUtxoIds }) {
   assert(allUtxos, 'allUtxos is required')
   // assert(ordinalAddress, 'ordinalAddress is required') // not used atm we may need to tune by ordinalAddress when unconfirmed or rubbish inscriptions
   return {
-    utxos: allUtxos.filter((utxo) => !isOrdinalUtxo({ utxo, ordinalsEnabled })),
-    ordinalsUtxos: allUtxos.filter((utxo) => isOrdinalUtxo({ utxo, ordinalsEnabled })),
+    utxos: allUtxos.filter(
+      (utxo) => !isOrdinalUtxo({ utxo, ordinalsEnabled, knownBalanceUtxoIds })
+    ),
+    ordinalsUtxos: allUtxos.filter((utxo) =>
+      isOrdinalUtxo({ utxo, ordinalsEnabled, knownBalanceUtxoIds })
+    ),
   }
 }
 
@@ -113,12 +118,20 @@ export function getConfirmedOrRfbDisabledUtxos({ utxos, allowUnconfirmedRbfEnabl
   return utxos.filter((utxo) => utxo.confirmations > 0 || !utxo.rbfEnabled)
 }
 
+function filterDustUtxos({ utxos, feeData }) {
+  if (feeData.utxoDustValue) {
+    return utxos.filter((utxo) => utxo.value.toBaseNumber() > feeData.utxoDustValue)
+  }
+  return utxos
+}
+
 export function getUsableUtxos({ asset, utxos, feeData, txSet }) {
   assert(asset, 'asset is required')
   assert(utxos, 'utxos is required')
   assert(feeData, 'feeData is required')
   assert(txSet, 'txSet is required')
-  if (!['bitcoin', 'bitcointestnet', 'bitcoinregtest'].includes(asset.name)) return utxos
+  if (!['bitcoin', 'bitcointestnet', 'bitcoinregtest'].includes(asset.name))
+    return filterDustUtxos({ utxos, feeData })
   const { fastestFee } = feeData
   const feeRate = fastestFee.toBaseNumber()
   const maxFee = feeData.maxExtraCpfpFee
@@ -130,7 +143,9 @@ export function getUsableUtxos({ asset, utxos, feeData, txSet }) {
     feeRate,
     maxFee,
   })
-  return largeUnconfirmedTxs.size === 0
-    ? utxos
-    : utxos.filter((utxo) => !largeUnconfirmedTxs.has(utxo.txId))
+  const confirmedAndSmallUtxos =
+    largeUnconfirmedTxs.size === 0
+      ? utxos
+      : utxos.filter((utxo) => !largeUnconfirmedTxs.has(utxo.txId))
+  return filterDustUtxos({ utxos: confirmedAndSmallUtxos, feeData })
 }