@exodus/bitcoin-api 2.3.7 → 2.3.8-ordinals.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.3.7",
+  "version": "2.3.8-ordinals.1",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -40,6 +40,5 @@
   "devDependencies": {
     "@exodus/bitcoin-meta": "^1.0.1",
     "jest-when": "^3.5.1"
-  },
-  "gitHead": "7a83d2ff5d672615938fba868779293df74ff51d"
+  }
 }

package/src/account-state.js

@@ -1,11 +1,18 @@
 import { AccountState, UtxoCollection } from '@exodus/models'
 
-export function createAccountState({ asset }) {
+export function createAccountState({ asset, ordinalsEnabled = false }) {
+  const empty = UtxoCollection.createEmpty({
+    currency: asset.currency,
+  })
+  const defaults = ordinalsEnabled
+    ? {
+        utxos: empty,
+        ordinalsUtxos: empty,
+      }
+    : {
+        utxos: empty,
+      }
   return class BitcoinAccountState extends AccountState {
-    static defaults = {
-      utxos: UtxoCollection.createEmpty({
-        currency: asset.currency,
-      }),
-    }
+    static defaults = defaults
   }
 }

package/src/address-utils.js

@@ -0,0 +1,24 @@
+import assert from 'minimalistic-assert'
+
+export function isOrdinalAddress(address, ordinalChainIndex) {
+  assert(typeof ordinalChainIndex === 'number', `ordinalChainIndex must be a number`)
+  return parsePath(address)[0] === ordinalChainIndex
+}
+
+export function isReceiveAddress(address): boolean {
+  return parsePath(address)[0] === 0
+}
+
+export function isChangeAddress(address): boolean {
+  return parsePath(address)[0] === 1
+}
+
+function parsePath(address) {
+  assert(
+    address.meta.path,
+    `address parameter ${address} does not have a meta.path. Is it a valid Address object?`
+  )
+  const path = address.meta.path
+  const p1 = path ? path.replace('m/', '').split('/') : ['0', '0']
+  return p1.map((i) => parseInt(i, 10))
+}

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

@@ -14,7 +14,13 @@ export class GetFeeResolver {
     this.#allowUnconfirmedRbfEnabledUtxos = allowUnconfirmedRbfEnabledUtxos
   }
 
-  getFee = ({ asset, accountState, txSet, feeData, amount, customFee, isSendAll }) => {
+  getFee = ({ asset, accountState, txSet, feeData, amount, customFee, isSendAll, nft }) => {
+    const inscriptionId = nft?.tokenId
+    if (inscriptionId) {
+      assert(!amount, 'Only inscriptionId or amount is allowed!!!')
+      assert(!isSendAll, 'Only inscriptionId or isSendAll:true is allowed!!!')
+    }
+
     const { resolvedFee, extraFee } = this.#getUtxosData({
       asset,
       accountState,
@@ -23,6 +29,7 @@ export class GetFeeResolver {
       amount,
       customFee,
       isSendAll,
+      inscriptionId,
     })
     return { fee: resolvedFee, extraFee }
   }

package/src/move-funds.js

@@ -27,6 +27,16 @@ export const getAddressesFromPrivateKeyFactory = ({ purposes, keys, coinInfo })
   }
 }
 
