@layerzerolabs/lz-corekit-solana 3.0.15 → 3.0.16

package/dist/index.d.ts

@@ -1,59 +1,256 @@
 import { Connection, SendOptions, TransactionConfirmationStrategy, Keypair, PublicKey, ConfirmOptions, Commitment, GetLatestBlockhashConfig, Transaction, VersionedTransaction } from '@solana/web3.js';
 import { Provider, Block, Finality, TransactionResponse, TransactionReceipt, BlockTag, BlockWithTransactions, SignedTransaction, TransactionPending, Signer, TransactionRequest } from '@layerzerolabs/lz-core';
 
+/**
+ * Represents a Solana blockchain provider.
+ * Implements the Provider interface for interacting with Solana-compatible blockchains.
+ */
 declare class SolanaProvider implements Provider {
     url: string;
     nativeProvider: Connection;
+    /**
+     * Creates an instance of SolanaProvider.
+     *
+     * @param {string} url - The URL of the Solana node.
+     */
     constructor(url: string);
+    /**
+     * Creates an instance of SolanaProvider from the given URL.
+     *
+     * @param {string} url - The URL of the Solana node.
+     * @returns {SolanaProvider} The created SolanaProvider instance.
+     * @throws {Error} If the URL parameter is invalid.
+     */
     static from(url: string): SolanaProvider;
+    /**
+     * Gets the native Solana provider instance.
+     *
+     * @returns {Connection} The native Solana provider instance.
+     */
     get native(): Connection;
+    /**
+     * Gets the balance of the specified address.
+     *
+     * @param {string} address - The address to get the balance of.
+     * @returns {Promise<string>} A promise that resolves to the balance of the address.
+     */
     getBalance(address: string): Promise<string>;
+    /**
+     * Gets the block specified by slot.
+     *
+     * @param {BlockTag} slot - The slot to specify the block.
+     * @returns {Promise<Block>} A promise that resolves to the block.
+     */
     getBlock(slot: string | number): Promise<Block>;
+    /**
+     * Gets the current block number.
+     *
+     * @returns {Promise<number>} A promise that resolves to the current block number.
+     */
     getBlockNumber(): Promise<number>;
+    /**
+     * Gets the current slot number for commitment.
+     *
+     * @param {Finality} [finality] - The commitment level (optional).
+     * @returns {Promise<number>} A promise that resolves to the current slot number.
+     */
     getSlot(finality?: Finality): Promise<number>;
+    /**
+     * Gets the UNIX timestamp for the block identified by slot.
+     *
+     * @param {BlockTag} slot - The slot to specify the block.
+     * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.
+     * @throws {Error} If the block timestamp is not available.
+     */
     getBlockTimestamp(slot: string | number): Promise<number>;
     /**
+     * Gets information about a transaction.
      *
-     * @param txHash string The transaction hash is TransactionSignature in Solana
-     * @returns TransactionResponse
+     * @param {string} txHash - The transaction hash is TransactionSignature in Solana
+     * @returns {Promise<TransactionResponse>} A promise that resolves to the transaction response
      */
     getTransaction(txHash: string): Promise<TransactionResponse>;
+    /**
+     * Gets the receipt of a transaction.
+     *
+     * @param {string} txHash - The transaction hash is TransactionSignature in Solana
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     * @throws {Error} If the transaction is not found.
+     */
     getTransactionReceipt(txHash: string): Promise<TransactionReceipt>;
+    /**
+     * Gets the number of transactions sent from the specified address.
+     *
+     * @param {string | Promise<string>} _addressOrName - The address to get the number of transactions from.
+     * @param {BlockTag | Promise<BlockTag>} [_blockTag] - The block tag to get the number of transactions from (optional).
+     * @returns {Promise<number>} A promise that resolves to the number of transactions sent from the address.
+     * @throws {Error} Method not implemented.
+     */
     getTransactionCount(_addressOrName: string | Promise<string>, _blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    /**
+     * Gets the block with transactions specified by blockTag.
+     *
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<BlockWithTransactions>} A promise that resolves to the block with transactions.
+     * @throws {Error} If the block is not found.
+     */
     getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    /**
+     * Sends a signed transaction to the blockchain.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {SendOptions} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, sendOptions?: SendOptions): Promise<TransactionPending>;
+    /**
+     * Confirms a pending transaction.
+     *
+     * @param {TransactionPending} pending - The pending transaction to confirm.
+     * @param {TransactionConfirmationStrategy} [opts] - Optional parameters for the confirmation.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     * @throws {Error} If the transaction fails.
+     */
     confirmTransaction(pending: TransactionPending, opts?: TransactionConfirmationStrategy): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction and waits for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     sendAndConfirm(transaction: SignedTransaction, opts?: {
         confirm?: TransactionConfirmationStrategy;
         send?: SendOptions;
     }): Promise<TransactionReceipt>;
 }
 
+/**
+ * Represents a Solana blockchain signer.
+ * Implements the Signer interface for interacting with Solana-compatible blockchains.
+ */
 declare class SolanaSigner implements Signer {
     private readonly keypair;
     private provider?;
+    /**
+     * Creates an instance of SolanaSigner.
+     *
+     * @param {Keypair} keypair - The Solana keypair to use as the signer.
+     */
     private constructor();
+    /**
+     * Creates an instance of SolanaSigner from a Keypair.
+     *
+     * @param {Keypair} source - The Solana keypair to create the signer from.
+     * @returns {SolanaSigner} The created SolanaSigner instance.
+     */
     static from(source: Keypair): SolanaSigner;
+    /**
+     * Creates an instance of SolanaSigner from a mnemonic and derivation path.
+     *
+     * @param {string} mnemonic - The mnemonic to create the signer from.
+     * @param {string} path - The derivation path (e.g., m/44'/501'/0'/0').
+     * @returns {SolanaSigner} The created SolanaSigner instance.
+     */
     static from(mnemonic: string, path: string): SolanaSigner;
+    /**
+     * Gets the native Solana keypair instance.
+     *
+     * @returns {Keypair} The native Solana keypair instance.
+     */
     get native(): unknown;
+    /**
+     * Connects the signer to a provider.
+     *
+     * @param {Provider} provider - The provider to connect to.
+     * @returns {this} The connected signer.
+     * @throws {Error} If the provider is not an instance of Connection.
+     */
     connect(provider: Provider): this;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {Promise<string>} A promise that resolves to the address of the signer.
+     */
     getAddress(): Promise<string>;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {string} The address of the signer.
+     */
     get address(): string;
+    /**
+     * Gets the public key of the signer.
+     *
+     * @returns {PublicKey} The public key of the signer.
+     */
     get publicKey(): PublicKey;
+    /**
+     * Gets the secret key of the signer.
+     *
+     * @returns {Uint8Array} The secret key of the signer.
+     */
     get secretKey(): Uint8Array;
+    /**
+     * Sends a signed transaction and waits for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {ConfirmOptions} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     sendAndConfirm(transaction: SignedTransaction, opts?: ConfirmOptions): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {SendOptions} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, sendOptions?: SendOptions): Promise<TransactionPending>;
+    /**
+     * Signs a transaction.
+     *
+     * @param {TransactionRequest} transaction - The transaction request to sign.
+     * @param {Commitment | GetLatestBlockhashConfig} [opts] - Optional parameters for signing the transaction.
+     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
+     */
     signTransaction(transaction: TransactionRequest, opts?: Commitment | GetLatestBlockhashConfig): Promise<SignedTransaction>;
+    /**
+     * Signs a buffer (e.g., a message hash) using the native Solana signer.
+     *
+     * @param {Uint8Array} _buffer - The buffer to sign.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.
+     * @throws {Error} Method not implemented.
+     */
     signBuffer(_buffer: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Partially signs a transaction.
+     *
+     * @param {Transaction | VersionedTransaction} tx - The transaction to partially sign.
+     */
     partialSign(tx: Transaction | VersionedTransaction): void;
+    /**
+     * Asserts that the provider is connected and returns it.
+     *
+     * @returns {Connection} The connected provider.
+     * @throws {Error} If the provider is not connected.
+     */
     private assertAndGetProvider;
+    /**
+     * Builds a transaction.
+     *
+     * @param {unknown} buildTxRequest - The transaction request to build.
+     * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.
+     * @throws {Error} Method not implemented.
+     */
     buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest>;
 }
 /**
  * Check if a transaction object is a VersionedTransaction or not
  * This function is not exported from @coral-xyz/anchor currently.
- * @param tx
- * @returns bool
+ *
+ * @param {Transaction | VersionedTransaction} tx - The transaction to check.
+ * @returns {boolean} True if the transaction is a VersionedTransaction, false otherwise.
  */
 declare const isVersionedTransaction: (tx: Transaction | VersionedTransaction) => tx is VersionedTransaction;