@aptos-labs/ts-sdk 1.29.1 → 1.31.0

package/dist/esm/api/ans.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-X4KEZTUQ.mjs";import"../chunk-7ZLBJUVZ.mjs";import"../chunk-G7MWTE2J.mjs";import"../chunk-WWZ3METZ.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-MEWFJJJN.mjs";import"../chunk-NNRAQP36.mjs";import"../chunk-3YKAGVHZ.mjs";import"../chunk-PKXEB7XP.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-BKEJMQQ6.mjs";import"../chunk-STGYDB5E.mjs";import"../chunk-MO4IZXLK.mjs";import"../chunk-GFGX3QDP.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-46D5QX3G.mjs";import"../chunk-FRGXKOU5.mjs";import"../chunk-B6M7QBUO.mjs";import"../chunk-KYSDF3CA.mjs";import"../chunk-6RZZIOGH.mjs";import"../chunk-YHAPZP5A.mjs";import"../chunk-K2O24YLZ.mjs";import"../chunk-KXBIA4KR.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-XONG5JZ4.mjs";import"../chunk-RNTXQYJQ.mjs";import"../chunk-CVDR5SJR.mjs";import"../chunk-TL7DR54X.mjs";import"../chunk-5655UVIK.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-2TQIU7CG.mjs";import"../chunk-QDIKOQRK.mjs";import"../chunk-QIW56MUH.mjs";import"../chunk-LXLISEQ4.mjs";import"../chunk-E37YRKWK.mjs";import"../chunk-N5JNKD5F.mjs";import"../chunk-TMW2HIXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WP7WF54Q.mjs";import"../chunk-B2CXRZL5.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BD6BJETG.mjs";import"../chunk-GGR3P2TG.mjs";import"../chunk-U67PFBTL.mjs";import"../chunk-LGD5KU56.mjs";import"../chunk-PNXUYOYI.mjs";import"../chunk-LG3DAAPD.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-M2QV232A.mjs";import"../chunk-3MCYLML2.mjs";import"../chunk-DAJOX4PL.mjs";import"../chunk-IMGLHDIA.mjs";import"../chunk-BF4ZE37Q.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-KA6FZNWP.mjs";import"../chunk-QPP6BX53.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-EV2USF7B.mjs";import"../chunk-7V6DEA7G.mjs";import"../chunk-PUZ25PTD.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-CCMHWJ3Q.mjs";import"../chunk-6QGVRNV6.mjs";import"../chunk-YJCZU6PR.mjs";import"../chunk-MS4MRLGA.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-HPZ2S4FE.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-555I4YHP.mjs";import"../chunk-FVA2OPG4.mjs";export{a as ANS};
+import{a}from"../chunk-L5J3V3HW.mjs";import"../chunk-SOLWFAUY.mjs";import"../chunk-5S3Z7MT4.mjs";import"../chunk-YZ5BCOGI.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-22ZSW5EN.mjs";import"../chunk-DMSHPWA5.mjs";import"../chunk-IFXUWUP2.mjs";import"../chunk-KRVLR3L4.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-Y267I7DC.mjs";import"../chunk-EE7GDBA5.mjs";import"../chunk-T5BCTWGK.mjs";import"../chunk-BVVHGSWC.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-5SGSPCOY.mjs";import"../chunk-3H5DGQKX.mjs";import"../chunk-WZCKSN2U.mjs";import"../chunk-VYMRIKUV.mjs";import"../chunk-GLATLXF6.mjs";import"../chunk-M22UGFQ5.mjs";import"../chunk-CDQGPCHU.mjs";import"../chunk-WSZCPSV4.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-F2RY4YQ7.mjs";import"../chunk-XQ7ONNII.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-RBJNSUSU.mjs";import"../chunk-4LKLOUMG.mjs";import"../chunk-ZPIMARUG.mjs";import"../chunk-OTY3NO7Q.mjs";import"../chunk-ZINOJTLU.mjs";import"../chunk-NODYW7DM.mjs";import"../chunk-AGBA3Y7A.mjs";import"../chunk-A2AEFKXS.mjs";import"../chunk-SGQFWWLQ.mjs";import"../chunk-MK2QAHXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-WV2VJQDS.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-CC7VOPYH.mjs";import"../chunk-6DMDYBV6.mjs";import"../chunk-TPJLAYW6.mjs";import"../chunk-4VU2ABLU.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BOWPP6YG.mjs";import"../chunk-FTZGP6XW.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-OAEDFM7T.mjs";import"../chunk-P3J54CQG.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-RNJHULIT.mjs";import"../chunk-2652SPOM.mjs";import"../chunk-2GEIHUHT.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-2CGJLPHP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as ANS};
 //# sourceMappingURL=ans.mjs.map

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