+export const renderAddresses = (addresses) => {
+  if (!addresses.length) {
+    return ''
+  }
+  if (addresses.length === 1) {
+    return `${addresses[0]}`
+  }
+  return `${addresses.slice(0, -1).join(', ')}, or ${addresses[addresses.length - 1]}`
+}
+
 export const moveFundsFactory = ({
   asset,
   insightClient,
@@ -93,7 +103,8 @@ export const moveFundsFactory = ({
       }
       throw new MoveFundsError('balance-zero', {
         ...formatProps,
-        fromAddress: `${addresses.slice(0, -1).join(', ')}, or ${addresses[addresses.length - 1]}`,
+        fromAddress: renderAddresses(addresses),
+        fromAddresses: addresses.map(String),
       })
     }
 

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

@@ -1,28 +1,17 @@
 /* @flow */
 import { orderTxs } from '../insight-api-client/util'
 import { Address, UtxoCollection } from '@exodus/models'
-import { isEqual, compact, uniq } from 'lodash'
+import { compact, isEqual, uniq } from 'lodash'
 import ms from 'ms'
 
 import assert from 'minimalistic-assert'
-import { getUtxos } from '../utxos-utils'
+import { isChangeAddress, isReceiveAddress } from '../address-utils'
+
+import { getOrdinalsUtxos, getUtxos, partitionUtxos } from '../utxos-utils'
 
 // Time to check whether to drop a sent tx
 const SENT_TIME_TO_DROP = ms('2m')
 
-function isReceiveAddress(addr: Address): boolean {
-  return parsePath(addr.meta.path)[0] === 0
-}
-function isChangeAddress(addr: Address): boolean {
-  return parsePath(addr.meta.path)[0] === 1
-}
-
-function parsePath(path) {
-  let p1 = path ? path.replace('m/', '').split('/') : ['0', '0']
-  p1 = p1.map((i) => parseInt(i, 10))
-  return p1
-}
-
 export class BitcoinMonitorScanner {
   #asset
   #insightClient
@@ -30,7 +19,8 @@ export class BitcoinMonitorScanner {
   #txFetchLimitResolver
   #shouldExcludeVoutUtxo
   #yieldToUI
-
+  #ordinalsEnabled
+  #ordinalChainIndex
   constructor({
     asset,
     assetClientInterface,
@@ -38,6 +28,8 @@ export class BitcoinMonitorScanner {
     yieldToUI = () => {},
     shouldExcludeVoutUtxo = () => false,
     txFetchLimitResolver = ({ refresh }) => (refresh ? 50 : 10),
+    ordinalsEnabled,
+    ordinalChainIndex,
   }) {
     assert(asset, 'asset is required!')
     assert(assetClientInterface, 'assetClientInterface is required!')
@@ -51,6 +43,8 @@ export class BitcoinMonitorScanner {
     this.#assetClientInterface = assetClientInterface
     this.#txFetchLimitResolver = txFetchLimitResolver
     this.#shouldExcludeVoutUtxo = shouldExcludeVoutUtxo
+    this.#ordinalsEnabled = ordinalsEnabled
+    this.#ordinalChainIndex = ordinalChainIndex
   }
 
   async rescanBlockchainInsight({ walletAccount, refresh }) {
@@ -64,7 +58,11 @@ export class BitcoinMonitorScanner {
     const accountState = await assetClientInterface.getAccountState({ assetName, walletAccount })
     const currency = asset.currency
     const currentTxs = await assetClientInterface.getTxLog({ assetName, walletAccount })
-    const currentUtxos = getUtxos({ asset, accountState })
+
+    const regularUtxos = getUtxos({ asset, accountState })
+    const ordinalsUtxos = getOrdinalsUtxos({ asset, accountState })
+
+    const currentUtxos = regularUtxos.union(ordinalsUtxos)
 
     const currentTime = new Date().getTime()
     const unconfirmedTxsToCheck = Array.from(currentTxs).reduce((txs, tx) => {
@@ -221,6 +219,21 @@ export class BitcoinMonitorScanner {
         })
         .flat()
 
+      if (
+        fetchCount === 0 &&
+        this.#ordinalsEnabled &&
+        this.#ordinalChainIndex > 1 &&
+        purposes.includes(86)
+      ) {
+        // this is the ordinal address
+        chainObjects.push({
+          purpose: 86,
+          chainIndex: this.#ordinalChainIndex,
+          startAddressIndex: 0,
+          endAddressIndex: 1,
+        })
+      }
+
       const addresses = await aggregateAddresses(chainObjects)
 
       const txs = await fetchAllTxs(addresses)
@@ -243,6 +256,11 @@ export class BitcoinMonitorScanner {
           const metaAddressIndex = parseInt(pd[2])
           const addressString = String(address)
           const purposeToUpdate = purposeMap[addressString]
+
+          if (metaChainIndex === this.#ordinalChainIndex && this.#ordinalChainIndex > 1) {
+            return
+          }
+
           if (!purposeToUpdate) {
             console.warn(`${assetName}: Cannot resolve purpose from address ${addressString}`)
             return
@@ -310,6 +328,7 @@ export class BitcoinMonitorScanner {
           rbfEnabled: txItem.rbf,
           blocksSeen: 0,
         },
+        currencies: { [assetName]: currency },
       }
 
       let from = []
@@ -345,13 +364,15 @@ export class BitcoinMonitorScanner {
         ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(asset.name)
       ) {
         txLogItem.data.inputs = UtxoCollection.fromArray(
-          txItem.vin.map((vin) => ({
-            address: addrMap[vin.addr],
-            script: asset.address.toScriptPubKey(vin.addr).toString('hex'),
-            txId: vin.txid,
-            vout: vin.vout,
-            value: currency.defaultUnit(vin.value || 0),
-          }))
+          txItem.vin
+            .filter((vin) => addrMap[vin.addr])
+            .map((vin) => ({
+              address: addrMap[vin.addr],
+              script: asset.address.toScriptPubKey(vin.addr).toString('hex'),
+              txId: vin.txid,
+              vout: vin.vout,
+              value: currency.defaultUnit(vin.value || 0),
+            }))
         ).toJSON()
       }
 
@@ -501,7 +522,9 @@ export class BitcoinMonitorScanner {
     return {
       txsToUpdate: existingTxs,
       txsToAdd: newTxs,
-      utxos: utxoCol,
+      ...(utxoCol
+        ? partitionUtxos({ allUtxos: utxoCol, ordinalChainIndex: this.#ordinalChainIndex })
+        : {}),
       changedUnusedAddressIndexes,
     }
   }
@@ -513,12 +536,14 @@ export class BitcoinMonitorScanner {
 
     const accountState = await aci.getAccountState({ assetName, walletAccount })
 
-    const allStoredUtxos = getUtxos({ accountState, asset })
+    const storedUtxos = getUtxos({ accountState, asset })
+    const storedOrdinalsUtxos = getOrdinalsUtxos({ accountState, asset })
+    const allStoredUtxos = storedUtxos.union(storedOrdinalsUtxos)
 
     const currentTxs = Array.from(await aci.getTxLog({ assetName, walletAccount }))
 
     const unconfirmedTxIds = uniq([
-      ...allStoredUtxos
+      ...storedUtxos
         .toArray()
         .filter((utxos) => !utxos.confirmations)
         .map((utxos) => utxos.txId),
@@ -548,12 +573,16 @@ export class BitcoinMonitorScanner {
       })
       .filter((tx) => Object.keys(tx).length > 1)
 
-    const txConfirmedUtxos = confirmationsList.length
-      ? allStoredUtxos.updateConfirmations(confirmationsList)
-      : null
+    const txConfirmedUtxos = allStoredUtxos.updateConfirmations(confirmationsList)
+
+    const { utxos, ordinalsUtxos } = partitionUtxos({
+      allUtxos: txConfirmedUtxos,
+      ordinalChainIndex: this.#ordinalChainIndex,
+    })
 
     return {
-      utxos: txConfirmedUtxos,
+      utxos: utxos.equals(storedUtxos) ? null : utxos,
+      ordinalsUtxos: ordinalsUtxos.equals(storedOrdinalsUtxos) ? null : ordinalsUtxos,
       txsToUpdate: updatedPropertiesTxs,
     }
   }

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

@@ -1,5 +1,5 @@
 import assert from 'minimalistic-assert'
-import { isEmpty, isEqual } from 'lodash'
+import { isEmpty, isEqual, pickBy } from 'lodash'
 
 import { BaseMonitor } from '@exodus/asset-lib'
 import InsightWSClient from '../insight-api-client/ws'
@@ -142,17 +142,21 @@ export class Monitor extends BaseMonitor {
     const assetName = asset.name
     const walletAccounts = await aci.getWalletAccounts({ assetName })
     for (const walletAccount of walletAccounts) {
-      const { txsToUpdate, utxos } = await this.#scanner.rescanOnNewBlock({
+      const { txsToUpdate, utxos, ordinalsUtxos } = await this.#scanner.rescanOnNewBlock({
         walletAccount,
       })
 
-      if (utxos) {
+      if (utxos || ordinalsUtxos) {
         await aci.updateAccountState({
           assetName,
           walletAccount,
-          newData: {
-            utxos,
-          },
+          newData: pickBy(
+            {
+              utxos,
+              ordinalsUtxos,
+            },
+            Boolean
+          ),
         })
       }
 
@@ -211,6 +215,7 @@ export class Monitor extends BaseMonitor {
       txsToAdd,
       txsToUpdate,
       utxos,
+      ordinalsUtxos,
       changedUnusedAddressIndexes,
     } = await this.#scanner.rescanBlockchainInsight({
       walletAccount,
@@ -218,7 +223,18 @@ export class Monitor extends BaseMonitor {
     })
     const accountState = await aci.getAccountState({ assetName, walletAccount })
 
-    if (utxos) await aci.updateAccountState({ assetName, walletAccount, newData: { utxos } })
+    if (utxos || ordinalsUtxos)
+      await aci.updateAccountState({
+        assetName,
+        walletAccount,
+        newData: pickBy(
+          {
+            utxos,
+            ordinalsUtxos,
+          },
+          Boolean
+        ),
+      })
 
     if (!isEmpty(changedUnusedAddressIndexes)) {
       // Only for mobile atm, browser and hydra calculates from the latest txLogs

package/src/tx-send/index.js

@@ -1,6 +1,6 @@
 import assert from 'minimalistic-assert'
 // Using this notation so it can be mocked by jest
-import shuffle from 'lodash/shuffle'
+import doShuffle from 'lodash/shuffle'
 
 import { UtxoCollection, Address } from '@exodus/models'
 import { retry } from '@exodus/simple-retry'
@@ -14,7 +14,7 @@ import {
   createOutput as dogecoinCreateOutput,
 } from './dogecoin'
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
-import { getUsableUtxos, getUtxos } from '../utxos-utils'
+import { getOrdinalsUtxos, getUsableUtxos, getUtxos } from '../utxos-utils'
 
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
 
@@ -130,13 +130,25 @@ export const createAndBroadcastTXFactory = ({
     isBip70,
     bumpTxId,
     isRbfAllowed = true,
+    nft,
   } = options
 
+  const inscriptionId = nft?.tokenId
+
+  const shuffle = (list) => {
+    return inscriptionId ? list : doShuffle(list) // don't shuffle when sending ordinal!!!!
+  }
+
   assert(assetClientInterface, `assetClientInterface must be supplied in sendTx for ${asset.name}`)
   assert(
     address || bumpTxId,
     'should not be called without either a receiving address or to bump a tx'
   )
+  if (inscriptionId) {
+    assert(!bumpTxId, 'only inscriptionId or bumpTxId must be provided')
+    assert(!amount, 'only inscriptionId or amount must be provided')
+    assert(address, 'address must be provided when sending an ordinal')
+  }
 
   const assetName = asset.name
 
@@ -152,6 +164,25 @@ export const createAndBroadcastTXFactory = ({
 
   const txSet = await assetClientInterface.getTxLog({ assetName, walletAccount })
   const accountState = await assetClientInterface.getAccountState({ assetName, walletAccount })
+
+  const currentOrdinalsUtxos = getOrdinalsUtxos({ accountState, asset })
+  const transferOrdinalsUtxos = inscriptionId
+    ? currentOrdinalsUtxos.filter((utxo) => utxo.inscriptionId === inscriptionId) /// this could be bulk transfer if multiple inscription ids are provided
+    : undefined
+
+  if (inscriptionId) {
+    assert(
+      transferOrdinalsUtxos?.size === 1,
+      `There should only be one utxo with inscription id ${inscriptionId}. Found: ${transferOrdinalsUtxos?.size ||
+        0}`
+    )
+
+    assert(
+      transferOrdinalsUtxos.toArray().every((ordinalUtxo) => ordinalUtxo.confirmations > 0),
+      `OrdinalUtxo for inscription id ${inscriptionId} has not confirmed yet`
+    )
+  }
+
   const insightClient = asset.baseAsset.insightClient
   const currency = asset.currency
   const feeData = await assetClientInterface.getFeeConfig({ assetName })
@@ -190,9 +221,10 @@ export const createAndBroadcastTXFactory = ({
     }
   }
 
-  const sendAmount = bumpTxId ? asset.currency.ZERO : amount.toDefault()
+  const sendAmount = bumpTxId || transferOrdinalsUtxos ? asset.currency.ZERO : amount.toDefault()
   let receiveAddress = bumpTxId ? (replaceableTxs.length > 0 ? null : 'P2WPKH') : address
   const feeRate = feeData.feePerKB
+  const resolvedIsSendAll = (!rbfEnabled && feePerKB) || transferOrdinalsUtxos ? false : isSendAll
 
   let { selectedUtxos, fee, replaceTx } = selectUtxos({
     asset,
@@ -201,7 +233,7 @@ export const createAndBroadcastTXFactory = ({
     amount: sendAmount,
     feeRate: customFee || feeRate,
     receiveAddress,
-    isSendAll: !rbfEnabled && feePerKB ? false : isSendAll,
+    isSendAll: resolvedIsSendAll,
     getFeeEstimator: (asset, { feePerKB }) => getFeeEstimator(asset, feePerKB),
     mustSpendUtxos: utxosToBump,
     allowUnconfirmedRbfEnabledUtxos,
@@ -217,7 +249,9 @@ export const createAndBroadcastTXFactory = ({
   if (bumpTxId && (!selectedUtxos || (replaceTx && replaceTx.txId !== bumpTxId))) {
     throw new Error(`Unable to bump ${bumpTxId}`)
   }
-
+  if (transferOrdinalsUtxos) {
+    selectedUtxos = transferOrdinalsUtxos.union(selectedUtxos)
+  }
   if (replaceTx) {
     replaceTx = replaceTx.clone()
     replaceTx = replaceTx.update({ data: { ...replaceTx.data } })
@@ -241,14 +275,25 @@ export const createAndBroadcastTXFactory = ({
     outputs = []
   }
   if (address) {
-    outputs.push(createOutput(assetName, address, sendAmount))
+    if (transferOrdinalsUtxos) {
+      outputs.push(
+        ...transferOrdinalsUtxos
+          .toArray()
+          .map((ordinalUtxo) => createOutput(assetName, address, ordinalUtxo.value))
+      )
+    } else {
+      outputs.push(createOutput(assetName, address, sendAmount))
+    }
   }
 
   const totalAmount = replaceTx
     ? replaceTx.data.sent.reduce((total, { amount }) => total.add(amount), sendAmount)
     : sendAmount
 
-  const change = selectedUtxos.value.sub(totalAmount).sub(fee)
+  const change = selectedUtxos.value
+    .sub(totalAmount)
+    .sub(transferOrdinalsUtxos?.value || currency.ZERO)
+    .sub(fee)
   const dust = getDustValue(asset)
   let ourAddress = replaceTx?.data?.changeAddress || changeAddress
   if (asset.address.toLegacyAddress) {
@@ -362,11 +407,17 @@ export const createAndBroadcastTXFactory = ({
     remainingUtxos = remainingUtxos.difference(remainingUtxos.getTxIdUtxos(replaceTx.txId))
   }
 
+  const remainingOrdinalsUtxos = transferOrdinalsUtxos
+    ? currentOrdinalsUtxos.difference(transferOrdinalsUtxos)
+    : undefined
   await assetClientInterface.updateAccountState({
     assetName,
     walletAccount,
     accountState,
-    newData: { utxos: remainingUtxos },
+    newData: {
+      utxos: remainingUtxos,
+      ordinalsUtxos: remainingOrdinalsUtxos,
+    },
   })
 
   // There are two cases of bumping, replacing or chaining a self-send.
@@ -406,6 +457,7 @@ export const createAndBroadcastTXFactory = ({
           blocksSeen: 0,
           inputs: selectedUtxos.toJSON(),
           replacedTxId: replaceTx ? replaceTx.txId : undefined,
+          nftId: inscriptionId ? `${assetName}:${inscriptionId}` : undefined, // it allows BE to load the nft info while the nft is in transit
         },
       },
     ],
@@ -442,6 +494,7 @@ function defaultCreateInputs(utxos, rbfEnabled) {
     value: parseInt(utxo.value.toBaseString(), 10),
     script: utxo.script,
     sequence: getTxSequence(rbfEnabled),
+    inscriptionId: utxo.inscriptionId,
   }))
 }
 

package/src/utxos-utils.js

@@ -2,6 +2,8 @@
 import { UtxoCollection } from '@exodus/models'
 import { findLargeUnconfirmedTxs } from './tx-utils'
 import assert from 'minimalistic-assert'
+import { isOrdinalAddress } from './address-utils'
+// import { isOrdinalAddress } from './address-utils'
 
 export function getUtxos({ accountState, asset }) {
   return (
@@ -12,6 +14,38 @@ export function getUtxos({ accountState, asset }) {
   )
 }
 
+export function getOrdinalsUtxos({ accountState, asset }) {
+  return (
+    accountState?.ordinalsUtxos ||
+    UtxoCollection.createEmpty({
+      currency: asset.currency,
+    })
+  )
+}
+
+const ordinalValueUnconfirmedThreshold = 10000
+
+function isOrdinalUtxo({ utxo, ordinalChainIndex }) {
+  if (utxo.inscriptionId) {
+    return true
+  }
+  const maybeAnOrdinalAddress =
+    ordinalChainIndex && isOrdinalAddress(utxo.address, ordinalChainIndex) // if wallet receives utxos to the special address, consider it as ordinal
+  if (utxo.confirmations) {
+    return maybeAnOrdinalAddress
+  }
+
+  return utxo.value.toBaseNumber() <= ordinalValueUnconfirmedThreshold || maybeAnOrdinalAddress // while unconfirmed, put  < 10000- sats in the ordinal utxos box just in case
+}
+
+export function partitionUtxos({ allUtxos, ordinalChainIndex }) {
+  assert(allUtxos, 'allUtxos is required')
+  return {
+    utxos: allUtxos.filter((utxo) => !isOrdinalUtxo({ utxo, ordinalChainIndex })),
+    ordinalsUtxos: allUtxos.filter((utxo) => isOrdinalUtxo({ utxo, ordinalChainIndex })),
+  }
+}
+
 export function getConfirmedUtxos({ utxos }) {
   assert(utxos, 'utxos is required')
   return utxos.filter(({ confirmations }) => confirmations > 0)