Class FeeEstimator

Hierarchy (View Summary)

FeeEstimator
- AdvancedFeeCalculator

Implements

IFeeEstimator

Index

Constructors

Methods

calculateCPFP calculateRBF calculateTransactionSize estimateFee getDustThresholds getFeeRates getInputSize getNormalizedFeeRates getOptimalFee getOutputSize getProviderInfo isAboveDustThreshold setProvider testProvider

Constructors

constructor

new FeeEstimator(
options?: FeeEstimatorOptions,
src20Options?: SRC20Options,
): FeeEstimator
Parameters
- Optionaloptions: FeeEstimatorOptions
- Optionalsrc20Options: SRC20Options
Returns FeeEstimator
- Defined in core/fee-estimator.ts:68

Methods

calculateCPFP

calculateCPFP(
    parentTxid: string,
    parentFee: number,
    childSize: number,
    targetFeeRate: number,
): Promise<number>
Calculate CPFP (Child Pays For Parent) fee
Parameters
- parentTxid: string
- parentFee: number
- childSize: number
- targetFeeRate: number
Returns Promise<number>
Implementation of IFeeEstimator.calculateCPFP
- Defined in core/fee-estimator.ts:298

calculateRBF

calculateRBF(originalFee: number, minRelayFee?: number): number
Calculate RBF (Replace By Fee) fee
Parameters
- originalFee: number
- minRelayFee: number = 1
Returns number
Implementation of IFeeEstimator.calculateRBF
- Defined in core/fee-estimator.ts:341

calculateTransactionSize

calculateTransactionSize(
inputs: { type: InputType; witnessScript?: Buffer<ArrayBufferLike> }[],
outputs: { size?: number; type: OutputType }[],
): SizeCalculation
Calculate accurate transaction size with witness data
Parameters
- inputs: { type: InputType; witnessScript?: Buffer<ArrayBufferLike> }[]
- outputs: { size?: number; type: OutputType }[]
Returns SizeCalculation
Implementation of IFeeEstimator.calculateTransactionSize
- Defined in core/fee-estimator.ts:195

estimateFee

estimateFee(
size: number,
priority: "low" | "medium" | "high" | "urgent",
): Promise<FeeEstimate>
Estimate fee for transaction with enhanced calculation
Parameters
- size: number
- priority: "low" | "medium" | "high" | "urgent"
Returns Promise<FeeEstimate>
Implementation of IFeeEstimator.estimateFee
- Defined in core/fee-estimator.ts:155

getDustThresholds

getDustThresholds(feeRate?: number): DustThresholds
Get dynamic dust thresholds based on fee rates
Parameters
- OptionalfeeRate: number
Returns DustThresholds
Implementation of IFeeEstimator.getDustThresholds
- Defined in core/fee-estimator.ts:268

getFeeRates

getFeeRates(): Promise<FeeRate>
Get current fee rates with historical context

Returns Promise<FeeRate>
Implementation of IFeeEstimator.getFeeRates
- Defined in core/fee-estimator.ts:100

getInputSize

getInputSize(
type: InputType,
witnessScript?: Buffer<ArrayBufferLike>,
): SizeCalculation
Calculate input type specific sizes
Parameters
- type: InputType
- OptionalwitnessScript: Buffer<ArrayBufferLike>
Returns SizeCalculation
Implementation of IFeeEstimator.getInputSize
- Defined in core/fee-estimator.ts:224

getNormalizedFeeRates

getNormalizedFeeRates(): Promise<
    {
        high: NormalizedFeeRate;
        low: NormalizedFeeRate;
        medium: NormalizedFeeRate;
        urgent: NormalizedFeeRate;
    },
>
Get normalized fee rates for all priority levels

Returns Promise<
    {
        high: NormalizedFeeRate;
        low: NormalizedFeeRate;
        medium: NormalizedFeeRate;
        urgent: NormalizedFeeRate;
    },
>
- Defined in core/fee-estimator.ts:404

getOptimalFee

