feat: add mempool.space fee market

Author: AngelCastilloB

apps/browser-extension-wallet/.env.defaults

@@ -148,3 +148,6 @@ E2E_FORCE_TREZOR_PICKED=false
 
 # ADA handle cache lifetime
 HANDLE_RESOLUTION_CACHE_LIFETIME=600000
+
+# mempool.space api
+MEMPOOLSPACE_URL=https://mempool.live-mainnet.eks.lw.iog.io

apps/browser-extension-wallet/.env.developerpreview

@@ -99,3 +99,6 @@ LACE_EXTENSION_UNINSTALL_REDIRECT_URL=
 
 # Midnight
 MIDNIGHT_EVENT_BANNER_REMINDER_TIME=129600000
+
+# mempool.space api
+MEMPOOLSPACE_URL=https://mempool.live-mainnet.eks.lw.iog.io

apps/browser-extension-wallet/.env.example

@@ -117,3 +117,6 @@ MIN_NUMBER_OF_COSIGNERS=2
 
 # POLLING PAUSE AFTER INACTIVITY
 SESSION_TIMEOUT=300000
+
+# mempool.space api
+MEMPOOLSPACE_URL=https://mempool.live-mainnet.eks.lw.iog.io

apps/browser-extension-wallet/manifest.json

@@ -18,7 +18,7 @@
   "permissions": ["webRequest", "storage", "tabs", "unlimitedStorage"],
   "host_permissions": ["<all_urls>"],
   "content_security_policy": {
-    "extension_pages": "default-src 'self' $LOCALHOST_DEFAULT_SRC; frame-src https://connect.trezor.io/ https://www.youtube-nocookie.com; script-src 'self' 'wasm-unsafe-eval'; font-src 'self' data: https://use.typekit.net; object-src 'self'; connect-src $BLOCKFROST_URLS $MAESTRO_URLS $CARDANO_SERVICES_URLS $CARDANO_WS_SERVER_URLS $SENTRY_URL $DAPP_RADAR_APPI_URL https://coingecko.live-mainnet.eks.lw.iog.io https://coingecko.live-mainnet.eks.lw.iog.io https://muesliswap.live-mainnet.eks.lw.iog.io $LOCALHOST_CONNECT_SRC $POSTHOG_HOST https://use.typekit.net https://api.handle.me/ https://*.api.handle.me/ data:; style-src * 'unsafe-inline'; img-src * data: blob:;"
+    "extension_pages": "default-src 'self' $LOCALHOST_DEFAULT_SRC; frame-src https://connect.trezor.io/ https://www.youtube-nocookie.com; script-src 'self' 'wasm-unsafe-eval'; font-src 'self' data: https://use.typekit.net; object-src 'self'; connect-src $MEMPOOLSPACE_URL $BLOCKFROST_URLS $MAESTRO_URLS $CARDANO_SERVICES_URLS $CARDANO_WS_SERVER_URLS $SENTRY_URL $DAPP_RADAR_APPI_URL https://coingecko.live-mainnet.eks.lw.iog.io https://coingecko.live-mainnet.eks.lw.iog.io https://muesliswap.live-mainnet.eks.lw.iog.io $LOCALHOST_CONNECT_SRC $POSTHOG_HOST https://use.typekit.net https://api.handle.me/ https://*.api.handle.me/ data:; style-src * 'unsafe-inline'; img-src * data: blob:;"
   },
   "content_scripts": [
     {

apps/browser-extension-wallet/src/lib/scripts/background/wallet.ts

@@ -254,6 +254,15 @@ const bitcoinWalletFactory: BitcoinWalletFactory<Wallet.WalletMetadata, Wallet.A
             Bitcoin.Network.Mainnet
           );
 
+    const featureFlags = await getFeatureFlags(
+      network === Bitcoin.Network.Testnet ? Cardano.NetworkMagics.Preprod : Cardano.NetworkMagics.Mainnet
+    );
+    const useMempoolSpaceFeeMarket = isExperimentEnabled(featureFlags, ExperimentName.MEMPOOLSPACE_FEE_MARKET);
+
+    const feeMarketProvider = useMempoolSpaceFeeMarket
+      ? new Bitcoin.MempoolSpaceMarketProvider(process.env.MEMPOOLSPACE_URL, logger, network)
+      : new Bitcoin.MaestroFeeMarketProvider(provider, logger, network);
+
     if (!walletAccount.metadata.bitcoin) {
       throw new Error('Bitcoin metadata not found');
     }
@@ -278,6 +287,7 @@ const bitcoinWalletFactory: BitcoinWalletFactory<Wallet.WalletMetadata, Wallet.A
     currentBitcoinWalletProvider$.next(provider);
     return new Bitcoin.BitcoinWallet(
       provider,
+      feeMarketProvider,
       localPollingIntervalConfig,
       20,
       walletInfo,

apps/browser-extension-wallet/src/lib/scripts/types/feature-flags.ts

@@ -14,7 +14,8 @@ export enum ExperimentName {
   SEND_CONSOLE_ERRORS_TO_SENTRY = 'send-console-errors-to-sentry',
   BITCOIN_WALLETS = 'bitcoin-wallets',
   NFTPRINTLAB = 'nftprintlab',
-  GLACIER_DROP = 'glacier-drop'
+  GLACIER_DROP = 'glacier-drop',
+  MEMPOOLSPACE_FEE_MARKET = 'bitcoin-mempool-space-fee-market'
 }
 
 export type FeatureFlag = `${ExperimentName}`;
@@ -43,7 +44,6 @@ type FeatureFlagCustomPayloads = {
 
 export type FeatureFlagPayloads = {
   [key in FeatureFlag]: FeatureFlagPayload;
-} &
-  FeatureFlagCustomPayloads;
+} & FeatureFlagCustomPayloads;
 
 export type RawFeatureFlagPayloads = Record<ExperimentName, JsonType>;

apps/browser-extension-wallet/src/providers/PostHogClientProvider/client/config.ts

@@ -38,7 +38,8 @@ const defaultFeatureFlags: FeatureFlags = {
   [ExperimentName.SEND_CONSOLE_ERRORS_TO_SENTRY]: false,
   [ExperimentName.BITCOIN_WALLETS]: false,
   [ExperimentName.NFTPRINTLAB]: false,
-  [ExperimentName.GLACIER_DROP]: false
+  [ExperimentName.GLACIER_DROP]: false,
+  [ExperimentName.MEMPOOLSPACE_FEE_MARKET]: false
 };
 
 export const featureFlagsByNetworkInitialValue: FeatureFlagsByNetwork = {

apps/browser-extension-wallet/webpack-utils.js

@@ -54,6 +54,7 @@ const transformManifest = (content, mode, jsAssets = []) => {
           : 'http://localhost:* http://127.0.0.1:*'
       )
       .replace('$POSTHOG_HOST', process.env.POSTHOG_HOST)
+      .replace('$MEMPOOLSPACE_URL', process.env.MEMPOOLSPACE_URL)
       .replace('$SENTRY_URL', constructSentryConnectSrc(process.env.SENTRY_DSN))
       .replace('$DAPP_RADAR_APPI_URL', process.env.DAPP_RADAR_API_URL);
 

packages/bitcoin/src/wallet/lib/common/constants.ts

@@ -1,4 +1,4 @@
 export const INPUT_SIZE = 68;
-export const OUTPUT_SIZE = 34;
+export const OUTPUT_SIZE = 31;
 export const TRANSACTION_OVERHEAD = 10;
 export const DUST_THRESHOLD = 546;

packages/bitcoin/src/wallet/lib/tx-builder/TransactionBuilder.ts

@@ -6,16 +6,15 @@ import {
   validateBitcoinAddress,
   AddressValidationResult,
   UnsignedTransaction,
-  isP2trAddress
+  isP2trAddress,
+  INPUT_SIZE,
+  OUTPUT_SIZE,
+  TRANSACTION_OVERHEAD
 } from '../common';
 import { UTxO } from '../providers';
 import { payments, script, Psbt } from 'bitcoinjs-lib';
 import * as bitcoin from 'bitcoinjs-lib';
 
-const INPUT_SIZE = 68;
-const OUTPUT_SIZE = 34;
-const TRANSACTION_OVERHEAD = 10;
-
 /**
  * A class to build Bitcoin transactions using a flexible input and output management system.
  */

packages/bitcoin/src/wallet/lib/wallet/BitcoinWallet.ts

@@ -3,7 +3,6 @@ import {
   BlockchainDataProvider,
   BlockchainInputResolver,
   BlockInfo,
-  FeeEstimationMode,
   InputResolver,
   TransactionHistoryEntry,
   UTxO
@@ -25,6 +24,7 @@ import * as bitcoin from 'bitcoinjs-lib';
 import * as ecc from '@bitcoinerlab/secp256k1';
 import isEqual from 'lodash/isEqual';
 import { historyEntryFromRawTx } from '../tx-builder/utils';
+import { FeeMarketProvider } from '@wallet/lib/wallet/FeeMarketProvider';
 
 bitcoin.initEccLib(ecc);
 
@@ -91,6 +91,7 @@ export class BitcoinWallet {
   private pollController$: Observable<boolean>;
   private logger: Logger;
   private inputResolver: InputResolver;
+  private readonly feeMarketProvider: FeeMarketProvider;
 
   public syncStatus: SyncStatus;
 
@@ -107,6 +108,7 @@ export class BitcoinWallet {
   // eslint-disable-next-line max-params
   constructor(
     provider: BlockchainDataProvider,
+    feeMarketProvider: FeeMarketProvider,
     pollInterval = 30_000,
     historyDepth = 20,
     info: BitcoinWalletInfo,
@@ -133,6 +135,7 @@ export class BitcoinWallet {
 
     // TODO: Allow this to be injected.
     this.inputResolver = new BlockchainInputResolver(provider);
+    this.feeMarketProvider = feeMarketProvider;
 
     const networkKeys = getNetworkKeys(info, network);
     const extendedAccountPubKey = networkKeys.nativeSegWit;
@@ -175,46 +178,7 @@ export class BitcoinWallet {
    * Fetches the current fee market for estimating transaction fees.
    */
   public async getCurrentFeeMarket(): Promise<EstimatedFees> {
-    try {
-      if (this.network === Network.Testnet) {
-        return {
-          fast: {
-            feeRate: 0.000_025,
-            targetConfirmationTime: 1
-          },
-          standard: {
-            feeRate: 0.000_015,
-            targetConfirmationTime: 3
-          },
-          slow: {
-            feeRate: 0.000_01,
-            targetConfirmationTime: 6
-          }
-        };
-      }
-
-      const fastEstimate = await this.provider.estimateFee(1, FeeEstimationMode.Conservative);
-      const standardEstimate = await this.provider.estimateFee(3, FeeEstimationMode.Conservative);
-      const slowEstimate = await this.provider.estimateFee(6, FeeEstimationMode.Conservative);
-
-      return {
-        fast: {
-          feeRate: fastEstimate.feeRate,
-          targetConfirmationTime: fastEstimate.blocks * 10 * 60
-        },
-        standard: {
-          feeRate: standardEstimate.feeRate,
-          targetConfirmationTime: standardEstimate.blocks * 10 * 60
-        },
-        slow: {
-          feeRate: slowEstimate.feeRate,
-          targetConfirmationTime: slowEstimate.blocks * 10 * 60
-        }
-      };
-    } catch (error) {
-      this.logger.error('Failed to fetch fee market:', error);
-      throw error;
-    }
+    return this.feeMarketProvider.getFeeMarket();
   }
 
   /**

packages/bitcoin/src/wallet/lib/wallet/FeeMarketProvider.ts

@@ -0,0 +1,16 @@
+import { EstimatedFees } from '@wallet';
+
+/**
+ * Interface for providing a fee estimation strategy.
+ *
+ * Implementations of this interface are responsible for retrieving
+ * current fee market data from a source and returning a normalized fee structure.
+ */
+export interface FeeMarketProvider {
+  /**
+   * Retrieves current fee estimates.
+   *
+   * @returns A promise resolving to the latest fee estimates.
+   */
+  getFeeMarket(): Promise<EstimatedFees>;
+}

packages/bitcoin/src/wallet/lib/wallet/MaestroFeeMarketProvider.ts

@@ -0,0 +1,44 @@
+/* eslint-disable no-magic-numbers */
+import { EstimatedFees, FeeEstimationMode, MaestroBitcoinDataProvider, Network } from '@wallet';
+import { Logger } from 'ts-log';
+import { FeeMarketProvider } from './FeeMarketProvider';
+import { DEFAULT_MARKETS } from './constants';
+
+export class MaestroFeeMarketProvider implements FeeMarketProvider {
+  constructor(
+    private readonly provider: MaestroBitcoinDataProvider,
+    private readonly logger: Logger,
+    private readonly network: Network = Network.Mainnet
+  ) {}
+
+  async getFeeMarket(): Promise<EstimatedFees> {
+    try {
+      if (this.network === Network.Testnet) {
+        return DEFAULT_MARKETS;
+      }
+
+      const fastEstimate = await this.provider.estimateFee(1, FeeEstimationMode.Economical);
+      const standardEstimate = await this.provider.estimateFee(3, FeeEstimationMode.Economical);
+      const slowEstimate = await this.provider.estimateFee(6, FeeEstimationMode.Economical);
+
+      return {
+        fast: {
+          feeRate: fastEstimate.feeRate,
+          targetConfirmationTime: fastEstimate.blocks * 10 * 60
+        },
+        standard: {
+          feeRate: standardEstimate.feeRate,
+          targetConfirmationTime: standardEstimate.blocks * 10 * 60
+        },
+        slow: {
+          feeRate: slowEstimate.feeRate,
+          targetConfirmationTime: slowEstimate.blocks * 10 * 60
+        }
+      };
+    } catch (error) {
+      this.logger.error('Failed to fetch fee market:', error);
+    }
+
+    return DEFAULT_MARKETS;
+  }
+}

packages/bitcoin/src/wallet/lib/wallet/MempoolSpaceMarketProvider.ts

@@ -0,0 +1,55 @@
+/* eslint-disable no-magic-numbers */
+import { EstimatedFees, Network } from '@wallet';
+import { FeeMarketProvider } from './FeeMarketProvider';
+import axios, { AxiosInstance } from 'axios';
+import { Logger } from 'ts-log';
+import { DEFAULT_MARKETS } from './constants';
+
+const satsPerVByteToBtcPerKB = (satsPerVByte: number): number => (satsPerVByte * 1000) / 100_000_000;
+
+export class MempoolSpaceMarketProvider implements FeeMarketProvider {
+  private readonly api: AxiosInstance;
+
+  constructor(
+    url: string,
+    private readonly logger: Logger,
+    private readonly network: Network = Network.Mainnet
+  ) {
+    this.api = axios.create({
+      baseURL: url
+    });
+  }
+
+  async getFeeMarket(): Promise<EstimatedFees> {
+    try {
+      if (this.network === Network.Testnet) {
+        return DEFAULT_MARKETS;
+      }
+
+      const response = await this.api.get('/api/v1/fees/recommended');
+
+      const fastEstimate = response.data.fastestFee;
+      const standardEstimate = response.data.halfHourFee;
+      const slowEstimate = response.data.hourFee;
+
+      return {
+        fast: {
+          feeRate: satsPerVByteToBtcPerKB(fastEstimate),
+          targetConfirmationTime: 600 // 10 minutes
+        },
+        standard: {
+          feeRate: satsPerVByteToBtcPerKB(standardEstimate),
+          targetConfirmationTime: 1800 // 30 minutes
+        },
+        slow: {
+          feeRate: satsPerVByteToBtcPerKB(slowEstimate),
+          targetConfirmationTime: 3600 // 60 minutes
+        }
+      };
+    } catch (error) {
+      this.logger.error('Failed to fetch fee market:', error);
+    }
+
+    return DEFAULT_MARKETS;
+  }
+}

packages/bitcoin/src/wallet/lib/wallet/constants.ts

@@ -0,0 +1,14 @@
+export const DEFAULT_MARKETS = {
+  fast: {
+    feeRate: 0.000_025,
+    targetConfirmationTime: 1
+  },
+  standard: {
+    feeRate: 0.000_015,
+    targetConfirmationTime: 3
+  },
+  slow: {
+    feeRate: 0.000_01,
+    targetConfirmationTime: 6
+  }
+};

packages/bitcoin/src/wallet/lib/wallet/index.ts

@@ -1,2 +1,5 @@
 export * from './BitcoinWallet';
 export * from './BitcoinSigner';
+export * from './FeeMarketProvider';
+export * from './MaestroFeeMarketProvider';
+export * from './MempoolSpaceMarketProvider';