@exodus/models

@exodus/models

This library contains a variety of classes/models used for various data structures.

Installation/Usage

yarn add @exodus/models

This library exports each model as a named export:

import { Address, AddressSet } from '@exodus/models'

Models

All models have a static method .isInstance(obj) which returns true if obj is an instance of the model. This check returns true even if the instance is of a duplicate, different version of the model; for this reason it should be used instead of the instanceof operator.

AccountState

A base class from which all asset account state clases extend. Cannot be initialized directly.

Address

A model for blockchain addresses.

AddressSet

An immutable set of Addresses with sorting functionality.

FiatOrder

A model for fiat orders.

FiatOrderSet

An immutable set of FiatOrders, with alternate get methods like getAt, getByTxId, & getAllByTxId, and an .update(orders) method for updating details of existing orders.

Order

A model for crypto swap orders.

OrderSet

An immutable set of Orders, with alternate get methods like getAt, getByTxId, & getAllByTxId, and an .update(orders) method for updating details of existing orders.

PersonalNote

A model for personal notes.

PersonalNoteSet

An immutable set of PersonalNotes. Unlike other *Set models, the .add() & .update() methods return the same PersonalNoteSet instance if there were no changes to the data.

Tx

A model for blockchain transactions.

TxSet

An immutable set of Txs. Cannot be constructed directly, either start with TxSet.EMPTY or use the static method TxSet.fromArray(). txSet.equals(otherSet) only compares transaction ids; use txSet.deepEquals(otherSet) for full transaction comparison.

UtxoCollection

An immutable colletion of UTXOs, with various methods for filtering, updating, and selecting from them.

WalletAccount

An immutable model for representing wallet accounts of all sources.

WalletAccountSet

A minimal, immutable set of WalletAccounts.