@aptos-labs/ts-sdk 1.29.0 → 1.30.0

package/dist/esm/api/digitalAsset.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-KUOB4DDE.mjs";import"../chunk-367OG3DB.mjs";import"../chunk-P2EIZ7WL.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-MDJ66AA3.mjs";import"../chunk-TQWGQLM6.mjs";import"../chunk-NWOMSL6K.mjs";import"../chunk-53RB2PRH.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-STUXKQVZ.mjs";import"../chunk-D3Q4BC3I.mjs";import"../chunk-SDWE6WMM.mjs";import"../chunk-FZ5EYP3D.mjs";import"../chunk-2BTTX2KO.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-RXE6NNOL.mjs";import"../chunk-QPB6EJVM.mjs";import"../chunk-4HR32TSY.mjs";import"../chunk-3W2DHZXK.mjs";import"../chunk-CB6H4VMZ.mjs";import"../chunk-E4O26ZJB.mjs";import"../chunk-Y3BATGHX.mjs";import"../chunk-O2BPA6TS.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-MAMPMCO7.mjs";import"../chunk-SWNFKKRE.mjs";import"../chunk-5PCNWXRN.mjs";import"../chunk-L2QXU6F4.mjs";import"../chunk-QBSU3L5Q.mjs";import"../chunk-7VKFXX5Q.mjs";import"../chunk-SUJLWCRN.mjs";import"../chunk-YDZBU2DJ.mjs";import"../chunk-YUNDX5I7.mjs";import"../chunk-A42BPAD4.mjs";import"../chunk-KUZ2YTJH.mjs";import"../chunk-BOYYQAB4.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WRRQ7L5K.mjs";import"../chunk-ADE6MVXC.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-45IUUCAV.mjs";import"../chunk-HHGJXVAE.mjs";import"../chunk-GMBSQDPO.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-GDO6Q2FI.mjs";import"../chunk-BA4RBST6.mjs";import"../chunk-G5XLMQ5E.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-MQGW234H.mjs";import"../chunk-F63E4CR7.mjs";import"../chunk-GWSDIX6C.mjs";import"../chunk-MLDQ2TY2.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-76OH2Z4Q.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-G5MGSV7Y.mjs";import"../chunk-OHRL766V.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-YU3IYJRL.mjs";import"../chunk-CRA2MFJC.mjs";import"../chunk-XMW65WCQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LNEZEYYE.mjs";import"../chunk-YPHH6CAO.mjs";import"../chunk-P5V7OZNN.mjs";import"../chunk-H6YNXJNF.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-A63SMUOU.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UAEODDZS.mjs";import"../chunk-FVA2OPG4.mjs";export{a as DigitalAsset};
+import{a}from"../chunk-5XXIIWG7.mjs";import"../chunk-QRTZYRH2.mjs";import"../chunk-TRU3EK64.mjs";import"../chunk-2I56E4T2.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-HGVZ7ULA.mjs";import"../chunk-RUDS7RSB.mjs";import"../chunk-KRVLR3L4.mjs";import"../chunk-N3OYD6VZ.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-7D3RY73L.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-L5I7F3NZ.mjs";import"../chunk-ZS3EWM5A.mjs";import"../chunk-HCV3NGLS.mjs";import"../chunk-KSKQVOBA.mjs";import"../chunk-K6MZXKVV.mjs";import"../chunk-LZS7BQ2B.mjs";import"../chunk-5ZBHIUWG.mjs";import"../chunk-VQTEGTUQ.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-LD5MUWGW.mjs";import"../chunk-5AAFF2PV.mjs";import"../chunk-JY3JJ55D.mjs";import"../chunk-FO4F3OJJ.mjs";import"../chunk-7PVIWKGT.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-JDYASF3E.mjs";import"../chunk-OTY3NO7Q.mjs";import"../chunk-OS2EG6AE.mjs";import"../chunk-IFHQSZLK.mjs";import"../chunk-ZINOJTLU.mjs";import"../chunk-NODYW7DM.mjs";import"../chunk-AGBA3Y7A.mjs";import"../chunk-UKAXCARD.mjs";import"../chunk-Z36WHOZV.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-WIXNX7HY.mjs";import"../chunk-6AGTDRNM.mjs";import"../chunk-S3FVA55H.mjs";import"../chunk-DZJXOL64.mjs";import"../chunk-37UZKMJI.mjs";import"../chunk-5CCHECTE.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-XHCALZ7X.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-WSVOJSAC.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-DCUVV3VY.mjs";import"../chunk-HDTKBFRX.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-OLPI7QAH.mjs";import"../chunk-WOOH5MMX.mjs";import"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UI3AKMZX.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as DigitalAsset};
 //# sourceMappingURL=digitalAsset.mjs.map

