@xchainjs/xchain-solana 0.0.4 → 0.0.6

package/lib/client.d.ts

@@ -1,11 +1,17 @@
-import { AssetInfo, BaseXChainClient, Fees, PreparedTx, TxHash, TxHistoryParams } from '@xchainjs/xchain-client';
+import { AssetInfo, BaseXChainClient, Fees, Network, PreparedTx, TxHash, TxHistoryParams } from '@xchainjs/xchain-client';
 import { Address, TokenAsset } from '@xchainjs/xchain-util';
 import { Balance, SOLClientParams, Tx, TxParams, TxsPage } from './types';
 export declare class Client extends BaseXChainClient {
     private explorerProviders;
-    private connection;
-    private umi;
+    private providers;
+    private clientUrls?;
     constructor(params?: SOLClientParams);
+    /**
+     * Set or update the current network.
+     * @param {Network} network The network to set
+     * @returns {void}
+     */
+    setNetwork(network: Network): void;
     /**
      * Get information about the native asset of the Solana.
      *
@@ -79,6 +85,12 @@ export declare class Client extends BaseXChainClient {
      * @returns {Tx} The transaction details.
      */
     getTransactionData(txId: string): Promise<Tx>;
+    /**
+     * Get the transaction history of a given address with pagination options.
+     *
+     * @param {TxHistoryParams} params The options to get transaction history.
+     * @returns {TxsPage} The transaction history.
+     */
     getTransactions(params?: TxHistoryParams): Promise<TxsPage>;
     /**
      * Transfers SOL or Solana token
@@ -104,4 +116,61 @@ export declare class Client extends BaseXChainClient {
     }): Promise<PreparedTx>;
     private getPrivateKeyPair;
     private parseTransaction;
+    /**
+     * Retrieves the balance of a given address making a round robin over the providers.
+     *
+     * @param {Address} address - The address to retrieve the balance for.
+     * @param {TokenAsset[]} assets - Assets to retrieve the balance for (optional).
+     * @returns {Promise<Balance[]>} An array containing the balance of the address.
+     * @throws {Error} if there is no provider able to retrieve the balances
+     */
+    private roundRobinGetBalance;
+    /**
+     * Get transaction fees making a round robin over the providers.
+     *
+     * @param {TxParams} params - The transaction parameters.
+     * @returns {Fees} The average, fast, and fastest fees.
+     * @throws {Error} if there is no provider able to retrieve the fees
+     */
+    private roundRobinGetFees;
+    /**
+     * Get the transaction details of a given transaction ID making a round robin over the providers.
+     *
+     * @param {string} txId The transaction ID.
+     * @returns {Tx} The transaction details.
+     * @throws {Error} if there is no provider able to retrieve the transaction data
+     */
+    private roundRobinGetTransactionData;
+    /**
+     * Get the transaction history of a given address with pagination options making a round robin over the providers.
+     *
+     * @param {TxHistoryParams} params The options to get transaction history.
+     * @returns {TxsPage} The transaction history.
+     * @throws {Error} if there is no provider able to retrieve the transactions
+     */
+    private roundRobinGetTransactions;
+    /**
+     * Transfers SOL or Solana token making a round robin over the providers
+     *
+     * @param {TxParams} params The transfer options.
+     * @returns {TxHash} The transaction hash.
+     * @throws {Error} if there is no provider able to make the transfer
+     */
+    private roundRobinTransfer;
+    /**
+     * Broadcast a transaction to the network making a round robin over the providers
+     *
+     * @param {string} txHex Raw transaction to broadcast
+     * @returns {TxHash} The hash of the transaction broadcasted
+     * @throws {Error} if there is no provider able to broadcast transaction
+     */
+    private roundRobinBroadcastTx;
+    /**
+     * Prepares a transaction for transfer making round robin over the providers.
+     *
+     * @param {TxParams&Address} params - The transfer options.
+     * @returns {Promise<PreparedTx>} The raw unsigned transaction.
+     * @throws {Error} if there is no provider able to prepare transaction
+     */
+    private roundRobinPrepareTx;
 }