Class Client

Cosmos client class extending the Cosmos SDK client.

Hierarchy

  • default
    • Client

Constructors

constructor

Properties

baseDenom chain clientUrls defaultDecimals feeBounds network phrase prefix registry rootDerivationPaths startgateClient

Methods

assetFromDenom broadcastTx getAddress getAddressAsync getAssetDecimals getAssetInfo getBalance getDenom getExplorerAddressUrl getExplorerTxUrl getExplorerUrl getFeeRateFromThorchain getFees getFullDerivationPath getMsgTypeUrlByType getNetwork getPrefix getStandardFee getTransactionData getTransactions prepareTx purgeClient setNetwork setPhrase thornodeAPIGet transfer transferOffline validateAddress

Constructors

constructor

  • new Client(config?): Client

  • Constructor for the Cosmos client.

    Parameters

    • config: Partial<CosmosSdkClientParams> = defaultClientConfig

      Configuration parameters for the client.

    Returns Client

Properties

Protected Readonly baseDenom

baseDenom: string

Protected chain

chain: string

Protected Readonly clientUrls

clientUrls: Record<Network, string>

Protected Readonly defaultDecimals

defaultDecimals: number

Protected feeBounds

feeBounds: FeeBounds

Protected network

network: Network

Protected phrase

phrase: string

Protected prefix

prefix: string

Protected Readonly registry

registry: Registry

Protected rootDerivationPaths

rootDerivationPaths: undefined | RootDerivationPaths

Protected startgateClient

startgateClient: CachedValue<StargateClient>

Methods

assetFromDenom

  • assetFromDenom(denom): null | Asset

  • Get the asset from a given denomination.

    Parameters

    • denom: string

      The denomination to convert.

    Returns null | Asset

    The asset corresponding to the given denomination.

broadcastTx

  • broadcastTx(txHex): Promise<string>

  • Parameters

    • txHex: string

    Returns Promise<string>

getAddress

  • getAddress(walletIndex?): string

  • Parameters

    • Optional walletIndex: number

    Returns string

    Deprecated

    this function eventually will be removed use getAddressAsync instead

getAddressAsync

  • getAddressAsync(index?): Promise<string>

  • Get an address derived from the phrase defined in the constructor.

    Parameters

    • Optional index: number

    Returns Promise<string>

    user address at index defined on walletIndex

getAssetDecimals

  • getAssetDecimals(asset): number

  • Get the number of decimals for a given asset.

    Parameters

    • asset: Asset

      The asset to get the decimals for.

    Returns number

    The number of decimals.

getAssetInfo

  • getAssetInfo(): AssetInfo

  • Get information about the client's native asset.

    Returns AssetInfo

    Information about the native asset.

getBalance

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

  • Obtains all the balances of the address passed as parameter for all the assets of the network. For the moment for this client the assets parameter is ignored. Do not hesitate to open a PR if you need it and it is not yet available.

    Parameters

    • address: string

      address to be validated

    • Optional _assets: Asset[]

      IGNORED FOR THIS IMPLEMENTATION

    Returns Promise<Balance[]>

    array of balances

getDenom

  • getDenom(asset): null | string

  • Get the denomination from a given asset.

    Parameters

    • asset: Asset

      The asset to get the denomination for.

    Returns null | string

    The denomination of the given asset.

getExplorerAddressUrl

  • getExplorerAddressUrl(address): string

  • Get the explorer url for the given address.

    Parameters

    • address: string

    Returns string

    The explorer url for the given address.

getExplorerTxUrl

  • getExplorerTxUrl(txID): string

  • Get the explorer url for the given transaction id.

    Parameters

    • txID: string

    Returns string

    The explorer url for the given transaction id.

getExplorerUrl

  • getExplorerUrl(): string

  • Get the explorer URL.

    Returns string

    The explorer URL.

Protected getFeeRateFromThorchain

  • getFeeRateFromThorchain(): Promise<number>

  • Returns Promise<number>

getFees

  • getFees(): Promise<Fees>

  • Get the current fees. If possible, fetches the fees from THORChain's inbound_addresses. Otherwise, returns default fees.

    Returns Promise<Fees>

    The current fees.

Protected getFullDerivationPath

  • getFullDerivationPath(walletIndex): string

  • Get getFullDerivationPath

    Parameters

    • walletIndex: number

      HD wallet index

    Returns string

    The bitcoin derivation path based on the network.

Protected getMsgTypeUrlByType

  • getMsgTypeUrlByType(msgType): string

  • Get the message type URL by message type.

    Parameters

    • msgType: TRANSFER

      The message type.

    Returns string

    The message type URL.

getNetwork

  • getNetwork(): Network

  • Get the current network.

    Returns Network

Protected getPrefix

  • getPrefix(): string

  • Get the address prefix based on the network.

    Returns string

    the address prefix

Protected getStandardFee

  • getStandardFee(asset): StdFee

  • Returns the standard fee used by the client for an asset.

    Parameters

    • asset: Asset

      The asset to retrieve the fee for.

    Returns StdFee

    The standard fee.

getTransactionData

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

  • Get transaction info using txId

    Parameters

    • txId: string

      Idetifier of transaction

    • Optional _assetAddress: string

    Returns Promise<Tx>

    Transaction data

getTransactions

  • getTransactions(params?): Promise<TxsPage>

  • Get transactions filtered using params

    Parameters

    • Optional params: TxHistoryParams

      Only param address IS SUPPORTED FOR THIS CLIENT, new feature will be added in the future

    Returns Promise<TxsPage>

    array of balances

prepareTx

  • prepareTx(params): Promise<PreparedTx>

  • Prepare a transaction for signing.

    Parameters

    • params: TxParams & {
          sender: string;
      }

      Transaction parameters including sender address.

    Returns Promise<PreparedTx>

    The prepared transaction.

    Throws

    Thrown if the sender address is invalid.

    Throws

    Thrown if the recipient address is invalid.

    Throws

    Thrown if the asset is invalid or not supported.

purgeClient

  • purgeClient(): void

  • Purge client.

    Returns void

setNetwork

  • setNetwork(network): void

  • Set client network to work with.

    Parameters

    • network: Network

    Returns void

setPhrase

  • setPhrase(phrase, walletIndex?): string

  • Set/update a new phrase

    Parameters

    • phrase: string

      A new phrase.

    • Optional walletIndex: number

      (optional) HD wallet index

    Returns string

    The address from the given phrase

    Throws

    Thrown if the given phase is invalid.

Protected thornodeAPIGet

  • thornodeAPIGet(endpoint): Promise<unknown>

  • Parameters

    • endpoint: string

    Returns Promise<unknown>

transfer

  • transfer(params): Promise<string>

  • Parameters

    • params: TxParams

    Returns Promise<string>

transferOffline

  • transferOffline(__namedParameters): Promise<string>

  • Creates and signs a transaction without broadcasting it.

    Parameters

    • __namedParameters: TxParams & {
          gasLimit?: BigNumber;
      } & {
          gasLimit?: BigNumber;
      }

    Returns Promise<string>

    Deprecated

    Use prepareTx instead.

validateAddress

  • validateAddress(address): boolean

  • Validate the address format.

    Parameters

    • address: string

      address to be validated

    Returns boolean

    represents whether the address is valid or invalid

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc