Interface XChainClient

Interface for an XChain client.

interface XChainClient {
    broadcastTx(txHex): Promise<string>;
    getAddress(walletIndex?): string;
    getAddressAsync(walletIndex?): Promise<string>;
    getBalance(address, assets?): Promise<Balance[]>;
    getExplorerAddressUrl(address): string;
    getExplorerTxUrl(txID): string;
    getExplorerUrl(): string;
    getFees(options?): Promise<Fees>;
    getNetwork(): Network;
    getTransactionData(txId, assetAddress?): Promise<Tx>;
    getTransactions(params?): Promise<TxsPage>;
    prepareTx(params): Promise<PreparedTx>;
    purgeClient(): void;
    setNetwork(net): void;
    setPhrase(phrase, walletIndex): string;
    transfer(params): Promise<string>;
    validateAddress(address): boolean;
}

Implemented by

BaseXChainClient

Index

Methods

broadcastTx getAddress getAddressAsync getBalance getExplorerAddressUrl getExplorerTxUrl getExplorerUrl getFees getNetwork getTransactionData getTransactions prepareTx purgeClient setNetwork setPhrase transfer validateAddress

Methods

broadcastTx

broadcastTx(txHex): Promise<string>
Parameters
- txHex: string
Returns Promise<string>
- Defined in xchain-client/src/types.ts:199

getAddress

getAddress(walletIndex?): string
Parameters
- Optional walletIndex: number
Returns string
- Defined in xchain-client/src/types.ts:190

getAddressAsync

getAddressAsync(walletIndex?): Promise<string>
Parameters
- Optional walletIndex: number
Returns Promise<string>
- Defined in xchain-client/src/types.ts:191

getBalance

getBalance(address, assets?): Promise<Balance[]>
Parameters
- address: string
- Optional assets: Asset[]
Returns Promise<Balance[]>
- Defined in xchain-client/src/types.ts:193

getExplorerAddressUrl

getExplorerAddressUrl(address): string
Parameters
- address: string
Returns string
- Defined in xchain-client/src/types.ts:187

getExplorerTxUrl

getExplorerTxUrl(txID): string
Parameters
- txID: string
Returns string
- Defined in xchain-client/src/types.ts:188

getExplorerUrl

getExplorerUrl(): string
Returns string
- Defined in xchain-client/src/types.ts:186

getFees

getFees(options?): Promise<Fees>
Parameters
- Optional options: FeeEstimateOptions
Returns Promise<Fees>
- Defined in xchain-client/src/types.ts:196

getNetwork

getNetwork(): Network
Returns Network
- Defined in xchain-client/src/types.ts:185

getTransactionData

getTransactionData(txId, assetAddress?): Promise<Tx>
Parameters
- txId: string
- Optional assetAddress: string
Returns Promise<Tx>
- Defined in xchain-client/src/types.ts:195

getTransactions

getTransactions(params?): Promise<TxsPage>
Parameters
- Optional params: TxHistoryParams
Returns Promise<TxsPage>
- Defined in xchain-client/src/types.ts:194

prepareTx

prepareTx(params): Promise<PreparedTx>
Parameters
- params: TxParams
Returns Promise<PreparedTx>
- Defined in xchain-client/src/types.ts:198

purgeClient

purgeClient(): void
Returns void
- Defined in xchain-client/src/types.ts:200

setNetwork

setNetwork(net): void
Parameters
- net: Network
Returns void
- Defined in xchain-client/src/types.ts:184

setPhrase

setPhrase(phrase, walletIndex): string
Parameters
- phrase: string
- walletIndex: number
Returns string
- Defined in xchain-client/src/types.ts:192

transfer

transfer(params): Promise<string>
Parameters
- params: TxParams
Returns Promise<string>
- Defined in xchain-client/src/types.ts:197

validateAddress

validateAddress(address): boolean
Parameters
- address: string
Returns boolean
- Defined in xchain-client/src/types.ts:189

Generated using TypeDoc