Class Client

Customized BSC client extending the base XchainEvmClient.

Hierarchy

  • default
    • Client

Constructors

constructor

Properties

chain config feeBounds network phrase rootDerivationPaths

Methods

approve broadcastTx call estimateApprove estimateCall estimateFeesWithGasPricesAndLimits estimateGasLimit estimateGasPrices getAddress getAddressAsync getAssetInfo getBalance getExplorerAddressUrl getExplorerTxUrl getExplorerUrl getFeeRateFromThorchain getFees getFullDerivationPath getNetwork getProvider getTransactionData getTransactions getWallet isApproved prepareApprove prepareTx purgeClient roundRobinGetBalance roundRobinGetFeeRates roundRobinGetTransactionData roundRobinGetTransactions setNetwork setPhrase thornodeAPIGet transfer validateAddress

Constructors

constructor

  • new Client(config?): Client

  • Constructor for the BSC client.

    Parameters

    • config: EVMClientParams = defaultBscParams

      Configuration parameters for the client. Defaults to defaultBscParams if not provided.

    Returns Client

Properties

Protected chain

chain: string

Readonly config

config: EVMClientParams

Protected feeBounds

feeBounds: FeeBounds

Protected network

network: Network

Protected phrase

phrase: string

Protected rootDerivationPaths

rootDerivationPaths: undefined | RootDerivationPaths

Methods

approve

  • approve(__namedParameters): Promise<TransactionResponse>

  • Approves an allowance for spending tokens.

    Parameters

    • __namedParameters: ApproveParams

    Returns Promise<TransactionResponse>

    The result of the approval transaction.

    Throws

    Error If gas estimation fails.

broadcastTx

  • broadcastTx(txHex): Promise<string>

  • Broadcasts a transaction.

    Parameters

    • txHex: string

      The transaction in hexadecimal format.

    Returns Promise<string>

    The transaction hash.

call

  • call<T>(__namedParameters): Promise<T>

  • Call a contract function.

    Type Parameters

    • T

    Parameters

    • __namedParameters: CallParams

    Returns Promise<T>

    The result of the contract function call..

estimateApprove

  • estimateApprove(__namedParameters): Promise<BigNumber>

  • Estimates the gas required for approving an allowance.

    Parameters

    • __namedParameters: EstimateApproveParams

    Returns Promise<BigNumber>

    The estimated gas required for the approval.

estimateCall

  • estimateCall(__namedParameters): Promise<BigNumber>

  • Estimates the gas required for calling a contract function.

    Parameters

    • __namedParameters: EstimateCallParams

    Returns Promise<BigNumber>

    The estimated gas required for the contract function call.

estimateFeesWithGasPricesAndLimits

  • estimateFeesWithGasPricesAndLimits(params): Promise<FeesWithGasPricesAndLimits>

  • Estimates gas prices/limits (average, fast, fastest) and fees for a transaction.

    Parameters

    • params: TxParams

      The transaction parameters.

    Returns Promise<FeesWithGasPricesAndLimits>

    The estimated gas prices/limits and fees.

estimateGasLimit

  • estimateGasLimit(params): Promise<BigNumber>

  • Estimates gas limit for a transaction.

    Parameters

    • params: TxParams & {
          from?: string;
      }

      The transaction and fees options.

    Returns Promise<BigNumber>

    The estimated gas limit.

    Throws

    Error Thrown if address could not be parsed from the given ERC20 asset.

estimateGasPrices

  • estimateGasPrices(protocol?): Promise<GasPrices>

  • Estimates gas prices (average, fast, fastest) for a transaction.

    Parameters

    • Optional protocol: THORCHAIN

      The protocol to use for estimating gas prices.

    Returns Promise<GasPrices>

    The gas prices (average, fast, fastest) in Wei (BaseAmount)

getAddress

  • getAddress(walletIndex?): string

  • Parameters

    • Optional walletIndex: number

    Returns string

    Deprecated

    Use getAddressAsync instead. This function will eventually be removed.

getAddressAsync

  • getAddressAsync(walletIndex?): Promise<string>

  • Parameters

    • Optional walletIndex: number

      (optional) Index of the HD wallet.

    Returns Promise<string>

    The current address.

    Throws

    Thrown if wallet index < 0.

getAssetInfo

  • getAssetInfo(): AssetInfo

  • Retrieves asset information.

    Returns AssetInfo

    Asset information containing the asset and its decimal places.

