@exodus/bitcoin-api 2.3.2 → 2.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.3.2",
+  "version": "2.3.4",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -19,6 +19,7 @@
   },
   "dependencies": {
     "@exodus/asset-lib": "^3.7.2",
+    "@exodus/basic-utils": "^2.0.1",
     "@exodus/bip44-constants": "^195.0.0",
     "@exodus/bitcoinjs-lib": "6.0.2-beta.5",
     "@exodus/models": "^8.10.4",
@@ -35,10 +36,11 @@
     "url-join": "4.0.0"
   },
   "devDependencies": {
+    "@exodus/asset-lib": "^3.7.1",
     "@exodus/bcash-meta": "^1.0.0",
     "@exodus/bip-schnorr": "0.6.6-fork-1",
     "@exodus/bitcoin-meta": "^1.0.1",
     "@noble/secp256k1": "~1.5.3"
   },
-  "gitHead": "5bc09581d58d29a80871f4fbb189ff2dcf389b96"
+  "gitHead": "ae212da85b29d90a3656bcfa034608950f883df1"
 }

package/src/btc-like-address.js

@@ -1,5 +1,5 @@
 import bs58check from 'bs58check'
-import bech32 from 'bech32'
+import * as bech32 from 'bech32'
 import assert from 'minimalistic-assert'
 import { identity, pickBy } from 'lodash'
 import * as bitcoinjsOriginal from '@exodus/bitcoinjs-lib'

package/src/btc-like-keys.js

@@ -1,6 +1,6 @@
 import bs58check from 'bs58check'
 import wif from 'wif'
-import bech32 from 'bech32'
+import * as bech32 from 'bech32'
 import assert from 'minimalistic-assert'
 import { identity, pickBy } from 'lodash'
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'

package/src/move-funds.js