@@ -24,9 +24,9 @@ import '../core/common.mjs';
 import '../bcs/deserializer.mjs';
 import '../transactions/instances/transactionArgument.mjs';
 import '../core/crypto/privateKey.mjs';
-import '../publicKey-B3XRNhHO.mjs';
+import '../publicKey-_tPa99ea.mjs';
 import '../core/crypto/signature.mjs';
-import '../Ed25519Account-B1VMJOY2.mjs';
+import '../Ed25519Account-DpH9qAcg.mjs';
 import '../transactions/authenticator/account.mjs';
 import '../core/crypto/ed25519.mjs';
 import '../core/crypto/multiEd25519.mjs';
@@ -67,15 +67,28 @@ import '../core/crypto/federatedKeyless.mjs';
 import '../account/FederatedKeylessAccount.mjs';
 
 /**
- * This class is the main entry point into Aptos's
- * APIs and separates functionality into different namespaces.
+ * The main entry point for interacting with the Aptos APIs,
+ * providing access to various functionalities organized into
+ * distinct namespaces.
  *
- * To use the SDK, create a new Aptos instance to get access
- * to all the sdk functionality.
+ * To utilize the SDK, instantiate a new Aptos object to gain
+ * access to the complete range of SDK features.
  *
  * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  *
- * const aptos = new Aptos();
+ * async function runExample() {
+ *     // Create a configuration for connecting to the Aptos testnet
+ *     const config = new AptosConfig({ network: Network.TESTNET });
+ *
+ *     // Initialize the Aptos client with the configuration
+ *     const aptos = new Aptos(config);
+ *
+ *     console.log("Aptos client initialized:", aptos);
+ * }
+ * runExample().catch(console.error);
+ * ```
  */
 declare class Aptos {
     readonly config: AptosConfig;
@@ -92,6 +105,26 @@ declare class Aptos {
     readonly table: Table;
     readonly keyless: Keyless;
     readonly object: AptosObject;
+    /**
+     * Initializes a new instance of the Aptos client with the provided configuration settings.
+     * This allows you to interact with various Aptos functionalities such as accounts, transactions, and events.
+     *
+     * @param settings - Configuration settings for the Aptos client.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a new Aptos client with default settings
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own settings if needed
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     constructor(settings?: AptosConfig);
 }
 interface Aptos extends Account, ANS, Coin, DigitalAsset, Event, Faucet, FungibleAsset, General, Keyless, Staking, Table, AptosObject, Omit<Transaction, "build" | "simulate" | "submit" | "batch"> {

package/dist/esm/api/aptos.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-SAPUZZEU.mjs";import"../chunk-XK3JFCP3.mjs";import"../chunk-ECWOLU5T.mjs";import"../chunk-DAXKRXRK.mjs";import"../chunk-TVFIUUVY.mjs";import"../chunk-25TIHDS6.mjs";import"../chunk-SR24OGHJ.mjs";import"../chunk-NH2S6SB2.mjs";import"../chunk-IHYTP2EW.mjs";import"../chunk-L5NY7TMI.mjs";import"../chunk-WS4RPKL6.mjs";import"../chunk-U6Z4FNB7.mjs";import"../chunk-BRFHAO2Y.mjs";import"../chunk-6EMN3BOV.mjs";import"../chunk-CPPBQDHB.mjs";import"../chunk-IYQISVDX.mjs";import"../chunk-HSPBA2TZ.mjs";import"../chunk-AFOPNDOJ.mjs";import"../chunk-XXHW3ZT3.mjs";import"../chunk-SWHLSREF.mjs";import"../chunk-LDFTE4MM.mjs";import"../chunk-OY2IX7HW.mjs";import"../chunk-TS3PYRAT.mjs";import"../chunk-QCUFTD7K.mjs";import"../chunk-Y7F2V3R6.mjs";import"../chunk-QLN2URFX.mjs";import"../chunk-XH7YKEYR.mjs";import"../chunk-DF4WKSTK.mjs";import"../chunk-EWZ2M5BW.mjs";import"../chunk-X4KEZTUQ.mjs";import"../chunk-7ZLBJUVZ.mjs";import"../chunk-G7MWTE2J.mjs";import"../chunk-NMD45OTM.mjs";import"../chunk-25NSCK4Q.mjs";import"../chunk-ZGO2SK6F.mjs";import"../chunk-WWZ3METZ.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-MEWFJJJN.mjs";import"../chunk-NNRAQP36.mjs";import"../chunk-3YKAGVHZ.mjs";import"../chunk-PKXEB7XP.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-BKEJMQQ6.mjs";import"../chunk-STGYDB5E.mjs";import"../chunk-MO4IZXLK.mjs";import"../chunk-GFGX3QDP.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-46D5QX3G.mjs";import"../chunk-FRGXKOU5.mjs";import"../chunk-B6M7QBUO.mjs";import"../chunk-KYSDF3CA.mjs";import"../chunk-6RZZIOGH.mjs";import"../chunk-YHAPZP5A.mjs";import"../chunk-K2O24YLZ.mjs";import"../chunk-KXBIA4KR.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-XONG5JZ4.mjs";import"../chunk-RNTXQYJQ.mjs";import"../chunk-CVDR5SJR.mjs";import"../chunk-TL7DR54X.mjs";import"../chunk-5655UVIK.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-2TQIU7CG.mjs";import"../chunk-QDIKOQRK.mjs";import"../chunk-QIW56MUH.mjs";import"../chunk-LXLISEQ4.mjs";import"../chunk-E37YRKWK.mjs";import"../chunk-N5JNKD5F.mjs";import"../chunk-TMW2HIXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WP7WF54Q.mjs";import"../chunk-B2CXRZL5.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BD6BJETG.mjs";import"../chunk-GGR3P2TG.mjs";import"../chunk-U67PFBTL.mjs";import"../chunk-LGD5KU56.mjs";import"../chunk-PNXUYOYI.mjs";import"../chunk-LG3DAAPD.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-M2QV232A.mjs";import"../chunk-3MCYLML2.mjs";import"../chunk-DAJOX4PL.mjs";import"../chunk-IMGLHDIA.mjs";import"../chunk-BF4ZE37Q.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-KA6FZNWP.mjs";import"../chunk-QPP6BX53.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-EV2USF7B.mjs";import"../chunk-7V6DEA7G.mjs";import"../chunk-PUZ25PTD.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-CCMHWJ3Q.mjs";import"../chunk-6QGVRNV6.mjs";import"../chunk-YJCZU6PR.mjs";import"../chunk-MS4MRLGA.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-HPZ2S4FE.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-555I4YHP.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Aptos};
+import{a}from"../chunk-JVTDP4KV.mjs";import"../chunk-RAJTNQNL.mjs";import"../chunk-MSHZ4FWB.mjs";import"../chunk-BAGUHYFD.mjs";import"../chunk-UGL2GPGK.mjs";import"../chunk-KW4FVBDD.mjs";import"../chunk-7JK7UG4E.mjs";import"../chunk-XFY4O2S3.mjs";import"../chunk-JNRMHDRA.mjs";import"../chunk-AZ6LVQEG.mjs";import"../chunk-73GCGRFW.mjs";import"../chunk-XFJD6QIP.mjs";import"../chunk-JN36BNWA.mjs";import"../chunk-I2NMCLNW.mjs";import"../chunk-IAVI3H4V.mjs";import"../chunk-IHYTP2EW.mjs";import"../chunk-4JXB6V5O.mjs";import"../chunk-ZPQUCT22.mjs";import"../chunk-2CJC43CV.mjs";import"../chunk-L5J3V3HW.mjs";import"../chunk-SOLWFAUY.mjs";import"../chunk-V5NDNR36.mjs";import"../chunk-4ZK3JNQT.mjs";import"../chunk-OXM4BVAY.mjs";import"../chunk-EUGLLGYW.mjs";import"../chunk-RNRNGJDA.mjs";import"../chunk-CL6EEMSL.mjs";import"../chunk-KYJU5PWF.mjs";import"../chunk-UCRROMZN.mjs";import"../chunk-5N6KJ7KS.mjs";import"../chunk-LDZPO76C.mjs";import"../chunk-AT2ZGTXQ.mjs";import"../chunk-5S3Z7MT4.mjs";import"../chunk-HM5HITUC.mjs";import"../chunk-YZ5BCOGI.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-22ZSW5EN.mjs";import"../chunk-DMSHPWA5.mjs";import"../chunk-IFXUWUP2.mjs";import"../chunk-KRVLR3L4.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-Y267I7DC.mjs";import"../chunk-EE7GDBA5.mjs";import"../chunk-BG2TZI3H.mjs";import"../chunk-T5BCTWGK.mjs";import"../chunk-BVVHGSWC.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-5SGSPCOY.mjs";import"../chunk-3H5DGQKX.mjs";import"../chunk-WZCKSN2U.mjs";import"../chunk-VYMRIKUV.mjs";import"../chunk-GLATLXF6.mjs";import"../chunk-M22UGFQ5.mjs";import"../chunk-CDQGPCHU.mjs";import"../chunk-WSZCPSV4.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-F2RY4YQ7.mjs";import"../chunk-XQ7ONNII.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-RBJNSUSU.mjs";import"../chunk-4LKLOUMG.mjs";import"../chunk-ZPIMARUG.mjs";import"../chunk-OTY3NO7Q.mjs";import"../chunk-ZINOJTLU.mjs";import"../chunk-NODYW7DM.mjs";import"../chunk-AGBA3Y7A.mjs";import"../chunk-A2AEFKXS.mjs";import"../chunk-SGQFWWLQ.mjs";import"../chunk-MK2QAHXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-WV2VJQDS.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-CC7VOPYH.mjs";import"../chunk-6DMDYBV6.mjs";import"../chunk-TPJLAYW6.mjs";import"../chunk-4VU2ABLU.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BOWPP6YG.mjs";import"../chunk-FTZGP6XW.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-OAEDFM7T.mjs";import"../chunk-P3J54CQG.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-RNJHULIT.mjs";import"../chunk-2652SPOM.mjs";import"../chunk-2GEIHUHT.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-2CGJLPHP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Aptos};
 //# sourceMappingURL=aptos.mjs.map

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

@@ -6,11 +6,24 @@ import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 
 /**
- * This class holds the config information for the SDK client instance.
+ * Represents the configuration settings for an Aptos SDK client instance.
+ * This class allows customization of various endpoints and client settings.
  *
  * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  *
- * const aptosConfig = new AptosConfig({network:Network.TESTNET})
+ * async function runExample() {
+ *     // Create a configuration for connecting to the Aptos testnet
+ *     const config = new AptosConfig({ network: Network.TESTNET });
+ *
+ *     // Initialize the Aptos client with the configuration
+ *     const aptos = new Aptos(config);
+ *
+ *     console.log("Aptos client initialized:", aptos);
+ * }
+ * runExample().catch(console.error);
+ * ```
  */
 declare class AptosConfig {
     /**
@@ -57,29 +70,104 @@ declare class AptosConfig {
      * Optional specific Faucet configurations
      */
     readonly faucetConfig?: FaucetConfig;
+    /**
+     * Initializes an instance of the Aptos client with the specified settings.
+     * This allows users to configure various aspects of the client, such as network and endpoints.
+     *
+     * @param settings - Optional configuration settings for the Aptos client.
+     * @param settings.network - The network to connect to, defaults to `Network.DEVNET`.
+     * @param settings.fullnode - The fullnode endpoint to use for requests.
+     * @param settings.faucet - The faucet endpoint for obtaining test tokens.
+     * @param settings.pepper - The pepper used for transaction signing.
+     * @param settings.prover - The prover endpoint for transaction verification.
+     * @param settings.indexer - The indexer endpoint for querying blockchain data.
+     * @param settings.client - Custom client settings, defaults to a standard Aptos client.
+     * @param settings.clientConfig - Additional configuration for the client.
+     * @param settings.fullnodeConfig - Additional configuration for the fullnode.
+     * @param settings.indexerConfig - Additional configuration for the indexer.
+     * @param settings.faucetConfig - Additional configuration for the faucet.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a new Aptos client with default settings
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify the network
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     constructor(settings?: AptosSettings);
     /**
-     * Returns the URL endpoint to send the request to.
-     * If a custom URL was provided in the config, that URL is returned.
-     * If a custom URL was provided but not URL endpoints, an error is thrown.
-     * Otherwise, the URL endpoint is derived from the network.
+     * Returns the URL endpoint to send the request to based on the specified API type.
+     * If a custom URL was provided in the configuration, that URL is returned. Otherwise, the URL endpoint is derived from the network.
+     *
+     * @param apiType - The type of Aptos API to get the URL for. This can be one of the following: FULLNODE, FAUCET, INDEXER, PEPPER, PROVER.
      *
-     * @param apiType - The type of Aptos API to get the URL for.
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, AptosApiType } from "@aptos-labs/ts-sdk";
      *
-     * @internal
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Getting the request URL for the FULLNODE API
+     *   const url = config.getRequestUrl(AptosApiType.FULLNODE);
+     *   console.log("Request URL for FULLNODE:", url);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getRequestUrl(apiType: AptosApiType): string;
     /**
-     * Checks if the URL is a known pepper service endpoint
+     * Checks if the provided URL is a known pepper service endpoint.
+     *
+     * @param url - The URL to check against the known pepper service endpoints.
      *
-     * @internal
-     * */
+     * @example
+     * ```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() {
+     *     const url = "https://example.pepper.service"; // replace with a real pepper service URL
+     *
+     *     // Check if the URL is a known pepper service endpoint
+     *     const isPepperService = config.isPepperServiceRequest(url);
+     *
+     *     console.log(`Is the URL a known pepper service? ${isPepperService}`);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     isPepperServiceRequest(url: string): boolean;
     /**
-     * Checks if the URL is a known prover service endpoint
+     * Checks if the provided URL is a known prover service endpoint.
      *
-     * @internal
-     * */
+     * @param url - The URL to check against known prover service endpoints.
+     * @returns A boolean indicating whether the URL is a known prover service endpoint.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * // Check if the URL is a known prover service endpoint
+     * const url = "https://prover.testnet.aptos.dev"; // replace with a real URL if needed
+     * const isProver = config.isProverServiceRequest(url);
+     *
+     * console.log(`Is the URL a known prover service? ${isProver}`);
+     * ```
+     */
     isProverServiceRequest(url: string): boolean;
 }
 

package/dist/esm/api/aptosConfig.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-NMD45OTM.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-FVA2OPG4.mjs";export{a as AptosConfig};
+import{a}from"../chunk-V5NDNR36.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as AptosConfig};
 //# sourceMappingURL=aptosConfig.mjs.map

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

@@ -6,12 +6,12 @@ import { InputGenerateTransactionOptions } from '../transactions/types.mjs';
 import '../bcs/serializer.mjs';
 import '../core/hex.mjs';
 import '../core/common.mjs';
-import '../bcs/deserializer.mjs';
-import '../transactions/instances/transactionArgument.mjs';
 import '../utils/apiEndpoints.mjs';
 import '../types/indexer.mjs';
 import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
+import '../bcs/deserializer.mjs';
+import '../transactions/instances/transactionArgument.mjs';
 import '../utils/const.mjs';
 import '../transactions/instances/rawTransaction.mjs';
 import '../transactions/instances/chainId.mjs';
@@ -22,7 +22,7 @@ import '../transactions/typeTag/index.mjs';
 import '../bcs/serializable/moveStructs.mjs';
 import '../bcs/serializable/movePrimitives.mjs';
 import '../bcs/serializable/fixedBytes.mjs';
-import '../publicKey-B3XRNhHO.mjs';
+import '../publicKey-_tPa99ea.mjs';
 import '../core/crypto/signature.mjs';
 import '../transactions/authenticator/account.mjs';
 import '../core/crypto/ed25519.mjs';
@@ -33,27 +33,64 @@ import '../core/crypto/singleKey.mjs';
 import '../transactions/instances/multiAgentTransaction.mjs';
 
 /**
- * A class to handle all `Coin` operations
+ * A class to handle all `Coin` operations.
  */
 declare class Coin {
     readonly config: AptosConfig;
-    constructor(config: AptosConfig);
     /**
-     * Generate a transfer coin transaction that can be simulated and/or signed and submitted
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows you to interact with the Aptos blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
      *
      * @example
-     * const transferCoinTransaction = await aptos.transferCoinTransaction({
-     * sender: "0x123",
-     * recipient:"0x456",
-     * amount: 10,
-     * })
+     * ```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 });
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Generate a transfer coin transaction that can be simulated, signed, and submitted.
+     * This function helps you create a transaction to transfer a specified amount of coins
+     * from one account to another within the Aptos network.
      *
-     * @param args.sender The sender account
-     * @param args.recipient The recipient address
-     * @param args.amount The amount to transfer
-     * @param args.coinType optional. The coin struct type to transfer. Defaults to 0x1::aptos_coin::AptosCoin
+     * @param args The arguments for the transfer transaction.
+     * @param args.sender The sender account address.
+     * @param args.recipient The recipient account address.
+     * @param args.amount The amount of coins to transfer.
+     * @param args.coinType Optional. The coin struct type to transfer. Defaults to 0x1::aptos_coin::AptosCoin.
+     * @param args.options Optional. Additional options for generating the transaction.
      *
      * @returns SimpleTransaction
+     *
+     * @example
+     * ```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() {
+     *   // Generate a transfer coin transaction
+     *   const transaction = await aptos.transferCoinTransaction({
+     *     sender: "0x1", // replace with a real sender account address
+     *     recipient: "0x2", // replace with a real recipient account address
+     *     amount: 10,
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     transferCoinTransaction(args: {
         sender: AccountAddressInput;

package/dist/esm/api/coin.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-25NSCK4Q.mjs";import"../chunk-ZGO2SK6F.mjs";import"../chunk-WWZ3METZ.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-MEWFJJJN.mjs";import"../chunk-NNRAQP36.mjs";import"../chunk-3YKAGVHZ.mjs";import"../chunk-PKXEB7XP.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-BKEJMQQ6.mjs";import"../chunk-STGYDB5E.mjs";import"../chunk-MO4IZXLK.mjs";import"../chunk-GFGX3QDP.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-46D5QX3G.mjs";import"../chunk-FRGXKOU5.mjs";import"../chunk-B6M7QBUO.mjs";import"../chunk-KYSDF3CA.mjs";import"../chunk-6RZZIOGH.mjs";import"../chunk-YHAPZP5A.mjs";import"../chunk-K2O24YLZ.mjs";import"../chunk-KXBIA4KR.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-XONG5JZ4.mjs";import"../chunk-RNTXQYJQ.mjs";import"../chunk-CVDR5SJR.mjs";import"../chunk-TL7DR54X.mjs";import"../chunk-5655UVIK.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-2TQIU7CG.mjs";import"../chunk-QDIKOQRK.mjs";import"../chunk-QIW56MUH.mjs";import"../chunk-LXLISEQ4.mjs";import"../chunk-E37YRKWK.mjs";import"../chunk-N5JNKD5F.mjs";import"../chunk-TMW2HIXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WP7WF54Q.mjs";import"../chunk-B2CXRZL5.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BD6BJETG.mjs";import"../chunk-GGR3P2TG.mjs";import"../chunk-U67PFBTL.mjs";import"../chunk-LGD5KU56.mjs";import"../chunk-PNXUYOYI.mjs";import"../chunk-LG3DAAPD.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-M2QV232A.mjs";import"../chunk-3MCYLML2.mjs";import"../chunk-DAJOX4PL.mjs";import"../chunk-IMGLHDIA.mjs";import"../chunk-BF4ZE37Q.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-KA6FZNWP.mjs";import"../chunk-QPP6BX53.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-EV2USF7B.mjs";import"../chunk-7V6DEA7G.mjs";import"../chunk-PUZ25PTD.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-CCMHWJ3Q.mjs";import"../chunk-6QGVRNV6.mjs";import"../chunk-YJCZU6PR.mjs";import"../chunk-MS4MRLGA.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-HPZ2S4FE.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-555I4YHP.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Coin};
+import{a}from"../chunk-4ZK3JNQT.mjs";import"../chunk-OXM4BVAY.mjs";import"../chunk-5S3Z7MT4.mjs";import"../chunk-I5OYNCZS.mjs";import"../chunk-JXCZTOYC.mjs";import"../chunk-22ZSW5EN.mjs";import"../chunk-DMSHPWA5.mjs";import"../chunk-IFXUWUP2.mjs";import"../chunk-KRVLR3L4.mjs";import"../chunk-BSCOVLWS.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-Y267I7DC.mjs";import"../chunk-EE7GDBA5.mjs";import"../chunk-T5BCTWGK.mjs";import"../chunk-BVVHGSWC.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-GAEAYY44.mjs";import"../chunk-5SGSPCOY.mjs";import"../chunk-3H5DGQKX.mjs";import"../chunk-WZCKSN2U.mjs";import"../chunk-VYMRIKUV.mjs";import"../chunk-GLATLXF6.mjs";import"../chunk-M22UGFQ5.mjs";import"../chunk-CDQGPCHU.mjs";import"../chunk-WSZCPSV4.mjs";import"../chunk-4NMDYPUD.mjs";import"../chunk-F2RY4YQ7.mjs";import"../chunk-XQ7ONNII.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-RBJNSUSU.mjs";import"../chunk-4LKLOUMG.mjs";import"../chunk-ZPIMARUG.mjs";import"../chunk-OTY3NO7Q.mjs";import"../chunk-ZINOJTLU.mjs";import"../chunk-NODYW7DM.mjs";import"../chunk-AGBA3Y7A.mjs";import"../chunk-A2AEFKXS.mjs";import"../chunk-SGQFWWLQ.mjs";import"../chunk-MK2QAHXC.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-WV2VJQDS.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-CC7VOPYH.mjs";import"../chunk-6DMDYBV6.mjs";import"../chunk-TPJLAYW6.mjs";import"../chunk-4VU2ABLU.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-BOWPP6YG.mjs";import"../chunk-FTZGP6XW.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-OAEDFM7T.mjs";import"../chunk-P3J54CQG.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-RNJHULIT.mjs";import"../chunk-2652SPOM.mjs";import"../chunk-2GEIHUHT.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-2CGJLPHP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Coin};
 //# sourceMappingURL=coin.mjs.map