Class Client

Custom Litecoin client.

Hierarchy

  • Client
    • Client

Constructors

constructor

Properties

chain dataProviders explorerProviders feeBounds network nodeAuth? nodeUrls phrase rootDerivationPaths

Methods

broadcastTx buildTx compileMemo getAddress getAddressAsync getAssetInfo getBalance getExplorerAddressUrl getExplorerTxUrl getExplorerUrl getFeeFromUtxos getFeeRateFromThorchain getFeeRates getFees getFeesWithRates getFullDerivationPath getLtcKeys getNetwork getTransactionData getTransactions prepareTx purgeClient roundRobinBroadcastTx roundRobinGetBalance roundRobinGetFeeRates roundRobinGetTransactionData roundRobinGetTransactions roundRobinGetUnspentTxs scanUTXOs setNetwork setPhrase thornodeAPIGet transfer validateAddress

Constructors

constructor

  • new Client(params?): Client

  • Constructs a new Client with the provided parameters.

    Parameters

    • params: XChainClientParams & {
          dataProviders: UtxoOnlineDataProviders[];
          explorerProviders: ExplorerProviders;
      } & {
          nodeAuth?: NodeAuth;
          nodeUrls: NodeUrls;
      } = defaultLtcParams

      The parameters for initializing the client.

    Returns Client

Properties

Protected chain

chain: string

Protected dataProviders

dataProviders: UtxoOnlineDataProviders[]

Protected explorerProviders

explorerProviders: ExplorerProviders

Protected feeBounds

feeBounds: FeeBounds

Protected network

network: Network

Private Optional nodeAuth

nodeAuth?: NodeAuth

Private nodeUrls

nodeUrls: NodeUrls

Protected phrase

phrase: string

Protected rootDerivationPaths

rootDerivationPaths: undefined | RootDerivationPaths

Methods

broadcastTx

  • broadcastTx(txHex): Promise<string>

  • Broadcast a transaction.

    Parameters

    • txHex: string

      The transaction hex string.

    Returns Promise<string>

    The transaction hash.

buildTx

  • buildTx(params): Promise<{
        psbt: Psbt;
        utxos: UTXO[];
    }>

  • Builds a Litecoin (LTC) transaction.

    Parameters

    • params: TxParams & {
          feeRate: number;
          sender: string;
      }

      The transaction build options.

    Returns Promise<{
        psbt: Psbt;
        utxos: UTXO[];
    }>

    A promise that resolves to the PSBT (Partially Signed Bitcoin Transaction) and UTXOs (Unspent Transaction Outputs).

    Deprecated

    This function will eventually be removed. Use prepareTx instead.

Protected compileMemo

  • compileMemo(memo): Buffer

  • Compile memo.

    Parameters

    • memo: string

      The memo to be compiled.

    Returns Buffer

    The compiled memo.

getAddress

  • getAddress(index?): string

  • [DEPRECATED] Retrieves the address at the specified index.

    Parameters

    • index: number = 0

      The index of the address.

    Returns string

    The address at the specified index.

    Deprecated

    Use getAddressAsync instead.

    Throws

    Thrown when the index is less than zero.

    Throws

    Thrown when the phrase has not been set.

    Throws

    Thrown when the address cannot be defined.

getAddressAsync

  • getAddressAsync(walletIndex?): Promise<string>

  • Retrieves the current address asynchronously.

    Generates a network-specific key-pair by first converting the buffer to a Wallet-Import-Format (WIF) The address is then decoded into type P2WPKH and returned.

    Parameters

    • walletIndex: number = 0

    Returns Promise<string>

    A promise that resolves to the current address

    Throws

    Thrown if phrase has not been set before.

    Throws

    Thrown if failed creating account from phrase.

getAssetInfo

  • getAssetInfo(): AssetInfo

  • Returns information about the asset used by the client.

    Returns AssetInfo

    Information about the asset.

getBalance

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

  • Gets balance of a given address.

    Parameters

    • address: string

      The address to get balances from

    • Optional _assets: Asset[]
    • Optional confirmedOnly: boolean

    Returns Promise<Balance[]>

    BTC balances

getExplorerAddressUrl

  • getExplorerAddressUrl(address): string

  • Get the explorer URL for a given address based on the network.

    Parameters

    • address: string

      The address to query.

    Returns string

    The explorer URL for the address.

getExplorerTxUrl

  • getExplorerTxUrl(txID): string

  • Get the explorer URL for a given transaction ID based on the network.

    Parameters

    • txID: string

      The transaction ID.

    Returns string

    The explorer URL for the transaction.

getExplorerUrl

  • getExplorerUrl(): string

  • Get the explorer URL based on the network.

    Returns string

    The explorer URL.

Protected getFeeFromUtxos

  • getFeeFromUtxos(inputs, feeRate, data?): number

  • Calculates the transaction fee based on the provided UTXOs, fee rate, and optional compiled memo.

    Parameters

    • inputs: UTXO[]

      The The UTXOs used as inputs in the transaction.

    • feeRate: number

      The fee rate.

    • data: null | Buffer = null

      The compiled memo (Optional).

    Returns number

    The calculated fee amount.

Protected getFeeRateFromThorchain

  • getFeeRateFromThorchain(): Promise<number>

  • Get the fee rate from the Thorchain API.

    Returns Promise<number>

    The fee rate

getFeeRates

  • getFeeRates(protocol?): Promise<FeeRates>

  • Get fee rates

    Parameters

    • Optional protocol: THORCHAIN

      Protocol to interact with. If there's no protocol provided, fee rates are retrieved from chain data providers

    Returns Promise<FeeRates>

    The fee rates (average, fast, fastest) in Satoshis/byte

getFees

  • getFees(options?): Promise<Fees>

  • Get estimated fees.

    Parameters

    • Optional options: FeeEstimateOptions

      Options for fee estimation.

    Returns Promise<Fees>

    Estimated fees.

getFeesWithRates

  • getFeesWithRates(options?): Promise<FeesWithRates>

  • Get estimated fees with fee rates.

    Parameters

    • Optional options: FeeEstimateOptions

      Options for fee estimation.

    Returns Promise<FeesWithRates>

    Estimated fees along with fee rates.

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

Private getLtcKeys

  • getLtcKeys(phrase, index?): ECPairInterface
  • Private

    [PRIVATE] Retrieves the private key.

    Private function to get keyPair from the this.phrase

    Parameters

    • phrase: string

      The phrase used to generate the private key.

    • index: number = 0

    Returns ECPairInterface

    The privkey generated from the given phrase

    Throws

    Throws an error if failed creating LTC keys from the given phrase

getNetwork

  • getNetwork(): Network

  • Get the current network.

    Returns Network

    The current network

getTransactionData

  • getTransactionData(txId): Promise<Tx>

  • Get the transaction details of a given transaction ID.

    Parameters

    • txId: string

      The transaction ID.

    Returns Promise<Tx>

    The transaction details.

getTransactions

  • getTransactions(params?): Promise<TxsPage>

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

    Parameters

    • Optional params: TxHistoryParams

      The options to get transaction history.

    Returns Promise<TxsPage>

    The transaction history.

prepareTx

  • prepareTx(params): Promise<PreparedTx>

  • Prepares a Litecoin (LTC) transaction.

    Parameters

    • params: TxParams & {
          feeRate: number;
          sender: string;
          spendPendingUTXO?: boolean;
      }

      The transfer options.

    Returns Promise<PreparedTx>

    A promise that resolves to the raw unsigned transaction.

purgeClient

  • purgeClient(): void

  • Purge the client by clearing the mnemonic phrase.

    Returns void

Protected roundRobinBroadcastTx

  • roundRobinBroadcastTx(txHex): Promise<string>

  • Broadcasts a transaction hex using a round-robin approach across multiple data providers.

    Parameters

    • txHex: string

      The transaction hex to broadcast.

    Returns Promise<string>

    The hash of the broadcasted transaction.

    Throws

    Throws an error if no provider is able to broadcast the transaction.

Protected roundRobinGetBalance

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

  • Round-robin method to get balance from data providers. Throws error if no provider can get balance.

    Parameters

    • address: string

      The address to get balance for.

    Returns Promise<Balance[]>

    The balances.

    Throws

    Error If no provider is able to get balance.

Protected roundRobinGetFeeRates

  • roundRobinGetFeeRates(): Promise<FeeRates>

  • Retrieves fee rates using a round-robin approach across multiple data providers.

    Returns Promise<FeeRates>

    The fee rates (average, fast, fastest) in Satoshis/byte.

    Throws

    Throws an error if no provider is able to retrieve fee rates.

Protected roundRobinGetTransactionData

  • roundRobinGetTransactionData(txid): Promise<Tx>

  • Round-robin method to get transaction data from data providers. Throws error if no provider can get transaction data.

    Parameters

    • txid: string

      The transaction ID to get data for.

    Returns Promise<Tx>

    The transaction data.

    Throws

    Error If no provider is able to get transaction data.

Protected roundRobinGetTransactions

  • roundRobinGetTransactions(params): Promise<TxsPage>

  • Round-robin method to get transactions from data providers. Throws error if no provider can get transactions.

    Parameters

    • params: TxHistoryParams

      The parameters for fetching transactions.

    Returns Promise<TxsPage>

    The transaction history.

    Throws

    Error If no provider is able to get transactions.

Protected roundRobinGetUnspentTxs

  • roundRobinGetUnspentTxs(address, confirmed): Promise<UTXO[]>

  • Round-robin method to get unspent transactions from data providers. Throws error if no provider can get unspent transactions.

    Parameters

    • address: string

      The address to get unspent transactions for.

    • confirmed: boolean

      Flag to indicate whether to get confirmed transactions only.

    Returns Promise<UTXO[]>

    The unspent transactions.

    Throws

    Error If no provider is able to get unspent transactions.

Protected scanUTXOs

  • scanUTXOs(address, confirmedOnly?): Promise<UTXO[]>

  • Scan UTXOs for a given address.

    Parameters

    • address: string

      The address to scan.

    • Optional confirmedOnly: boolean

      Flag to scan only confirmed UTXOs.

    Returns Promise<UTXO[]>

    The UTXOs found.

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

setPhrase

  • setPhrase(phrase, walletIndex?): string

  • Set or update the mnemonic phrase.

    Parameters

    • phrase: string

      The new mnemonic phrase

    • Optional walletIndex: number

      (Optional) The HD wallet index

    Returns string

    The address derived from the provided phrase

    Throws

    Thrown if an invalid mnemonic phrase is provided

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(params): Promise<string>

  • Transfers Litecoin (LTC) from one address to another.

    Parameters

    • params: TxParams & {
          feeRate?: number;
      }

      The transfer options.

    Returns Promise<string>

    A promise that resolves to the transaction hash.

validateAddress

  • validateAddress(address): boolean

  • Validates the given Litecoin address.

    Parameters

    • address: string

      The Litecoin address to validate.

    Returns boolean

    true if the address is valid, false otherwise.

Settings

Member Visibility

Theme

On This Page

constructorchaindataProvidersexplorerProvidersfeeBoundsnetworknodeAuthnodeUrlsphraserootDerivationPathsbroadcastTxbuildTxcompileMemogetAddressgetAddressAsyncgetAssetInfogetBalancegetExplorerAddressUrlgetExplorerTxUrlgetExplorerUrlgetFeeFromUtxosgetFeeRateFromThorchaingetFeeRatesgetFeesgetFeesWithRatesgetFullDerivationPathgetLtcKeysgetNetworkgetTransactionDatagetTransactionsprepareTxpurgeClientroundRobinBroadcastTxroundRobinGetBalanceroundRobinGetFeeRatesroundRobinGetTransactionDataroundRobinGetTransactionsroundRobinGetUnspentTxsscanUTXOssetNetworksetPhrasethornodeAPIGettransfervalidateAddress

Generated using TypeDoc