Class AccumulativeSelector

Simple accumulative UTXO selection algorithm

Remarks

Selects UTXOs in order (typically largest first) until the target amount is reached. This is the simplest and fastest selection algorithm, suitable for most basic transactions.

Features:

Fast O(n) selection
Deterministic results
Minimal computational overhead
Good for time-sensitive operations

Example

const selector = new AccumulativeSelector();
const result = selector.select(utxos, {
  targetValue: 100000,
  feeRate: 10
});

Hierarchy

BaseSelector
- AccumulativeSelector

Constructors

constructor

new AccumulativeSelector(): AccumulativeSelector
Returns AccumulativeSelector
Inherited from BaseSelector.constructor

Properties

`Protected` `Readonly`DUST_THRESHOLD

DUST_THRESHOLD: 546

`Protected` `Readonly`INPUT_SIZE

INPUT_SIZE: 148

`Protected` `Readonly`OUTPUT_SIZE

OUTPUT_SIZE: 34

`Protected` `Readonly`TRANSACTION_OVERHEAD

TRANSACTION_OVERHEAD: 10

Methods

`Protected`calculateChange

calculateChange(inputValue: number, targetValue: number, fee: number): number
Calculate change amount
Parameters
- inputValue: number
- targetValue: number
- fee: number
Returns number
Inherited from BaseSelector.calculateChange
- Defined in selectors/base-selector.ts:111

`Protected`calculateWaste

calculateWaste(
    inputs: UTXO[],
    targetValue: number,
    feeRate: number,
    longTermFeeRate?: number,
): number
Calculate waste metric for coin selection Lower waste is better
Parameters
- inputs: UTXO[]
- targetValue: number
- feeRate: number
- longTermFeeRate: number = 10
Returns number
Inherited from BaseSelector.calculateWaste
- Defined in selectors/base-selector.ts:202

`Protected`checkOptionsValidity

checkOptionsValidity(options: SelectionOptions): null | EnhancedSelectionResult
Check if options are valid and return failure result if not
Parameters
- options: SelectionOptions
Returns null | EnhancedSelectionResult
Inherited from BaseSelector.checkOptionsValidity
- Defined in selectors/base-selector.ts:167

`Protected`createResult

createResult(
    inputs: UTXO[],
    targetValue: number,
    feeRate: number,
    hasChange: boolean,
): SelectionSuccess
Create selection result
Parameters
- inputs: UTXO[]
- targetValue: number
- feeRate: number
- hasChange: boolean
Returns SelectionSuccess
Inherited from BaseSelector.createResult
- Defined in selectors/base-selector.ts:122

estimateFee

estimateFee(numInputs: number, numOutputs: number, feeRate: number): number
Estimate transaction fee
Parameters
- numInputs: number
- numOutputs: number
- feeRate: number
Returns number
Inherited from BaseSelector.estimateFee
- Defined in selectors/base-selector.ts:85

`Protected`estimateTransactionSize

estimateTransactionSize(numInputs: number, numOutputs: number): number
Estimate transaction size in vBytes
Parameters
- numInputs: number
- numOutputs: number
Returns number
Inherited from BaseSelector.estimateTransactionSize
- Defined in selectors/base-selector.ts:93

`Protected`filterEligibleUTXOs

filterEligibleUTXOs(utxos: UTXO[], options: SelectionOptions): UTXO[]
Filter UTXOs with protection and confirmation checks
Parameters
- utxos: UTXO[]
- options: SelectionOptions
Returns UTXO[]
Inherited from BaseSelector.filterEligibleUTXOs
- Defined in selectors/base-selector.ts:36

`Protected`filterUTXOs

filterUTXOs(utxos: UTXO[], minConfirmations?: number): UTXO[]
Filter UTXOs based on confirmation requirements
Parameters
- utxos: UTXO[]
- minConfirmations: number = 0
Returns UTXO[]
Inherited from BaseSelector.filterUTXOs
- Defined in selectors/base-selector.ts:29

getName

getName(): string
Returns string
Overrides BaseSelector.getName
- Defined in selectors/accumulative.ts:39

`Protected`isDust

