Class ElectrumXFeeEstimator

constructor

• new ElectrumXFeeEstimator(
      provider: ElectrumXProvider | ElectrumXConnectionPool,
      options?: Partial<FeeEstimationOptions>,
  ): ElectrumXFeeEstimator

  Parameters

  • provider: ElectrumXProvider | ElectrumXConnectionPool
  • Optionaloptions: Partial<FeeEstimationOptions>

  Returns ElectrumXFeeEstimator

Readonlyprovider

clearCache

• clearCache(): void

  Clear all cached estimates

  Returns void

exportFeeEstimates

• exportFeeEstimates(): Promise<
      {
          estimates: FeeEstimate[];
          metadata: {
              cacheSize: number;
              options: FeeEstimationOptions;
              provider: string;
          };
          timestamp: number;
      },
  >

  Export current fee estimates

  Returns Promise<
      {
          estimates: FeeEstimate[];
          metadata: {
              cacheSize: number;
              options: FeeEstimationOptions;
              provider: string;
          };
          timestamp: number;
      },
  >

getAllFeeEstimates

• getAllFeeEstimates(): Promise<FeeEstimate[]>

  Get comprehensive fee estimates for all priority levels

  Returns Promise<FeeEstimate[]>

getCacheStats

• getCacheStats(): {
      entries: { age: number; feeRate: number; key: string; priority: string }[];
      hitRate: number;
      size: number;
  }

  Get cache statistics

  Returns {
      entries: { age: number; feeRate: number; key: string; priority: string }[];
      hitRate: number;
      size: number;
  }

getFeeEstimate

• getFeeEstimate(
      priority: "low" | "medium" | "high" | "urgent" | "economy",
      confirmationTarget?: number,
      estimatedTime?: string,
  ): Promise<FeeEstimate>

  Get fee estimate for specific priority

  Parameters

  • priority: "low" | "medium" | "high" | "urgent" | "economy"
  • OptionalconfirmationTarget: number
  • OptionalestimatedTime: string

  Returns Promise<FeeEstimate>

getFeeRangeEstimate

• getFeeRangeEstimate(
      minTarget?: number,
      maxTarget?: number,
  ): Promise<
      {
          estimates: { estimatedTime: string; feeRate: number; target: number }[];
          recommended: FeeEstimate;
      },
  >

  Get fee estimates from multiple confirmation targets

  Parameters

  • minTarget: number = 1
  • maxTarget: number = 25

  Returns Promise<
      {
          estimates: { estimatedTime: string; feeRate: number; target: number }[];
          recommended: FeeEstimate;
      },
  >

getOptimalFee

• getOptimalFee(
      transactionSizeBytes: number,
      priority?: "low" | "medium" | "high" | "urgent" | "economy",
  ): Promise<{ estimate: FeeEstimate; feeRate: number; totalFee: number }>

  Get optimal fee for transaction size

  Parameters

  • transactionSizeBytes: number
  • priority: "low" | "medium" | "high" | "urgent" | "economy" = 'medium'

  Returns Promise<{ estimate: FeeEstimate; feeRate: number; totalFee: number }>

shutdown

• shutdown(): void

  Shutdown fee estimator

  Returns void

updateOptions

• updateOptions(newOptions: Partial<FeeEstimationOptions>): void

  Update estimation options

  Parameters

  • newOptions: Partial<FeeEstimationOptions>

  Returns void