@exodus/models
Version: 0.0.0
Classes
Functions
Type Aliases
AccountState
class
Constructor
constructor
Properties
_version?
number
_allFieldNames
null | string[]
_dateKeys
string[]
_fieldNames
null | string[]
_isInstance
any
_tokens
any[]
_version
number
defaults
any
isInstance
any
Methods
equals
Parameters:
other: AccountState
opts (optional): any
Returns:
booleantoJSON
toJSON(opts?: any): any
Parameters:
opts (optional): any
Returns:
anytoRedactedJSON
toRedactedJSON(): any
Returns:
any_getAllFieldNames
_getAllFieldNames(): string[]
Returns:
string[]_getFieldNames
_getFieldNames(): string[]
Returns:
string[]_legacyParse
_legacyParse(rawData: Record): Record
Parameters:
rawData: Record
Returns:
Record_postParse
_postParse(data: Record): Record
Parameters:
data: Record
Returns:
Record[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anycreate
deserialize
deserialize(serialized: AccountStateJson | any): AccountState
Parameters:
serialized: AccountStateJson | any
Returns:
AccountStatefromJSON
fromJSON(serialized: AccountStateJson | any): AccountState
Parameters:
serialized: AccountStateJson | any
Returns:
AccountStateserialize
Parameters:
json: AccountStateJson
__namedParameters (optional): any
Returns:
anyAccessors
[ModelIdSymbol]
Address
class
Constructor
constructor
Parameters:
address: string
meta (optional): AddressMeta
Returns:
AddressProperties
address
string
meta
Partial
_isInstance
any
isInstance
any
util
__module
Methods
toJSON
toJSON(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anycreate
Parameters:
address: string
meta (optional): AddressMeta
Returns:
ReadonlyfromJSON
isAddress
isAddress(address: unknown): any
Parameters:
address: unknown
Returns:
anyAccessors
[toStringTag]
pathArray
[ModelIdSymbol]
AddressSet
class
Constructor
constructor
AddressSet(): AddressSet
Returns:
AddressSetMethods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratoradd
delete
remove
sort
toAddressStrings
toAddressStrings(): any[]
Returns:
any[]toArray
toArray(): any[]
Returns:
any[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[]toString
toString(): string
Returns:
stringunion
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr: string | Address | AddressJson[]): AddressSet
Parameters:
arr: string | Address | AddressJson[]
Returns:
AddressSetAccessors
size
[ModelIdSymbol]
FiatOrder
class
Constructor
constructor
Parameters:
props: FiatOrderProps
initSymbol: any
Returns:
FiatOrderProperties
date
Date
errorMessage?
string
exodusRate
number
fees?
any
feesWereSubsidized?
boolean
fiatValue
number
fromAddress
null | string
fromAmount
number | NumberUnit
fromAsset
string
fromWalletAccount
null | string
hideInHistory?
boolean
orderId
string
orderType
string
paymentMethodType?
string
provider
P
providerOrderId?
string
providerRate
number
showedFailureBanner?
boolean
status
any
subProvider
string
subProviderOrderId
string
supportMessage?
string
toAddress
null | string
toAmount
number | NumberUnit
toAsset
string
toWalletAccount
null | string
txId?
string
_isInstance
any
isInstance
any
validate
any
Methods
inspect
inspect(): string
Returns:
stringtoJSON
toJSON(): any | any
Returns:
any | anytoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns a string representation of an object.
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyAccessors
cryptoAmount
cryptoAsset
error
exodusStatus
isBuy
isSell
txIds
[ModelIdSymbol]
FiatOrderSet
class
Constructor
constructor
FiatOrderSet(__namedParameters: any): FiatOrderSet
Parameters:
__namedParameters: any
Returns:
FiatOrderSetMethods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratoradd
clone
clone(): FiatOrderSet
Returns:
FiatOrderSetdelete
equals
toJSON
toJSON(): any | any[]
Returns:
any | any[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[]union
update
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr?: FiatOrder | FiatOrderProps[]): FiatOrderSet
Parameters:
arr (optional): FiatOrder | FiatOrderProps[]
Returns:
FiatOrderSetAccessors
size
[ModelIdSymbol]
Order
class
Constructor
constructor
Parameters:
props: OrderProps
initSymbol: any
Returns:
OrderProperties
_version
number
date
Date
displaySvc?
string
errorDetails?
Record
fromAmount?
fromAsset?
string
fromTxId?
string
fromWalletAccount?
string
message?
string
orderId
string
potentialToTxIds?
string[]
region?
string
slippage?
number
status
string
svc
string
svcOptions?
Record
synced?
boolean
toAddress?
string
toAmount?
toAsset?
string
toTxId?
string
toWalletAccount?
string
txIds?
any[]
_isInstance
any
isInstance
any
Methods
inspect
inspect(): string
Returns:
stringtoJSON
toJSON(): SerializedOrder
Returns:
SerializedOrdertoJSONLegacy
toJSONLegacy(): Partial
Returns:
PartialtoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns a string representation of an object.
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromJSON
fromJSON(json: string | DenormalizedOrder | SerializedOrder): Order
Parameters:
json: string | DenormalizedOrder | SerializedOrder
Returns:
OrderAccessors
displayStatus
error
exchangeApp
exodusStatus
finalized
floatingRate
hasOptimisticStatus
[ModelIdSymbol]
OrderSet
class
Constructor
Methods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratortoJSON
toJSON(): SerializedOrder[]
Returns:
SerializedOrder[]toJSONLegacy
toJSONLegacy(): Partial[]
Returns:
Partial[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[][hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr: null | Order | OrderProps | DenormalizedOrder[]): OrderSet
Parameters:
arr: null | Order | OrderProps | DenormalizedOrder[]
Returns:
OrderSetAccessors
size
[ModelIdSymbol]
PersonalNote
class
Constructor
constructor
Properties
message
string
sends?
Record
txId
string
_isInstance
any
isInstance
any
Methods
equals
getMessage
getMessage(__namedParameters?: any): string
Parameters:
__namedParameters (optional): any
Returns:
stringsetMessage
setMessage(__namedParameters: any): PersonalNote
Parameters:
__namedParameters: any
Returns:
PersonalNotetoJSON
toJSON(): PersonalNoteJson
Returns:
PersonalNoteJsontoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns a string representation of an object.
Returns:
stringupdate
update(fields: PersonalNote | Partial): PersonalNote
Parameters:
fields: PersonalNote | Partial
Returns:
PersonalNote[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromJSON
fromJSON(json: string | PersonalNoteProps): PersonalNote
Parameters:
json: string | PersonalNoteProps
Returns:
PersonalNoteAccessors
[ModelIdSymbol]
PersonalNoteSet
class
Constructor
constructor
PersonalNoteSet(notes?: PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
notes (optional): PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSetMethods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratoradd
add(input: PersonalNote | PersonalNoteJson | PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
input: PersonalNote | PersonalNoteJson | PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSetclone
clone(): PersonalNoteSet
Returns:
PersonalNoteSetequals
get
get(item: string | PersonalNote): undefined | PersonalNote
Parameters:
item: string | PersonalNote
Returns:
undefined | PersonalNotehas
toJSON
toJSON(): PersonalNoteJson[]
Returns:
PersonalNoteJson[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[]update
update(items: PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
items: PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSet[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr?: null | PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
arr (optional): null | PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSetAccessors
size
[ModelIdSymbol]
Tx
class
Constructor
constructor
Tx(__namedParameters: ConstructorParams): Tx
Parameters:
__namedParameters: ConstructorParams
Returns:
TxProperties
addresses
coinAmount?
coinName?
string
confirmations
number
currencies
Record
data
Record
date
Date
dropped?
boolean
error?
null | string
feeAmount?
feeCoinName?
string
from
string[]
meta
Record
selfSend
boolean
to?
string
tokens
string[]
txId?
string
version
number
_isInstance
any
isInstance
any
Methods
clone
clone(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): Partial
Returns:
PartialtoString
toString(): string
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyAccessors
accepted
confirmed
failed
pending
received
sent
token
[ModelIdSymbol]
TxSet
class
Constructor
Properties
_mutations?
any[]
_order
string[]
_txs
Map
addresses
_isInstance
any
EMPTY
isInstance
any
util
__module
Methods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratorgetMutations
getMutations(): any[]
Returns:
any[]reverse
reverse(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): Partial[]
Returns:
Partial[][hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyAccessors
size
[ModelIdSymbol]
UtxoCollection
class
Constructor
constructor
UtxoCollection(__namedParameters?: ConstructorParams): UtxoCollection
Parameters:
__namedParameters (optional): ConstructorParams
Returns:
UtxoCollectionMethods
[iterator]
[iterator](): Generator
Returns:
GeneratoraddUtxo
Parameters:
utxo: Utxo
addressMap: AddressMap
Returns:
UtxoCollectionclone
clone(): UtxoCollection
Returns:
UtxoCollectiondifference
difference(utxoCol: UtxoCollection): UtxoCollection
Parameters:
utxoCol: UtxoCollection
Returns:
UtxoCollectionequals
filter
getAddressesForTxId
getAddressPathsMap
getAddressPathsMap(): any
Returns:
anygetAddressUtxos
getAddressUtxos(address: string | Address): UtxoCollection
Parameters:
address: string | Address
Returns:
UtxoCollectiongetTxIdUtxos
hasAddressUtxos
hasAddressUtxos(address: string): boolean
Parameters:
address: string
Returns:
booleaninspect
inspect(): string
Returns:
stringisEmpty
isEmpty(): boolean
Returns:
booleanmerge
merge(utxoCol: UtxoCollection): UtxoCollection
Parameters:
utxoCol: UtxoCollection
Returns:
UtxoCollectionremoveAddressUtxos
removeAddressUtxos(address: string | Address): UtxoCollection
Parameters:
address: string | Address
Returns:
UtxoCollectionselect
Parameters:
amount: NumberUnit
feeEstimator: any
Returns:
undefined | UtxoCollection[]setAddressUtxos
setAddressUtxos(address: string | Address, utxos: UtxoCollection | Utxo[], __namedParameters?: any): UtxoCollection
Parameters:
Returns:
UtxoCollectiontoJSON
toJSON(): Record
Returns:
Recordunion
unionOverwrite
unionOverwrite(utxos: UtxoCollection): UtxoCollection
Parameters:
utxos: UtxoCollection
Returns:
UtxoCollectionupdateConfirmations
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anycreateEmpty
fromArray
Parameters:
utxoArray: undefined | null | RawUtxo[]
__namedParameters (optional): any
Returns:
UtxoCollectionfromJSON
Parameters:
json: string | UtxoCollectionJson
__namedParameters: any
Returns:
UtxoCollectionAccessors
addresses
empty
size
txIds
value
[ModelIdSymbol]
WalletAccount
class
Constructor
constructor
WalletAccount(__namedParameters: WalletAccountParams): WalletAccount
Parameters:
__namedParameters: WalletAccountParams
Returns:
WalletAccountProperties
color?
string
compatibilityMode?
string
delegated?
boolean
enabled
boolean
icon?
string
id?
string | number
index
null | number
is2FA?
boolean
isMultisig?
boolean
label
string
lastConnected?
number
model?
string
seedId?
string
source
_isInstance
any
DEFAULT_COLORS
Readonly
DEFAULT_ICONS
Readonly
EXODUS_SRC
"exodus"
FTX_SRC
"ftx"
isInstance
any
LABEL_MAX_LENGTH
100
LEDGER_SRC
"ledger"
MPSWAPS_SRC
"mpswaps"
PASSKEY_SRC
"passkey"
POLYMARKET_SRC
"polymarket"
SEED_SRC
"seed"
TREZOR_SRC
"trezor"
Methods
equals
equals(otherWalletAccount: WalletAccount): boolean
Parameters:
otherWalletAccount: WalletAccount
Returns:
booleantoJSON
toJSON(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns:
stringupdate
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anydefaultWith
Accessors
isCustodial
isExternal
isHardware
isPasskey
isSoftware
[ModelIdSymbol]
DEFAULT
DEFAULT_NAME
VALID_SOURCES
WalletAccountSet
class
Constructor
constructor
WalletAccountSet(byName?: any): WalletAccountSet
Parameters:
byName (optional): any
Returns:
WalletAccountSetMethods
equals
equals(walletAccountsByName: WalletAccountSet): boolean
Parameters:
walletAccountsByName: WalletAccountSet
Returns:
booleanget
get(name: string | WalletAccount): undefined | WalletAccount
Parameters:
name: string | WalletAccount
Returns:
undefined | WalletAccountnames
names(): string[]
Returns:
string[]toJSON
toJSON(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): any
Returns:
anyupdate
update(walletAccountsByName: WalletAccountSet | any): WalletAccountSet
Parameters:
walletAccountsByName: WalletAccountSet | any
Returns:
WalletAccountSet[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyAccessors
[ModelIdSymbol]
WalletAccountParams
type
Properties
color?
string
compatibilityMode?
string
delegated?
boolean
enabled?
boolean
icon?
string
id?
string | number
index?
number | null
is2FA?
boolean
isMultisig?
boolean
label?
string
lastConnected?
number
model?
string
seedId?
string
source
WalletAccountSource
type
ensureCurrencies
variable
Type
const ensureCurrencies: (json: TxProps, assets: { ... }) => any | any | any | any | { ... } | { ... }fiatFusionOrderToOrderAdapter
variable
Type
const fiatFusionOrderToOrderAdapter: (order: any, assets: Assets) => { ... }Properties
date
string | Date
errorMessage?
string
exodusRate
number
fees?
any
feesWereSubsidized?
boolean
fiatValue
number
fromAddress
string | null
fromAmount
number | string | NumberUnit | null
fromAsset
string
fromWalletAccount
string | null
hideInHistory?
boolean
orderId
string
orderType
string
paymentMethodType?
string
provider
P
providerOrderId?
string
providerRate
number
showedFailureBanner?
boolean
status
any
subProvider?
string
subProviderOrderId?
string
supportMessage?
string
toAddress
string | null
toAmount
number | NumberUnit
toAsset
string
toWalletAccount
string | null
txId?
string
fiatOrderAdapter
variable
Type
const fiatOrderAdapter: ({ createdAt, fee, from, id, networkFee, paymentMethodType, provider, providerId, rate, status, subProvider, subProviderId, to, totalFee, txId, type, walletAccount, walletAddress, }: AdapterParams, assets: Assets) => { ... }Signature
__type({ createdAt, fee, from, id, networkFee, paymentMethodType, provider, providerId, rate, status, subProvider, subProviderId, to, totalFee, txId, type, walletAccount, walletAddress, }: AdapterParams, assets: Assets): any
Parameters:
{ createdAt, fee, from, id, networkFee, paymentMethodType, provider, providerId, rate, status, subProvider, subProviderId, to, totalFee, txId, type, walletAccount, walletAddress, }: AdapterParams
assets: Assets
Returns:
anyProperties
date
Date
exodusRate
number
fees
any
fiatValue
number
fromAddress
string | null
fromAmount
any
fromAsset
string
fromWalletAccount
string | null
orderId
string
orderType
string
paymentMethodType
string | undefined
provider
providerOrderId
string
providerRate
number
status
string
subProvider
string | undefined
subProviderOrderId
string | undefined
toAddress
string | null
toAmount
any
toAsset
string
toWalletAccount
string | null
txId
string | undefined
ModelIdSymbol
variable
Type
any
orderFromJSONLegacy
variable
Type
const orderFromJSONLegacy: (json: any, { assets }: { ... }) => OrderorderSetFromJSONLegacy
variable
Type
const orderSetFromJSONLegacy: (orders: any[], { assets }: { ... }) => OrderSetorderSetToJSONLegacy
variable
Type
const orderSetToJSONLegacy: (orderSet: OrderSet) => Record[]orderToJSONLegacy
variable
Type
const orderToJSONLegacy: (order: Order) => RecordcurrenciesForAsset
function
Signature
currenciesForAsset(asset: any): any
Parameters:
asset: any
Returns:
anynormalizeTxJSON
function
normalizeTxsJSON
function
Asset
type
Assets
type
WithType
type
AccountState
class
Constructor
constructor
Properties
_version?
number
_allFieldNames
null | string[]
_dateKeys
string[]
_fieldNames
null | string[]
_isInstance
any
_tokens
any[]
_version
number
defaults
any
isInstance
any
Methods
equals
Parameters:
other: AccountState
opts: any
Returns:
booleantoJSON
toJSON(opts?: any): any
Parameters:
opts (optional): any
Returns:
anytoRedactedJSON
toRedactedJSON(): PickNonNullable
Returns:
PickNonNullable_getAllFieldNames
_getAllFieldNames(): string[]
Returns:
string[]_getFieldNames
_getFieldNames(): string[]
Returns:
string[]_legacyParse
_legacyParse(rawData: Record): Record
Parameters:
rawData: Record
Returns:
Record_postParse
_postParse(data: Record): Record
Parameters:
data: Record
Returns:
Record[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anycreate
deserialize
deserialize(serialized: AccountStateJson | any): AccountState
Parameters:
serialized: AccountStateJson | any
Returns:
AccountStatefromJSON
fromJSON(serialized: AccountStateJson | any): AccountState
Parameters:
serialized: AccountStateJson | any
Returns:
AccountStateserialize
Parameters:
json: AccountStateJson
__namedParameters: any
Returns:
anyAccessors
[ModelIdSymbol]
Address
class
Constructor
constructor
Parameters:
address: string
meta (optional): AddressMeta
Returns:
AddressProperties
address
string
meta
Partial
_isInstance
any
isInstance
any
util
__module
Methods
toJSON
toJSON(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anycreate
Parameters:
address: string
meta (optional): AddressMeta
Returns:
ReadonlyfromJSON
isAddress
isAddress(address: unknown): any
Parameters:
address: unknown
Returns:
anyAccessors
[toStringTag]
pathArray
[ModelIdSymbol]
AddressSet
class
Constructor
constructor
AddressSet(): AddressSet
Returns:
AddressSetMethods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratoradd
delete
remove
sort
toAddressStrings
toAddressStrings(): any[]
Returns:
any[]toArray
toArray(): any[]
Returns:
any[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[]toString
toString(): string
Returns:
stringunion
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr: string | Address | AddressJson[]): AddressSet
Parameters:
arr: string | Address | AddressJson[]
Returns:
AddressSetAccessors
size
[ModelIdSymbol]
FiatOrder
class
Constructor
constructor
Parameters:
props: FiatOrderProps
initSymbol: any
Returns:
FiatOrderProperties
date
Date
errorMessage?
string
exodusRate
number
fees?
any
feesWereSubsidized?
boolean
fiatValue
number
fromAddress
null | string
fromAmount
number | NumberUnit
fromAsset
string
fromWalletAccount
null | string
hideInHistory?
boolean
orderId
string
orderType
string
paymentMethodType?
string
provider
P
providerOrderId?
string
providerRate
number
showedFailureBanner?
boolean
status
any
subProvider
string
subProviderOrderId
string
supportMessage?
string
toAddress
null | string
toAmount
number | NumberUnit
toAsset
string
toWalletAccount
null | string
txId?
string
_isInstance
any
isInstance
any
Methods
inspect
inspect(): string
Returns:
stringtoJSON
toJSON(): any | any
Returns:
any | anytoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns a string representation of an object.
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyvalidate
validate(order: Partial, initSymbol: any): void
Parameters:
order: Partial
initSymbol: any
Returns:
voidAccessors
cryptoAmount
cryptoAsset
error
exodusStatus
isBuy
isSell
txIds
[ModelIdSymbol]
FiatOrderSet
class
Constructor
constructor
FiatOrderSet(__namedParameters: any): FiatOrderSet
Parameters:
__namedParameters: any
Returns:
FiatOrderSetMethods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratoradd
clone
clone(): FiatOrderSet
Returns:
FiatOrderSetdelete
equals
toJSON
toJSON(): any | any[]
Returns:
any | any[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[]union
update
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr?: FiatOrder | FiatOrderProps[]): FiatOrderSet
Parameters:
arr (optional): FiatOrder | FiatOrderProps[]
Returns:
FiatOrderSetAccessors
size
[ModelIdSymbol]
Order
class
Constructor
constructor
Parameters:
props: OrderProps
initSymbol: any
Returns:
OrderProperties
_version
number
date
Date
displaySvc?
string
errorDetails?
Record
fromAmount?
fromAsset?
string
fromTxId?
string
fromWalletAccount?
string
message?
string
orderId
string
potentialToTxIds?
string[]
region?
string
slippage?
number
status
string
svc
string
svcOptions?
Record
synced?
boolean
toAddress?
string
toAmount?
toAsset?
string
toTxId?
string
toWalletAccount?
string
txIds?
any[]
_isInstance
any
isInstance
any
Methods
inspect
inspect(): string
Returns:
stringtoJSON
toJSON(): SerializedOrder
Returns:
SerializedOrdertoJSONLegacy
toJSONLegacy(): Partial
Returns:
PartialtoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns a string representation of an object.
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromJSON
fromJSON(json: string | DenormalizedOrder | SerializedOrder): Order
Parameters:
json: string | DenormalizedOrder | SerializedOrder
Returns:
OrderAccessors
displayStatus
error
exchangeApp
exodusStatus
finalized
floatingRate
hasOptimisticStatus
[ModelIdSymbol]
OrderSet
class
Constructor
Methods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratortoJSON
toJSON(): SerializedOrder[]
Returns:
SerializedOrder[]toJSONLegacy
toJSONLegacy(): Partial[]
Returns:
Partial[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[][hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr: null | Order | OrderProps | DenormalizedOrder[]): OrderSet
Parameters:
arr: null | Order | OrderProps | DenormalizedOrder[]
Returns:
OrderSetAccessors
size
[ModelIdSymbol]
PersonalNote
class
Constructor
constructor
Properties
message
string
sends?
Record
txId
string
_isInstance
any
isInstance
any
Methods
equals
getMessage
getMessage(__namedParameters: any): string
Parameters:
__namedParameters: any
Returns:
stringsetMessage
setMessage(__namedParameters: any): PersonalNote
Parameters:
__namedParameters: any
Returns:
PersonalNotetoJSON
toJSON(): PersonalNoteJson
Returns:
PersonalNoteJsontoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns a string representation of an object.
Returns:
stringupdate
update(fields: PersonalNote | Partial): PersonalNote
Parameters:
fields: PersonalNote | Partial
Returns:
PersonalNote[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromJSON
fromJSON(json: string | PersonalNoteProps): PersonalNote
Parameters:
json: string | PersonalNoteProps
Returns:
PersonalNoteAccessors
[ModelIdSymbol]
PersonalNoteSet
class
Constructor
constructor
PersonalNoteSet(notes?: PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
notes (optional): PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSetMethods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratoradd
add(input: PersonalNote | PersonalNoteJson | PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
input: PersonalNote | PersonalNoteJson | PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSetclone
clone(): PersonalNoteSet
Returns:
PersonalNoteSetequals
get
get(item: string | PersonalNote): undefined | PersonalNote
Parameters:
item: string | PersonalNote
Returns:
undefined | PersonalNotehas
toJSON
toJSON(): PersonalNoteJson[]
Returns:
PersonalNoteJson[]toRedactedJSON
toRedactedJSON(): any[]
Returns:
any[]update
update(items: PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
items: PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSet[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyfromArray
fromArray(arr?: null | PersonalNote | PersonalNoteJson[]): PersonalNoteSet
Parameters:
arr (optional): null | PersonalNote | PersonalNoteJson[]
Returns:
PersonalNoteSetAccessors
size
[ModelIdSymbol]
Tx
class
Constructor
constructor
Tx(__namedParameters: ConstructorParams): Tx
Parameters:
__namedParameters: ConstructorParams
Returns:
TxProperties
addresses
coinAmount?
coinName?
string
confirmations
number
currencies
Record
data
Record
date
Date
dropped?
boolean
error?
null | string
feeAmount?
feeCoinName?
string
from
string[]
meta
Record
selfSend
boolean
to?
string
tokens
string[]
txId?
string
version
number
_isInstance
any
isInstance
any
Methods
clone
clone(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): Partial
Returns:
PartialtoString
toString(): string
Returns:
string[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyAccessors
accepted
confirmed
failed
pending
received
sent
token
[ModelIdSymbol]
TxSet
class
Constructor
Properties
_mutations?
any[]
_order
string[]
_txs
Map
addresses
_isInstance
any
EMPTY
isInstance
any
util
__module
Methods
[iterator]
[iterator](): MapIterator
Returns:
MapIteratorgetMutations
getMutations(): any[]
Returns:
any[]reverse
reverse(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): Partial[]
Returns:
Partial[][hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyAccessors
size
[ModelIdSymbol]
UtxoCollection
class
Constructor
constructor
UtxoCollection(__namedParameters: ConstructorParams): UtxoCollection
Parameters:
__namedParameters: ConstructorParams
Returns:
UtxoCollectionMethods
[iterator]
[iterator](): Generator
Returns:
GeneratoraddUtxo
Parameters:
utxo: Utxo
addressMap: AddressMap
Returns:
UtxoCollectionclone
clone(): UtxoCollection
Returns:
UtxoCollectiondifference
difference(utxoCol: UtxoCollection): UtxoCollection
Parameters:
utxoCol: UtxoCollection
Returns:
UtxoCollectionequals
filter
getAddressesForTxId
getAddressPathsMap
getAddressPathsMap(): any
Returns:
anygetAddressUtxos
getAddressUtxos(address: string | Address): UtxoCollection
Parameters:
address: string | Address
Returns:
UtxoCollectiongetTxIdUtxos
hasAddressUtxos
hasAddressUtxos(address: string): boolean
Parameters:
address: string
Returns:
booleaninspect
inspect(): string
Returns:
stringisEmpty
isEmpty(): boolean
Returns:
booleanmerge
merge(utxoCol: UtxoCollection): UtxoCollection
Parameters:
utxoCol: UtxoCollection
Returns:
UtxoCollectionremoveAddressUtxos
removeAddressUtxos(address: string | Address): UtxoCollection
Parameters:
address: string | Address
Returns:
UtxoCollectionselect
Parameters:
amount: NumberUnit
feeEstimator: any
Returns:
undefined | UtxoCollection[]setAddressUtxos
setAddressUtxos(address: string | Address, utxos: UtxoCollection | Utxo[], __namedParameters: any): UtxoCollection
Parameters:
Returns:
UtxoCollectiontoJSON
toJSON(): Record
Returns:
Recordunion
unionOverwrite
unionOverwrite(utxos: UtxoCollection): UtxoCollection
Parameters:
utxos: UtxoCollection
Returns:
UtxoCollectionupdateConfirmations
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anycreateEmpty
fromArray
Parameters:
utxoArray: undefined | null | RawUtxo[]
__namedParameters: any
Returns:
UtxoCollectionfromJSON
Parameters:
json: string | UtxoCollectionJson
__namedParameters: any
Returns:
UtxoCollectionAccessors
addresses
empty
size
txIds
value
[ModelIdSymbol]
WalletAccount
class
Constructor
constructor
WalletAccount(__namedParameters: WalletAccountParams): WalletAccount
Parameters:
__namedParameters: WalletAccountParams
Returns:
WalletAccountProperties
color?
string
compatibilityMode?
string
delegated?
boolean
enabled
boolean
icon?
string
id?
string | number
index
null | number
is2FA?
boolean
isMultisig?
boolean
label
string
lastConnected?
number
model?
string
seedId?
string
source
_isInstance
any
DEFAULT_COLORS
Readonly
DEFAULT_ICONS
Readonly
EXODUS_SRC
"exodus"
FTX_SRC
"ftx"
isInstance
any
LABEL_MAX_LENGTH
100
LEDGER_SRC
"ledger"
MPSWAPS_SRC
"mpswaps"
PASSKEY_SRC
"passkey"
POLYMARKET_SRC
"polymarket"
SEED_SRC
"seed"
TREZOR_SRC
"trezor"
Methods
equals
equals(otherWalletAccount: WalletAccount): boolean
Parameters:
otherWalletAccount: WalletAccount
Returns:
booleantoJSON
toJSON(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): any
Returns:
anytoString
toString(): string
Returns:
stringupdate
[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anydefaultWith
Accessors
isCustodial
isExternal
isHardware
isPasskey
isSoftware
[ModelIdSymbol]
DEFAULT
DEFAULT_NAME
VALID_SOURCES
WalletAccountSet
class
Constructor
constructor
Methods
equals
equals(walletAccountsByName: WalletAccountSet): boolean
Parameters:
walletAccountsByName: WalletAccountSet
Returns:
booleanget
get(name: string | WalletAccount): undefined | WalletAccount
Parameters:
name: string | WalletAccount
Returns:
undefined | WalletAccountnames
names(): string[]
Returns:
string[]toJSON
toJSON(): any
Returns:
anytoRedactedJSON
toRedactedJSON(): any
Returns:
anyupdate
update(walletAccountsByName: WalletAccountSet | any): WalletAccountSet
Parameters:
walletAccountsByName: WalletAccountSet | any
Returns:
WalletAccountSet[hasInstance]
[hasInstance](x: any): any
Parameters:
x: any
Returns:
anyAccessors
[ModelIdSymbol]
WalletAccountParams
type
Properties
color?
string
compatibilityMode?
string
delegated?
boolean
enabled?
boolean
icon?
string
id?
string | number
index?
number | null
is2FA?
boolean
isMultisig?
boolean
label?
string
lastConnected?
number
model?
string
seedId?
string
source
WalletAccountSource
type
ModelIdSymbol
variable
Type
any
currenciesForAsset
function
Signature
currenciesForAsset(asset: any): any
Parameters:
asset: any
Returns:
anyensureCurrencies
function
fiatFusionOrderToOrderAdapter
function
fiatOrderAdapter
function
Signature
Parameters:
__namedParameters: AdapterParams
assets: Assets
Returns:
anynormalizeTxJSON
function
normalizeTxsJSON
function
orderFromJSONLegacy
function
orderSetFromJSONLegacy
function
orderSetToJSONLegacy
function
orderToJSONLegacy
Asset
type
Assets
type
WithType
type