isDust(amount: number, dustThreshold?: number): boolean
Check if amount is dust
Parameters
- amount: number
- OptionaldustThreshold: number
Returns boolean
Inherited from BaseSelector.isDust
- Defined in selectors/base-selector.ts:104

select

select(utxos: UTXO[], options: SelectionOptions): EnhancedSelectionResult
Parameters
- utxos: UTXO[]
- options: SelectionOptions
Returns EnhancedSelectionResult
Overrides BaseSelector.select
- Defined in selectors/accumulative.ts:43

selectFIFO

selectFIFO(utxos: UTXO[], options: SelectionOptions): EnhancedSelectionResult
Variant that prioritizes older UTXOs (FIFO)
Parameters
- utxos: UTXO[]
- options: SelectionOptions
Returns EnhancedSelectionResult
- Defined in selectors/accumulative.ts:148

selectForConsolidation

selectForConsolidation(
utxos: UTXO[],
options: SelectionOptions,
): EnhancedSelectionResult
Variant that consolidates UTXOs
Parameters
- utxos: UTXO[]
- options: SelectionOptions
Returns EnhancedSelectionResult
- Defined in selectors/accumulative.ts:178

`Protected`sortByConfirmations

sortByConfirmations(utxos: UTXO[]): UTXO[]
Sort UTXOs by confirmations (most confirmed first)
Parameters
- utxos: UTXO[]
Returns UTXO[]
Inherited from BaseSelector.sortByConfirmations
- Defined in selectors/base-selector.ts:71

`Protected`sortByValue

sortByValue(utxos: UTXO[], descending?: boolean): UTXO[]
Sort UTXOs by value (ascending)
Parameters
- utxos: UTXO[]
- descending: boolean = false
Returns UTXO[]
Inherited from BaseSelector.sortByValue
- Defined in selectors/base-selector.ts:61

`Protected`sumUTXOs

sumUTXOs(utxos: UTXO[]): number
Calculate total value of UTXOs
Parameters
- utxos: UTXO[]
Returns number
Inherited from BaseSelector.sumUTXOs
- Defined in selectors/base-selector.ts:78

`Protected`validateOptions

validateOptions(options: SelectionOptions): void
Validate selection options
Parameters
- options: SelectionOptions
Returns void
Inherited from BaseSelector.validateOptions
- Defined in selectors/base-selector.ts:150

Class AccumulativeSelector

Remarks

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AccumulativeSelector

Properties

Protected ReadonlyDUST_THRESHOLD

Protected ReadonlyINPUT_SIZE

Protected ReadonlyOUTPUT_SIZE

Protected ReadonlyTRANSACTION_OVERHEAD

Methods

ProtectedcalculateChange

Parameters

Returns number

ProtectedcalculateWaste

Parameters

Returns number

ProtectedcheckOptionsValidity

Parameters

Returns null | EnhancedSelectionResult

ProtectedcreateResult

Parameters

Returns SelectionSuccess

estimateFee

Parameters

Returns number

ProtectedestimateTransactionSize

Parameters

Returns number

ProtectedfilterEligibleUTXOs

Parameters

Returns UTXO[]

ProtectedfilterUTXOs

Parameters

Returns UTXO[]

getName

Returns string

ProtectedisDust

Parameters

Returns boolean

select

Parameters

Returns EnhancedSelectionResult

selectFIFO

Parameters

Returns EnhancedSelectionResult

selectForConsolidation

Parameters

Returns EnhancedSelectionResult

ProtectedsortByConfirmations

Parameters

Returns UTXO[]

ProtectedsortByValue

Parameters

Returns UTXO[]

ProtectedsumUTXOs

Parameters

Returns number

ProtectedvalidateOptions

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`DUST_THRESHOLD

`Protected` `Readonly`INPUT_SIZE

`Protected` `Readonly`OUTPUT_SIZE

`Protected` `Readonly`TRANSACTION_OVERHEAD

`Protected`calculateChange

`Protected`calculateWaste

`Protected`checkOptionsValidity

`Protected`createResult

`Protected`estimateTransactionSize

`Protected`filterEligibleUTXOs

`Protected`filterUTXOs

`Protected`isDust

`Protected`sortByConfirmations

`Protected`sortByValue

`Protected`sumUTXOs

`Protected`validateOptions