Class: UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:47

Constructors

Constructor

new UtxoCollection(__namedParameters): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:55

Parameters

Parameter	Type
`__namedParameters`	`ConstructorParams`

Returns

UtxoCollection

Properties

Property	Modifier	Type	Defined in
`currency?`	`readonly`	`UnitType`	libraries/models/src/utxo-collection/index.ts:48
`isInstance`	`static`	(`this`, `instance`) => `instance is UtxoCollection`	libraries/models/src/utxo-collection/index.ts:63

Accessors

addresses

Get Signature

get addresses(): AddressSet

Defined in: libraries/models/src/utxo-collection/index.ts:405

Returns

AddressSet

empty

Get Signature

get empty(): boolean

Defined in: libraries/models/src/utxo-collection/index.ts:428

Returns

boolean

size

Get Signature

get size(): number

Defined in: libraries/models/src/utxo-collection/index.ts:432

Returns

number

txIds

Get Signature

get txIds(): string[]

Defined in: libraries/models/src/utxo-collection/index.ts:438

Returns

string[]

value

Get Signature

get value(): NumberUnit

Defined in: libraries/models/src/utxo-collection/index.ts:442

Returns

NumberUnit

[ModelIdSymbol]

Get Signature

get static [ModelIdSymbol](): string

Defined in: libraries/models/src/utxo-collection/index.ts:59

Returns

string

Methods

[iterator]()

[iterator](): Generator<Utxo, void, unknown>

Defined in: libraries/models/src/utxo-collection/index.ts:450

Returns

Generator<Utxo, void, unknown>

addUtxo()

addUtxo(utxo, addressMap): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:324

Parameters

Parameter	Type
`utxo`	`Utxo`
`addressMap`	`AddressMap`

Returns

UtxoCollection

clone()

clone(): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:133

Returns

UtxoCollection

difference()

difference(utxoCol): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:145

Parameters

Parameter	Type
`utxoCol`	`UtxoCollection`

Returns

UtxoCollection

equals()

equals(utxoCol): boolean

Defined in: libraries/models/src/utxo-collection/index.ts:137

Parameters

Parameter	Type
`utxoCol`	`UtxoCollection`

Returns

boolean

filter()

filter(predicate): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:392

Parameters

Parameter	Type
`predicate`	(`utxo`) => `boolean`

Returns

UtxoCollection

getAddressesForTxId()

getAddressesForTxId(txId): AddressSet

Defined in: libraries/models/src/utxo-collection/index.ts:176

Parameters

Parameter	Type
`txId`	`string`

Returns

AddressSet

getAddressPathsMap()

getAddressPathsMap(): any

Defined in: libraries/models/src/utxo-collection/index.ts:185

Returns

any

Deprecated

getAddressUtxos()

getAddressUtxos(address): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:166

Parameters

Parameter	Type
`address`	`string` \| `Address`

Returns

UtxoCollection

getTxIdUtxos()

getTxIdUtxos(txId): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:171

Parameters

Parameter	Type
`txId`	`string`

Returns

UtxoCollection

hasAddressUtxos()

hasAddressUtxos(address): boolean

Defined in: libraries/models/src/utxo-collection/index.ts:191

Parameters

Parameter	Type
`address`	`string`

Returns

boolean

inspect()

inspect(): string

Defined in: libraries/models/src/utxo-collection/index.ts:195

Returns

string

isEmpty()

isEmpty(): boolean

Defined in: libraries/models/src/utxo-collection/index.ts:199

Returns

boolean

merge()

merge(utxoCol): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:206

Parameters

Parameter	Type
`utxoCol`	`UtxoCollection`

Returns

UtxoCollection

removeAddressUtxos()

removeAddressUtxos(address): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:215

Parameters

Parameter	Type
`address`	`string` \| `Address`

Returns

UtxoCollection

select()

select(amount, feeEstimator): (undefined | UtxoCollection)[]

Defined in: libraries/models/src/utxo-collection/index.ts:225

Parameters

Parameter	Type
`amount`	`NumberUnit`
`feeEstimator`	(`options`) => `NumberUnit`

Returns

(undefined | UtxoCollection)[]

setAddressUtxos()

setAddressUtxos(address, utxos, __namedParameters): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:328

Parameters

Parameter	Type
`address`	`string` \| `Address`
`utxos`	`UtxoCollection` \| `Utxo`[]
`__namedParameters`	{ `addressMap?`: `AddressMap`; }
`__namedParameters.addressMap?`	`AddressMap`

Returns

UtxoCollection

toArray()

toArray(): Utxo[]

Defined in: libraries/models/src/utxo-collection/index.ts:347

Returns

Utxo[]

toJSON()

toJSON(): Record<string, { address: string; path: string; utxos: Omit<Utxo, "address" | "value"> & object[]; }>

Defined in: libraries/models/src/utxo-collection/index.ts:360

Returns

Record<string, { address: string; path: string; utxos: Omit<Utxo, "address" | "value"> & object[]; }>

toPriorityOrderedArray()

toPriorityOrderedArray(descending): Utxo[]

Defined in: libraries/models/src/utxo-collection/index.ts:351

Parameters

Parameter	Type	Default value
`descending`	`boolean`	`false`

Returns

Utxo[]

union()

union(utxos): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:385

Parameters

Parameter	Type
`utxos`	`UtxoCollection`

Returns

UtxoCollection

unionOverwrite()

unionOverwrite(utxos): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:397

Parameters

Parameter	Type
`utxos`	`UtxoCollection`

Returns

UtxoCollection

updateConfirmations()

updateConfirmations(txs): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:313

Parameters

Parameter	Type
`txs`	`Tx`[]

Returns

UtxoCollection

[hasInstance]()

static [hasInstance](instance): instance is UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:65

Parameters

Parameter	Type
`instance`	`unknown`

Returns

instance is UtxoCollection

createEmpty()

static createEmpty(options): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:69

Parameters

Parameter	Type
`options`	`ConstructorParams` & `object`

Returns

UtxoCollection

fromArray()

static fromArray(utxoArray, __namedParameters): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:75

Parameters

Parameter	Type
`utxoArray`	`undefined` \| `null` \| `RawUtxo`[]
`__namedParameters`	`ConstructorParams` & `object`

Returns

UtxoCollection

fromJSON()

static fromJSON(json, __namedParameters): UtxoCollection

Defined in: libraries/models/src/utxo-collection/index.ts:110

Parameters

Parameter	Type
`json`	`string` \| `UtxoCollectionJson`
`__namedParameters`	{ `currency`: `UnitType`; }
`__namedParameters.currency`	`UnitType`

Returns

UtxoCollection