getBalance

  • getBalance(address, assets?): Promise<Balance[]>

  • Retrieves the balance of a given address.

    Parameters

    • address: string

      The address to retrieve the balance for.

    • Optional assets: Asset[]

      Assets to retrieve the balance for (optional).

    Returns Promise<Balance[]>

    An array containing the balance of the address.

    Throws

    Thrown when the provided asset is invalid.

getExplorerAddressUrl

  • getExplorerAddressUrl(address): string

  • Retrieves the explorer URL for a given address.

    Parameters

    • address: string

      The address to retrieve the explorer URL for.

    Returns string

    The explorer URL for the given address.

getExplorerTxUrl

  • getExplorerTxUrl(txID): string

  • Retrieves the explorer URL for a given transaction ID.

    Parameters

    • txID: string

      The transaction ID to retrieve the explorer URL for.

    Returns string

    The explorer URL for the given transaction ID.

getExplorerUrl

  • getExplorerUrl(): string

  • Retrieves the explorer URL based on the current network.

    Returns string

    The explorer URL for Ethereum based on the current network.

Protected getFeeRateFromThorchain

  • getFeeRateFromThorchain(): Promise<number>

  • Get the fee rate from the Thorchain API.

    Returns Promise<number>

    The fee rate

getFees

  • getFees(): never

  • Get transaction fees.

    Returns never

    The average, fast, and fastest fees.

    Throws

    Thrown if parameters are not provided.

  • getFees(params): Promise<Fees>

  • Parameters

    • params: TxParams

    Returns Promise<Fees>

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

getNetwork

  • getNetwork(): Network

  • Get the current network.

    Returns Network

    The current network

getProvider

  • getProvider(): Provider

  • Retrieves the Ethereum Provider interface.

    Returns Provider

    The current Ethereum Provider interface.

getTransactionData

  • getTransactionData(txId, assetAddress?): Promise<Tx>

  • Retrieves the transaction details of a given transaction ID.

    Parameters

    • txId: string

      The transaction ID.

    • Optional assetAddress: string

      The asset address (optional).

    Returns Promise<Tx>

    The transaction details of the given transaction ID.

    Throws

    Thrown if the provided transaction ID is invalid.

getTransactions

  • getTransactions(params?): Promise<TxsPage>

  • Retrieves the transaction history of a given address with pagination options.

    Parameters

    • Optional params: TxHistoryParams

      Options to get transaction history (optional).

    Returns Promise<TxsPage>

    The transaction history.

getWallet

  • getWallet(walletIndex?): Wallet

  • Retrieves the Ethereum wallet interface.

    Parameters

    • Optional walletIndex: number

      The index of the HD wallet (optional).

    Returns Wallet

    The current Ethereum wallet interface.

    Throws

    Error - Thrown if the HDNode is not defined, indicating that a phrase is needed to create a wallet and derive an address. Note: A phrase is needed to create a wallet and to derive an address from it.

isApproved

  • isApproved(__namedParameters): Promise<boolean>

  • Check allowance.

    Parameters

    • __namedParameters: IsApprovedParams

    Returns Promise<boolean>

    true if the allowance is approved, false otherwise.

prepareApprove

  • prepareApprove(params): Promise<PreparedTx>

  • Prepares an approval transaction.

    Parameters

    • params: ApproveParams & {
          sender: string;
      }

      The approval options.

    Returns Promise<PreparedTx>

    The raw unsigned transaction.

    Throws

    Error Thrown if any of the addresses are invalid.

prepareTx

  • prepareTx(params): Promise<PreparedTx>

  • Prepares a transaction for transfer.

    Parameters

    • params: TxParams & {
          feeOption?: FeeOption;
          gasLimit?: BigNumber;
          gasPrice?: {
              amount: (() => BigNumber);
              decimal: number;
              div: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              eq: ((value) => boolean);
              gt: ((value) => boolean);
              gte: ((value) => boolean);
              lt: ((value) => boolean);
              lte: ((value) => boolean);
              minus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              plus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              times: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              type: Base;
          };
          sender: string;
      }

      The transfer options.

    Returns Promise<PreparedTx>

    The raw unsigned transaction.

    Throws

    Error Thrown if the provided asset chain does not match the client's chain, or if any of the addresses are invalid.

purgeClient

  • purgeClient(): void

  • Purges the client, resetting it to initial state.

    Returns void

