@layerzerolabs/tron-utilities 3.0.15 → 3.0.17

package/dist/index.d.mts

@@ -1,90 +1,289 @@
 import TronWeb, { TransactionResult, TransactionInfo } from 'tronweb';
 export { BlockTransaction, ChainParameter, ContractExecutionParams, Transaction, default as TronWeb } from 'tronweb';
 
+/**
+ * Enum representing the types of transactions that can be performed on the Tron network.
+ */
 declare enum TronTransactionType {
     TRIGGER_SMART_CONTRACT = "TriggerSmartContract"
 }
+/**
+ * Interface representing the overrides for a transaction.
+ */
 interface TransactionOverrides {
+    /**
+     * The gas limit for the transaction.
+     */
     gasLimit?: number;
+    /**
+     * The gas price for the transaction.
+     */
     gasPrice?: number;
+    /**
+     * The energy factor for the transaction.
+     */
     energyFactor?: number;
+    /**
+     * The value to be sent with the transaction.
+     */
     value?: number;
 }
+/**
+ * Interface representing a partial Tron transaction.
+ */
 interface PartialTronTransaction {
+    /**
+     * Indicates whether the transaction is visible.
+     */
     visible: boolean;
+    /**
+     * The transaction ID.
+     */
     txID: string;
+    /**
+     * The raw data in hexadecimal format.
+     */
     raw_data_hex: string;
+    /**
+     * The raw data of the transaction.
+     * @see {@link PartialTronTransactionContract}
+     */
     raw_data: {
         contract: [PartialTronTransactionContract];
     };
 }
+/**
+ * Interface representing a full Tron transaction.
+ */
 interface TronTransaction extends PartialTronTransaction {
+    /**
+     * The raw data of the transaction.
+     */
     raw_data: {
+        /**
+         * The contract details of the transaction.
+         * @see {@link FullTronTransactionContract}
+         */
         contract: [FullTronTransactionContract];
+        /**
+         * The reference block bytes.
+         */
         ref_block_bytes: string;
+        /**
+         * The reference block hash.
+         */
         ref_block_hash: string;
+        /**
+         * The expiration time of the transaction.
+         */
         expiration: number;
+        /**
+         * The fee limit for the transaction.
+         */
         fee_limit: number;
+        /**
+         * The timestamp of the transaction.
+         */
         timestamp: number;
     };
 }
+/**
+ * Interface representing a signed Tron transaction.
+ */
 interface SignedTronTransaction extends TronTransaction {
+    /**
+     * The signatures of the transaction.
+     */
     signature: string[];
 }
+/**
+ * Interface representing the parameter value of a partial Tron transaction.
+ */
 interface PartialTronTransactionParameterValue {
+    /**
+     * The data of the transaction.
+     */
     data: string;
+    /**
+     * The contract address.
+     */
     contract_address: string;
+    /**
+     * The owner address.
+     */
     owner_address: string;
 }
+/**
+ * Interface representing the parameter value of a full Tron transaction.
+ */
 interface TronTransactionParameterValue extends PartialTronTransactionParameterValue {
+    /**
+     * The token ID.
+     */
     token_id?: number;
+    /**
+     * The call token value.
+     */
     call_token_value?: number;
+    /**
+     * The call value.
+     */
     call_value?: number;
 }
+/**
+ * Interface representing the parameter of a Tron transaction.
+ * @template T - The type of the parameter value.
+ */
 interface TronTransactionParameter<T> {
+    /**
+     * The value of the parameter.
+     */
     value: T;
+    /**
+     * The type URL of the parameter.
+     */
     type_url: `type.googleapis.com/protocol.${TronTransactionType}`;
 }
+/**
+ * Interface representing a Tron transaction contract.
+ * @template T - The type of the parameter value.
+ */
 interface TronTransactionContract<T> {
+    /**
+     * The parameter of the transaction contract.
+     */
     parameter: TronTransactionParameter<T>;
+    /**
+     * The type of the transaction contract.
+     */
     type: TronTransactionType;
+    /**
+     * The permission ID for the transaction contract.
+     */
     Permission_id?: number;
 }
+/**
+ * Type representing a partial Tron transaction contract.
+ */
 type PartialTronTransactionContract = TronTransactionContract<PartialTronTransactionParameterValue>;
+/**
+ * Type representing a full Tron transaction contract.
+ */
 type FullTronTransactionContract = TronTransactionContract<TronTransactionParameterValue>;
+/**
+ * Interface representing the raw data of a Tron block header.
+ */
 interface TronBlockHeaderRawData {
+    /**
+     * The block number.
+     */
     number: number;
+    /**
+     * The transaction trie root.
+     */
     txTrieRoot: string;
+    /**
+     * The witness address.
+     */
     witness_address: string;
+    /**
+     * The parent hash.
+     */
     parentHash: string;
+    /**
+     * The timestamp of the block.
+     */
     timestamp: number;
 }
+/**
+ * Interface representing a Tron block header.
+ */
 interface TronBlockHeader {
+    /**
+     * The raw data of the block header.
+     */
     raw_data: TronBlockHeaderRawData;
+    /**
+     * The witness signature.
+     */
     witness_signature: string;
 }
+/**
+ * Interface representing Tron block data.
+ */
 interface TronBlockData {
+    /**
+     * The block ID.
+     */
     blockID: string;
+    /**
+     * The block header.
+     */
     block_header: TronBlockHeader;
 }
