@exodus/bitcoin-api 2.19.0 → 2.20.0

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/bitcoin-api",
-  "version": "2.19.0",
+  "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": "9c3024f69fbda1069a437fb19c43e6f341185c6f"
+  "gitHead": "0dc141fc6a249ac051a5ca591d46cbc81096a4f3"
 }

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

@@ -19,6 +19,7 @@ const _canBumpTx = ({
   allowUnconfirmedRbfEnabledUtxos,
   utxosDescendingOrder,
   taprootInputWitnessSize,
+  changeAddressType,
 }) => {
   assert(asset, 'asset must be provided')
   assert(tx, 'tx must be provided')
@@ -95,6 +96,7 @@ const _canBumpTx = ({
       unconfirmedTxAncestor,
       utxosDescendingOrder,
       taprootInputWitnessSize,
+      changeAddressType,
     })
     if (replaceTx) return { bumpType: BumpType.RBF, bumpFee: fee.sub(replaceTx.feeAmount) }
   }
@@ -103,13 +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/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 = ({
@@ -151,10 +158,11 @@ export class GetFeeResolver {
       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,
@@ -164,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

@@ -36,6 +36,7 @@ export const selectUtxos = ({
   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,
@@ -54,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
@@ -263,6 +260,7 @@ export const getUtxosData = ({
   unconfirmedTxAncestor,
   utxosDescendingOrder,
   taprootInputWitnessSize,
+  changeAddressType,
 }) => {
   const { selectedUtxos, replaceTx, fee } = selectUtxos({
     asset,
@@ -281,6 +279,7 @@ export const getUtxosData = ({
     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 {
@@ -243,6 +244,7 @@ export const getPrepareSendTransaction =
     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 }))
@@ -354,6 +356,7 @@ export const getPrepareSendTransaction =
       transferOrdinalsUtxos,
       utxosDescendingOrder,
       taprootInputWitnessSize,
+      changeAddressType,
     })
 
     if (!selectedUtxos && !replaceTx) throw new Error('Not enough funds.')
@@ -473,18 +476,11 @@ export const createAndBroadcastTXFactory =
     ordinalsEnabled = false,
     utxosDescendingOrder,
     assetClientInterface,
+    changeAddressType,
   }) =>
   async ({ asset: maybeToken, walletAccount, address, amount: tokenAmount, options }) => {
     // Prepare transaction
-    const {
-      bumpTxId,
-      nft,
-      isExchange,
-      isBip70,
-      isRbfAllowed = true,
-      feeOpts,
-      taprootInputWitnessSize,
-    } = options
+    const { bumpTxId, nft, isExchange, isBip70, isRbfAllowed = true, feeOpts } = options
 
     const asset = maybeToken.baseAsset
     const assetName = asset.name
@@ -508,7 +504,7 @@ export const createAndBroadcastTXFactory =
       utxosDescendingOrder,
       rbfEnabled,
       assetClientInterface,
-      taprootInputWitnessSize,
+      changeAddressType,
     })({ asset: maybeToken, walletAccount, address, amount: tokenAmount, options })
     const {
       amount,