@exodus/bitcoin-api 2.2.1 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -13,7 +13,6 @@
     "access": "restricted"
   },
   "scripts": {
-    "build": "babel --root-mode upward --delete-dir-on-start --ignore '**/__tests__/**' src --out-dir lib",
     "test": "jest",
     "lint": "eslint ./src",
     "lint:fix": "yarn lint --fix"
@@ -41,5 +40,5 @@
     "@exodus/bitcoin-meta": "^1.0.0",
     "@noble/secp256k1": "~1.5.3"
   },
-  "gitHead": "17fcd32b82150b04903edc83c72b16a73ee00e86"
+  "gitHead": "e2dd97caae4a23757f38f2156450f17d86fdce34"
 }

package/src/balances.js

@@ -0,0 +1,26 @@
+import assert from 'minimalistic-assert'
+import { getUtxos } from './utxos-utils'
+
+// known issue!! fee data is static here!
+// Hydra's balances's module does not provide it when calling asset.api.getBalances
+// https://github.com/ExodusMovement/exodus-hydra/blob/f9110f8e9e76b8b199bc4d40461cb1bed3a5be1e/modules/balances/module/index.js#L130
+// feeData is required to know if an unconfirmed tx can or cannot be RBFed?
+// This could be fixed once we allow all unconfirmed utxos to be RBFed or if we change the balance module to provide the feeData when calling asset.api.getBalances
+export const getBalancesFactory = ({ feeData, getSpendableBalance }) => {
+  assert(feeData, 'feeData is required')
+  assert(getSpendableBalance, 'getSpendableBalance is required')
+  return ({ asset, accountState, txLog }) => {
+    assert(asset, 'asset is required')
+    assert(accountState, 'accountState is required')
+    assert(txLog, 'txLog is required')
+    const utxos = getUtxos({ asset, accountState })
+    const balance = utxos.value
+    const spendableBalance = getSpendableBalance({
+      asset,
+      accountState,
+      txSet: txLog,
+      feeData,
+    })
+    return { balance, spendableBalance }
+  }
+}

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

@@ -1,7 +1,7 @@
 import assert from 'minimalistic-assert'
 import { getUtxosData } from './utxo-selector'
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
-import { getSpendableUtxos, getUsableUtxos, getUtxos } from '../utxos-utils'
+import { getUsableUtxos, getUtxos } from '../utxos-utils'
 import { canBumpTx } from './can-bump-tx'
 
 export class GetFeeResolver {
@@ -40,15 +40,13 @@ export class GetFeeResolver {
   }
 
   getSpendableBalance = ({ asset, accountState, txSet, feeData }) => {
-    const utxos = getUtxos({ accountState, asset })
-    const spendableUtxos = getSpendableUtxos({
+    return this.#getUtxosData({
       asset,
-      utxos,
-      feeData,
+      accountState,
       txSet,
-      allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
-    })
-    return spendableUtxos.value
+      feeData,
+      isSendAll: true,
+    }).spendableBalance
   }
 
   #getUtxosData = ({ asset, accountState, txSet, feeData, amount, customFee, isSendAll }) => {

package/src/fee/utxo-selector.js

@@ -209,12 +209,15 @@ export const getUtxosData = ({
   })
 
   const resolvedFee = replaceTx ? fee.sub(replaceTx.feeAmount) : fee
-
-  const spendableBalance = getConfirmedOrRfbDisabledUtxos({
+  const empty = UtxoCollection.createEmpty({ currency: asset.currency })
+  const spendableUtxos = getConfirmedOrRfbDisabledUtxos({
     asset,
     utxos: usableUtxos,
     allowUnconfirmedRbfEnabledUtxos,
-  }).value
+  }).union(replaceTx ? usableUtxos.getTxIdUtxos(replaceTx.txId) : empty)
+  // .union(selectedUtxos || empty)
+
+  const spendableBalance = spendableUtxos.value
 
   const extraFee = selectedUtxos
     ? asset.currency.baseUnit(getExtraFee({ asset, inputs: selectedUtxos, feePerKB: feeRate }))

