Class Client

Custom MayaChain client.

Hierarchy

  • default
    • Client

Implements

Constructors

constructor

Properties

baseDenom chain clientUrls defaultDecimals feeBounds network phrase prefix registry rootDerivationPaths startgateClient

Methods

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

Constructors

constructor

  • new Client(config?): Client

  • Constructor for the MayaChain client.

    Parameters

    • config: Partial<CosmosSdkClientParams> = defaultClientConfig

      Optional configuration for the client. Default values will be used if not provided.

    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 corresponding to the provided denomination.

    Parameters

    • denom: string

      The denomination for which to retrieve the asset.

    Returns null | Asset

    The asset corresponding to the denomination, or null if not found.

broadcastTx

  • broadcastTx(txHex): Promise<string>

  • Parameters

    • txHex: string

    Returns Promise<string>

deposit

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 for which to retrieve the decimals.

    Returns number

    The number of decimals.

getAssetInfo

  • getAssetInfo(): AssetInfo

  • Get information about the native asset of the MayaChain.

    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 of the provided asset.

    Parameters

    • asset: Asset

      The asset for which to retrieve the denomination.

    Returns null | string

    The denomination of the asset, or null if not found.

getDepositTransaction

getExplorerAddressUrl

  • getExplorerAddressUrl(address): string

  • Get the explorer URL for the given address.

    Parameters

    • address: string

      The address for which to retrieve the explorer URL.

    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

      The transaction ID for which to retrieve the explorer URL.

    Returns string

    The explorer URL for the given transaction ID.

getExplorerUrl

  • getExplorerUrl(): string

  • Get the explorer URL for the current network.

    Returns string

    The explorer URL for the current network.

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

  • Retrieve the message type URL by type used by the Cosmos SDK client to make certain actions.

    Parameters

    • msgType: TRANSFER

      The message type of which to return the type URL.

    Returns string

    The type URL of the message.

getNetwork

  • getNetwork(): Network

  • Get the current network.

    Returns Network

Protected getPrefix

  • getPrefix(network): string

  • Get the address prefix for the given network.

    Parameters

    • network: Network

      The network identifier.

    Returns string

    The address prefix.

getPrivateKey

  • getPrivateKey(index?): Promise<Uint8Array>

  • Retrieve the private key associated with the specified index.

    Parameters

    • index: number = 0

      Optional - The index to use to generate the private key. If it is not set, address associated with index 0 will be used

    Returns Promise<Uint8Array>

    The private key

getPubKey

  • getPubKey(index?): Promise<Uint8Array>

  • Retrieve the compressed public key associated with the specified index.

    Parameters

    • index: number = 0

      Optional - The index to use to generate the public key. If not set, the address associated with index 0 will be used.

    Returns Promise<Uint8Array>

    The compressed public key

Protected getStandardFee

  • getStandardFee(): StdFee

  • Retrieve the standard fee used by the client.

    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 transfer.

    Parameters

    • params: TxParams & {
          sender: string;
      }

      The transfer options.

    Returns Promise<PreparedTx>

    The raw unsigned transaction.

    Throws

    If sender or recipient addresses are invalid, or if the asset symbol 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>

transferOffline

  • transferOffline(params): Promise<string>

  • Create and sign a transaction without broadcasting it.

    Parameters

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

      The offline transaction parameters.

    Returns Promise<string>

    The raw unsigned transaction.

    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