@exodus/blockchain-metadata

BlockchainMetadataAtomValue

BlockchainMetadataApi

BlockchainMetadataDependencies

BlockchainMetadataReportValue

BlockchainQueryDependencies

BlockchainQuery

DeferredPromiseWithState

LoadedWalletAccountsPayload

OverwriteTxsParams

ReduxWalletAssetState

TxWatcherDependencies

UpdateAccountStateParams

AccountStateChange

AccountStateClass

AccountStatesAtomValue

BatchingReducerContext

BlockchainMetadataAtomValue

BlockchainMetadataApi

BlockchainMetadataDependencies

BlockchainMetadataReportValue

BlockchainQueryDependencies

BlockchainQuery

DeferredPromiseWithState

LoadedWalletAccountsPayload

OverwriteTxsParams

ReduxWalletAssetState

TxWatcherDependencies

UpdateAccountStateParams

Functions

blockchainMetadata

Type Aliases

AccountStateData

AccountStatesAtom

AccountStatesReduxState

EarliestTxDateAtom

EnabledAssetsAtom

SerializedAccountState

AccountStatesReduxState

EarliestTxDateAtom

EnabledAssetsAtom

SerializedAccountState

Variables

blockchainMetadata

variable

Type

const blockchainMetadata: () => { ... }

Signature

__type(): any

Returns:

any

Properties

definitions

any | any | any | any | any | any | any | any | any | any | any | any[]

SafeString

AccountStateChange

interface

Properties

accountState

assetName

string

walletAccount

string

AccountStateClass

interface

Methods

create

create(props?: Record): AccountState

Parameters:

props (optional): Record

Returns:

fromJSON

fromJSON(value: JsonObject): AccountState

Parameters:

value: JsonObject

Returns:

serialize

serialize(value: AccountState, options?: any): JsonObject

Parameters:

value: AccountState

options (optional): any

Returns:

AccountStatesAtomValue

interface

Properties

changes?

value

AddressAssetSource

interface

Properties

address

string

assetName

string

walletAccount

string

Analytics

interface

Methods

requireDefaultEventProperties

requireDefaultEventProperties(properties: any): void

Parameters:

properties: any

Returns:

void

setDefaultEventProperties

setDefaultEventProperties(payload: any): void

Parameters:

payload: any

Returns:

void

AssetsModule

interface

Methods

getAsset

getAsset(assetName: string): Asset

Parameters:

assetName: string

Returns:

getAssets

getAssets(): AssetsByName

Returns:

AssetSource

interface

Properties

assetName

string

walletAccount

string

Batch

interface

Methods

addTxs

addTxs(params: TxParams): Batch

Parameters:

params: TxParams

Returns:

clearTxs

clearTxs(params: AssetSource): Batch

Parameters:

params: AssetSource

Returns:

commit

commit(): Promise

Returns:

Promise

overwriteTxs

overwriteTxs(params: OverwriteTxsParams): Batch

Parameters:

params: OverwriteTxsParams

Returns:

removeAccountState

removeAccountState(params: AssetSource): Batch

Parameters:

params: AssetSource

Returns:

removeTxs

removeTxs(params: TxParams): Batch

Parameters:

params: TxParams

Returns:

updateAccountState

updateAccountState(params: UpdateAccountStateParams): Batch

Parameters:

Returns:

updateTxs

updateTxs(params: TxParams): Batch

Parameters:

params: TxParams

Returns:

BatchingChanges

interface

Properties

accountStates

newlyReceivedTxLogs

NewlyReceivedTxLogs

txLogs

BatchingReducerContext

interface

Methods

getAsset

getAsset(assetName: string): Asset

Parameters:

assetName: string

Returns:

getAssets

getAssets(): AssetsByName

Returns:

getCachedAccountState

getCachedAccountState(assetSource: AssetSource): undefined | AccountState

Parameters:

assetSource: AssetSource

Returns:

undefined | AccountState

getCachedTxLog

getCachedTxLog(assetSource: AssetSource): undefined | TxSet

Parameters:

assetSource: AssetSource

Returns:

undefined | TxSet

