@exodus/bitcoin-api 2.18.4 → 2.20.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.20.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.19.0...@exodus/bitcoin-api@2.20.0) (2024-07-09)
+
+
+### Features
+
+* **BTC:** add changeAddressType to createAsset config ([#2772](https://github.com/ExodusMovement/assets/issues/2772)) ([d8e38dd](https://github.com/ExodusMovement/assets/commit/d8e38dddfbe59b3e8ff9fc2432049bb512a91c22))
+
+
+
+## [2.19.0](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.18.4...@exodus/bitcoin-api@2.19.0) (2024-07-05)
+
+
+### Features
+
+* **BTC:** add taprootInputWitnessSize for tx size estimation ([#2737](https://github.com/ExodusMovement/assets/issues/2737)) ([13f727a](https://github.com/ExodusMovement/assets/commit/13f727a836f9fc620628abb6a94a49c1a6774ca5))
+
+
+
 ## [2.18.4](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.18.3...@exodus/bitcoin-api@2.18.4) (2024-06-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.18.4",
+  "version": "2.20.0",
   "description": "Exodus bitcoin-api",
   "main": "src/index.js",
   "files": [
@@ -66,5 +66,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "b7cc185dce729a04f48833e29c606eeb7b24407b"
+  "gitHead": "0dc141fc6a249ac051a5ca591d46cbc81096a4f3"
 }

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

@@ -18,6 +18,8 @@ const _canBumpTx = ({
   getFeeEstimator,
   allowUnconfirmedRbfEnabledUtxos,
   utxosDescendingOrder,
+  taprootInputWitnessSize,
+  changeAddressType,
 }) => {
   assert(asset, 'asset must be provided')
   assert(tx, 'tx must be provided')
@@ -93,6 +95,8 @@ const _canBumpTx = ({
       allowUnconfirmedRbfEnabledUtxos,
       unconfirmedTxAncestor,
       utxosDescendingOrder,
+      taprootInputWitnessSize,
+      changeAddressType,
     })
     if (replaceTx) return { bumpType: BumpType.RBF, bumpFee: fee.sub(replaceTx.feeAmount) }
   }
@@ -101,12 +105,14 @@ const _canBumpTx = ({
     asset,
     usableUtxos,
     feeRate,
-    receiveAddress: 'P2WPKH',
+    receiveAddress: changeAddressType,
     getFeeEstimator,
     mustSpendUtxos: changeUtxos,
     allowUnconfirmedRbfEnabledUtxos,
     unconfirmedTxAncestor,
     utxosDescendingOrder,
+    taprootInputWitnessSize,
+    changeAddressType,
   })
 
   return fee ? { bumpType: BumpType.CPFP, bumpFee: fee } : { errorMessage: 'insufficient funds' }

package/src/fee/fee-estimator.js

@@ -48,6 +48,11 @@ const scriptPubKeyLengths = {
   [P2TR]: 34,
 }
 
+// Only the 64 byte Schnorr signature is present for Taproot Key-Path spend
+const signatureLength = 64
+const taprootInputKeyPathWitnessSize =
+  varuint.encodingLength(1) + varuint.encodingLength(signatureLength) + signatureLength
+
 // bitcoin and bitcoin-like:
 // 10 = version: 4, locktime: 4, inputs and outputs count: 1
 // 148 = txId: 32, vout: 4, count: 1, script: 107 (max), sequence: 4
@@ -58,7 +63,12 @@ export const getSizeFactory = ({ defaultOutputType, addressApi }) => {
 
   const scriptClassifier = scriptClassifierFactory({ addressApi })
 
-  return (asset, inputs, outputs, { compressed = true } = {}) => {
+  return (
+    asset,
+    inputs,
+    outputs,
+    { compressed = true, taprootInputWitnessSize = taprootInputKeyPathWitnessSize } = {}
+  ) => {
     if (inputs instanceof UtxoCollection) {
       inputs = [...inputs].map((utxo) => utxo.script || null)
     }
@@ -136,14 +146,7 @@ export const getSizeFactory = ({ defaultOutputType, addressApi }) => {
         }
 
         if ([P2TR].includes(utxoScriptType)) {
-          // Only the 64 byte Schnorr signature is present for Taproot Key-Path spend
-          const signatureLength = 64
-          return (
-            t +
-            varuint.encodingLength(1) +
-            varuint.encodingLength(signatureLength) +
-            signatureLength
-          )
+          return t + taprootInputWitnessSize
         }
 
         // Non-witness inputs get a placeholder zero byte

package/src/fee/fee-utils.js

@@ -36,11 +36,12 @@ export default function createDefaultFeeEstimator(getSize) {
       inputs = options.inputs,
       outputs = options.outputs,
       unconfirmedTxAncestor = options.unconfirmedTxAncestor,
+      taprootInputWitnessSize,
     } = {}) => {
       const extraFee = getExtraFee({ asset, inputs, feePerKB, unconfirmedTxAncestor })
       // Yes, it's suppose to be '1000' and not '1024'
       // https://bitcoin.stackexchange.com/questions/24000/a-fee-is-added-per-kilobyte-of-data-that-means-1000-bytes-or-1024
-      const size = getSize(asset, inputs, outputs, options)
+      const size = getSize(asset, inputs, outputs, { ...options, taprootInputWitnessSize })
       const feeRaw = Math.ceil((feePerKB.toBaseNumber() * size) / 1000)
       return asset.currency.baseUnit(feeRaw + extraFee)
     }

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

@@ -15,13 +15,20 @@ export class GetFeeResolver {
   #getFeeEstimator
   #allowUnconfirmedRbfEnabledUtxos
   #utxosDescendingOrder
+  #changeAddressType
 
-  constructor({ getFeeEstimator, allowUnconfirmedRbfEnabledUtxos, utxosDescendingOrder }) {
+  constructor({
+    getFeeEstimator,
+    allowUnconfirmedRbfEnabledUtxos,
+    utxosDescendingOrder,
+    changeAddressType,
+  }) {
     assert(getFeeEstimator, 'getFeeEstimator must be provided')
     this.#getFeeEstimator = (asset, { feePerKB, ...options }) =>
       getFeeEstimator(asset, feePerKB, options)
     this.#allowUnconfirmedRbfEnabledUtxos = allowUnconfirmedRbfEnabledUtxos
     this.#utxosDescendingOrder = utxosDescendingOrder
+    this.#changeAddressType = changeAddressType
   }
 
   getFee = ({
@@ -35,6 +42,7 @@ export class GetFeeResolver {
     nft, // sending one nft
     brc20, // sending multiple inscriptions ids (as in sending multiple transfer ordinals)
     receiveAddress,
+    taprootInputWitnessSize,
   }) => {
     if (nft) {
       assert(!amount, 'amount must not be provided when nft is provided!!!')
@@ -60,11 +68,21 @@ export class GetFeeResolver {
       customFee,
       isSendAll,
       inscriptionIds,
+      taprootInputWitnessSize,
     })
     return { fee: resolvedFee, extraFee }
   }
 
-  getAvailableBalance = ({ asset, accountState, txSet, feeData, amount, customFee, isSendAll }) => {
+  getAvailableBalance = ({
+    asset,
+    accountState,
+    txSet,
+    feeData,
+    amount,
+    customFee,
+    isSendAll,
+    taprootInputWitnessSize,
+  }) => {
     return this.#getUtxosData({
       asset,
       accountState,
@@ -73,16 +91,18 @@ export class GetFeeResolver {
       customFee,
       isSendAll,
       amount,
+      taprootInputWitnessSize,
     }).availableBalance
   }
 
-  getSpendableBalance = ({ asset, accountState, txSet, feeData }) => {
+  getSpendableBalance = ({ asset, accountState, txSet, feeData, taprootInputWitnessSize }) => {
     return this.#getUtxosData({
       asset,
       accountState,
       txSet,
       feeData,
       isSendAll: true,
+      taprootInputWitnessSize,
     }).spendableBalance
   }
 
@@ -96,6 +116,7 @@ export class GetFeeResolver {
     customFee,
     isSendAll,
     inscriptionIds,
+    taprootInputWitnessSize,
   }) => {
     assert(asset, 'asset must be provided')
     assert(feeData, 'feeData must be provided')
@@ -136,10 +157,12 @@ export class GetFeeResolver {
       allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
       unconfirmedTxAncestor,
       utxosDescendingOrder: this.#utxosDescendingOrder,
+      taprootInputWitnessSize,
+      changeAddressType: this.#changeAddressType,
     })
   }
 
-  canBumpTx = ({ asset, tx, txSet, accountState, feeData }) => {
+  canBumpTx = ({ asset, tx, txSet, accountState, feeData, taprootInputWitnessSize }) => {
     return canBumpTx({
       asset,
       tx,
@@ -149,6 +172,8 @@ export class GetFeeResolver {
       getFeeEstimator: this.#getFeeEstimator,
       allowUnconfirmedRbfEnabledUtxos: this.#allowUnconfirmedRbfEnabledUtxos,
       utxosDescendingOrder: this.#utxosDescendingOrder,
+      taprootInputWitnessSize,
+      changeAddressType: this.#changeAddressType,
     })
   }
 }

package/src/fee/utxo-selector.js

@@ -35,6 +35,8 @@ export const selectUtxos = ({
   unconfirmedTxAncestor,
   inscriptionIds, // for each inscription transfer, we need to calculate one more input and one more output
   transferOrdinalsUtxos, // to calculate the size of the input
+  taprootInputWitnessSize,
+  changeAddressType = 'P2PKH',
 }) => {
   const resolvedReceiveAddresses = getBestReceiveAddresses({
     asset,
@@ -53,10 +55,6 @@ export const selectUtxos = ({
   assert(usableUtxos, 'usableUtxos is required')
   assert(getFeeEstimator, 'getFeeEstimator is required')
 
-  const changeAddressType = ['bitcoin', 'bitcoinregtest', 'bitcointestnet'].includes(asset.name)
-    ? 'P2WPKH'
-    : 'P2PKH'
-
   const feeEstimator = getFeeEstimator(asset, { feePerKB: feeRate, unconfirmedTxAncestor })
   const { currency } = asset
   if (!amount) amount = currency.ZERO
@@ -100,9 +98,13 @@ export const selectUtxos = ({
 
       if (isSendAll) {
         additionalUtxos = UtxoCollection.fromArray(confirmedUtxosArray, { currency })
-        fee = replaceFeeEstimator({ inputs: inputs.union(additionalUtxos), outputs })
+        fee = replaceFeeEstimator({
+          inputs: inputs.union(additionalUtxos),
+          outputs,
+          taprootInputWitnessSize,
+        })
       } else {
-        fee = replaceFeeEstimator({ inputs, outputs })
+        fee = replaceFeeEstimator({ inputs, outputs, taprootInputWitnessSize })
         additionalUtxos = UtxoCollection.createEmpty({ currency })
         while (replaceTxAmount.add(additionalUtxos.value).lt(amount.add(fee))) {
           if (confirmedUtxosArray.length === 0) {
@@ -116,6 +118,7 @@ export const selectUtxos = ({
               fee = replaceFeeEstimator({
                 inputs: inputs.union(additionalUtxos),
                 outputs: noChangeOutputs,
+                taprootInputWitnessSize,
               })
             }
 
@@ -127,6 +130,7 @@ export const selectUtxos = ({
           fee = replaceFeeEstimator({
             inputs: inputs.union(additionalUtxos),
             outputs,
+            taprootInputWitnessSize,
           })
         }
       }
@@ -136,6 +140,7 @@ export const selectUtxos = ({
         const chainFee = feeEstimator({
           inputs: changeUtxos.union(additionalUtxos),
           outputs: chainOutputs,
+          taprootInputWitnessSize,
         })
         // If batching is same or more expensive than chaining, don't replace
         // Unless we are accelerating a changeless tx, then we must replace because it can't be chained
@@ -173,7 +178,11 @@ export const selectUtxos = ({
 
   if (isSendAll) {
     const selectedUtxos = UtxoCollection.fromArray(utxosArray, { currency })
-    const fee = feeEstimator({ inputs: selectedUtxos, outputs: receiveAddresses })
+    const fee = feeEstimator({
+      inputs: selectedUtxos,
+      outputs: receiveAddresses,
+      taprootInputWitnessSize,
+    })
     if (selectedUtxos.value.lt(amount.add(fee))) {
       return { fee }
     }
@@ -208,19 +217,23 @@ export const selectUtxos = ({
       ? [changeAddressType]
       : [...receiveAddresses, changeAddressType]
 
-  let fee = feeEstimator({ inputs: selectedUtxos, outputs })
+  let fee = feeEstimator({ inputs: selectedUtxos, outputs, taprootInputWitnessSize })
 
   while (selectedUtxos.value.lt(amount.add(fee))) {
     // We ran out of UTXOs, give up now
     if (remainingUtxosArray.length === 0) {
       // Try fee with no change
-      fee = feeEstimator({ inputs: selectedUtxos, outputs: receiveAddresses })
+      fee = feeEstimator({
+        inputs: selectedUtxos,
+        outputs: receiveAddresses,
+        taprootInputWitnessSize,
+      })
       break
     }
 
     // Add a new UTXO and recalculate the fee
     selectedUtxos = selectedUtxos.addUtxo(remainingUtxosArray.shift())
-    fee = feeEstimator({ inputs: selectedUtxos, outputs })
+    fee = feeEstimator({ inputs: selectedUtxos, outputs, taprootInputWitnessSize })
   }
 
   if (selectedUtxos.value.lt(amount.add(fee))) {
@@ -246,6 +259,8 @@ export const getUtxosData = ({
   transferOrdinalsUtxos,
   unconfirmedTxAncestor,
   utxosDescendingOrder,
+  taprootInputWitnessSize,
+  changeAddressType,
 }) => {
   const { selectedUtxos, replaceTx, fee } = selectUtxos({
     asset,
@@ -263,6 +278,8 @@ export const getUtxosData = ({
     inscriptionIds,
     transferOrdinalsUtxos,
     utxosDescendingOrder,
+    taprootInputWitnessSize,
+    changeAddressType,
   })
 
   const resolvedFee = replaceTx ? fee.sub(replaceTx.feeAmount) : fee

package/src/tx-send/index.js

@@ -223,6 +223,7 @@ export const getPrepareSendTransaction =
     utxosDescendingOrder,
     rbfEnabled: providedRbfEnabled,
     assetClientInterface,
+    changeAddressType,
   }) =>
   async ({ asset: maybeToken, walletAccount, address, amount: tokenAmount, options }) => {
     const {
@@ -236,12 +237,14 @@ export const getPrepareSendTransaction =
       isExchange,
       isBip70,
       isRbfAllowed,
+      taprootInputWitnessSize,
     } = options
 
     const asset = maybeToken.baseAsset
     const assetName = asset.name
     const accountState = await assetClientInterface.getAccountState({ assetName, walletAccount })
     const feeData = await assetClientInterface.getFeeConfig({ assetName })
+    feeData.feePerKB = feePerKB ?? feeData.feePerKB
     const insightClient = asset.baseAsset.insightClient
 
     const blockHeight = providedBlockHeight || (await getBlockHeight({ assetName, insightClient }))
@@ -352,6 +355,8 @@ export const getPrepareSendTransaction =
       inscriptionIds,
       transferOrdinalsUtxos,
       utxosDescendingOrder,
+      taprootInputWitnessSize,
+      changeAddressType,
     })
 
     if (!selectedUtxos && !replaceTx) throw new Error('Not enough funds.')
@@ -471,6 +476,7 @@ export const createAndBroadcastTXFactory =
     ordinalsEnabled = false,
     utxosDescendingOrder,
     assetClientInterface,
+    changeAddressType,
   }) =>
   async ({ asset: maybeToken, walletAccount, address, amount: tokenAmount, options }) => {
     // Prepare transaction
@@ -498,6 +504,7 @@ export const createAndBroadcastTXFactory =
       utxosDescendingOrder,
       rbfEnabled,
       assetClientInterface,
+      changeAddressType,
     })({ asset: maybeToken, walletAccount, address, amount: tokenAmount, options })
     const {
       amount,