@@ -41,13 +41,20 @@ export const moveFundsFactory = ({
   assert(address, 'address 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?
+
+  async function prepareSendFundsTx({
+    assetName,
+    walletAccount,
+    input,
+    toAddress,
+    assetClientInterface,
+    MoveFundsError,
+  }) {
+    assert(asset.name === assetName, `expected asset ${asset.name} but got assetName ${assetName}`)
+    assert(walletAccount, 'walletAccount is required')
     assert(toAddress, 'toAddress is required')
     assert(assetClientInterface, 'assetClientInterface is required')
-    assert(walletAccount, 'walletAccount is required')
-    assert(asset.name === assetName, `expected asset ${asset.name} but got assetName ${assetName}`)
+    assert(MoveFundsError, 'MoveFundsError is required') // should we move MoveFundsError to asset libs?
 
     const formatProps = {
       asset,
@@ -69,71 +76,78 @@ export const moveFundsFactory = ({
       multiAddressMode: true,
     })
 
-    let found, address, utxos
-    for (address of addresses) {
-      const selfSend = receiveAddresses.some(
-        (receiveAddress) => String(receiveAddress) === String(address)
-      )
-      if (selfSend) {
-        throw new MoveFundsError('private-key-own-key', formatProps)
-      }
+    const findFromAddress = async () => {
+      for (const currentAddress of addresses) {
+        const selfSend = receiveAddresses.some(
+          (receiveAddress) => String(receiveAddress) === String(currentAddress)
+        )
+        if (selfSend) {
+          throw new MoveFundsError('private-key-own-key', formatProps)
+        }
 
-      utxos = await getUtxos({ asset, address })
+        const utxos = await getUtxos({ asset, address: currentAddress })
 
-      if (!utxos.value.isZero) {
-        found = true
-        break
+        if (!utxos.value.isZero) {
+          return { fromAddress: currentAddress, utxos }
+        }
       }
+      throw new MoveFundsError('balance-zero', {
+        ...formatProps,
+        fromAddress: `${addresses.slice(0, -1).join(', ')}, or ${addresses[addresses.length - 1]}`,
+      })
     }
-    if (!found) {
-      formatProps.fromAddress = `${addresses.slice(0, -1).join(', ')}, or ${
-        addresses[addresses.length - 1]
-      }`
-      throw new MoveFundsError('balance-zero', formatProps)
-    }
-    const fromAddress = address
-    formatProps.fromAddress = fromAddress
 
+    const { fromAddress, utxos } = await findFromAddress()
+    formatProps.fromAddress = fromAddress
     const feeData = await assetClientInterface.getFeeConfig({ assetName })
-    const fee = getFee({ asset, feeData, utxos, compressed })
+    const { fee, sizeKB } = getFee({ asset, feeData, utxos, compressed })
 
     let amount = utxos.value.sub(fee)
     if (amount.isNegative) {
       throw new MoveFundsError('balance-negative', formatProps)
     }
 
-    return { fromAddress, toAddress, amount, fee, utxos, privateKey }
-  }
-
-  const sendFunds = async (
-    assetName,
-    { fromAddress, toAddress, amount, fee, utxos, privateKey }
-  ) => {
-    assert(fromAddress, 'fromAddress is required')
-    assert(toAddress, 'toAddress is required')
-    assert(fee, 'fee is required')
-    assert(utxos, 'utxos is required')
-    assert(privateKey, 'privateKey is required')
-    const selected = utxos
-    const privateKeysAddressMap = {
-      [fromAddress]: privateKey,
-    }
     const unsignedTx = {
       txData: {
-        inputs: createInputs(assetName, selected.toArray()),
+        inputs: createInputs(assetName, utxos.toArray()),
         outputs: [createOutput(assetName, toAddress, amount)],
       },
       txMeta: {
-        addressPathsMap: selected.getAddressPathsMap(),
+        addressPathsMap: utxos.getAddressPathsMap(),
       },
     }
     const nonWitnessTxs = await getNonWitnessTxs(
       { name: assetName, address }, // pretty ugly hack!
-      selected,
+      utxos,
       insightClient
     )
     Object.assign(unsignedTx.txMeta, { rawTxs: nonWitnessTxs })
 
+    return { fromAddress, toAddress, amount, fee, utxos, unsignedTx, sizeKB, privateKey }
+  }
+
+  const sendFunds = async ({
+    assetName,
+    fromAddress,
+    toAddress,
+    amount,
+    fee,
+    unsignedTx,
+    privateKey,
+  }) => {
+    // the response from prepareSendFundsTx
+    assert(assetName, 'assetName is required')
+    assert(fromAddress, 'fromAddress is required')
+    assert(toAddress, 'toAddress is required')
+    assert(amount, 'amount is required')
+    assert(fee, 'fee is required')
+    assert(unsignedTx, 'unsignedTx is required')
+    assert(privateKey, 'privateKey is required')
+
+    const privateKeysAddressMap = {
+      [fromAddress]: privateKey,
+    }
+
     const { rawTx, txId } = await signTx({ unsignedTx, privateKeysAddressMap })
 
     await insightClient.broadcastTx(rawTx.toString('hex'))
@@ -158,7 +172,9 @@ export const moveFundsFactory = ({
   function getFee({ asset, feeData, utxos, compressed }) {
     const { feePerKB } = feeData
     const feeEstimator = getFeeEstimator(asset, feePerKB, { compressed })
-    return feeEstimator({ inputs: utxos, outputs: [null] }).toDefault()
+    const fee = feeEstimator({ inputs: utxos, outputs: [null] })
+    const sizeKB = fee.toDefaultNumber() / feePerKB
+    return { fee, sizeKB }
   }
 
   function isValidPrivateKey(privateKey) {
@@ -171,7 +187,7 @@ export const moveFundsFactory = ({
   }
 
   return {
-    prepareFunds,
+    prepareSendFundsTx,
     sendFunds,
   }
 }

package/src/tx-send/index.js

@@ -16,6 +16,8 @@ import {
 import { findUnconfirmedSentRbfTxs } from '../tx-utils'
 import { getUsableUtxos, getUtxos } from '../utxos-utils'
 
+import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
+
 const ASSETS_SUPPORTED_BIP_174 = [
   'bitcoin',
   'bitcoinregtest',
@@ -79,12 +81,40 @@ export async function getNonWitnessTxs(asset, utxos, insightClient) {
   return rawTxs
 }
 
+export const getSizeAndChangeScriptFactory = ({ bitcoinJsLib = defaultBitcoinjsLib } = {}) => ({
+  assetName,
+  tx,
+  rawTx,
+  changeUtxoIndex,
+  txId,
+}) => {
+  assert(assetName, 'assetName is required')
+  assert(rawTx, 'rawTx is required')
+  assert(typeof changeUtxoIndex === 'number', 'changeUtxoIndex must be a number')
+  if (tx) {
+    return { script: tx.outs?.[changeUtxoIndex]?.script.toString('hex'), size: tx.virtualSize }
+  }
+  // Trezor doesn't return tx!! we need to reparse it!
+  const parsedTx = bitcoinJsLib.Transaction.fromBuffer(Buffer.from(rawTx, 'hex'))
+  try {
+    return {
+      script: parsedTx.outs?.[changeUtxoIndex]?.script.toString('hex'),
+      size: parsedTx.virtualSize(),
+    }
+  } catch (e) {
+    console.warn(
+      `tx-send warning: ${assetName} cannot extract script and size from tx ${txId}. ${e}`
+    )
+    return {}
+  }
+}
+
 // not ported from Exodus; but this demos signing / broadcasting
 // NOTE: this will be ripped out in the coming weeks
 
 export const createAndBroadcastTXFactory = ({
   getFeeEstimator,
-
+  getSizeAndChangeScript = getSizeAndChangeScriptFactory(), // for decred customizations
   allowUnconfirmedRbfEnabledUtxos,
 }) => async ({ asset, walletAccount, address, amount, options }, { assetClientInterface }) => {
   const {
@@ -308,6 +338,8 @@ export const createAndBroadcastTXFactory = ({
     }
   }
 
+  const { script, size } = getSizeAndChangeScript({ assetName, tx, rawTx, changeUtxoIndex, txId })
+
   let remainingUtxos = usableUtxos.difference(selectedUtxos)
   if (changeUtxoIndex !== -1) {
     const address = Address.create(ourAddress.address, ourAddress.meta)
@@ -315,7 +347,7 @@ export const createAndBroadcastTXFactory = ({
       txId,
       address,
       vout: changeUtxoIndex,
-      script: tx.outs[changeUtxoIndex].script.toString('hex'),
+      script,
       value: change,
       confirmations: 0,
       rbfEnabled,
@@ -364,9 +396,7 @@ export const createAndBroadcastTXFactory = ({
         data: {
           sent: selfSend ? [] : receivers,
           rbfEnabled,
-          feePerKB: ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(assetName)
-            ? fee.div(tx.virtualSize / 1000).toBaseNumber()
-            : undefined,
+          feePerKB: size ? fee.div(size / 1000).toBaseNumber() : undefined,
           changeAddress: changeOutput ? ourAddress : undefined,
           blockHeight,
           blocksSeen: 0,

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

@@ -1,7 +1,10 @@
 import assert from 'minimalistic-assert'
 import lodash from 'lodash'
 import ECPairFactory from 'ecpair'
-import { Psbt, Transaction } from '@exodus/bitcoinjs-lib'
+import { payments, Psbt, Transaction } from '@exodus/bitcoinjs-lib'
+import { getOwnProperty } from '@exodus/basic-utils'
+
+import secp256k1 from 'secp256k1'
 
 import { toAsyncSigner, tweakSigner } from './taproot'
 
@@ -45,10 +48,11 @@ export const signTxFactory = ({ assetName, resolvePurpose, keys, coinInfo, netwo
     ECPair = ECPair || ECPairFactory(ecc)
 
     const getKeyAndPurpose = lodash.memoize((address) => {
-      // TODO: Consider using privateKeysAddressMap for other assets
       const purpose = resolvePurpose(address)
       if (privateKeysAddressMap) {
-        const key = ECPair.fromWIF(privateKeysAddressMap[address], networkInfo)
+        const privateKey = getOwnProperty(privateKeysAddressMap, address, 'string')
+        assert(privateKey, `there is no private key for address ${address}`)
+        const key = ECPair.fromWIF(privateKey, networkInfo)
         return { key, purpose }
       }
       const path = addressPathsMap[address]
@@ -96,6 +100,20 @@ export const signTxFactory = ({ assetName, resolvePurpose, keys, coinInfo, netwo
     for (let index = 0; index < inputs.length; index++) {
       const { address } = inputs[index]
       const { key, purpose } = getKeyAndPurpose(address)
+
+      if (purpose === 49) {
+        // If spending from a P2SH address, we assume the address is P2SH wrapping
+        // P2WPKH. Exodus doesn't use P2SH addresses so we should only ever be
+        // signing a P2SH input if we are importing a private key
+        // BIP143: As a default policy, only compressed public keys are accepted in P2WPKH and P2WSH
+        const publicKey = secp256k1.publicKeyCreate(key.privateKey, true)
+        const p2wpkh = payments.p2wpkh({ pubkey: publicKey })
+        const p2sh = payments.p2sh({ redeem: p2wpkh })
+        psbt.updateInput(index, {
+          redeemScript: p2sh.redeem.output,
+        })
+      }
+
       if (ecc.signSchnorrAsync) {
         // desktop / BE / mobile with bip-schnorr signing
         const isTaprootAddress = purpose === 86