Class OrdinalsAwareSelector

Ordinals-aware UTXO selector

This selector wraps another selector and filters out UTXOs that contain ordinals or inscriptions before performing selection. It provides:

Automatic ordinals detection and filtering
Caching of detection results for performance
Fallback strategies when protected UTXOs are the only option
Clear reporting of when protected UTXOs are used

Hierarchy

BaseSelector
- OrdinalsAwareSelector

Constructors

constructor

new OrdinalsAwareSelector(
    detector: OrdinalsDetector,
    fallbackSelector: BaseSelector,
    options?: OrdinalsAwareSelectorOptions,
): OrdinalsAwareSelector
Parameters
- detector: OrdinalsDetector
- fallbackSelector: BaseSelector
- options: OrdinalsAwareSelectorOptions = {}
Returns OrdinalsAwareSelector
Overrides BaseSelector.constructor
- Defined in selectors/ordinals-aware-selector.ts:54

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

clearProtectionCache

clearProtectionCache(): void
Clear the protection cache

Returns void
- Defined in selectors/ordinals-aware-selector.ts:162

`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

getDetector

getDetector(): OrdinalsDetector
Get the underlying detector

Returns OrdinalsDetector
- Defined in selectors/ordinals-aware-selector.ts:230

getFallbackSelector

getFallbackSelector(): BaseSelector
Get the fallback selector

Returns BaseSelector
- Defined in selectors/ordinals-aware-selector.ts:237

getName

getName(): string
Returns string
Overrides BaseSelector.getName
- Defined in selectors/ordinals-aware-selector.ts:68

getProtectionSummary

getProtectionSummary(): {
    cacheEnabled: boolean;
    cacheSize: number;
    cacheTtl: number;
    protectedCount: number;
}
Get protection summary for debugging

Returns {
    cacheEnabled: boolean;
    cacheSize: number;
    cacheTtl: number;
    protectedCount: number;
}
- Defined in selectors/ordinals-aware-selector.ts:210

`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

isProtectedAllowed

isProtectedAllowed(): boolean
Check if protected UTXOs are allowed as last resort

Returns boolean
- Defined in selectors/ordinals-aware-selector.ts:244

populateProtectionCache

populateProtectionCache(utxos: UTXO[]): Promise<void>
Pre-populate the protection cache for a set of UTXOs This should be called before select() for optimal performance
Parameters
- utxos: UTXO[]
Returns Promise<void>
- Defined in selectors/ordinals-aware-selector.ts:127

select

select(utxos: UTXO[], options: SelectionOptions): EnhancedSelectionResult
Select UTXOs while avoiding ordinals/inscriptions
Parameters
- utxos: UTXO[]
- options: SelectionOptions
Returns EnhancedSelectionResult
Overrides BaseSelector.select
- Defined in selectors/ordinals-aware-selector.ts:75

setAllowProtected

setAllowProtected(allow: boolean): void
Set whether to allow protected UTXOs as last resort
Parameters
- allow: boolean
Returns void
- Defined in selectors/ordinals-aware-selector.ts:251

`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