@exodus/bitcoin-api 1.0.2 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -38,5 +38,5 @@
     "@exodus/bip-schnorr": "0.6.6-fork-1",
     "@noble/secp256k1": "~1.5.3"
   },
-  "gitHead": "6bbd1f431656185196b2dbe74a9347a29e6bb3b1"
+  "gitHead": "6da3cc2b9aaba76c1e3523d9598e465c4b4f45eb"
 }

package/src/bitcoinjs-lib/ecc/index.js

@@ -1,9 +1,3 @@
-export const eccFactory = (useDesktopEcc, useSchnorrEcc) => {
-  if (useDesktopEcc) {
-    return require('./desktop').desktopEcc
-  }
-  if (useSchnorrEcc) {
-    return require('./mobile-schnorr').mobileSchnorrEcc
-  }
-  return require('./mobile').mobileEcc
-}
+import { desktopEcc } from './desktop'
+
+export const eccFactory = () => desktopEcc

package/src/bitcoinjs-lib/ecc/index.native.js

@@ -1,7 +1,4 @@
-import assert from 'minimalistic-assert'
-
-export const eccFactory = (useDesktopEcc, useSchnorrEcc) => {
-  assert(!useDesktopEcc, 'useDesktopEcc must be false on mobile!!')
+export const eccFactory = (useSchnorrEcc) => {
   if (useSchnorrEcc) {
     return require('./mobile-schnorr').mobileSchnorrEcc
   }

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

@@ -1,7 +1,7 @@
 import { selectUtxos } from './utxo-selector'
 import assert from 'minimalistic-assert'
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
-import { getSpendableUtxos, getUtxos } from '../utxos-utils'
+import { getUsableUtxos, getUtxos } from '../utxos-utils'
 
 import { BumpType } from '@exodus/bitcoin-lib/lib/selectors/get-can-bump-tx-factory'
 
@@ -16,6 +16,7 @@ const _canBumpTx = ({
   feeData,
   getFeeEstimator,
   taprootEnabled,
+  allowUnconfirmedRbfEnabledUtxos,
 }) => {
   assert(asset, 'asset must be provided')
   assert(tx, 'tx must be provided')
@@ -52,19 +53,20 @@ const _canBumpTx = ({
 
   const utxos = getUtxos({ accountState, asset })
 
-  const spendableUtxos = getSpendableUtxos({
+  const usableUtxos = getUsableUtxos({
     asset,
     utxos,
     feeData,
     txSet,
     taprootEnabled,
+    allowUnconfirmedRbfEnabledUtxos,
   })
-  if (!spendableUtxos) return { errorMessage: 'insufficient funds' }
+  if (usableUtxos.value.isZero) return { errorMessage: 'insufficient funds' }
 
   const { txId } = tx
   const replaceableTxs = findUnconfirmedSentRbfTxs(txSet)
   const bumpTx = replaceableTxs.find((tx) => tx.txId === txId)
-  const changeUtxos = spendableUtxos.getTxIdUtxos(txId)
+  const changeUtxos = usableUtxos.getTxIdUtxos(txId)
 
   // Can't bump a non-rbf tx with no change
   if (!bumpTx && changeUtxos.size === 0) return { errorMessage: 'no change' }
@@ -80,22 +82,24 @@ const _canBumpTx = ({
   if (bumpTx) {
     const { replaceTx } = selectUtxos({
       asset,
-      spendableUtxos,
+      usableUtxos,
       replaceableTxs: [bumpTx],
       feeRate,
       receiveAddress: null,
       getFeeEstimator,
+      allowUnconfirmedRbfEnabledUtxos,
     })
     if (replaceTx) return { bumpType: BumpType.RBF }
   }
 
   const { fee } = selectUtxos({
     asset,
-    spendableUtxos,
+    usableUtxos,
     feeRate,
     receiveAddress: 'P2WPKH',
     getFeeEstimator,
     mustSpendUtxos: changeUtxos,
+    allowUnconfirmedRbfEnabledUtxos,
   })
 
   return fee ? { bumpType: BumpType.CPFP } : { errorMessage: 'insufficient funds' }

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

@@ -1,17 +1,19 @@
 import assert from 'minimalistic-assert'
 import { getUtxosData } from './utxo-selector'
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
-import { getSpendableUtxos, getUtxos } from '../utxos-utils'
+import { getSpendableUtxos, getUsableUtxos, getUtxos } from '../utxos-utils'
 import { canBumpTx } from './can-bump-tx'
 
 export class GetFeeResolver {
   #getFeeEstimator
   #taprootEnabled
+  #allowUnconfirmedRbfEnabledUtxos
 
-  constructor({ getFeeEstimator, taprootEnabled }) {
+  constructor({ getFeeEstimator, taprootEnabled, allowUnconfirmedRbfEnabledUtxos }) {
     assert(getFeeEstimator, 'getFeeEstimator must be provided')
     this.#getFeeEstimator = (asset, { feePerKB }) => getFeeEstimator(asset, feePerKB)
     this.#taprootEnabled = taprootEnabled
+    this.#allowUnconfirmedRbfEnabledUtxos = allowUnconfirmedRbfEnabledUtxos
   }
 
   getFee = ({ asset, accountState, txSet, feeData, amount, customFee, isSendAll }) => {
@@ -47,6 +49,7 @@ export class GetFeeResolver {
       feeData,
       txSet,
       taprootEnabled: this.#taprootEnabled,
+      allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
     })
     return spendableUtxos.value
   }
@@ -59,7 +62,7 @@ export class GetFeeResolver {
 
     const utxos = getUtxos({ accountState, asset })
 
-    const spendableUtxos = getSpendableUtxos({
+    const usableUtxos = getUsableUtxos({
       asset,
       utxos,
       feeData,
@@ -75,13 +78,14 @@ export class GetFeeResolver {
     const feePerKB = customFee || feeData.feePerKB
     return getUtxosData({
       asset,
-      spendableUtxos,
+      usableUtxos,
       replaceableTxs,
       amount,
       feeRate: feePerKB,
       receiveAddress,
       isSendAll: isSendAll,
       getFeeEstimator: this.#getFeeEstimator,
+      allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
     })
   }
 
@@ -94,6 +98,7 @@ export class GetFeeResolver {
       feeData,
       getFeeEstimator: this.#getFeeEstimator,
       taprootEnabled: this.#taprootEnabled,
+      allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
     })
   }
 }

package/src/fee/utxo-selector.js

@@ -2,12 +2,13 @@ import { UtxoCollection } from '@exodus/models'
 import NumberUnit from '@exodus/currency'
 import assert from 'minimalistic-assert'
 import { getExtraFee } from './fee-utils'
+import { getConfirmedUtxos, getConfirmedOrRfbDisabledUtxos } from '../utxos-utils'
 
 const MIN_RELAY_FEE = 1000
 
 export const selectUtxos = ({
   asset,
-  spendableUtxos,
+  usableUtxos,
   replaceableTxs,
   amount,
   feeRate,
@@ -16,9 +17,10 @@ export const selectUtxos = ({
   getFeeEstimator,
   disableReplacement = false,
   mustSpendUtxos,
+  allowUnconfirmedRbfEnabledUtxos,
 }) => {
   assert(asset, 'asset is required')
-  assert(spendableUtxos, 'spendableUtxos is required')
+  assert(usableUtxos, 'usableUtxos is required')
   assert(getFeeEstimator, 'getFeeEstimator is required')
 
   const changeAddressType = ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(asset.name)
@@ -30,19 +32,17 @@ export const selectUtxos = ({
   if (!amount) amount = currency.ZERO
 
   // We can only replace for a sendAll if only 1 replaceable tx and no unconfirmed utxos
-  const confirmedUtxosArray = Array.from(spendableUtxos).filter(
-    ({ confirmations }) => confirmations > 0
-  )
+  const confirmedUtxosArray = getConfirmedUtxos({ asset, utxos: usableUtxos }).toArray()
   const canReplace =
     !mustSpendUtxos &&
     !disableReplacement &&
     replaceableTxs &&
     (!isSendAll ||
-      (replaceableTxs.length === 1 && confirmedUtxosArray.length === spendableUtxos.size - 1))
+      (replaceableTxs.length === 1 && confirmedUtxosArray.length === usableUtxos.size - 1))
 
   if (canReplace) {
     for (let tx of replaceableTxs) {
-      const changeUtxos = spendableUtxos.getTxIdUtxos(tx.txId)
+      const changeUtxos = usableUtxos.getTxIdUtxos(tx.txId)
       // Don't replace a tx that has already been spent
       if (tx.data.changeAddress && changeUtxos.size === 0) continue
       let feePerKB
@@ -117,11 +117,17 @@ export const selectUtxos = ({
   if (replaceableTxs) {
     for (let tx of replaceableTxs) {
       if (!tx.data.changeAddress) continue
-      const changeUtxos = spendableUtxos.getTxIdUtxos(tx.txId)
+      const changeUtxos = usableUtxos.getTxIdUtxos(tx.txId)
       ourRbfUtxos = ourRbfUtxos.union(changeUtxos)
     }
   }
 
+  const spendableUtxos = getConfirmedOrRfbDisabledUtxos({
+    asset,
+    utxos: usableUtxos,
+    allowUnconfirmedRbfEnabledUtxos,
+  })
+
   const utxosArray = spendableUtxos.union(ourRbfUtxos).toPriorityOrderedArray()
 
   if (isSendAll) {
@@ -177,7 +183,7 @@ export const selectUtxos = ({
 
 export const getUtxosData = ({
   asset,
-  spendableUtxos,
+  usableUtxos,
   replaceableTxs,
   amount,
   feeRate,
@@ -186,10 +192,11 @@ export const getUtxosData = ({
   getFeeEstimator,
   disableReplacement,
   mustSpendUtxos,
+  allowUnconfirmedRbfEnabledUtxos,
 }) => {
   const { selectedUtxos, replaceTx, fee } = selectUtxos({
     asset,
-    spendableUtxos,
+    usableUtxos,
     replaceableTxs,
     amount,
     feeRate,
@@ -198,11 +205,16 @@ export const getUtxosData = ({
     getFeeEstimator,
     disableReplacement,
     mustSpendUtxos,
+    allowUnconfirmedRbfEnabledUtxos,
   })
 
   const resolvedFee = replaceTx ? fee.sub(replaceTx.feeAmount) : fee
 
-  const spendableBalance = spendableUtxos.value
+  const spendableBalance = getConfirmedOrRfbDisabledUtxos({
+    asset,
+    utxos: usableUtxos,
+    allowUnconfirmedRbfEnabledUtxos,
+  }).value
 
   const extraFee = selectedUtxos
     ? asset.currency.baseUnit(getExtraFee({ asset, inputs: selectedUtxos, feePerKB: feeRate }))

package/src/insight-api-client/index.js

@@ -165,7 +165,7 @@ export default class InsightAPIClient {
     return response.json()
   }
 
-  broadcastTx = async (rawTx) => {
+  async broadcastTx(rawTx) {
     console.log('gonna broadcastTx')
     const url = urlJoin(this._baseURL, '/tx/send')
     const fetchOptions = {

package/src/tx-send/index.js

@@ -14,7 +14,7 @@ import {
   createOutput as dogecoinCreateOutput,
 } from './dogecoin'
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
-import { getSpendableUtxos, getUtxos } from '../utxos-utils'
+import { getUsableUtxos, getUtxos } from '../utxos-utils'
 
 const ASSETS_SUPPORTED_BIP_174 = [
   'bitcoin',
@@ -82,10 +82,11 @@ export async function getNonWitnessTxs(asset, utxos, insightClient) {
 // not ported from Exodus; but this demos signing / broadcasting
 // NOTE: this will be ripped out in the coming weeks
 
-export const createAndBroadcastTXFactory = ({ getFeeEstimator, taprootEnabled }) => async (
-  { asset, walletAccount, address, amount, options },
-  { assetClientInterface }
-) => {
+export const createAndBroadcastTXFactory = ({
+  getFeeEstimator,
+  taprootEnabled,
+  allowUnconfirmedRbfEnabledUtxos,
+}) => async ({ asset, walletAccount, address, amount, options }, { assetClientInterface }) => {
   const {
     multipleAddressesEnabled,
     feePerKB,
@@ -120,7 +121,7 @@ export const createAndBroadcastTXFactory = ({ getFeeEstimator, taprootEnabled })
   const insightClient = asset.baseAsset.insightClient
   const currency = asset.currency
   const feeData = await assetClientInterface.getFeeConfig({ assetName })
-  const spendableUtxos = getSpendableUtxos({
+  const usableUtxos = getUsableUtxos({
     asset,
     utxos: getUtxos({ accountState, asset }),
     feeData,
@@ -145,7 +146,7 @@ export const createAndBroadcastTXFactory = ({ getFeeEstimator, taprootEnabled })
   if (bumpTxId) {
     const bumpTx = replaceableTxs.find(({ txId }) => txId === bumpTxId)
     if (!bumpTx) {
-      utxosToBump = spendableUtxos.getTxIdUtxos(bumpTxId)
+      utxosToBump = usableUtxos.getTxIdUtxos(bumpTxId)
       if (utxosToBump.size === 0) {
         throw new Error(`Cannot bump transaction ${bumpTxId}`)
       }
@@ -161,7 +162,7 @@ export const createAndBroadcastTXFactory = ({ getFeeEstimator, taprootEnabled })
 
   let { selectedUtxos, fee, replaceTx } = selectUtxos({
     asset,
-    spendableUtxos,
+    usableUtxos,
     replaceableTxs,
     amount: sendAmount,
     feeRate: customFee || feeRate,
@@ -169,6 +170,7 @@ export const createAndBroadcastTXFactory = ({ getFeeEstimator, taprootEnabled })
     isSendAll: !rbfEnabled && feePerKB ? false : isSendAll,
     getFeeEstimator: (asset, { feePerKB }) => getFeeEstimator(asset, feePerKB),
     mustSpendUtxos: utxosToBump,
+    allowUnconfirmedRbfEnabledUtxos,
   })
 
   if (!selectedUtxos && !replaceTx) throw new Error('Not enough funds.')
@@ -287,7 +289,7 @@ export const createAndBroadcastTXFactory = ({ getFeeEstimator, taprootEnabled })
       err.txInfo = JSON.stringify({
         amount: sendAmount.toDefaultString({ unit: true }),
         fee: ((fee && fee.toDefaultString({ unit: true })) || 0).toString(), // todo why does 0 not have a unit? Is default unit ok here?
-        allUtxos: spendableUtxos.toJSON(),
+        allUtxos: usableUtxos.toJSON(),
       })
       throw err
     } else {
@@ -306,7 +308,7 @@ export const createAndBroadcastTXFactory = ({ getFeeEstimator, taprootEnabled })
     }
   }
 
-  let remainingUtxos = spendableUtxos.difference(selectedUtxos)
+  let remainingUtxos = usableUtxos.difference(selectedUtxos)
   if (changeUtxoIndex !== -1) {
     const address = Address.create(ourAddress.address, ourAddress.meta)
     const changeUtxo = {

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

@@ -0,0 +1,4 @@
+// extension point so tests can assert signatures deterministically
+export function getSchnorrEntropy() {
+  return undefined
+}

package/src/tx-sign/taproot.js

@@ -1,5 +1,6 @@
 import { crypto } from '@exodus/bitcoinjs-lib'
 import assert from 'minimalistic-assert'
+import { getSchnorrEntropy } from './default-entropy'
 
 export function tweakSigner({ signer, ECPair, ecc, tweakHash, network }) {
   assert(signer, 'signer is required')
@@ -42,7 +43,7 @@ export function toAsyncSigner({ keyPair, ecc }) {
   }
 
   keyPair.signSchnorr = async (h) => {
-    const sig = await ecc.signSchnorrAsync(h, keyPair.privateKey)
+    const sig = await ecc.signSchnorrAsync(h, keyPair.privateKey, getSchnorrEntropy())
     return Buffer.from(sig)
   }
   return keyPair

package/src/utxos-utils.js

@@ -12,7 +12,11 @@ export function getUtxos({ accountState, asset }) {
   )
 }
 
-export const getBalancesFactory = ({ taprootEnabled, feeData }) => {
+export const getBalancesFactory = ({
+  taprootEnabled,
+  feeData,
+  allowUnconfirmedRbfEnabledUtxos,
+}) => {
   assert(feeData, 'feeData is required')
   return ({ asset, accountState, txLog }) => {
     assert(asset, 'asset is required')
@@ -26,6 +30,7 @@ export const getBalancesFactory = ({ taprootEnabled, feeData }) => {
       txSet: txLog,
       feeData,
       taprootEnabled,
+      allowUnconfirmedRbfEnabledUtxos,
     }).value
     return { balance, spendableBalance }
   }
@@ -33,16 +38,45 @@ export const getBalancesFactory = ({ taprootEnabled, feeData }) => {
 
 const isTaprootUtxo = ({ utxo }) => String(utxo.address).length === 62
 
-export function getSpendableUtxos({ asset, utxos, feeData, txSet, taprootEnabled }) {
-  if (!['bitcoin', 'bitcointestnet', 'bitcoinregtest'].includes(asset.name)) return utxos
+export function getConfirmedUtxos({ asset, utxos }) {
+  assert(asset, 'asset is required')
+  assert(utxos, 'utxos is required')
+  const currency = asset.currency
+  return UtxoCollection.fromArray(
+    utxos.toArray().filter(({ confirmations }) => confirmations > 0),
+    { currency }
+  )
+}
+
+export function getConfirmedOrRfbDisabledUtxos({ asset, utxos, allowUnconfirmedRbfEnabledUtxos }) {
+  assert(asset, 'asset is required')
+  assert(utxos, 'utxos is required')
+  assert(
+    allowUnconfirmedRbfEnabledUtxos !== undefined,
+    'allowUnconfirmedRbfEnabledUtxos is required'
+  )
+  if (allowUnconfirmedRbfEnabledUtxos) {
+    return utxos
+  }
+  const currency = asset.currency
+  return UtxoCollection.fromArray(
+    utxos.toArray().filter((utxo) => utxo.confirmations > 0 || !utxo.rbfEnabled),
+    { currency }
+  )
+}
 
+export function getUsableUtxos({ asset, utxos, feeData, txSet, taprootEnabled }) {
+  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 (!taprootEnabled) {
     utxos = UtxoCollection.fromArray(
       utxos.toArray().filter((utxo) => !isTaprootUtxo({ utxo })),
       { currency: asset.currency }
     )
   }
-
   const { fastestFee } = feeData
   const feeRate = fastestFee.toBaseNumber()
   const maxFee = feeData.maxExtraCpfpFee
@@ -61,3 +95,19 @@ export function getSpendableUtxos({ asset, utxos, feeData, txSet, taprootEnabled
         { currency: asset.currency }
       )
 }
+
+export function getSpendableUtxos({
+  asset,
+  utxos,
+  feeData,
+  txSet,
+  taprootEnabled,
+  allowUnconfirmedRbfEnabledUtxos,
+}) {
+  const usableUtxos = getUsableUtxos({ asset, utxos, feeData, txSet, taprootEnabled })
+  return getConfirmedOrRfbDisabledUtxos({
+    asset,
+    utxos: usableUtxos,
+    allowUnconfirmedRbfEnabledUtxos,
+  })
+}