getOptimalFee(
    params: {
        inputs: { type: InputType; witnessScript?: Buffer<ArrayBufferLike> }[];
        outputs: { size?: number; type: OutputType }[];
        priority?: "low" | "medium" | "high" | "urgent";
    },
): Promise<FeeEstimate & { sizeBreakdown: SizeCalculation }>
Get fee estimation for specific transaction parameters
Parameters
- params: {
      inputs: { type: InputType; witnessScript?: Buffer<ArrayBufferLike> }[];
      outputs: { size?: number; type: OutputType }[];
      priority?: "low" | "medium" | "high" | "urgent";
  }
Returns Promise<FeeEstimate & { sizeBreakdown: SizeCalculation }>
- Defined in core/fee-estimator.ts:351

getOutputSize

getOutputSize(type: OutputType, scriptSize?: number): number
Calculate output type specific sizes
Parameters
- type: OutputType
- OptionalscriptSize: number
Returns number
Implementation of IFeeEstimator.getOutputSize
- Defined in core/fee-estimator.ts:216

getProviderInfo

getProviderInfo(): {
    electrumXConnected: boolean;
    fallbackFeeRate: number;
    provider: string;
    useMockProvider: boolean;
}
Get current provider configuration

Returns {
    electrumXConnected: boolean;
    fallbackFeeRate: number;
    provider: string;
    useMockProvider: boolean;
}
- Defined in core/fee-estimator.ts:550

isAboveDustThreshold

isAboveDustThreshold(
    value: number,
    outputType: OutputType,
    feeRate?: number,
): boolean
Validate if output value is above dust threshold
Parameters
- value: number
- outputType: OutputType
- OptionalfeeRate: number
Returns boolean
- Defined in core/fee-estimator.ts:373

setProvider

setProvider(
    provider: NonNullable<
        undefined
        | "mempool"
        | "blockstream"
        | "electrum"
        | "custom",
    >,
): void
Set custom fee provider
Parameters
- provider: NonNullable<undefined | "mempool" | "blockstream" | "electrum" | "custom">
Returns void
- Defined in core/fee-estimator.ts:533

testProvider

testProvider(): Promise<
{ error?: string; latency?: number; provider: string; success: boolean },
>
Test connection to current fee provider

Returns Promise<
{ error?: string; latency?: number; provider: string; success: boolean },
>
- Defined in core/fee-estimator.ts:567

Class FeeEstimator

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FeeEstimator

Methods

calculateCPFP

Parameters

Returns Promise<number>

calculateRBF

Parameters

Returns number

calculateTransactionSize

Parameters

Returns SizeCalculation

estimateFee

Parameters

Returns Promise<FeeEstimate>

getDustThresholds

Parameters

Returns DustThresholds

getFeeRates

Returns Promise<FeeRate>

getInputSize

Parameters

Returns SizeCalculation

getNormalizedFeeRates

Returns Promise< { high: NormalizedFeeRate; low: NormalizedFeeRate; medium: NormalizedFeeRate; urgent: NormalizedFeeRate; },>

getOptimalFee

Parameters

Returns Promise<FeeEstimate & { sizeBreakdown: SizeCalculation }>

getOutputSize

Parameters

Returns number

getProviderInfo

Returns { electrumXConnected: boolean; fallbackFeeRate: number; provider: string; useMockProvider: boolean;}

isAboveDustThreshold

Parameters

Returns boolean

setProvider

Parameters

Returns void

testProvider

Returns Promise< { error?: string; latency?: number; provider: string; success: boolean },>

Settings

On This Page

Returns Promise<
{
high: NormalizedFeeRate;
low: NormalizedFeeRate;
medium: NormalizedFeeRate;
urgent: NormalizedFeeRate;
},
>

Returns {
electrumXConnected: boolean;
fallbackFeeRate: number;
provider: string;
useMockProvider: boolean;
}

Returns Promise<
{ error?: string; latency?: number; provider: string; success: boolean },
>