package/src/index.js

@@ -1,4 +1,5 @@
 export * from './account-state'
+export * from './balances'
 export * from './btc-address'
 export * from './btc-like-address'
 export * from './btc-like-keys'

package/src/move-funds.js

@@ -2,21 +2,45 @@ import wif from 'wif'
 import { UtxoCollection, Address } from '@exodus/models'
 import { createInputs, createOutput, getNonWitnessTxs } from './tx-send'
 import assert from 'minimalistic-assert'
+import secp256k1 from 'secp256k1'
+
+function wifToPublicKey({ coinInfo, privateKeyWIF }) {
+  assert(coinInfo, 'coinInfo is required')
+  assert(privateKeyWIF, 'privateKeyWIF is required')
+  const { versions } = coinInfo
+
+  const { privateKey, compressed } = wif.decode(privateKeyWIF, versions.private)
+  return secp256k1.publicKeyCreate(privateKey, compressed)
+}
+
+export const getAddressesFromPrivateKeyFactory = ({ purposes, keys, coinInfo }) => {
+  assert(purposes, 'purposes is required')
+  assert(keys, 'keys is required')
+  assert(coinInfo, 'coinInfo is required')
+  return ({ privateKey }) => {
+    const publicKey = wifToPublicKey({ coinInfo, privateKeyWIF: privateKey })
+    return purposes.map((purpose) =>
+      keys.encodePublic(purpose === 49 ? secp256k1.publicKeyConvert(publicKey, true) : publicKey, {
+        purpose,
+      })
+    )
+  }
+}
 
 export const moveFundsFactory = ({
   asset,
   insightClient,
   getFeeEstimator,
-  keys,
   signTx,
   address,
+  getAddressesFromPrivateKey,
 }) => {
   assert(asset, 'asset is required')
   assert(insightClient, 'insightClient is required')
   assert(getFeeEstimator, 'getFeeEstimator is required')
   assert(address, 'address is required')
-  assert(keys, 'keys is required')
   assert(signTx, 'signTx is required')
+  assert(getAddressesFromPrivateKey, 'getAddressesFromPrivateKey is required')
   async function prepareFunds(assetName, input, options = {}) {
     const { toAddress, assetClientInterface, MoveFundsError, walletAccount } = options
     assert(MoveFundsError, 'MoveFundsError is required') // should we move MoveFundsError to asset libs?
@@ -29,6 +53,7 @@ export const moveFundsFactory = ({
       asset,
       input,
     }
+    // WIF format private key
     const privateKey = input
 
     if (!isValidPrivateKey(privateKey)) {
@@ -36,7 +61,7 @@ export const moveFundsFactory = ({
     }
 
     const { compressed } = wif.decode(privateKey)
-    const addresses = getAllAddressesFromWIF(privateKey)
+    const addresses = getAddressesFromPrivateKey({ privateKey })
 
     const receiveAddresses = await assetClientInterface.getReceiveAddresses({
       walletAccount,
@@ -61,7 +86,9 @@ export const moveFundsFactory = ({
       }
     }
     if (!found) {
-      formatProps.fromAddress = addresses.join(' or ')
+      formatProps.fromAddress = `${addresses.slice(0, -1).join(', ')}, or ${
+        addresses[addresses.length - 1]
+      }`
       throw new MoveFundsError('balance-zero', formatProps)
     }
     const fromAddress = address
@@ -114,35 +141,6 @@ export const moveFundsFactory = ({
     return { txId, fromAddress, toAddress, amount, fee }
   }
 
-  function getAllAddressesFromWIF(privateKeyWIF) {
-    const { compressed } = wif.decode(privateKeyWIF)
-    const legacyAddress = keys.encodePublicFromWIF(privateKeyWIF)
-    // TODO: support nested segwit address, right now we don't support send
-    // const nestedSegwitAddress = encodeNestedSegwitFromWIF(privateKeyWIF, { asset })
-    const nativeSegwitAddress = keys.encodePublicBech32FromWIF(privateKeyWIF)
-
-    if (compressed) {
-      return [nativeSegwitAddress, legacyAddress]
-    } else {
-      return [legacyAddress]
-    }
-  }
-
-  /*
-function getPublicFromWIF(privateKeyWIF, { asset }) {
-  const { versions } = asset.coinInfo
-  const { privateKey, compressed } = wif.decode(privateKeyWIF, versions.private)
-  return secp256k1.pointFromScalar(privateKey, compressed)
-}
-
-function encodeNestedSegwitFromWIF(privateKeyWIF, { asset }) {
-  const publicKey = getPublicFromWIF(privateKeyWIF, { asset })
-  const witnessProgram = bitcoinjs.payments.p2wpkh({ pubkey: publicKey }).output
-  const witnessProgramHash = bitcoinjs.crypto.hash160(witnessProgram)
-  return bitcoinjs.address.toBase58Check(witnessProgramHash, asset.coinInfo.versions.scripthash)
-}
-*/
-
   async function getUtxos({ asset, address }) {
     const rawUtxos = await insightClient.fetchUTXOs([address])
     return UtxoCollection.fromArray(

package/src/tx-send/index.js

@@ -363,7 +363,7 @@ export const createAndBroadcastTXFactory = ({
           sent: selfSend ? [] : receivers,
           rbfEnabled,
           feePerKB: ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)
-            ? fee.div(tx.virtualSize() / 1000).toBaseNumber()
+            ? fee.div(tx.virtualSize / 1000).toBaseNumber()
             : undefined,
           changeAddress: changeOutput ? ourAddress : undefined,
           blockHeight,

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

@@ -115,6 +115,7 @@ export const signTxFactory = ({ assetName, resolvePurpose, keys, coinInfo, netwo
     const rawTx = tx.toBuffer()
     const txId = tx.getId()
 
-    return { rawTx, txId, tx }
+    // tx needs to be serializable for desktop RPC send => sign communication
+    return { rawTx, txId, tx: { ...tx, virtualSize: tx.virtualSize?.() } }
   }
 }

package/src/utxos-utils.js

@@ -12,26 +12,6 @@ export function getUtxos({ accountState, asset }) {
   )
 }
 
-export const getBalancesFactory = ({ feeData, allowUnconfirmedRbfEnabledUtxos }) => {
-  assert(feeData, 'feeData is required')
-  return ({ asset, accountState, txLog }) => {
-    assert(asset, 'asset is required')
-    assert(accountState, 'accountState is required')
-    assert(txLog, 'txLog is required')
-    const utxos = getUtxos({ asset, accountState })
-    const balance = utxos.value
-    const spendableBalance = getSpendableUtxos({
-      asset,
-      utxos,
-      txSet: txLog,
-      feeData,
-
-      allowUnconfirmedRbfEnabledUtxos,
-    }).value
-    return { balance, spendableBalance }
-  }
-}
-
 export function getConfirmedUtxos({ asset, utxos }) {
   assert(asset, 'asset is required')
   assert(utxos, 'utxos is required')
@@ -83,19 +63,3 @@ export function getUsableUtxos({ asset, utxos, feeData, txSet }) {
         { currency: asset.currency }
       )
 }
-
-export function getSpendableUtxos({
-  asset,
-  utxos,
-  feeData,
-  txSet,
-
-  allowUnconfirmedRbfEnabledUtxos,
-}) {
-  const usableUtxos = getUsableUtxos({ asset, utxos, feeData, txSet })
-  return getConfirmedOrRfbDisabledUtxos({
-    asset,
-    utxos: usableUtxos,
-    allowUnconfirmedRbfEnabledUtxos,
-  })
-}