Skip to main content

CoinSelectionService

@totemsdk/tx-builder

@totemsdk/tx-builder / CoinSelectionService

Class: CoinSelectionService

Constructors​

Constructor​

new CoinSelectionService(fetcher, storage?): CoinSelectionService

Parameters​

fetcher​

CoinFetcher

storage?​

StoragePort

Returns​

CoinSelectionService

Methods​

addExcludedAddress()​

addExcludedAddress(address): void

Parameters​

address​

string

Returns​

void

fetchSpendableCoins()​

fetchSpendableCoins(addresses, tokenId?): Promise<SpendableCoin[]>

Parameters​

addresses​

string[]

tokenId?​

string = '0x00'

Returns​

Promise<SpendableCoin[]>

formatCoinInputs()​

formatCoinInputs(coins): object[]

Parameters​

coins​

SpendableCoin[]

Returns​

object[]

getExcludedAddresses()​

getExcludedAddresses(): string[]

Returns​

string[]

isAddressExcluded()​

isAddressExcluded(address): boolean

Parameters​

address​

string

Returns​

boolean

loadExcludedAddresses()​

loadExcludedAddresses(): Promise<void>

Returns​

Promise<void>

orderCoinsByAmount()​

orderCoinsByAmount(coins): SpendableCoin[]

Parameters​

coins​

SpendableCoin[]

Returns​

SpendableCoin[]

removeExcludedAddress()​

removeExcludedAddress(address): void

Parameters​

address​

string

Returns​

void

saveExcludedAddresses()​

saveExcludedAddresses(): Promise<void>

Returns​

Promise<void>

selectCoins()​

selectCoins(coins, options): CoinSelectionResult

Parameters​

coins​

SpendableCoin[]

options​

CoinSelectionOptions

Returns​

CoinSelectionResult

selectCoinsForSend()​

selectCoinsForSend(allAddresses, options): Promise<CoinSelectionResult>

Parameters​

allAddresses​

string[]

options​

CoinSelectionOptions

Returns​

Promise<CoinSelectionResult>