+/**
+ * Interface representing a TronWeb error response (type 1).
+ */
 interface TronWebError1 {
+    /**
+     * The error code.
+     */
     code: string;
+    /**
+     * The error message.
+     */
     message: string;
+    /**
+     * The transaction ID.
+     */
     txid: string;
 }
+/**
+ * Interface representing a TronWeb error response (type 2).
+ */
 interface TronWebError2 {
+    /**
+     * The error message.
+     */
     Error: string;
 }
+/**
+ * Type representing a TronWeb error response.
+ */
 type TronWebErrorResponse = TronWebError1 | TronWebError2;
 
+/**
+ * Type representing provider settings.
+ * It can be either a string representing the URL or an object containing the URL and an optional API key.
+ */
 type ProviderSetting = {
+    /**
+     * The URL of the provider.
+     */
     url: string;
+    /**
+     * The API key for the provider (optional).
+     */
     apiKey?: string;
 } | string;
+/**
+ * Creates a TronWeb instance.
+ *
+ * @param {{ rpcSetting: ProviderSetting; privateKey: string } | TronWeb} signer - The signer object containing rpcSetting and privateKey, or an existing TronWeb instance.
+ * @returns {TronWeb} The created TronWeb instance.
+ */
 declare function createTronWeb(signer: {
     rpcSetting: ProviderSetting;
     privateKey: string;
 } | TronWeb): TronWeb;
+/**
+ * Signs and sends a Tron transaction.
+ *
+ * @param {object} txn - The transaction object containing data, to, and transaction overrides.
+ * @param {object} signer - The signer object containing rpcSetting and privateKey, or an existing TronWeb instance.
+ * @param {number} [permissionId] - The permission ID for multi-sig.
+ * @returns {Promise<object>} A promise that resolves to an object containing txId, result, and wait function.
+ */
 declare function signAndSendTronTransaction(txn: {
     data: string;
     to: string;
@@ -96,11 +295,28 @@ declare function signAndSendTronTransaction(txn: {
     result: TransactionResult;
     wait: () => Promise<TransactionInfo>;
 }>;
+/**
+ * Sends a signed Tron transaction.
+ *
+ * @param {SignedTronTransaction} signedTxn - The signed Tron transaction.
+ * @param {TronWeb} client - The TronWeb client.
+ * @returns {Promise<object>} A promise that resolves to an object containing txId, result, and wait function.
+ * @throws {Error} If the transaction broadcast fails.
+ */
 declare function sendTronTransaction(singedTxn: SignedTronTransaction, client: TronWeb): Promise<{
     txId: string;
     result: TransactionResult;
     wait: () => Promise<TransactionInfo>;
 }>;
+/**
+ * Signs a Tron transaction.
+ *
+ * @param {object} txn - The transaction object containing data, to, and transaction overrides.
+ * @param {object} signer - The signer object containing rpcSetting and privateKey, or an existing TronWeb instance.
+ * @param {number} [permissionId] - The permission ID for multi-sig.
+ * @returns {Promise<SignedTronTransaction>} A promise that resolves to the signed Tron transaction.
+ * @throws {Error} If the private key is invalid.
+ */
 declare function signTronTx(txn: {
     data: string;
     to: string;
@@ -108,15 +324,58 @@ declare function signTronTx(txn: {
     rpcSetting: ProviderSetting;
     privateKey: string;
 } | TronWeb, permissionId?: number): Promise<SignedTronTransaction>;
+/**
+ * Fills in the missing fields of a Tron transaction.
+ *
+ * @param {TronWeb} signer - The TronWeb client.
+ * @param {PartialTronTransaction} txn - The partial Tron transaction.
+ * @param {TransactionOverrides} [overrides={}] - The transaction overrides.
+ * @returns {Promise<TronTransaction>} A promise that resolves to the full Tron transaction.
+ */
 declare function fullFillTxn(signer: TronWeb, txn: PartialTronTransaction, overrides?: TransactionOverrides): Promise<TronTransaction>;
+/**
+ * Checks the result of a Tron transaction.
+ *
+ * @param {TronWeb} tronWeb - The TronWeb client.
+ * @param {string} txId - The transaction ID.
+ * @returns {Promise<TransactionInfo>} A promise that resolves to the transaction info.
+ * @throws {Error} If the transaction fails or times out.
+ */
 declare function checkResult(tronWeb: TronWeb, txId: string): Promise<TransactionInfo>;
 
+/**
+ * Interface representing a provider conversion strategy.
+ */
 interface ProviderConversionStrategy {
+    /**
+     * Converts a URL to its REST endpoint equivalent.
+     *
+     * @param {string} url - The URL to convert.
+     * @returns {string} The converted REST endpoint URL.
+     */
     asREST(url: string): string;
+    /**
+     * Converts a URL to its JSON-RPC endpoint equivalent.
+     *
+     * @param {string} url - The URL to convert.
+     * @returns {string} The converted JSON-RPC endpoint URL.
+     */
     asJSONRPC(url: string): string;
 }
+/**
+ * Class representing a factory for creating provider conversion strategies.
+ */
 declare class StrategyFactory {
+    /**
+     * A map of URL patterns to provider conversion strategies.
+     */
     static strategies: Map<RegExp, ProviderConversionStrategy>;
+    /**
+     * Gets the appropriate provider conversion strategy for a given URL.
+     *
+     * @param {string} url - The URL to get the conversion strategy for.
+     * @returns {ProviderConversionStrategy} The provider conversion strategy.
+     */
     static get(url: string): ProviderConversionStrategy;
 }