Class BaseXChainClient`Abstract`

Interface for an XChain client.

Implements

XChainClient

Constructors

constructor

new BaseXChainClient(chain, params): BaseXChainClient
Constructor for the BaseXChainClient class. Initializes the client with the provided chain and parameters.
Parameters
- chain: string
  The blockchain chain identifier
- params: XChainClientParams
  The client parameters, including network, fee bounds, and root derivation paths
Returns BaseXChainClient
Throws
Thrown if an invalid mnemonic phrase is provided
- Defined in xchain-client/src/BaseXChainClient.ts:44

Properties

`Protected` chain

chain: string

`Protected` feeBounds

feeBounds: FeeBounds

`Protected` network

network: Network

`Protected` phrase

phrase: string = ''

`Protected` rootDerivationPaths

rootDerivationPaths: undefined | RootDerivationPaths

Methods

`Abstract` broadcastTx

broadcastTx(txHex): Promise<string>
Parameters
- txHex: string
Returns Promise<string>
Implementation of XChainClient.broadcastTx
- Defined in xchain-client/src/BaseXChainClient.ts:168

`Abstract` getAddress

getAddress(walletIndex?): string
Parameters
- Optional walletIndex: number
Returns string
Implementation of XChainClient.getAddress
- Defined in xchain-client/src/BaseXChainClient.ts:158

`Abstract` getAddressAsync

getAddressAsync(walletIndex?): Promise<string>
Parameters
- Optional walletIndex: number
Returns Promise<string>
Implementation of XChainClient.getAddressAsync
- Defined in xchain-client/src/BaseXChainClient.ts:159

`Abstract` getAssetInfo

getAssetInfo(): AssetInfo
Returns AssetInfo
- Defined in xchain-client/src/BaseXChainClient.ts:169

`Abstract` getBalance

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

`Abstract` getExplorerAddressUrl

getExplorerAddressUrl(address): string
Parameters
- address: string
Returns string
Implementation of XChainClient.getExplorerAddressUrl
- Defined in xchain-client/src/BaseXChainClient.ts:161

`Abstract` getExplorerTxUrl

getExplorerTxUrl(txID): string
Parameters
- txID: string
Returns string
Implementation of XChainClient.getExplorerTxUrl
- Defined in xchain-client/src/BaseXChainClient.ts:162

`Abstract` getExplorerUrl

getExplorerUrl(): string
Returns string
Implementation of XChainClient.getExplorerUrl
- Defined in xchain-client/src/BaseXChainClient.ts:160

`Protected` getFeeRateFromThorchain

getFeeRateFromThorchain(): Promise<number>
Get the fee rate from the Thorchain API.

Returns Promise<number>
The fee rate
- Defined in xchain-client/src/BaseXChainClient.ts:92

`Abstract` getFees

getFees(): Promise<Fees>
Returns Promise<Fees>
Implementation of XChainClient.getFees
- Defined in xchain-client/src/BaseXChainClient.ts:157

`Protected` getFullDerivationPath

getFullDerivationPath(walletIndex): string
Get the full derivation path based on the wallet index.
Parameters
- walletIndex: number
  The HD wallet index
Returns string
The full derivation path
- Defined in xchain-client/src/BaseXChainClient.ts:144

getNetwork

getNetwork(): Network
Get the current network.

Returns Network
The current network
Implementation of XChainClient.getNetwork
- Defined in xchain-client/src/BaseXChainClient.ts:84

`Abstract` getTransactionData

getTransactionData(txId, assetAddress?): Promise<Tx>
Parameters
- txId: string
- Optional assetAddress: string
Returns Promise<Tx>
Implementation of XChainClient.getTransactionData
- Defined in xchain-client/src/BaseXChainClient.ts:166

`Abstract` getTransactions

getTransactions(params?): Promise<TxsPage>
Parameters
- Optional params: TxHistoryParams
Returns Promise<TxsPage>
Implementation of XChainClient.getTransactions
- Defined in xchain-client/src/BaseXChainClient.ts:165

`Abstract` prepareTx

