Class WasteMetrics

Hierarchy (View Summary)

WalletMetrics
- WasteMetrics

Index

Constructors

Properties

Methods

calculateDustLimits constructAddressUsageMap feesToAmountRatio getClosestPercentile getFeeRateForTransaction getFeeRatePercentileScore isReusedAddress relativeFeesScore utxoMassFactor weightedWasteScore

Constructors

constructor

new WasteMetrics(
transactions?: Transaction[],
utxos?: AddressUtxos,
): WasteMetrics
Parameters
- Optionaltransactions: Transaction[]
- Optionalutxos: AddressUtxos
Returns WasteMetrics
Inherited from WalletMetrics.constructor
- Defined in packages/caravan-health/src/wallet.ts:8

Properties

addressUsageMap

addressUsageMap: Map<string, number> = ...

transactions

transactions: Transaction[] = []

utxos

utxos: AddressUtxos = {}

Methods

calculateDustLimits

calculateDustLimits(
    feeRate: number,
    scriptType: MultisigAddressType,
    config: { requiredSignerCount: number; totalSignerCount: number },
    riskMultiplier?: number,
): { lowerLimit: number; upperLimit: number }
Parameters
- feeRate: number
- scriptType: MultisigAddressType
- config: { requiredSignerCount: number; totalSignerCount: number }
- riskMultiplier: number = 2
Returns { lowerLimit: number; upperLimit: number }
- Defined in packages/caravan-health/src/waste.ts:107

constructAddressUsageMap

constructAddressUsageMap(): Map<string, number>
Returns Map<string, number>
Inherited from WalletMetrics.constructAddressUsageMap
- Defined in packages/caravan-health/src/wallet.ts:120

feesToAmountRatio

feesToAmountRatio(): number
Returns number
- Defined in packages/caravan-health/src/waste.ts:67

getClosestPercentile

getClosestPercentile(
    timestamp: number,
    feeRate: number,
    feeRatePercentileHistory: FeeRatePercentile[],
): number
Parameters
- timestamp: number
- feeRate: number
- feeRatePercentileHistory: FeeRatePercentile[]
Returns number
Inherited from WalletMetrics.getClosestPercentile
- Defined in packages/caravan-health/src/wallet.ts:80

getFeeRateForTransaction

getFeeRateForTransaction(transaction: Transaction): number
Parameters
- transaction: Transaction
Returns number
Inherited from WalletMetrics.getFeeRateForTransaction
- Defined in packages/caravan-health/src/wallet.ts:55

getFeeRatePercentileScore

getFeeRatePercentileScore(
    timestamp: number,
    feeRate: number,
    feeRatePercentileHistory: FeeRatePercentile[],
): number
Parameters
- timestamp: number
- feeRate: number
- feeRatePercentileHistory: FeeRatePercentile[]
Returns number
Inherited from WalletMetrics.getFeeRatePercentileScore
- Defined in packages/caravan-health/src/wallet.ts:64

isReusedAddress

isReusedAddress(address: string): boolean
Parameters
- address: string
Returns boolean
Inherited from WalletMetrics.isReusedAddress
- Defined in packages/caravan-health/src/wallet.ts:139

relativeFeesScore

relativeFeesScore(feeRatePercentileHistory: FeeRatePercentile[]): number
Parameters
- feeRatePercentileHistory: FeeRatePercentile[]
Returns number
- Defined in packages/caravan-health/src/waste.ts:26

utxoMassFactor

utxoMassFactor(): number
Returns number
Inherited from WalletMetrics.utxoMassFactor
- Defined in packages/caravan-health/src/wallet.ts:30

weightedWasteScore

weightedWasteScore(feeRatePercentileHistory: FeeRatePercentile[]): number
Parameters
- feeRatePercentileHistory: FeeRatePercentile[]
Returns number
- Defined in packages/caravan-health/src/waste.ts:164

Class WasteMetrics

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WasteMetrics

Properties

addressUsageMap

transactions

utxos

Methods

calculateDustLimits

Parameters

Returns { lowerLimit: number; upperLimit: number }

constructAddressUsageMap

Returns Map<string, number>

feesToAmountRatio

Returns number

getClosestPercentile

Parameters

Returns number

getFeeRateForTransaction

Parameters

Returns number

getFeeRatePercentileScore

Parameters

Returns number

isReusedAddress

Parameters

Returns boolean

relativeFeesScore

Parameters

Returns number

utxoMassFactor

Returns number

weightedWasteScore

Parameters

Returns number

Settings

On This Page