Protected roundRobinGetBalance

  • roundRobinGetBalance(address, assets?): Promise<Balance[]>

  • Retrieves the balance of an address by round-robin querying multiple data providers.

    Parameters

    • address: string

      The address to query the balance for.

    • Optional assets: Asset[]

      Optional list of assets to query the balance for.

    Returns Promise<Balance[]>

    The balance information for the address.

    Throws

    Error Thrown if no provider is able to retrieve the balance.

Protected roundRobinGetFeeRates

  • roundRobinGetFeeRates(): Promise<FeeRates>

  • Retrieves fee rates by round-robin querying multiple data providers.

    Returns Promise<FeeRates>

    The fee rates.

    Throws

    Error Thrown if no provider is able to retrieve the fee rates.

Protected roundRobinGetTransactionData

  • roundRobinGetTransactionData(txId, assetAddress?): Promise<Tx>

  • Retrieves transaction data by round-robin querying multiple data providers.

    Parameters

    • txId: string

      The transaction ID.

    • Optional assetAddress: string

      Optional asset address.

    Returns Promise<Tx>

    The transaction data.

    Throws

    Error Thrown if no provider is able to retrieve the transaction data.

Protected roundRobinGetTransactions

  • roundRobinGetTransactions(params): Promise<TxsPage>

  • Retrieves transaction history by round-robin querying multiple data providers.

    Parameters

    • params: TxHistoryParams

      The transaction history parameters.

    Returns Promise<TxsPage>

    The transaction history.

    Throws

    Error Thrown if no provider is able to retrieve the transaction history.

setNetwork

  • setNetwork(network): void

  • Sets or updates the current network.

    Parameters

    • network: Network

      The network to set or update.

    Returns void

    Throws

    Thrown if the network has not been set before.

setPhrase

  • setPhrase(phrase, walletIndex?): string

  • Validates the given Ethereum address.

    Parameters

    • phrase: string
    • Optional walletIndex: number

    Returns string

    true if the address is valid, false otherwise.

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

transfer

  • transfer(__namedParameters): Promise<string>

  • Transfers ETH or ERC20 token

    Note: A given feeOption wins over gasPrice and gasLimit

    Parameters

    • __namedParameters: TxParams & {
          feeOption?: FeeOption;
          gasLimit?: BigNumber;
          gasPrice?: {
              amount: (() => BigNumber);
              decimal: number;
              div: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              eq: ((value) => boolean);
              gt: ((value) => boolean);
              gte: ((value) => boolean);
              lt: ((value) => boolean);
              lte: ((value) => boolean);
              minus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              plus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              times: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              type: Base;
          };
          maxFeePerGas?: {
              amount: (() => BigNumber);
              decimal: number;
              div: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              eq: ((value) => boolean);
              gt: ((value) => boolean);
              gte: ((value) => boolean);
              lt: ((value) => boolean);
              lte: ((value) => boolean);
              minus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              plus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              times: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              type: Base;
          };
          maxPriorityFeePerGas?: {
              amount: (() => BigNumber);
              decimal: number;
              div: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              eq: ((value) => boolean);
              gt: ((value) => boolean);
              gte: ((value) => boolean);
              lt: ((value) => boolean);
              lte: ((value) => boolean);
              minus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              plus: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              times: ((value, decimal?) => { type: Denomination.Base; amount: () => BigNumber; plus: (value: ... | Value, decimal?: number | undefined) => ...; minus: (value: ... | Value, decimal?: number | undefined) => ...; ... 7 more ...; decimal: number; });
              type: Base;
          };
          signer?: Signer;
      }

    Returns Promise<string>

    The transaction hash.

    Throws

    Error Thrown if address of given Asset could not be parsed

validateAddress

  • validateAddress(address): boolean

  • Validate the given address.

    Parameters

    • address: string

    Returns boolean

    true or false

Settings

Member Visibility

Theme

On This Page

constructorchainconfigfeeBoundsnetworkphraserootDerivationPathsapprovebroadcastTxcallestimateApproveestimateCallestimateFeesWithGasPricesAndLimitsestimateGasLimitestimateGasPricesgetAddressgetAddressAsyncgetAssetInfogetBalancegetExplorerAddressUrlgetExplorerTxUrlgetExplorerUrlgetFeeRateFromThorchaingetFeesgetFullDerivationPathgetNetworkgetProvidergetTransactionDatagetTransactionsgetWalletisApprovedprepareApproveprepareTxpurgeClientroundRobinGetBalanceroundRobinGetFeeRatesroundRobinGetTransactionDataroundRobinGetTransactionssetNetworksetPhrasethornodeAPIGettransfervalidateAddress

Generated using TypeDoc