prepareTx(params): Promise<PreparedTx>
Parameters
- params: TxParams
Returns Promise<PreparedTx>
Implementation of XChainClient.prepareTx
- Defined in xchain-client/src/BaseXChainClient.ts:170

purgeClient

purgeClient(): void
Purge the client by clearing the mnemonic phrase.

Returns void
Implementation of XChainClient.purgeClient
- Defined in xchain-client/src/BaseXChainClient.ts:152

setNetwork

setNetwork(network): void
Set or update the current network.
Parameters
- network: Network
  The network to set
Returns void
Throws
Thrown if no network is provided
Implementation of XChainClient.setNetwork
- Defined in xchain-client/src/BaseXChainClient.ts:70

setPhrase

setPhrase(phrase, walletIndex?): string
Set or update the mnemonic phrase.
Parameters
- phrase: string
  The new mnemonic phrase
- walletIndex: number = 0
  (Optional) The HD wallet index
Returns string
The address derived from the provided phrase

Throws
Thrown if an invalid mnemonic phrase is provided
Implementation of XChainClient.setPhrase
- Defined in xchain-client/src/BaseXChainClient.ts:128

`Protected` thornodeAPIGet

thornodeAPIGet(endpoint): Promise<unknown>
Make a GET request to the Thorchain API.
Parameters
- endpoint: string
  The API endpoint
Returns Promise<unknown>
The response data
- Defined in xchain-client/src/BaseXChainClient.ts:107

`Abstract` transfer

transfer(params): Promise<string>
Parameters
- params: TxParams
Returns Promise<string>
Implementation of XChainClient.transfer
- Defined in xchain-client/src/BaseXChainClient.ts:167

`Abstract` validateAddress

validateAddress(address): boolean
Parameters
- address: string
Returns boolean
Implementation of XChainClient.validateAddress
- Defined in xchain-client/src/BaseXChainClient.ts:163

Class BaseXChainClientAbstract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseXChainClient

Throws

Properties

Protected chain

Protected feeBounds

Protected network

Protected phrase

Protected rootDerivationPaths

Methods

Abstract broadcastTx

Parameters

Returns Promise<string>

Abstract getAddress

Parameters

Returns string

Abstract getAddressAsync

Parameters

Returns Promise<string>

Abstract getAssetInfo

Returns AssetInfo

Abstract getBalance

Parameters

Returns Promise<Balance[]>

Abstract getExplorerAddressUrl

Parameters

Returns string

Abstract getExplorerTxUrl

Parameters

Returns string

Abstract getExplorerUrl

Returns string

Protected getFeeRateFromThorchain

Returns Promise<number>

Abstract getFees

Returns Promise<Fees>

Protected getFullDerivationPath

Parameters

Returns string

getNetwork

Returns Network

Abstract getTransactionData

Parameters

Returns Promise<Tx>

Abstract getTransactions

Parameters

Returns Promise<TxsPage>

Abstract prepareTx

Parameters

Returns Promise<PreparedTx>

purgeClient

Returns void

setNetwork

Parameters

Returns void

Throws

setPhrase

Parameters

Returns string

Throws

Protected thornodeAPIGet

Parameters

Returns Promise<unknown>

Abstract transfer

Parameters

Returns Promise<string>

Abstract validateAddress

Parameters

Returns boolean

Settings

Member Visibility

Theme

Class BaseXChainClient`Abstract`

`Protected` chain

`Protected` feeBounds

`Protected` network

`Protected` phrase

`Protected` rootDerivationPaths

`Abstract` broadcastTx

`Abstract` getAddress

`Abstract` getAddressAsync

`Abstract` getAssetInfo

`Abstract` getBalance

`Abstract` getExplorerAddressUrl

`Abstract` getExplorerTxUrl

`Abstract` getExplorerUrl

`Protected` getFeeRateFromThorchain

`Abstract` getFees

`Protected` getFullDerivationPath

`Abstract` getTransactionData

`Abstract` getTransactions

`Abstract` prepareTx

`Protected` thornodeAPIGet

`Abstract` transfer

`Abstract` validateAddress