Class Client

Represents a client for interacting with the Kujira blockchain network. Inherits from the CosmosSdkClient class.

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 validateAddress

Constructors

constructor

  • new Client(config?): Client

  • Constructs a new instance of the Kujira client.

    Parameters

    • config: Partial<CosmosSdkClientParams> = defaultClientConfig

      The client configuration parameters.

    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

  • Retrieves the asset from the given denomination.

    Parameters

    • denom: string

      The denomination to retrieve the asset for.

    Returns null | Asset

    The corresponding asset, or null if not found.

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

  • Retrieves the number of decimals for a given asset.

    Parameters

    • asset: Asset

      The asset for which to retrieve the number of decimals.

    Returns number

    The number of decimals.

getAssetInfo

  • getAssetInfo(): AssetInfo

  • Retrieves information about the assets used in the Kujira network.

    Returns AssetInfo

    Information about the 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

  • Retrieves the denomination of the given asset.

    Parameters

    • asset: Asset

      The asset for which to retrieve the denomination.

    Returns null | string

    The denomination, or null if not found.

getExplorerAddressUrl

  • getExplorerAddressUrl(address): string

  • Constructs the URL for viewing the address on the blockchain explorer.

    Parameters

    • address: string

      The address to view.

    Returns string

    The explorer address URL.

getExplorerTxUrl

  • getExplorerTxUrl(txID): string

  • Constructs the URL for viewing the transaction on the blockchain explorer.

    Parameters

    • txID: string

      The transaction ID to view.

    Returns string

    The explorer transaction URL.

getExplorerUrl

  • getExplorerUrl(): string

  • Retrieves the URL of the blockchain explorer for the current network.

    Returns string

    The explorer URL.

Protected getFeeRateFromThorchain

  • getFeeRateFromThorchain(): Promise<number>

  • Returns Promise<number>

getFees

  • getFees(): Promise<Fees>

  • This function returns the fee object in a generalised way for a simple transfer function. In this case this funcion use the default fee defined in the constructor.

    Returns Promise<Fees>

    fees estimation for average, fast and fastests scenarios.

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

  • Retrieves the message type URL by message type for cosmos-sdk client actions.

    Parameters

    • msgType: TRANSFER

      The message type.

    Returns string

    The type URL of the message.

getNetwork

  • getNetwork(): Network

  • Get the current network.

    Returns Network

Protected getPrefix

  • getPrefix(): string

  • Retrieves the address prefix used by the Kujira network.

    Returns string

    the address prefix

Protected getStandardFee

  • getStandardFee(asset): StdFee

  • Retrieves the standard fee used by the client for a given 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>

  • Prepares a transaction for transfer.

    Parameters

    • params: TxParams & {
          sender: string;
      }

      The transfer options.

    Returns Promise<PreparedTx>

    The raw unsigned transaction.

    Throws

    Thrown if sender or recipient address is invalid or if the asset is invalid.

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>

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