package/dist/esm/api/event.d.mts

@@ -4,30 +4,71 @@ import { AccountAddressInput } from '../core/accountAddress.mjs';
 import { AptosConfig } from './aptosConfig.mjs';
 import { GetEventsResponse } from '../types/indexer.mjs';
 import '../utils/apiEndpoints.mjs';
-import '../types/generated/operations.mjs';
 import '../bcs/serializer.mjs';
 import '../core/hex.mjs';
 import '../core/common.mjs';
 import '../bcs/deserializer.mjs';
 import '../transactions/instances/transactionArgument.mjs';
 import '../utils/const.mjs';
+import '../types/generated/operations.mjs';
 
 /**
- * A class to query all `Event` Aptos related queries
+ * A class to query all `Event` Aptos related queries.
  */
 declare class Event {
     readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos client with the provided configuration.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., Testnet, Mainnet).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.faucetUrl - The URL of the faucet to use for funding accounts.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a new Aptos client with Testnet configuration
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own network if needed
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
-     * Get module events by event type
+     * Retrieve module events based on a specified event type.
+     * This function allows you to query for events that are associated with a particular module event type in the Aptos blockchain.
+     *
+     * @param args - The arguments for retrieving module events.
+     * @param args.eventType - The event type to filter the results.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     * @param args.options - Optional pagination and ordering parameters for the event results.
+     *
+     * @returns Promise<GetEventsResponse> - A promise that resolves to the retrieved events.
      *
      * @example
