Interface OnlineDataProvider

Interface for online data providers.

interface OnlineDataProvider {
    getBalance(address, assets?): Promise<Balance[]>;
    getFeeRates(): Promise<FeeRates>;
    getTransactionData(txId, assetAddress?): Promise<Tx>;
    getTransactions(params): Promise<TxsPage>;
}

Index

Methods

getBalance getFeeRates getTransactionData getTransactions

Methods

getBalance

getBalance(address, assets?): Promise<Balance[]>
Get the balance for a given address.
Parameters
- address: string
  The address to get the balance for.
- Optional assets: Asset[]
  (Optional) An array of assets to get the balance for.
Returns Promise<Balance[]>
A promise that resolves to an array of balances.
- Defined in xchain-client/src/provider-types.ts:15

getFeeRates

getFeeRates(): Promise<FeeRates>
Get the fee rates.

Returns Promise<FeeRates>
A promise that resolves to the fee rates.
- Defined in xchain-client/src/provider-types.ts:36

getTransactionData

getTransactionData(txId, assetAddress?): Promise<Tx>
Get transaction data based on its ID.
Parameters
- txId: string
  The ID of the transaction.
- Optional assetAddress: string
  (Optional) The address of the asset.
Returns Promise<Tx>
A promise that resolves to the transaction data.
- Defined in xchain-client/src/provider-types.ts:30

getTransactions

getTransactions(params): Promise<TxsPage>
Get transactions based on provided parameters.
Parameters
- params: TxHistoryParams
  The parameters for fetching transactions.
Returns Promise<TxsPage>
A promise that resolves to a page of transactions.
- Defined in xchain-client/src/provider-types.ts:22

Generated using TypeDoc