Class ProtectionAwareSelector

Protection-aware UTXO selector

Wraps another selector and filters out UTXOs that contain valuable ordinals, stamps, or other protected assets.

Can use different protection strategies:

Strict: Never use protected UTXOs (safest)
Careful: Use dummy UTXOs from protected assets if needed
Emergency: Use any UTXO as last resort (not recommended)

Hierarchy

BaseSelector
- ProtectionAwareSelector

Constructors

constructor

new ProtectionAwareSelector(
    detector: IProtectionDetector,
    fallbackSelector: BaseSelector,
    allowProtectedIfNecessary?: boolean,
    dummyUtxoAmount?: number,
): ProtectionAwareSelector
Parameters
- detector: IProtectionDetector
- fallbackSelector: BaseSelector
- allowProtectedIfNecessary: boolean = false
- dummyUtxoAmount: number = 546
Returns ProtectionAwareSelector
Overrides BaseSelector.constructor
- Defined in selectors/protection-aware-selector.ts:77

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

getAssetData

getAssetData(utxo: UTXO): Promise<null | ProtectedAssetData>
Get asset data for a UTXO
Parameters
- utxo: UTXO
Returns Promise<null | ProtectedAssetData>
- Defined in selectors/protection-aware-selector.ts:167

getFallbackSelector

getFallbackSelector(): BaseSelector
Get the current fallback selector

Returns BaseSelector
- Defined in selectors/protection-aware-selector.ts:248

getName

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

getProtectionDetector

getProtectionDetector(): IProtectionDetector
Get the current protection detector

Returns IProtectionDetector
- Defined in selectors/protection-aware-selector.ts:262

getProtectionSummary

getProtectionSummary(
    utxos: UTXO[],
): Promise<
    {
        protectedAssets: ProtectedAssetData[];
        protectedCount: number;
        protectedValue: number;
        spendableCount: number;
        spendableValue: number;
        totalUtxos: number;
        totalValue: number;
    },
>
Get protection summary for a set of UTXOs
Parameters
- utxos: UTXO[]
Returns Promise<
    {
        protectedAssets: ProtectedAssetData[];
        protectedCount: number;
        protectedValue: number;
        spendableCount: number;
        spendableValue: number;
        totalUtxos: number;
        totalValue: number;
    },
>
- Defined in selectors/protection-aware-selector.ts:196

`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

isProtected

isProtected(utxo: UTXO): Promise<boolean>
Check if a specific UTXO is protected
Parameters
- utxo: UTXO
Returns Promise<boolean>
- Defined in selectors/protection-aware-selector.ts:160

select

select(utxos: UTXO[], options: SelectionOptions): EnhancedSelectionResult
Parameters
- utxos: UTXO[]
- options: SelectionOptions
Returns EnhancedSelectionResult
Overrides BaseSelector.select
- Defined in selectors/protection-aware-selector.ts:94

setAllowProtectedIfNecessary

setAllowProtectedIfNecessary(allow: boolean): void
Set whether to allow protected UTXOs if necessary
Parameters
- allow: boolean
Returns void
- Defined in selectors/protection-aware-selector.ts:234

setDummyUtxoAmount

setDummyUtxoAmount(amount: number): void
Set the dummy UTXO amount for ordinal protection
Parameters
- amount: number
Returns void
- Defined in selectors/protection-aware-selector.ts:241

setFallbackSelector

setFallbackSelector(selector: BaseSelector): void
Set a new fallback selector
Parameters
- selector: BaseSelector
Returns void
- Defined in selectors/protection-aware-selector.ts:255

setProtectionDetector

setProtectionDetector(detector: IProtectionDetector): void
Set a new protection detector
Parameters
- detector: IProtectionDetector
Returns void
- Defined in selectors/protection-aware-selector.ts:269

`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 ProtectionAwareSelector

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProtectionAwareSelector

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[]

getAssetData

Parameters

Returns Promise<null | ProtectedAssetData>

getFallbackSelector

Returns BaseSelector

getName

Returns string

getProtectionDetector

Returns IProtectionDetector

getProtectionSummary

Parameters

Returns Promise< { protectedAssets: ProtectedAssetData[]; protectedCount: number; protectedValue: number; spendableCount: number; spendableValue: number; totalUtxos: number; totalValue: number; },>

ProtectedisDust

Parameters

Returns boolean

isProtected

Parameters

Returns Promise<boolean>

select

Parameters

Returns EnhancedSelectionResult

setAllowProtectedIfNecessary

Parameters

Returns void

setDummyUtxoAmount

Parameters

Returns void

setFallbackSelector

Parameters

Returns void

setProtectionDetector

Parameters

Returns void

ProtectedsortByConfirmations

Parameters

Returns UTXO[]

ProtectedsortByValue

Parameters

Returns UTXO[]

ProtectedsumUTXOs

`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

Returns Promise<
{
protectedAssets: ProtectedAssetData[];
protectedCount: number;
protectedValue: number;
spendableCount: number;
spendableValue: number;
totalUtxos: number;
totalValue: number;
},
>

`Protected`isDust

`Protected`sortByConfirmations

`Protected`sortByValue

`Protected`sumUTXOs

`Protected`validateOptions