-     * const events = await aptos.getModuleEventsByEventType({eventType:"0x1::transaction_fee::FeeStatement"})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.eventType - The event type
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns Promise<GetEventsResponse>
+     * async function runExample() {
+     *   // Retrieve module events for a specific event type
+     *   const events = await aptos.getModuleEventsByEventType({
+     *     eventType: "0x1::transaction_fee::FeeStatement", // specify the event type
+     *     minimumLedgerVersion: 1, // optional: specify minimum ledger version if needed
+     *   });
+     *
+     *   console.log(events); // log the retrieved events
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getModuleEventsByEventType(args: {
         eventType: MoveStructId;
@@ -35,16 +76,33 @@ declare class Event {
         options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
     }): Promise<GetEventsResponse>;
     /**
-     * Get events by creation number and an account address
+     * Retrieve events associated with a specific account address and creation number.
+     *
+     * @param args - The parameters for retrieving account events.
+     * @param args.accountAddress - The account address to query events for.
+     * @param args.creationNumber - The event creation number to filter the events.
+     * @param args.minimumLedgerVersion - Optional minimum ledger version to sync up to before querying.
+     *
+     * @returns Promise<GetEventsResponse>
      *
      * @example
-     * const events = await aptos.getAccountEventsByCreationNumber({accountAddress:"0x123",creationNumber: 0})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.accountAddress - The account address
-     * @param args.creationNumber - The event creation number
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns Promise<GetEventsResponse>
+     * async function runExample() {
+     *   // Get events for the account at creation number 0
+     *   const events = await aptos.getAccountEventsByCreationNumber({
+     *     accountAddress: "0x1", // replace with a real account address
+     *     creationNumber: 0,
+     *   });
+     *
+     *   console.log(events);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getAccountEventsByCreationNumber(args: {
         accountAddress: AccountAddressInput;
@@ -52,16 +110,34 @@ declare class Event {
         minimumLedgerVersion?: AnyNumber;
     }): Promise<GetEventsResponse>;
     /**
-     * Get events by event type and an account address
+     * Retrieve events associated with a specific account address and event type.
+     *
+     * @param args.accountAddress - The account address to query events for.
+     * @param args.eventType - The type of event to filter by.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     * @param args.options - Optional pagination and ordering parameters for the event query.
+     *
+     * @returns Promise<GetEventsResponse>
      *
      * @example
-     * const events = await aptos.getAccountEventsByEventType({accountAddress:"0x123",eventType: "0x1::transaction_fee::FeeStatement"})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.accountAddress - The account address
-     * @param args.eventType - The event type
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns Promise<GetEventsResponse>
+     * async function runExample() {
+     *   // Get events for a specific account and event type
+     *   const events = await aptos.getAccountEventsByEventType({
+     *     accountAddress: "0x1", // replace with a real account address
+     *     eventType: "0x1::transaction_fee::FeeStatement", // replace with a real event type
+     *     minimumLedgerVersion: 1, // optional, specify if needed
+     *   });
+     *
+     *   console.log(events);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getAccountEventsByEventType(args: {
         accountAddress: AccountAddressInput;
@@ -70,16 +146,43 @@ declare class Event {
         options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
     }): Promise<GetEventsResponse>;
     /**
-     * Get all events
+     * Retrieve all events from the Aptos blockchain.
+     * An optional `where` clause can be provided to filter the results based on specific criteria.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
+     * @param args.options Optional pagination and filtering options.
+     * @param args.options.where Optional condition to filter events.
+     * @param args.options.offset Optional pagination offset.
+     * @param args.options.limit Optional maximum number of events to return.
+     * @param args.options.orderBy Optional ordering of the results.
+     *
+     * @returns GetEventsQuery response type containing the events.
      *
-     * An optional `where` can be passed in to filter out the response.
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
      * @example
-     * const events = await aptos.getEvents()
-     * // with filtering
-     * const events = await aptos.getEvents({options: { where: { account_address: { _eq: "0x123" } } }});
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Retrieve all events
+     *   const events = await aptos.getEvents();
+     *
+     *   // Retrieve events with filtering by account address
+     *   const whereCondition = {
+     *     account_address: { _eq: "0x123" }, // replace with a real account address
+     *   };
+     *   const filteredEvents = await aptos.getEvents({
+     *     options: { where: whereCondition },
+     *   });
      *
-     * @returns GetEventsQuery response type
+     *   console.log(events);
+     *   console.log(filteredEvents);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getEvents(args?: {
         minimumLedgerVersion?: AnyNumber;

package/dist/esm/api/event.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-P3TAY5PP.mjs";import"../chunk-S2KDCIZN.mjs";import"../chunk-SDWE6WMM.mjs";import"../chunk-FZ5EYP3D.mjs";import"../chunk-2BTTX2KO.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WRRQ7L5K.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-45IUUCAV.mjs";import"../chunk-HHGJXVAE.mjs";import"../chunk-GMBSQDPO.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-GDO6Q2FI.mjs";import"../chunk-BA4RBST6.mjs";import"../chunk-G5XLMQ5E.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-MQGW234H.mjs";import"../chunk-F63E4CR7.mjs";import"../chunk-GWSDIX6C.mjs";import"../chunk-MLDQ2TY2.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-76OH2Z4Q.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-G5MGSV7Y.mjs";import"../chunk-OHRL766V.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-YU3IYJRL.mjs";import"../chunk-CRA2MFJC.mjs";import"../chunk-XMW65WCQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LNEZEYYE.mjs";import"../chunk-YPHH6CAO.mjs";import"../chunk-P5V7OZNN.mjs";import"../chunk-H6YNXJNF.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-A63SMUOU.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UAEODDZS.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Event};
+import{a}from"../chunk-2QRWGJJA.mjs";import"../chunk-DXQT55L3.mjs";import"../chunk-TRU3EK64.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-WIXNX7HY.mjs";import"../chunk-6AGTDRNM.mjs";import"../chunk-S3FVA55H.mjs";import"../chunk-DZJXOL64.mjs";import"../chunk-37UZKMJI.mjs";import"../chunk-5CCHECTE.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-XHCALZ7X.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-WSVOJSAC.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-DCUVV3VY.mjs";import"../chunk-HDTKBFRX.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-OLPI7QAH.mjs";import"../chunk-WOOH5MMX.mjs";import"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UI3AKMZX.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Event};
 //# sourceMappingURL=event.mjs.map

package/dist/esm/api/faucet.d.mts

@@ -17,18 +17,55 @@ import '../utils/const.mjs';
  */
 declare class Faucet {
     readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // specify your own network if needed
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
-     * This creates an account if it does not exist and mints the specified amount of
-     * coins into that account
+     * This function creates an account if it does not exist and mints the specified amount of coins into that account.
+     *
+     * @param args - The arguments for funding the account.
+     * @param args.accountAddress - The address of the account to fund.
+     * @param args.amount - The amount of tokens to fund the account with.
+     * @param args.options - Configuration options for waiting for the transaction.
+     * @returns Transaction hash of the transaction that funded the account.
      *
      * @example
-     * const transaction = await aptos.fundAccount({accountAddress:"0x123", amount: 100})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fund an account with a specified amount of tokens
+     *   const transaction = await aptos.fundAccount({
+     *     accountAddress: "0x1", // replace with your account address
+     *     amount: 100,
+     *   });
      *
-     * @param args.accountAddress Address of the account to fund
-     * @param args.amount Amount of tokens to fund the account with
-     * @param args.options Configuration options for waitForTransaction
-     * @returns Transaction hash of the transaction that funded the account
+     *   console.log("Transaction hash:", transaction.hash);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     fundAccount(args: {
         accountAddress: AccountAddressInput;

package/dist/esm/api/faucet.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-J64ARI4E.mjs";import"../chunk-APN6AV5Q.mjs";import"../chunk-FZ5EYP3D.mjs";import"../chunk-2BTTX2KO.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WRRQ7L5K.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-45IUUCAV.mjs";import"../chunk-HHGJXVAE.mjs";import"../chunk-GMBSQDPO.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-GDO6Q2FI.mjs";import"../chunk-BA4RBST6.mjs";import"../chunk-G5XLMQ5E.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-MQGW234H.mjs";import"../chunk-F63E4CR7.mjs";import"../chunk-GWSDIX6C.mjs";import"../chunk-MLDQ2TY2.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-76OH2Z4Q.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-G5MGSV7Y.mjs";import"../chunk-OHRL766V.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-YU3IYJRL.mjs";import"../chunk-CRA2MFJC.mjs";import"../chunk-XMW65WCQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LNEZEYYE.mjs";import"../chunk-YPHH6CAO.mjs";import"../chunk-P5V7OZNN.mjs";import"../chunk-H6YNXJNF.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-A63SMUOU.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UAEODDZS.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Faucet};
+import{a}from"../chunk-EKZQ3EYX.mjs";import"../chunk-D3KBNFZR.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-WIXNX7HY.mjs";import"../chunk-6AGTDRNM.mjs";import"../chunk-S3FVA55H.mjs";import"../chunk-DZJXOL64.mjs";import"../chunk-37UZKMJI.mjs";import"../chunk-5CCHECTE.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-XHCALZ7X.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-WSVOJSAC.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-DCUVV3VY.mjs";import"../chunk-HDTKBFRX.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-OLPI7QAH.mjs";import"../chunk-WOOH5MMX.mjs";import"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UI3AKMZX.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Faucet};
 //# sourceMappingURL=faucet.mjs.map

package/dist/esm/api/fungibleAsset.d.mts

@@ -2,12 +2,11 @@ import { AnyNumber, PaginationArgs, WhereArg } from '../types/index.mjs';
 import { FungibleAssetMetadataBoolExp, FungibleAssetActivitiesBoolExp, CurrentFungibleAssetBalancesBoolExp } from '../types/generated/types.mjs';
 import { AptosConfig } from './aptosConfig.mjs';
 import { AccountAddressInput } from '../core/accountAddress.mjs';
-import { A as Account } from '../Ed25519Account-B1VMJOY2.mjs';
+import { A as Account } from '../Ed25519Account-DpH9qAcg.mjs';
 import { InputGenerateTransactionOptions } from '../transactions/types.mjs';
 import { SimpleTransaction } from '../transactions/instances/simpleTransaction.mjs';
 import { GetFungibleAssetMetadataResponse, GetFungibleAssetActivitiesResponse, GetCurrentFungibleAssetBalancesResponse } from '../types/indexer.mjs';
 import '../utils/apiEndpoints.mjs';
-import '../types/generated/operations.mjs';
 import '../utils/const.mjs';
 import '../bcs/serializer.mjs';
 import '../core/hex.mjs';
@@ -16,7 +15,7 @@ import '../bcs/deserializer.mjs';
 import '../transactions/instances/transactionArgument.mjs';
 import '../transactions/authenticator/account.mjs';
 import '../core/crypto/ed25519.mjs';
-import '../publicKey-B3XRNhHO.mjs';
+import '../publicKey-_tPa99ea.mjs';
 import '../core/crypto/signature.mjs';
 import '../core/crypto/privateKey.mjs';
 import '../core/crypto/multiEd25519.mjs';
@@ -32,115 +31,219 @@ import '../transactions/instances/identifier.mjs';
 import '../transactions/instances/moduleId.mjs';
 import '../transactions/typeTag/index.mjs';
 import '../transactions/instances/multiAgentTransaction.mjs';
+import '../types/generated/operations.mjs';
 
 /**
- * A class to query all `FungibleAsset` related queries on Aptos.
+ * A class for querying and managing fungible asset-related operations on the Aptos blockchain.
  */
 declare class FungibleAsset {
     readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos class with the provided configuration.
+     * This allows you to interact with the Aptos blockchain using the specified network settings.
+     *
+     * @param config - The configuration settings for connecting to the Aptos network.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own network if needed
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
      * Queries all fungible asset metadata.
      *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
+     * @param args.options Optional configuration for pagination and filtering.
+     *
+     * @returns A list of fungible asset metadata.
+     *
      * @example
-     * const fungibleAsset = await aptos.getFungibleAssetMetadata()
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @param args.options Optional configuration for pagination and filtering
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns A list of fungible asset metadata
+     * async function runExample() {
+     *   // Fetching fungible asset metadata
+     *   const fungibleAssets = await aptos.getFungibleAssetMetadata();
+     *   console.log(fungibleAssets);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getFungibleAssetMetadata(args?: {
         minimumLedgerVersion?: AnyNumber;
         options?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>;
     }): Promise<GetFungibleAssetMetadataResponse>;
     /**
-     * Queries a fungible asset metadata by the asset type
+     * Queries the fungible asset metadata for a specific asset type.
+     * This function helps retrieve detailed information about a fungible asset based on its type.
+     *
+     * @param args - The parameters for the query.
+     * @param args.assetType - The asset type of the fungible asset, e.g., "0x1::aptos_coin::AptosCoin" for Aptos Coin.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
      *
-     * This query returns the fungible asset metadata for a specific fungible asset.
+     * @returns A fungible asset metadata item.
      *
      * @example
-     * const fungibleAsset = await aptos.getFungibleAssetMetadataByAssetType({assetType:"0x123::test_coin::TestCoin"})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @param args.assetType The asset type of the fungible asset.
-     * e.g
-     * "0x1::aptos_coin::AptosCoin" for Aptos Coin
-     * "0xc2948283c2ce03aafbb294821de7ee684b06116bb378ab614fa2de07a99355a8" - address format if this is fungible asset
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns A fungible asset metadata item
+     * async function runExample() {
+     *   // Retrieve fungible asset metadata by asset type
+     *   const fungibleAsset = await aptos.getFungibleAssetMetadataByAssetType({
+     *     assetType: "0x1::aptos_coin::AptosCoin" // replace with your asset type
+     *   });
+     *
+     *   console.log(fungibleAsset);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getFungibleAssetMetadataByAssetType(args: {
         assetType: string;
         minimumLedgerVersion?: AnyNumber;
     }): Promise<GetFungibleAssetMetadataResponse[0]>;
     /**
-     * Queries a fungible asset metadata by the creator address
+     * Retrieves fungible asset metadata based on the creator address.
+     *
+     * This function allows you to query metadata for a specific fungible asset created by a given address.
+     *
+     * @param args - The parameters for the query.
+     * @param args.creatorAddress - The creator address of the fungible asset.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
      *
-     * This query returns the fungible asset metadata for a specific fungible asset.
+     * @returns A fungible asset metadata item.
      *
      * @example
-     * const fungibleAsset = await aptos.getFungibleAssetMetadataByCreatorAddress({creatorAddress:"0x123"})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @param args.creatorAddress The creator address of the fungible asset.
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns A fungible asset metadata item
+     * async function runExample() {
+     *   // Retrieve fungible asset metadata by creator address
+     *   const fungibleAsset = await aptos.getFungibleAssetMetadataByCreatorAddress({
+     *     creatorAddress: "0x123", // replace with a real creator address
+     *   });
+     *
+     *   console.log(fungibleAsset);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getFungibleAssetMetadataByCreatorAddress(args: {
         creatorAddress: AccountAddressInput;
         minimumLedgerVersion?: AnyNumber;
     }): Promise<GetFungibleAssetMetadataResponse>;
     /**
-     * Queries all fungible asset activities
+     * Queries all fungible asset activities and returns a list of their metadata.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.
+     * @param args.options Optional configuration for pagination and filtering.
+     * @returns A list of fungible asset metadata.
      *
      * @example
-     * const fungibleAssetActivities = await aptos.getFungibleAssetActivities()
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @param args.options Optional configuration for pagination and filtering
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @returns A list of fungible asset metadata
+     * async function runExample() {
+     *   // Fetching fungible asset activities
+     *   const fungibleAssetActivities = await aptos.getFungibleAssetActivities();
+     *   console.log(fungibleAssetActivities);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getFungibleAssetActivities(args?: {
         minimumLedgerVersion?: AnyNumber;
         options?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>;
     }): Promise<GetFungibleAssetActivitiesResponse>;
     /**
-     * Queries all fungible asset balances
+     * Queries all fungible asset balances.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.
+     * @param args.options Optional configuration for pagination and filtering.
+     *
+     * @returns A list of fungible asset metadata.
      *
      * @example
-     * const fungibleAssetBalances = await aptos.getCurrentFungibleAssetBalances()
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @param args.options Optional configuration for pagination and filtering
+     * async function runExample() {
+     *   // Fetching current fungible asset balances
+     *   const fungibleAssetBalances = await aptos.getCurrentFungibleAssetBalances();
      *
-     * @returns A list of fungible asset metadata
+     *   console.log(fungibleAssetBalances);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getCurrentFungibleAssetBalances(args?: {
         minimumLedgerVersion?: AnyNumber;
         options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
     }): Promise<GetCurrentFungibleAssetBalancesResponse>;
     /**
-     * Transfer `amount` of fungible asset from sender's primary store to recipient's primary store.
+     * Transfer a specified amount of fungible asset from the sender's primary store to the recipient's primary store.
+     * This method allows you to transfer any fungible asset, including fungible tokens.
+     *
+     * @param args - The arguments for the transfer operation.
+     * @param args.sender - The sender account.
+     * @param args.fungibleAssetMetadataAddress - The fungible asset account address. For example, if you’re transferring USDT,
+     * this would be the USDT address.
+     * @param args.recipient - The recipient account address.
+     * @param args.amount - The number of assets to transfer.
+     * @param args.options - Optional parameters for generating the transaction.
      *
-     * Use this method to transfer any fungible asset including fungible token.
+     * @returns A SimpleTransaction that can be simulated or submitted to the chain.
      *
      * @example
-     * const transaction = await aptos.transferFungibleAsset({
-     *  sender: alice,
-     *  fungibleAssetMetadataAddress: "0x123",
-     *  recipient: "0x456",
-     *  amount: 5
-     * })
-     *
-     * @param sender The sender account
-     * @param fungibleAssetMetadataAddress The fungible asset account address.
-     * For example if you’re transferring USDT this would be the USDT address
-     * @param recipient The recipient account address
-     * @param amount Number of assets to transfer
-     *
-     * @returns A SimpleTransaction that can be simulated or submitted to chain.
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Transfer fungible asset from sender to recipient
+     *   const transaction = await aptos.transferFungibleAsset({
+     *     sender: Account.generate(), // replace with a real sender account
+     *     fungibleAssetMetadataAddress: "0x123", // replace with a real fungible asset address
+     *     recipient: "0x456", // replace with a real recipient account
+     *     amount: 5
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     transferFungibleAsset(args: {
         sender: Account;