BlockchainMetadata

interface

Methods

addTxs

addTxs(params: TxParams): Promise

Parameters:

params: TxParams

Returns:

Promise

batch

batch(): Batch

Returns:

clear

clear(): Promise

Returns:

Promise

clearTxs

clearTxs(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

getAccountState

getAccountState(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

getLoadedAccountStates

getLoadedAccountStates(): Promise

Returns:

Promise

getLoadedTxLogs

getLoadedTxLogs(): Promise

Returns:

Promise

getTxLog

getTxLog(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

load

load(): Promise

Returns:

Promise

on(eventName: string, listener: any): void

Parameters:

eventName: string

listener: any

Returns:

void

once

once(eventName: string, listener: any): void

Parameters:

eventName: string

listener: any

Returns:

void

overwriteTxs

overwriteTxs(params: OverwriteTxsParams): Promise

Parameters:

params: OverwriteTxsParams

Returns:

Promise

removeAccountState

removeAccountState(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

removeTxs

removeTxs(params: TxParams): Promise

Parameters:

params: TxParams

Returns:

Promise

serializePayload

serializePayload(params: any): any

Parameters:

params: any

Returns:

any

stop

stop(): void

Returns:

void

sync

sync(): void

Returns:

void

updateAccountState

updateAccountState(params: UpdateAccountStateParams): Promise

Parameters:

Returns:

Promise

updateTxs

updateTxs(params: TxParams): Promise

Parameters:

params: TxParams

Returns:

Promise

BlockchainMetadataApi

interface

Properties

blockchainMetadata

any

BlockchainMetadataAtomValue

interface

Properties

accountStateChanges?

newlyReceivedTxLogs?

txLogChanges?

value

BlockchainMetadataDependencies

interface

Properties

assetsModule

AssetsModule

blockchainMetadataAtom

enabledWalletAccountsAtom

errorTracking

ErrorTracking

logger

Logger

storage

StoragePort

BlockchainMetadataReportValue

interface

Properties

accountStates

earliestTxDate?

string

txLogs

BlockchainMetadataValue

interface

Properties

accountStates

txs

BlockchainQuery

interface

Methods

isUsedRecipientAddress

isUsedRecipientAddress(params: AddressAssetSource): Promise

Parameters:

params: AddressAssetSource

Returns:

Promise

BlockchainQueryDependencies

interface

Properties

blockchainMetadata

DeferredPromiseWithState

interface

Properties

promise

Promise

resolved?

boolean

started?

boolean

Methods

reject

reject(reason?: string | Error): void

Parameters:

reason (optional): string | Error

Returns:

void

resolve

resolve(value: T | PromiseLike): void

Parameters:

value: T | PromiseLike

Returns:

void

ErrorTracking

interface

Methods

track

track(payload: any): void

Parameters:

payload: any

Returns:

void

EventPort

interface

Methods

emit

emit(eventName: "txLogs" | "accountStates", payload: any | any | any | any): void

Parameters:

eventName: "txLogs" | "accountStates"

payload: any | any | any | any

Returns:

void

JsonObject

interface

LifecycleEvent

interface

Properties

isLocked

boolean

LoadedWalletAccountsPayload

interface

Properties

walletAccounts

string[]

OverwriteTxsParams

interface

Properties

assetName

string

notifyReceivedTxs?

boolean

txs

any

walletAccount

string

ReduxWalletAssetState

interface

Properties

data

Record

error

null | string

loaded

boolean

ReportExportParams

interface

Properties

isLocked?

boolean

walletExists?

boolean

ReportNode

interface

Properties

namespace

"blockchainMetadata"

Methods

export

export(params?: ReportExportParams): Promise

Parameters:

params (optional): ReportExportParams

Returns:

Promise

getSchema

getSchema(): any

Returns:

any

SanitizedTxLog

interface

Properties

coinName?

null | string

send?

null | boolean

StorageNamespace

interface

Methods

batchGet

batchGet(keys: any): Promise

Parameters:

keys: any

Returns:

Promise

clear

clear(): Promise

Returns:

Promise

set

set(key: string, value: Value): Promise

Parameters:

key: string

value: Value

Returns:

Promise

StoragePort

interface

Methods

namespace

namespace(name: string): StorageNamespace

Parameters:

name: string

Returns:

StorageNamespace

TxLogChange

interface

Properties

assetName

string

txLog

walletAccount

string

TxLogsAtomValue

interface

Properties

changes?

newlyReceivedTxLogs?

value

TxParams

interface

Properties

assetName

string

txs

any

walletAccount

string

TxWatcher

interface

Methods

watch

watch(params: any): Promise

Parameters:

params: any

Returns:

Promise

TxWatcherDependencies

interface

Properties

txLogsAtom

TxLogsAtom

UpdateAccountStateParams

interface

Properties

assetName

string

newData

walletAccount

string

AccountStateData

type

AccountStateMap

type

AccountStatesAtom

type

AccountStatesReduxState

type

Asset

type

AssetName

type

AssetsByName

type

BatchAction

type

BatchingReducer

type

BlockchainMetadataAtom

type

EarliestTxDateAtom

type

EnabledAssetsAtom

type

EnabledWalletAccountsAtom

type

Fusion

type

ISODate

type

JsonValue

type

NewlyReceivedTxLogs

type

ObserveTxLogs

type

OnCommit

type

SanitizedAccountStates

type

SanitizedTxLogs

type

SerializedAccountState

type

SerializedTx

type

TxInput

type

TxJson

type

TxLogMap

type

TxLogsAtom

type

TxLogsReduxState

type

WalletAccountName

type

WalletAccountsRecord

type

blockchainMetadata

function

Signature

blockchainMetadata(): any

Returns:

any

AccountState

interface

Properties

_version?

number

Methods

contains

contains(data: Props): boolean

Parameters:

data: Props

Returns:

boolean

equals

equals(other: AccountState, opts?: any): boolean

Parameters:

other: AccountState

opts (optional): any

Returns:

boolean

merge

merge(data: Props): any

Parameters:

data: Props

Returns:

any

toJSON

toJSON(opts?: any): any

Parameters:

opts (optional): any

Returns:

any

toRedactedJSON

toRedactedJSON(): any

Returns:

any

AccountStateChange

interface

Properties

accountState

assetName

string

walletAccount

string

AccountStateClass

interface

Methods

create

create(props?: Record): AccountState

Parameters:

props (optional): Record

Returns:

fromJSON

fromJSON(value: JsonObject): AccountState

Parameters:

value: JsonObject

Returns:

serialize

serialize(value: AccountState, options?: any): JsonObject

Parameters:

value: AccountState

options (optional): any

Returns:

AccountStatesAtomValue

interface

Properties

changes?

value

AddressAssetSource

interface

Properties

address

string

assetName

string

walletAccount

string

Analytics

interface

Methods

requireDefaultEventProperties

requireDefaultEventProperties(properties: any): void

Parameters:

properties: any

Returns:

void

setDefaultEventProperties

setDefaultEventProperties(payload: any): void

Parameters:

payload: any

Returns:

void

AssetsModule

interface

Methods

getAsset

getAsset(assetName: string): Asset

Parameters:

assetName: string

Returns:

getAssets

getAssets(): AssetsByName

Returns:

AssetSource

interface

Properties

assetName

string

walletAccount

string

Batch

interface

Methods

addTxs

addTxs(params: TxParams): Batch

Parameters:

params: TxParams

Returns:

clearTxs

clearTxs(params: AssetSource): Batch

Parameters:

params: AssetSource

Returns:

commit

commit(): Promise

Returns:

Promise

overwriteTxs

overwriteTxs(params: OverwriteTxsParams): Batch

Parameters:

params: OverwriteTxsParams

Returns:

removeAccountState

removeAccountState(params: AssetSource): Batch

Parameters:

params: AssetSource

Returns:

removeTxs

removeTxs(params: TxParams): Batch

Parameters:

params: TxParams

Returns:

updateAccountState

updateAccountState(params: UpdateAccountStateParams): Batch

Parameters:

Returns:

updateTxs

updateTxs(params: TxParams): Batch

Parameters:

params: TxParams

Returns:

BatchingChanges

interface

Properties

accountStates

newlyReceivedTxLogs

NewlyReceivedTxLogs

txLogs

BatchingReducerContext

interface

Methods

getAsset

getAsset(assetName: string): Asset

Parameters:

assetName: string

Returns:

getAssets

getAssets(): AssetsByName

Returns:

getCachedAccountState

getCachedAccountState(assetSource: AssetSource): undefined | AccountState

Parameters:

assetSource: AssetSource

Returns:

undefined | AccountState

getCachedTxLog

getCachedTxLog(assetSource: AssetSource): undefined | TxSet

Parameters:

assetSource: AssetSource

Returns:

undefined | TxSet

BlockchainMetadata

interface

Methods

addTxs

addTxs(params: TxParams): Promise

Parameters:

params: TxParams

Returns:

Promise

batch

batch(): Batch

Returns:

clear

clear(): Promise

Returns:

Promise

clearTxs

clearTxs(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

getAccountState

getAccountState(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

getLoadedAccountStates

getLoadedAccountStates(): Promise

Returns:

Promise

getLoadedTxLogs

getLoadedTxLogs(): Promise

Returns:

Promise

getTxLog

getTxLog(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

load

load(): Promise

Returns:

Promise

on(eventName: string, listener: any): void

Parameters:

eventName: string

listener: any

Returns:

void

once

once(eventName: string, listener: any): void

Parameters:

eventName: string

listener: any

Returns:

void

overwriteTxs

overwriteTxs(params: OverwriteTxsParams): Promise

Parameters:

params: OverwriteTxsParams

Returns:

Promise

removeAccountState

removeAccountState(params: AssetSource): Promise

Parameters:

params: AssetSource

Returns:

Promise

removeTxs

removeTxs(params: TxParams): Promise

Parameters:

params: TxParams

Returns:

Promise

serializePayload

serializePayload(params: any): any

Parameters:

params: any

Returns:

any

stop

stop(): void

Returns:

void

sync

sync(): void

Returns:

void

updateAccountState

updateAccountState(params: UpdateAccountStateParams): Promise

Parameters:

Returns:

Promise

updateTxs

updateTxs(params: TxParams): Promise

Parameters:

params: TxParams

Returns:

Promise

BlockchainMetadataApi

interface

Properties

blockchainMetadata

any

BlockchainMetadataAtomValue

interface

Properties

accountStateChanges?

newlyReceivedTxLogs?

txLogChanges?

value

BlockchainMetadataDependencies

interface

Properties

assetsModule

AssetsModule

blockchainMetadataAtom

enabledWalletAccountsAtom

errorTracking

ErrorTracking

logger

Logger

storage

StoragePort

BlockchainMetadataReportValue

interface

Properties

accountStates

earliestTxDate?

string

txLogs

BlockchainMetadataValue

interface

Properties

accountStates

txs

BlockchainQuery

interface

Methods

isUsedRecipientAddress

isUsedRecipientAddress(params: AddressAssetSource): Promise

Parameters:

params: AddressAssetSource

Returns:

Promise

BlockchainQueryDependencies

interface

Properties

blockchainMetadata

DeferredPromiseWithState

interface

Properties

promise

Promise

resolved?

boolean

started?

boolean

Methods

reject

reject(reason?: string | Error): void

Parameters:

reason (optional): string | Error

Returns:

void

resolve

resolve(value: T | PromiseLike): void

Parameters:

value: T | PromiseLike

Returns:

void

ErrorTracking

interface

Methods

track

track(payload: any): void

Parameters:

payload: any

Returns:

void

EventPort

interface

Methods

emit

emit(eventName: "txLogs" | "accountStates", payload: any | any | any | any): void

Parameters:

eventName: "txLogs" | "accountStates"

payload: any | any | any | any

Returns:

void

JsonObject

interface

LifecycleEvent

interface

Properties

isLocked

boolean

LoadedWalletAccountsPayload

interface

Properties

walletAccounts

string[]

OverwriteTxsParams

interface

Properties

assetName

string

notifyReceivedTxs?

boolean

txs

any

walletAccount

string

ReduxWalletAssetState

interface

Properties

data

Record

error

null | string

loaded

boolean

ReportExportParams

interface

Properties

isLocked?

boolean

walletExists?

boolean

ReportNode

interface

Properties

namespace

"blockchainMetadata"

Methods

export

export(params?: ReportExportParams): Promise

Parameters:

params (optional): ReportExportParams

Returns:

Promise

getSchema

getSchema(): any

Returns:

any

SanitizedTxLog

interface

Properties

coinName?

null | string

send?

null | boolean

StorageNamespace

interface

Methods

batchGet

batchGet(keys: any): Promise

Parameters:

keys: any

Returns:

Promise

clear

clear(): Promise

Returns:

Promise

set

set(key: string, value: Value): Promise

Parameters:

key: string

value: Value

Returns:

Promise

StoragePort

interface

Methods

namespace

namespace(name: string): StorageNamespace

Parameters:

name: string

Returns:

StorageNamespace

Tx

interface

Properties

addresses

AddressSet

coinAmount?

NumberUnit

coinName?

string

confirmations

number

currencies

Record

data

Record

date

Date

dropped?

boolean

error?

null | string

feeAmount?

NumberUnit

feeCoinName?

string

from

string[]

Methods

clone

clone(): any

Returns:

any

equals

equals(otherTx: Tx): boolean

Parameters:

otherTx: Tx

Returns:

boolean

toJSON

toJSON(): TxJson

Returns:

TxJson

toRedactedJSON

toRedactedJSON(): Partial

Returns:

Partial

toString

toString(): string

Returns:

string

update

update(fields: Tx | Partial | Partial): any

Parameters:

fields: Tx | Partial | Partial

Returns:

any

Accessors

accepted

confirmed

failed

pending

received

sent

token

TxLogChange

interface

Properties

assetName

string

txLog

walletAccount

string

TxLogsAtomValue

interface

Properties

changes?

newlyReceivedTxLogs?

value

TxParams

interface

Properties

assetName

string

txs

any

walletAccount

string

TxSet

interface

Properties

_mutations?

any[]

_order

string[]

_txs

Map

addresses

AddressSet

Methods

[iterator]

[iterator](): MapIterator

Returns:

MapIterator

add

add(tx: Tx): TxSet

Parameters:

tx: Tx

Returns:

clone

clone(): TxSet

Returns:

deepEquals

deepEquals(otherSet: TxSet): boolean

Parameters:

otherSet: TxSet

Returns:

boolean

delete

delete(tx: string | Tx): TxSet

Parameters:

tx: string | Tx

Returns:

equals

equals(otherSet: TxSet): boolean

Parameters:

otherSet: TxSet

Returns:

boolean

get

get(tx: string | Tx): undefined | Tx

Parameters:

tx: string | Tx

Returns:

undefined | Tx

getAt

getAt(order: number): undefined | Tx

Parameters:

order: number

Returns:

undefined | Tx

getMutations

getMutations(): any[]

Returns:

any[]

has

has(tx: string | Tx): boolean

Parameters:

tx: string | Tx

Returns:

boolean

reverse

reverse(): any

Returns:

any

toJSON

toJSON(): TxJson[]

Returns:

TxJson[]

toRedactedJSON

toRedactedJSON(): Partial[]

Returns:

Partial[]

union

union(otherSet: TxSet): TxSet

Parameters:

otherSet: TxSet

Returns:

update

update(otherSet: TxSet | Tx | WithType[]): TxSet

Parameters:

otherSet: TxSet | Tx | WithType[]

Returns:

updateTxsProperties

updateTxsProperties(items: any[]): TxSet

Parameters:

items: any[]

Returns:

Accessors

size

TxWatcher

interface

Methods

watch

watch(params: any): Promise

Parameters:

params: any

Returns:

Promise

TxWatcherDependencies

interface

Properties

txLogsAtom

TxLogsAtom

UpdateAccountStateParams

interface

Properties

assetName

string

newData