@layerzerolabs/lz-corekit-tron 3.0.15 → 3.0.17

package/dist/index.d.mts

@@ -10,29 +10,130 @@ declare class TronProvider implements Provider {
     url: string;
     nativeProvider: ethers.providers.StaticJsonRpcProvider;
     /**
+     * Creates an instance of TronProvider.
      *
-     * @param url RPC endpoint of the Tron full node, e.g. 'https://api.trongrid.io'
-     * @param apiKey
+     * @param {string} url - RPC endpoint of the Tron full node, e.g. 'https://api.trongrid.io'
+     * @param {string} [apiKey] - The API key for accessing the Tron full node (optional).
      */
     private constructor();
+    /**
+     * Creates an instance of TronProvider from the given URL and API key.
+     *
+     * @param {string} url - The URL of the Tron node.
+     * @param {string} [apiKey] - The API key for accessing the Tron node (optional).
+     * @returns {TronProvider} The created TronProvider instance.
+     */
     static from(url: string, apiKey?: string): TronProvider;
+    /**
+     * Creates an instance of TronProvider from a TronWeb client.
+     *
+     * @param {TronWeb} client - The TronWeb client to create the provider from.
+     * @returns {TronProvider} The created TronProvider instance.
+     */
     static from(client: TronWeb): TronProvider;
     /**
-     * Returns the native provider
+     * Returns the native provider.
+     *
+     * @returns {unknown} The native provider.
      */
     get native(): unknown;
+    /**
+     * Builds a TronWeb instance from the given provider.
+     * The result will be cached based on the provider's URL and API key.
+     *
+     * @param {ethers.providers.Provider} provider - The provider to build the TronWeb instance from.
+     * @returns {TronWeb} The built TronWeb instance.
+     * @throws {Error} If the provider is not supported.
+     */
     private buildTronWebFrom;
+    /**
+     * 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 blockTag.
+     *
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<Block>} A promise that resolves to the block.
+     */
     getBlock(blockTag: string | number): Promise<Block>;
+    /**
+     * 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.
+     */
     getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    /**
+     * Gets the current block number.
+     *
+     * @returns {Promise<number>} A promise that resolves to the current block number.
+     */
     getBlockNumber(): Promise<number>;
+    /**
+     * Gets the UNIX timestamp for the block identified by blockTag.
+     *
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.
+     */
     getBlockTimestamp(blockTag: string | number): Promise<number>;
+    /**
+     * Gets the current slot number for commitment, not suitable for Tron.
+     *
+     * @param {Finality} [finality] - The commitment level (optional).
+     * @returns {Promise<number>} A promise that resolves to the current slot number.
+     * @throws {Error} Method not implemented.
+     */
     getSlot(_finality?: Finality): Promise<number>;
+    /**
+     * Gets information about a transaction.
+     *
+     * @param {string} txHash - The hash of the transaction.
+     * @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 hash of the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     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 supported in Tron.
+     */
     getTransactionCount(_addressOrName: string | Promise<string>, _blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    /**
+     * Sends a signed transaction to the blockchain.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * Confirms a pending transaction.
+     *
+     * @param {TransactionPending} pending - The pending transaction to confirm.
+     * @param {object} [opts] - Optional parameters for the confirmation.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     confirmTransaction(pending: TransactionPending, _opts?: object): 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?: object): Promise<TransactionReceipt>;
 }
 
@@ -49,28 +150,118 @@ declare class TronWebProvider implements Provider {
     private apiKey?;
     nativeProvider: TronWeb;
     /**
-     * Create a new TronProvider
-     * @param url RPC endpoint of the Tron full node, e.g. 'https://api.trongrid.io'
-     * @param apiKey
+     * Creates a new TronWebProvider.
+     *
+     * @param {string} url - The RPC endpoint of the Tron full node, e.g., 'https://api.trongrid.io'.
+     * @param {string} [apiKey] - The API key for accessing the Tron full node (optional).
      */
     constructor(url: string, apiKey?: string | undefined);
+    /**
+     * Creates an instance of TronWebProvider from the given URL and API key.
+     *
+     * @param {string} url - The URL of the Tron node.
+     * @param {string} [apiKey] - The API key for accessing the Tron node (optional).
+     * @returns {TronWebProvider} The created TronWebProvider instance.
+     */
     static from(url: string, apiKey?: string): TronWebProvider;
+    /**
+     * Gets the native TronWeb provider instance.
+     *
+     * @returns {TronWeb} The native TronWeb provider instance.
+     */
     get native(): unknown;
+    /**
+     * 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 blockTag.
+     *
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<Block>} A promise that resolves to the block.
+     */
     getBlock(blockTag: string | number): Promise<Block>;
+    /**
+     * 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.
+     */
     getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    /**
+     * Gets the current block number.
+     *
+     * @returns {Promise<number>} A promise that resolves to the current block number.
+     */
     getBlockNumber(): Promise<number>;
+    /**
+     * Gets the UNIX timestamp for the block identified by blockTag.
+     *
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.
+     */
     getBlockTimestamp(blockTag: string | number): Promise<number>;
+    /**
+     * Gets the current slot number for commitment, not suitable for Tron.
+     *
+     * @param {Finality} [finality] - The commitment level (optional).
+     * @returns {Promise<number>} A promise that resolves to the current slot number.
+     * @throws {Error} Method not implemented.
+     */
     getSlot(_finality?: Finality): Promise<number>;
+    /**
+     * Gets information about a transaction.
+     *
+     * @param {string} txHash - The hash of the transaction.
+     * @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 hash of the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     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 supported in Tron.
+     */
     getTransactionCount(_addressOrName: string | Promise<string>, _blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    /**
+     * Sends a signed transaction to the blockchain.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, sendOptions?: {
         confirmations?: number;
     }): Promise<TransactionPending>;
+    /**
+     * Confirms a pending transaction.
+     *
+     * @param {TransactionPending} pending - The pending transaction to confirm.
+     * @param {object} [opts] - Optional parameters for the confirmation.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     confirmTransaction(pending: TransactionPending, opts?: {
         confirmations?: number;
     }): 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?: {
         confirmations?: number;
     }): Promise<TransactionReceipt>;
@@ -82,22 +273,120 @@ declare class TronWebProvider implements Provider {
  */
 declare class TronSigner implements Signer {
     private readonly nativeSigner;
+    /**
+     * Creates an instance of TronSigner.
+     *
+     * @param {ethers.Signer} signer - The Ethers signer to use.
+     */
     private constructor();
+    /**
+     * Creates an instance of TronSigner from an Ethers signer.
+     *
+     * @param {ethers.Signer} source - The Ethers signer to create the TronSigner from.
+     * @returns {Signer} The created TronSigner instance.
+     */
     static from(source: ethers.Signer): Signer;
+    /**
+     * Creates an instance of TronSigner from a TronWeb client.
+     *
+     * @param {TronWeb} client - The TronWeb client to create the TronSigner from.
+     * @returns {Signer} The created TronSigner instance.
+     */
     static from(client: TronWeb): Signer;
+    /**
+     * Creates an instance of TronSigner from a private key.
+     *
+     * @param {string} privKey - The private key to create the TronSigner from.
+     * @returns {Signer} The created TronSigner instance.
+     */
     static from(privKey: string): Signer;
+    /**
+     * Creates an instance of TronSigner from a mnemonic and derivation path.
+     *
+     * @param {string} mnemonic - The mnemonic to create the TronSigner from.
+     * @param {string} path - The derivation path (e.g., m/44'/195'/0'/0/0).
+     * @returns {Signer} The created TronSigner instance.
+     */
     static from(mnemonic: string, path: string): Signer;
+    /**
+     * Gets the native signer instance.
+     *
+     * @returns {unknown} The native signer instance.
+     */
     get native(): unknown;
+    /**
+     * Connects the signer to a provider.
+     * IMPORTANT: native provider must be an instance of ethers.providers.JsonRpcProvider.
+     *
+     * @param {Provider} provider - The provider to connect to.
+     * @returns {Signer} The connected signer.
+     * @throws {Error} If the provider is not an instance of JsonRpcProvider.
+     */
     connect(provider: Provider): Signer;
+    /**
+     * Builds a TronWeb instance from the given signer.
+     * IMPORTANT: signer must be an instance of ethers.Wallet.
+     *
+     * @param {ethers.Signer} signer - The signer to build the TronWeb instance from.
+     * @returns {TronWeb} The built TronWeb instance.
+     * @throws {Error} If the signer is not supported.
+     */
     static buildTronWebFrom(signer: ethers.Signer): TronWeb;
-    static createTronWeb: (url: string, privateKey: string, apiKey?: string) => TronWeb;
+    /**
+     * Creates a TronWeb instance.
+     * The result will be cached based on the arguments.
+     *
+     * @param {string} url - The URL of the Tron node.
+     * @param {string} privateKey - The private key to use.
+     * @param {string} [apiKey] - The API key for accessing the Tron node (optional).
+     * @returns {TronWeb} The created TronWeb instance.
+     */
+    static createTronWeb(url: string, privateKey: string, apiKey?: string): TronWeb;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {Promise<string>} A promise that resolves to the address of the signer.
+     */
     getAddress(): Promise<string>;
+    /**
+     * 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?: object): Promise<TransactionReceipt>;
+    /**
+     * Signs a transaction.
+     *
+     * @param {TransactionRequest} transaction - The transaction request to sign.
+     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
+     * @throws {Error} If the transaction is invalid.
+     */
     signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    /**
+     * Sends a signed transaction.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * Signs a buffer (e.g., a message hash) using the native Tron signer.
+     *
+     * @param {Uint8Array} buffer - The buffer to sign.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.
+     */
     signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Validates a transaction.
+     *
+     * @param {ethers.PopulatedTransaction} transaction - The transaction to validate.
+     * @returns {boolean} True if the transaction is valid, false otherwise.
+     * @throws {Error} If the transaction is invalid.
+     */
     static validateTransaction(transaction: ethers.PopulatedTransaction): boolean;
-    buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest>;
 }
 
 /**
@@ -111,15 +400,76 @@ declare class TronSigner implements Signer {
  */
 declare class TronWebSigner implements Signer {
     private readonly nativeSigner;
+    /**
+     * Creates an instance of TronWebSigner.
+     *
+     * @param {TronWeb} signer - The TronWeb signer to use.
+     */
     private constructor();
+    /**
+     * Creates an instance of TronWebSigner from a TronWeb client.
+     *
+     * @param {TronWeb} signer - The TronWeb client to create the TronWebSigner from.
+     * @returns {Signer} The created TronWebSigner instance.
+     */
     static from(signer: TronWeb): Signer;
+    /**
+     * Creates an instance of TronWebSigner from a private key.
+     *
+     * @param {string} privKey - The private key to create the TronWebSigner from.
+     * @returns {Signer} The created TronWebSigner instance.
+     */
     static from(privKey: string): Signer;
+    /**
+     * Creates an instance of TronWebSigner from a mnemonic and derivation path.
+     *
+     * @param {string} mnemonic - The mnemonic to create the TronWebSigner from.
+     * @param {string} [path] - The derivation path (optional).
+     * @returns {Signer} The created TronWebSigner instance.
+     */
     static from(mnemonic: string, path?: string): Signer;
+    /**
+     * Gets the native TronWeb signer instance.
+     *
+     * @returns {unknown} The native TronWeb signer instance.
+     */
     get native(): unknown;
+    /**
+     * Connects the signer to a provider.
+     *
+     * @param {Provider} provider - The provider to connect to.
+     * @returns {Signer} The connected signer.
+     */
     connect(provider: Provider): Signer;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {Promise<string>} A promise that resolves to the address of the signer.
+     */
     getAddress(): Promise<string>;
+    /**
+     * Sends a signed transaction and waits for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [sendOptions] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     sendAndConfirm(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionReceipt>;
+    /**
+     * Signs a transaction.
+     *
+     * @param {TransactionRequest} transaction - The transaction request to sign.
+     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
+     * @throws {Error} If the transaction is invalid.
+     */
     signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    /**
+     * Sends a signed transaction.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
     /**
      * signBuffer signs a buffer using the native signer
@@ -128,12 +478,20 @@ declare class TronWebSigner implements Signer {
      * the message length is 32 bytes, the signature will be the same as the ethereum signature.
      * you can find the signString function here:
      * https://github.com/tronprotocol/tronweb/blob/master/src/lib/trx.js
-     * @param buffer
-     * @returns
+     *
+     * @param {Uint8Array} buffer - The buffer to sign.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.
+     * @throws {Error} If the private key is invalid.
      */
     signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Validates a transaction.
+     *
+     * @param {ethers.PopulatedTransaction} transaction - The transaction to validate.
+     * @returns {boolean} True if the transaction is valid, false otherwise.
+     * @throws {Error} If the transaction is invalid.
+     */
     static validateTransaction(transaction: ethers.PopulatedTransaction): boolean;
-    buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest>;
 }
 
 export { TronProvider, TronSigner, TronWebProvider, TronWebSigner };