@exodus/bitcoin-api 2.6.8-hiro.1 → 2.6.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.6.8-hiro.1",
+  "version": "2.6.8",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -42,5 +42,6 @@
     "@scure/base": "^1.1.3",
     "@scure/btc-signer": "^1.1.0",
     "jest-when": "^3.5.1"
-  }
+  },
+  "gitHead": "eae322a1c75f9cdaebc919af510619cb59ba4c0e"
 }

package/src/account-state.js

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

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

@@ -67,6 +67,7 @@ export class BitcoinMonitorScanner {
 
     const storedUtxos = getUtxos({ asset, accountState })
     const storedOrdinalUtxos = getOrdinalsUtxos({ asset, accountState })
+    const ordinalAddress = await this.getOrdinalAddress({ walletAccount })
 
     const currentStoredUtxos = storedUtxos.union(storedOrdinalUtxos)
 
@@ -89,9 +90,7 @@ export class BitcoinMonitorScanner {
       : (txs) =>
           txs.filter((tx) => {
             const txItem = currentTxs.get(tx.txid)
-            const confirmed = txItem && txItem.confirmed
-            const inscriptionsIndexed = txItem?.data?.inscriptionsIndexed
-            return confirmed && (!this.#ordinalsEnabled || inscriptionsIndexed)
+            return txItem && txItem.confirmed
           }).length >= txs.length
 
     const unusedAddressIndexes = await assetClientInterface.getUnusedAddressIndexes({
@@ -345,15 +344,6 @@ export class BitcoinMonitorScanner {
         currencies: { [assetName]: currency },
       }
 
-      if (this.#ordinalsEnabled) {
-        txLogItem.data = {
-          ...txLogItem.data,
-          inscriptionsIndexed: txItem.inscriptionsIndexed,
-          sentInscriptions: [],
-          receivedInscriptions: [],
-        }
-      }
-
       let from = []
 
       // if txItem.vin has an address that matches ours, means we've spent this tx
@@ -371,13 +361,8 @@ export class BitcoinMonitorScanner {
         txLogItem.coinAmount = txLogItem.coinAmount.sub(currency.defaultUnit(vin.value))
         isSent = true
         txLogItem.data.sent = []
-        if (this.#ordinalsEnabled && vin.inscriptions) {
-          txLogItem.data.sentInscriptions.push(
-            ...vin.inscriptions.map((i) => ({
-              ...i,
-              value: currency.defaultUnit(vin.value).toBaseNumber(),
-            }))
-          )
+        if (ordinalAddress && address.toString() === ordinalAddress.toString()) {
+          txLogItem.data.isInscriptionSent = true
         }
 
         // this is only used to exclude the utxos in the reducer which is why we don't care about the other fields
@@ -447,13 +432,8 @@ export class BitcoinMonitorScanner {
           txLogItem.data.changeAddress = address
         }
 
-        if (this.#ordinalsEnabled && vout.inscriptions) {
-          txLogItem.data.receivedInscriptions.push(
-            ...vout.inscriptions.map((i) => ({
-              ...i,
-              value: currency.defaultUnit(vout.value).toBaseNumber(),
-            }))
-          )
+        if (ordinalAddress && address.toString() === ordinalAddress.toString()) {
+          txLogItem.data.isInscriptionReceived = true
         }
 
         // it was sent to us...
@@ -470,11 +450,6 @@ export class BitcoinMonitorScanner {
           rbfEnabled: txItem.rbf,
         }
 
-        if (this.#ordinalsEnabled) {
-          output.inscriptionsIndexed = txItem.inscriptionsIndexed
-          output.inscriptions = vout.inscriptions || []
-        }
-
         if (this.#shouldExcludeVoutUtxo({ asset, output, txItem, vout })) {
           return
         }
@@ -565,13 +540,10 @@ export class BitcoinMonitorScanner {
       return !isEqual(chain, originalChain.chain)
     })
 
-    const ordinalAddress = await this.getOrdinalAddress({ walletAccount })
     const utxosData = utxoCol
       ? partitionUtxos({
           allUtxos: utxoCol,
-          ordinalsEnabled: this.#ordinalsEnabled,
           ordinalAddress,
-          knownBalanceUtxoIds: accountState.knownBalanceUtxoIds,
         })
       : {}
 
@@ -631,9 +603,7 @@ export class BitcoinMonitorScanner {
 
     const { utxos, ordinalsUtxos } = partitionUtxos({
       allUtxos: txConfirmedUtxos,
-      ordinalsEnabled: this.#ordinalsEnabled,
       ordinalAddress: await this.getOrdinalAddress({ walletAccount }),
-      knownBalanceUtxoIds: accountState.knownBalanceUtxoIds,
     })
 
     return {

package/src/tx-send/index.js

@@ -14,12 +14,7 @@ import {
   createOutput as dogecoinCreateOutput,
 } from './dogecoin'
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
-import {
-  getOrdinalsUtxos,
-  getTransferOrdinalsUtxos,
-  getUsableUtxos,
-  getUtxos,
-} from '../utxos-utils'
+import { getOrdinalsUtxos, getUsableUtxos, getUtxos } from '../utxos-utils'
 
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
 
@@ -137,7 +132,6 @@ export const createAndBroadcastTXFactory = ({
   getFeeEstimator,
   getSizeAndChangeScript = getSizeAndChangeScriptFactory(), // for decred customizations
   allowUnconfirmedRbfEnabledUtxos,
-  ordinalsEnabled = false,
 }) => async (
   { asset: maybeToken, walletAccount, address, amount: tokenAmount, options },
   { assetClientInterface }
@@ -173,11 +167,6 @@ export const createAndBroadcastTXFactory = ({
 
   const inscriptionIds = nft?.tokenId ? [nft?.tokenId] : brc20 ? brc20.inscriptionIds : undefined
 
-  assert(
-    ordinalsEnabled || !inscriptionIds,
-    'inscriptions cannot be sent when ordinalsEnabled=false '
-  )
-
   const shuffle = (list) => {
     return inscriptionIds ? list : doShuffle(list) // don't shuffle when sending ordinal!!!!
   }
@@ -203,9 +192,26 @@ export const createAndBroadcastTXFactory = ({
 
   const currentOrdinalsUtxos = getOrdinalsUtxos({ accountState, asset })
   const transferOrdinalsUtxos = inscriptionIds
-    ? getTransferOrdinalsUtxos({ inscriptionIds, ordinalsUtxos: currentOrdinalsUtxos })
+    ? currentOrdinalsUtxos.filter((utxo) => inscriptionIds.includes(utxo.inscriptionId)) /// this could be bulk transfer if multiple inscription ids are provided
     : undefined
 
+  if (inscriptionIds) {
+    assert(
+      transferOrdinalsUtxos?.size === inscriptionIds.length,
+      `Expected ordinal utxos ${inscriptionIds.length}. Found: ${transferOrdinalsUtxos?.size || 0}`
+    )
+
+    // const unconfirmedOrdinalUtxos = transferOrdinalsUtxos
+    //   .toArray()
+    //   .filter((ordinalUtxo) => !(ordinalUtxo.confirmations > 0))
+    // assert(
+    //   !unconfirmedOrdinalUtxos.length,
+    //   `OrdinalUtxo with inscription ids ${unconfirmedOrdinalUtxos
+    //     .map((utxo) => utxo.inscriptionId)
+    //     .join(', ')} have not confirmed yet`
+    // )
+  }
+
   const insightClient = asset.baseAsset.insightClient
   const currency = asset.currency
   const feeData = await assetClientInterface.getFeeConfig({ assetName })
@@ -428,8 +434,6 @@ 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)
@@ -442,8 +446,6 @@ export const createAndBroadcastTXFactory = ({
       confirmations: 0,
       rbfEnabled,
     }
-
-    knownBalanceUtxoIds.push(`${changeUtxo.txId}:${changeUtxo.vout}`.toLowerCase())
     remainingUtxos = remainingUtxos.addUtxo(changeUtxo)
   }
   if (replaceTx) {
@@ -460,7 +462,6 @@ export const createAndBroadcastTXFactory = ({
     newData: {
       utxos: remainingUtxos,
       ordinalsUtxos: remainingOrdinalsUtxos,
-      knownBalanceUtxoIds,
     },
   })
 
@@ -521,16 +522,7 @@ export const createAndBroadcastTXFactory = ({
           inputs: selectedUtxos.toJSON(),
           replacedTxId: replaceTx ? replaceTx.txId : undefined,
           nftId: nft ? `${assetName}:${nft.tokenId}` : undefined, // it allows BE to load the nft info while the nft is in transit
-          inscriptionsIndexed: ordinalsEnabled ? true : undefined,
-          sentInscriptions: inscriptionIds
-            ? inscriptionIds.map((inscriptionId) => {
-                return {
-                  inscriptionId,
-                  offset: 0,
-                  value: 0,
-                }
-              })
-            : undefined,
+          inscriptionIds: inscriptionIds,
         },
       },
     ],

package/src/utxos-utils.js

@@ -5,46 +5,6 @@ import assert from 'minimalistic-assert'
 
 const MAX_ORDINAL_VALUE_POSTAGE = 10000
 
-export function getTransferOrdinalsUtxos({ inscriptionIds, ordinalsUtxos }) {
-  const transferOrdinalsUtxos = ordinalsUtxos.filter((utxo) =>
-    utxo.inscriptions?.some((i) => inscriptionIds.includes(i.inscriptionId))
-  )
-  const unsafeInscriptions = transferOrdinalsUtxos.toArray().flatMap(
-    (utxo) =>
-      utxo.inscriptions?.filter((i) => {
-        const validInscription = isValidInscription({
-          value: utxo.value.toBaseNumber(),
-          offset: i.offset,
-        })
-        return validInscription && !inscriptionIds.includes(i.inscriptionId)
-      }) || []
-  )
-  assert(
-    !unsafeInscriptions.length,
-    `The following inscriptions are unsafe ${unsafeInscriptions.map(
-      (i) => i.inscriptionId
-    )} when ${inscriptionIds} should be spent`
-  )
-
-  const transferInscriptionIds = transferOrdinalsUtxos
-    .toArray()
-    .flatMap((utxo) => utxo.inscriptions)
-    .filter(({ inscriptionId }) => inscriptionIds.includes(inscriptionId))
-
-  assert(
-    transferInscriptionIds.length === inscriptionIds.length,
-    `Expected inscriptions ${inscriptionIds.length}. Found: ${transferInscriptionIds.length}`
-  )
-  return transferOrdinalsUtxos
-}
-
-export function isValidInscription({ value, offset }) {
-  assert(typeof value === 'number', 'value must be a number')
-  assert(typeof offset === 'number', 'offset must be a number')
-  // value >= 0 in case offset, alternatively convert to string/ln
-  return (value >= 0 && value <= MAX_ORDINAL_VALUE_POSTAGE) || offset === 0
-}
-
 export function getUtxos({ accountState, asset }) {
   return (
     accountState?.utxos ||
@@ -63,41 +23,31 @@ export function getOrdinalsUtxos({ accountState, asset }) {
   )
 }
 
-export function getValidInscriptions({ utxo }) {
-  return (utxo.inscriptions || []).filter((i) =>
-    isValidInscription({ value: utxo.value.toBaseNumber(), offset: i.offset })
-  )
-}
-
-function isOrdinalUtxo({ utxo, ordinalsEnabled, knownBalanceUtxoIds }) {
-  if (!ordinalsEnabled) {
+function isOrdinalUtxo({ utxo, ordinalAddress }) {
+  if (utxo.inscriptionId) {
+    return true
+  }
+  if (!ordinalAddress) {
+    // exclude utxos splitting
     return false
   }
 
-  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
+  if (utxo.address.toString() === ordinalAddress.toString()) {
+    return true // we assume any utxo to the ordinal address is a ordinal utxos just in case
   }
 
-  if (!utxo.inscriptionsIndexed) {
-    return true
+  if (utxo.confirmations) {
+    return false
   }
 
-  const validInscriptions = getValidInscriptions({ utxo })
-  return validInscriptions.length > 0
+  return utxo.value.toBaseNumber() <= MAX_ORDINAL_VALUE_POSTAGE // while unconfirmed, put  < 10000- sats in the ordinal utxos box just in case
 }
 
-export function partitionUtxos({ allUtxos, ordinalsEnabled, knownBalanceUtxoIds }) {
+export function partitionUtxos({ allUtxos, ordinalAddress }) {
   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, knownBalanceUtxoIds })
-    ),
-    ordinalsUtxos: allUtxos.filter((utxo) =>
-      isOrdinalUtxo({ utxo, ordinalsEnabled, knownBalanceUtxoIds })
-    ),
+    utxos: allUtxos.filter((utxo) => !isOrdinalUtxo({ utxo, ordinalAddress })),
+    ordinalsUtxos: allUtxos.filter((utxo) => isOrdinalUtxo({ utxo, ordinalAddress })),
   }
 }