@exodus/bitcoin-api 2.19.0 → 2.20.1

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.20.1](https://github.com/ExodusMovement/assets/compare/@exodus/bitcoin-api@2.20.0...@exodus/bitcoin-api@2.20.1) (2024-07-15)
+
+**Note:** Version bump only for package @exodus/bitcoin-api
+
+
+
+
+
+## [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.1",
   "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": "e1354557f99e81651fad1b25a4f72183587324b6"
 }

package/src/account-state.js

@@ -1,6 +1,11 @@
 import { AccountState, UtxoCollection } from '@exodus/models'
 
-export function createAccountState({ asset, ordinalsEnabled = false, brc20Enabled = false }) {
+export function createAccountState({
+  asset,
+  ordinalsEnabled = false,
+  brc20Enabled = false,
+  isMagicEdenFungibleBalancesEnabled = false,
+}) {
   const empty = UtxoCollection.createEmpty({
     currency: asset.currency,
   })
@@ -22,6 +27,10 @@ export function createAccountState({ asset, ordinalsEnabled = false, brc20Enable
     defaults.brc20Balances = {}
   }
 
+  if (isMagicEdenFungibleBalancesEnabled) {
+    defaults.magicEdenApiFungibleBalances = []
+  }
+
   return class BitcoinAccountState extends AccountState {
     static defaults = defaults
   }

package/src/balances.js

@@ -13,6 +13,20 @@ export const getBalancesFactory = ({ feeData, getSpendableBalance, ordinalsEnabl
     assert(asset, 'asset is required')
     assert(accountState, 'accountState is required')
     assert(txLog, 'txLog is required')
+
+    if (accountState.magicEdenApiFungibleBalances) {
+      const validBalances = accountState.magicEdenApiFungibleBalances.filter(
+        (fungibleBalance) => fungibleBalance.asset.ticker === asset.ticker
+      )
+      const parsedBalances = validBalances.map(({ balance }) =>
+        asset.currency.defaultUnit(balance.balance)
+      )
+      const totalBalance = asset.currency.defaultUnit(
+        parsedBalances.reduce((sum, item) => sum.add(item), asset.currency.ZERO)
+      )
+      return { balance: totalBalance }
+    }
+
     const utxos = getUtxos({ asset, accountState })
     const balance = utxos.value
     const spendableBalance = getSpendableBalance({

package/src/btc-like-keys.js

@@ -4,7 +4,7 @@ import * as bech32 from 'bech32'
 import assert from 'minimalistic-assert'
 import { identity, pickBy } from 'lodash'
 import * as defaultBitcoinjsLib from '@exodus/bitcoinjs-lib'
-import * as secp256k1 from 'secp256k1'
+import secp256k1 from 'secp256k1'
 import { hash160 } from './hash-utils'
 import { toXOnly } from './bitcoinjs-lib/ecc-utils'
 import { ecc } from './bitcoinjs-lib/ecc'

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/move-funds.js

@@ -2,7 +2,7 @@ import wif from 'wif'
 import { UtxoCollection, Address } from '@exodus/models'
 import { createInputs, createOutput, getNonWitnessTxs } from './tx-send'
 import assert from 'minimalistic-assert'
-import * as secp256k1 from 'secp256k1'
+import secp256k1 from 'secp256k1'
 
 const isValidPrivateKey = (privateKey) => {
   try {

package/src/tx-log/bitcoin-me-monitor.js

@@ -0,0 +1,78 @@
+import { Monitor as BitcoinMonitor } from './bitcoin-monitor'
+import fetchFlagrEvaluation from './me-flagr'
+
+const FLAGR_KEY = 'bitcoin-balance-api'
+
+export class MagicEdenBitcoinMonitor extends BitcoinMonitor {
+  constructor(args) {
+    super(args)
+    this.useMagicEdenMonitor = false
+  }
+
+  async setServer(assetConfig = {}) {
+    super.setServer(assetConfig)
+
+    const walletAccounts = await this.aci.getWalletAccounts({ assetName: this.asset.name })
+    const address = await this.aci.getReceiveAddress({
+      assetName: this.asset.name,
+      walletAccount: walletAccounts[0],
+      useCache: true,
+    })
+    await this.initFlagr(address)
+  }
+
+  async initFlagr(address) {
+    if (this.useMagicEdenMonitor) return
+    try {
+      const response = await fetchFlagrEvaluation(address, FLAGR_KEY)
+      if (response.variantKey === 'on') {
+        this.useMagicEdenMonitor = true
+      }
+    } catch (error) {
+      console.error('Failed to fetch useMagicEdenMonitor config:', error)
+    }
+  }
+
+  async fetchFungibleBalances(walletAccount) {
+    if (!this.useMagicEdenMonitor) return
+
+    const purposes = await this.aci.getSupportedPurposes({
+      assetName: this.asset.name,
+      walletAccount,
+    })
+
+    const addresses = await Promise.all(
+      purposes.map((purpose) =>
+        this.aci.getReceiveAddress({
+          assetName: this.asset.name,
+          walletAccount,
+          useCache: true,
+          purpose,
+        })
+      )
+    )
+
+    const response = await fetch('https://api-mainnet.magiceden.io/v1/wallet/balances/fungible', {
+      method: 'POST',
+      headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(
+        addresses.map((address) => ({ address, chain: this.asset.baseAssetName }))
+      ),
+    })
+
+    if (!response.ok) {
+      throw new Error(
+        `Unable to fetch bitcoin fungible balanes: API returned ${response.status}: ${response.statusText || 'Unknown Status Text'}`
+      )
+    }
+
+    const { balances } = await response.json()
+
+    return balances
+  }
+}
+
+export const createMagicEdenBitcoinMonitor = (args) => new MagicEdenBitcoinMonitor(args)

package/src/tx-log/bitcoin-monitor.js

@@ -281,6 +281,12 @@ export class Monitor extends BaseMonitor {
       newData.mem = { unconfirmedTxAncestor }
     }
 
+    if (this.fetchFungibleBalances) {
+      try {
+        newData.magicEdenApiFungibleBalances = await this.fetchFungibleBalances(walletAccount)
+      } catch {}
+    }
+
     await aci.updateAccountState({
       assetName,
       walletAccount,

package/src/tx-log/index.js

@@ -1,2 +1,3 @@
 export * from './bitcoin-monitor'
+export * from './magic-eden-bitcoin-monitor'
 export * from './bitcoin-monitor-scanner'

package/src/tx-log/magic-eden-bitcoin-monitor.js

@@ -0,0 +1,86 @@
+import { Monitor as BitcoinMonitor } from './bitcoin-monitor'
+import fetchFlagrEvaluation from './me-flagr'
+
+const FLAGR_KEY = 'bitcoin-balance-api'
+
+export class MagicEdenBitcoinMonitor extends BitcoinMonitor {
+  constructor(args) {
+    super(args)
+    this.useMagicEdenMonitor = false
+  }
+
+  async setServer(assetConfig = {}) {
+    super.setServer(assetConfig)
+
+    const walletAccounts = await this.aci.getWalletAccounts({ assetName: this.asset.name })
+    const address = await this.aci.getReceiveAddress({
+      assetName: this.asset.name,
+      walletAccount: walletAccounts[0],
+      useCache: true,
+    })
+    await this.initFlagr(address)
+  }
+
+  async initFlagr(address) {
+    if (this.useMagicEdenMonitor) return
+    try {
+      const response = await fetchFlagrEvaluation(address, FLAGR_KEY)
+      if (response.variantKey === 'on') {
+        this.useMagicEdenMonitor = true
+      }
+    } catch (error) {
+      console.error('Failed to fetch useMagicEdenMonitor config:', error)
+    }
+  }
+
+  async fetchFungibleBalances(walletAccount) {
+    if (!this.useMagicEdenMonitor) return
+
+    const purposes = await this.aci.getSupportedPurposes({
+      assetName: this.asset.name,
+      walletAccount,
+    })
+
+    const addresses = await Promise.all(
+      purposes.map((purpose) =>
+        this.aci.getReceiveAddress({
+          assetName: this.asset.name,
+          walletAccount,
+          useCache: true,
+          purpose,
+        })
+      )
+    )
+
+    const response = await fetch('https://api-mainnet.magiceden.io/v1/wallet/balances/fungible', {
+      method: 'POST',
+      headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(
+        addresses.map((address) => ({ address, chain: this.asset.baseAssetName }))
+      ),
+    })
+
+    if (!response.ok) {
+      throw new Error(
+        `Unable to fetch bitcoin fungible balanes: API returned ${response.status}: ${response.statusText || 'Unknown Status Text'}`
+      )
+    }
+
+    const { balances } = await response.json()
+
+    const metadata = new Map()
+    balances.forEach((balance) => {
+      if (balance.asset?.id && balance.image) {
+        metadata.set(balance.asset.id, { imageURL: balance.image })
+      }
+    })
+    this.emit('token-metadata', { source: 'bitcoin', metadata })
+
+    return balances
+  }
+}
+
+export const createMagicEdenBitcoinMonitor = (args) => new MagicEdenBitcoinMonitor(args)

package/src/tx-log/me-flagr.js

@@ -0,0 +1,22 @@
+const FLAGR_URL = 'https://flagr-w.magiceden.io/api/v1/evaluation'
+
+const fetchFlagrEvaluation = async (wallet, flagKey) => {
+  const response = await fetch(FLAGR_URL, {
+    method: 'POST',
+    headers: {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({ entityContext: { wallet }, flagKey }),
+  })
+
+  if (!response.ok) {
+    throw new Error(
+      `${FLAGR_URL} returned ${response.status}: ${response.statusText || 'Unknown Status Text'}`
+    )
+  }
+
+  return response.json()
+}
+
+export default fetchFlagrEvaluation

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,

package/src/tx-sign/create-get-key-and-purpose.js

@@ -6,7 +6,7 @@ import KeyIdentifier from '@exodus/key-identifier'
 
 import { getECPair } from '../bitcoinjs-lib'
 
-import * as secp256k1 from 'secp256k1'
+import secp256k1 from 'secp256k1'
 
 const ECPair = getECPair()