@aptos-labs/ts-sdk 1.29.0 → 1.30.0

package/dist/esm/cli/localNode.d.mts

@@ -1,35 +1,51 @@
 import { ChildProcessWithoutNullStreams } from 'child_process';
 
+/**
+ * Represents a local node for running a testnet environment.
+ * This class provides methods to start, stop, and check the status of the local testnet process.
+ * It manages the lifecycle of the node process and ensures that it is operational before executing tests.
+ */
 declare class LocalNode {
     readonly MAXIMUM_WAIT_TIME_SEC = 75;
     readonly READINESS_ENDPOINT = "http://127.0.0.1:8070/";
+    showStdout: boolean;
     process: ChildProcessWithoutNullStreams | null;
+    constructor(args?: {
+        showStdout?: boolean;
+    });
     /**
-     * kills all the descendent processes
-     * of the node process, including the node process itself
+     * Kills the current process and all its descendant processes.
+     *
+     * @returns {Promise<void>} A promise that resolves to true if the process was successfully killed.
+     * @throws {Error} If there is an error while attempting to kill the process.
      */
     stop(): Promise<void>;
     /**
-     * Runs a local testnet and waits for process to be up.
+     * Runs a local testnet and waits for the process to be up.
+     * If the local node process is already running, it returns without starting the process.
      *
-     * If local node process is already up it returns and does
-     * not start the process
+     * @returns {Promise<void>} A promise that resolves when the process is up.
      */
     run(): Promise<void>;
     /**
-     * Starts the local testnet by running the aptos node run-local-testnet command
+     * Starts the local testnet by running the Aptos node with the specified command-line arguments.
+     *
+     * @returns {void}
+     *
+     * @throws {Error} If there is an issue starting the local testnet.
      */
     start(): void;
     /**
-     * Waits for the local testnet process to be up
+     * Waits for the local testnet process to be operational within a specified maximum wait time.
+     * This function continuously checks if the process is up and will throw an error if it fails to start.
      *
-     * @returns Promise<boolean>
+     * @returns Promise<boolean> - Resolves to true if the process is up, otherwise throws an error.
      */
     waitUntilProcessIsUp(): Promise<boolean>;
     /**
-     * Checks if the local testnet is up
+     * Checks if the local testnet is up by querying the readiness endpoint.
      *
-     * @returns Promise<boolean>
+     * @returns Promise<boolean> - A promise that resolves to true if the testnet is up, otherwise false.
      */
     checkIfProcessIsUp(): Promise<boolean>;
 }

package/dist/esm/cli/localNode.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-B5NYEWNM.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-FVA2OPG4.mjs";export{a as LocalNode};
+import{a}from"../chunk-XOCRDV2V.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-KDMSOCZY.mjs";export{a as LocalNode};
 //# sourceMappingURL=localNode.mjs.map

package/dist/esm/cli/move.d.mts

@@ -10,85 +10,78 @@ import '../types/generated/types.mjs';
 import '../bcs/deserializer.mjs';
 import '../transactions/instances/transactionArgument.mjs';
 
+/**
+ * Class representing a Move package management utility for the Aptos blockchain.
+ * This class provides methods to initialize directories, compile packages, run tests, publish modules, create objects, upgrade
+ * packages, build transaction payloads, and run scripts.
+ */
 declare class Move {
     /**
-     * Function to initialize current directory for Aptos
-     *
-     * Configuration will be pushed into .aptos/config.yaml
-     * @param args.network optional Network type argument to use for default settings, default is local
-     * @param args.profile optional Profile to use from the config file, default is 'default'
-     * This will be used to override associated settings such as the REST URL, the Faucet URL, and the private key arguments.
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
-     *
+     * Initialize the current directory for Aptos by configuring the necessary settings.
+     * Configuration will be pushed into .aptos/config.yaml.
+     *
+     * @param args - The arguments for initialization.
+     * @param args.network - Optional Network type argument to use for default settings; defaults to local.
+     * @param args.profile - Optional Profile to use from the config file; defaults to 'default'. This will override associated
+     * settings such as the REST URL, the Faucet URL, and the private key arguments.
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]
      * @returns stdout
      */
     init(args: {
         network?: Network;
         profile?: string;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         output: string;
     }>;
     /**
-     * Function to compile a package
-     *
-     * @param args.packageDirectoryPath Path to a move package (the folder with a Move.toml file)
-     * @param args.namedAddresses  Named addresses for the move binary
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
-     * @example
-     * {
-     *  alice:0x1234, bob:0x5678
-     * }
-     *
+     * Compile a Move package located at the specified directory path.
+     * This function helps in preparing the Move package for deployment or further processing.
+     *
+     * @param args - The arguments for compiling the package.
+     * @param args.packageDirectoryPath - Path to a Move package (the folder with a Move.toml file).
+     * @param args.namedAddresses - Named addresses for the move binary. Ex. { alice: 0x1234, bob: 0x5678 }
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]
      * @returns stdout
      */
     compile(args: {
         packageDirectoryPath: string;
         namedAddresses: Record<string, AccountAddress>;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         output: string;
     }>;
     /**
-     * Function to run Move unit tests for a package
-     *
-     * @param args.packageDirectoryPath Path to a move package (the folder with a Move.toml file)
-     * @param args.namedAddresses  Named addresses for the move binary
-     * @example
-     * {
-     *  alice:0x1234, bob:0x5678
-     * }
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
-     *
-     * @returns stdout
+     * Run Move unit tests for a specified package.
+     *
+     * @param args - The arguments for running the tests.
+     * @param args.packageDirectoryPath - The path to a Move package (the folder containing a Move.toml file).
+     * @param args.namedAddresses - Named addresses for the move binary. Ex. { alice: 0x1234, bob: 0x5678 }
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]
+     * @returns The stdout output from running the tests.
      */
     test(args: {
         packageDirectoryPath: string;
         namedAddresses: Record<string, AccountAddress>;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         output: string;
     }>;
     /**
-     * Function to publish the modules to the publisher account on the Aptos blockchain
-     *
-     * @param args.packageDirectoryPath Path to a move package (the folder with a Move.toml file)
-     * @param args.namedAddresses  Named addresses for the move binary
-     * @example
-     * {
-     *  alice:0x1234, bob:0x5678
-     * }
-     * @param args.profile optional Profile to use from the config file.
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
-     *
+     * Publishes the modules to the publisher account on the Aptos blockchain.
+     *
+     * @param args - The arguments for publishing the modules.
+     * @param args.packageDirectoryPath - The path to a move package (the folder with a Move.toml file).
+     * @param args.namedAddresses - Named addresses for the move binary. Ex. { alice: 0x1234, bob: 0x5678 }
+     * @param args.profile - Optional profile to use from the config file.
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]
      * @returns stdout
      */
     publish(args: {
@@ -96,34 +89,29 @@ declare class Move {
         namedAddresses: Record<string, AccountAddress>;
         profile?: string;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         output: string;
     }>;
     /**
-     * Function to create a new object and publish the Move package to it on the Aptos blockchain
-     *
-     * @param args.packageDirectoryPath Path to a move package (the folder with a Move.toml file)
-     * @param args.addressName Address name for the Move package
-     * @example
-     * MoonCoin, please find the actual address name in Move.toml
-     * @param args.namedAddresses  Named addresses for the move binary
-     * @example
-     * {
-     *  alice:0x1234, bob:0x5678
-     * }
-     * @param args.profile optional Profile to use from the config file.
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
-     *
-     * A complete example in cli
+     * Create a new object and publish the Move package to it on the Aptos blockchain.
+     *
+     * @param args - The arguments for creating the object and publishing the package.
+     * @param args.packageDirectoryPath - Path to a Move package (the folder with a Move.toml file).
+     * @param args.addressName - Address name for the Move package.
+     * @param args.namedAddresses - Named addresses for the Move binary.
+     * @param args.profile - Optional profile to use from the config file.
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]
+     * @returns The object address.
+     *
+     * A complete example in CLI:
      * aptos move create-object-and-publish-package \
      * --package-dir path_to_directory_that_has_move.toml \
      * --address-name launchpad_addr \
-     * --named-addresses "launchpad_addr=0x123,initial_creator_addr=0x456"\
+     * --named-addresses "launchpad_addr=0x123,initial_creator_addr=0x456" \
      * --profile my_profile \
      * --assume-yes
-     * @returns object address
      */
     createObjectAndPublishPackage(args: {
         packageDirectoryPath: string;
@@ -131,27 +119,21 @@ declare class Move {
         namedAddresses: Record<string, AccountAddress>;
         profile?: string;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         objectAddress: string;
     }>;
     /**
-     * Function to upgrade a Move package previously published to an object on the Aptos blockchain
-     * Caller must be the object owner to call this function
-     *
-     * @param args.packageDirectoryPath Path to a move package (the folder with a Move.toml file)
-     * @param args.objectAddress Address of the object that the Move package published to
-     * @example
-     * 0x1000
-     * @param args.namedAddresses  Named addresses for the move binary
-     * @example
-     * {
-     *  alice:0x1234, bob:0x5678
-     * }
-     * @param args.profile optional Profile to use from the config file.
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
-     *
+     * Upgrade a Move package previously published to an object on the Aptos blockchain.
+     * The caller must be the object owner to execute this function.
+     *
+     * @param args - The arguments for upgrading the object package.
+     * @param args.packageDirectoryPath - Path to a Move package (the folder with a Move.toml file).
+     * @param args.objectAddress - Address of the object that the Move package published to. Ex. 0x1000
+     * @param args.namedAddresses - Named addresses for the move binary. Ex. { alice: 0x1234, bob: 0x5678 }
+     * @param args.profile - Optional profile to use from the config file.
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]
      * @returns stdout
      */
     upgradeObjectPackage(args: {
@@ -160,23 +142,19 @@ declare class Move {
         namedAddresses: Record<string, AccountAddress>;
         profile?: string;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         output: string;
     }>;
     /**
-     * Build a publication transaction payload and store it in a JSON output file
-     *
-     * @param args.packageDirectoryPath Path to a move package (the folder with a Move.toml file)
-     * @param args.outputFile Output file to write publication transaction to
-     * @param args.namedAddresses  Named addresses for the move binary
-     * @example
-     * {
-     *  alice:0x1234, bob:0x5678
-     * }
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
-     *
+     * Build a publication transaction payload and store it in a JSON output file.
+     *
+     * @param args - The arguments for building the publishing payload.
+     * @param args.packageDirectoryPath - Path to a move package (the folder with a Move.toml file).
+     * @param args.outputFile - Output file to write the publication transaction to.
+     * @param args.namedAddresses - Named addresses for the move binary. Ex. { alice: 0x1234, bob: 0x5678 }
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]   *
      * @returns stdout
      */
     buildPublishPayload(args: {
@@ -184,60 +162,63 @@ declare class Move {
         outputFile: string;
         namedAddresses: Record<string, AccountAddress>;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         output: string;
     }>;
     /**
-     * Function to run a Move script, please run compile before running this
+     * Runs a Move script using the provided compiled script path and optional parameters. Ensure that the script is compiled
+     * before executing this function.
      *
-     * @param args.compiledScriptPath Path to a compiled Move script bytecode file
-     * @param args.namedAddresses  Named addresses for the move binary
-     * @example
-     * build/my_package/bytecode_scripts/my_move_script.mv
-     * @param args.profile optional Profile to use from the config file.
-     * @param args.extraArguments (optional) Any extra arguments to include in the form of an array of strings
-     * @example
-     * ["--assume-yes","--gas-unit-price=10"]
+     * @param args - The arguments for running the script.
+     * @param args.compiledScriptPath - Path to a compiled Move script bytecode file.
+     * Ex. "build/my_package/bytecode_scripts/my_move_script.mv"
+     * @param args.profile - Optional profile to use from the config file.
+     * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
+     * Ex. ["--assume-yes","--gas-unit-price=10"]
      *
-     * @returns stdout
+     * @returns The standard output from running the script.
      */
     runScript(args: {
         compiledScriptPath: string;
         profile?: string;
         extraArguments?: Array<string>;
+        showStdout?: boolean;
     }): Promise<{
         output: string;
     }>;
     /**
-     * Run a move command
+     * Run a command with the specified arguments and return the output.
      *
-     * @param args
-     * @returns stdout
+     * @param args - An array of strings representing the command-line arguments to be passed to the command.
+     * @param showStdout - Show the standard output generated by the command.
+     * @returns The standard output generated by the command.
      */
     private runCommand;
     /**
-     * Convert named addresses from a Map into an array seperated by a comma
+     * Convert named addresses from a Map into an array separated by a comma.
      *
-     * @example
-     * input: {'alice' => '0x123', 'bob' => '0x456'}
-     * output: "alice=0x123,bob=0x456"
-     *
-     * @param namedAddresses
-     * @returns An array of names addresses seperated by a comma
+     * @param namedAddresses - A Map where the key is a string representing the name and the value is an AccountAddress.
+     * Ex. {'alice' => '0x123', 'bob' => '0x456'}
+     * @returns An array of named addresses formatted as strings separated by a comma. Ex. "alice=0x123,bob=0x456"
      */
     private prepareNamedAddresses;
     /**
-     * Parse named addresses from a Record type into a Map
+     * Parse named addresses from a Record type into a Map.
+     *
+     * This function transforms a collection of named addresses into a more accessible format by mapping each name to its
+     * corresponding address.
      *
-     * @param namedAddresses
-     * @returns Map<name,address>
+     * @param namedAddresses - A record containing named addresses where the key is the name and the value is the AccountAddress.
+     * @returns A Map where each key is a name and each value is the corresponding address.
      */
     private parseNamedAddresses;
     /**
-     * Extract object address from the output
+     * Extracts the object address from the provided output string.
      *
-     * @param output
-     * @returns object address
+     * @param output - The output string containing the object address.
+     * @returns The extracted object address.
+     * @throws Error if the object address cannot be extracted from the output.
      */
     private extractAddressFromOutput;
 }

package/dist/esm/cli/move.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-HAT5S2XX.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Move};
+import{a}from"../chunk-GPZRGLU2.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Move};
 //# sourceMappingURL=move.mjs.map

package/dist/esm/client/core.d.mts

@@ -8,16 +8,31 @@ import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 
 /**
- * Given a url and method, sends the request with axios and
- * returns the response.
+ * Sends a request using the specified options and returns the response.
+ *
+ * @param options - The options for the request.
+ * @param options.url - The URL to send the request to.
+ * @param options.method - The HTTP method to use for the request.
+ * @param options.body - The body of the request.
+ * @param options.contentType - The content type of the request.
+ * @param options.params - The query parameters to include in the request.
+ * @param options.overrides - Additional overrides for the request.
+ * @param options.overrides.HEADERS - Custom headers to include in the request.
+ * @param options.overrides.AUTH_TOKEN - The authorization token for the request.
+ * @param options.overrides.API_KEY - The API key for the request.
+ * @param options.originMethod - The origin method for the request.
+ * @param client - The client used to make the request.
+ *
+ * @returns The response from the request.
  */
 declare function request<Req, Res>(options: ClientRequest<Req>, client: Client): Promise<ClientResponse<Res>>;
 /**
- * The main function to use when doing an API request.
+ * The main function to use when making an API request, returning the response or throwing an AptosApiError on failure.
  *
- * @param aptosRequestOpts AptosRequest
- * @param aptosConfig The config information for the SDK client instance
- * @returns the response or AptosApiError
+ * @param aptosRequestOpts - Options for the Aptos request, including the URL and path.
+ * @param aptosConfig - The configuration information for the SDK client instance.
+ * @param apiType - The type of API being accessed, which determines how the response is handled.
+ * @returns The response from the API request or throws an AptosApiError if the request fails.
  */
 declare function aptosRequest<Req extends {}, Res extends {}>(aptosRequestOpts: AptosRequest, aptosConfig: AptosConfig, apiType: AptosApiType): Promise<AptosResponse<Req, Res>>;
 

package/dist/esm/client/core.mjs

@@ -1,2 +1,2 @@
-import{a,b}from"../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{b as aptosRequest,a as request};
+import{a,b}from"../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-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{b as aptosRequest,a as request};
 //# sourceMappingURL=core.mjs.map

package/dist/esm/client/get.d.mts

@@ -7,6 +7,9 @@ import '../types/indexer.mjs';
 import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 
+/**
+ * Options for making a GET request, including configuration for the API client.
+ */
 type GetRequestOptions = {
     /**
      * The config for the API client
@@ -41,20 +44,45 @@ type GetRequestOptions = {
      */
     overrides?: ClientConfig;
 };
+/**
+ * Options for making a request to the Aptos API, excluding the "type" field.
+ */
 type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
 /**
- * Main function to do a Get request
+ * Executes a GET request to retrieve data based on the provided options.
  *
- * @param options GetRequestOptions
- * @returns
+ * @param options - The options for the GET request.
+ * @param options.aptosConfig - The configuration object for Aptos requests.
+ * @param options.overrides - Optional overrides for the request configuration.
+ * @param options.params - Query parameters to include in the request.
+ * @param options.contentType - The content type of the request.
+ * @param options.acceptType - The accepted response type.
+ * @param options.path - The specific path for the request.
+ * @param options.originMethod - The original method of the request.
+ * @param options.type - The type of request being made.
+ * @returns The response from the GET request.
  */
 declare function get<Req extends {}, Res extends {}>(options: GetRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Retrieves data from the Aptos full node using the provided options.
+ *
+ * @param options - The options for the request to the Aptos full node.
+ * @param options.aptosConfig - Configuration settings specific to the Aptos client and full node.
+ * @param options.aptosConfig.clientConfig - The client configuration settings.
+ * @param options.aptosConfig.fullnodeConfig - The full node configuration settings.
+ * @param options.overrides - Additional overrides for the request.
+ * @param options.type - The type of API request being made.
+ *
+ * @returns A promise that resolves with the response from the Aptos full node.
+ */
 declare function getAptosFullNode<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
- * Makes a get request to the pepper service
+ * Makes a GET request to the Aptos Pepper service to retrieve data.
  *
- * @param options GetAptosRequestOptions
- * @returns AptosResponse
+ * @param options - The options for the request.
+ * @param options.param1 - Description of param1.
+ * @param options.param2 - Description of param2.
+ * @returns AptosResponse - The response from the Aptos Pepper service.
  */
 declare function getAptosPepperService<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 declare function paginateWithCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<Res>;

package/dist/esm/client/get.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d}from"../chunk-YU3IYJRL.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 get,b as getAptosFullNode,c as getAptosPepperService,d as paginateWithCursor};
+import{a,b,c,d}from"../chunk-OLPI7QAH.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-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 get,b as getAptosFullNode,c as getAptosPepperService,d as paginateWithCursor};
 //# sourceMappingURL=get.mjs.map

package/dist/esm/client/index.mjs

@@ -1,2 +1,2 @@
-import"../chunk-N2FKVZ4D.mjs";import{a as d,b as e,c as f,d as g}from"../chunk-YU3IYJRL.mjs";import{a as h,b as i,c as j,d as k,e as l,f as m}from"../chunk-CRA2MFJC.mjs";import{a as b,b as c}from"../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{a}from"../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 AptosApiError,c as aptosRequest,d as get,e as getAptosFullNode,f as getAptosPepperService,g as paginateWithCursor,h as post,k as postAptosFaucet,i as postAptosFullNode,j as postAptosIndexer,l as postAptosPepperService,m as postAptosProvingService,b as request};
+import"../chunk-N2FKVZ4D.mjs";import{a as d,b as e,c as f,d as g}from"../chunk-OLPI7QAH.mjs";import{a as h,b as i,c as j,d as k,e as l,f as m}from"../chunk-WOOH5MMX.mjs";import{a as b,b as c}from"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import{a}from"../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-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 AptosApiError,c as aptosRequest,d as get,e as getAptosFullNode,f as getAptosPepperService,g as paginateWithCursor,h as post,k as postAptosFaucet,i as postAptosFullNode,j as postAptosIndexer,l as postAptosPepperService,m as postAptosProvingService,b as request};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/client/post.d.mts

@@ -7,6 +7,9 @@ import '../types/indexer.mjs';
 import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 
+/**
+ * Options for making a POST request, including the API client configuration.
+ */
 type PostRequestOptions = {
     /**
      * The config for the API client
@@ -45,24 +48,78 @@ type PostRequestOptions = {
      */
     overrides?: ClientConfig;
 };
+/**
+ * Options for posting a request to Aptos, excluding the type field.
+ */
 type PostAptosRequestOptions = Omit<PostRequestOptions, "type">;
 /**
- * Main function to do a Post request
+ * Executes a POST request to the specified URL with the provided options.
  *
- * @param options PostRequestOptions
- * @returns
+ * @param options - The options for the POST request.
+ * @param options.type - The type of the request.
+ * @param options.originMethod - The original method that initiated the request.
+ * @param options.path - The path for the request.
+ * @param options.body - The body content to be sent with the request.
+ * @param options.acceptType - The type of response expected from the server.
+ * @param options.contentType - The content type of the request body.
+ * @param options.params - Additional parameters to include in the request.
+ * @param options.aptosConfig - Configuration settings for the Aptos request.
+ * @param options.overrides - Any overrides for the default request behavior.
+ * @returns The response from the POST request.
  */
 declare function post<Req extends {}, Res extends {}>(options: PostRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Sends a request to the Aptos full node using the specified options.
+ * This function allows you to interact with the Aptos blockchain by sending requests to the full node.
+ *
+ * @param options - The options for the request.
+ * @param options.aptosConfig - Configuration settings for the Aptos client.
+ * @param options.aptosConfig.clientConfig - Client-specific configuration settings.
+ * @param options.aptosConfig.fullnodeConfig - Full node-specific configuration settings.
+ * @param options.overrides - Additional overrides for the request.
+ */
 declare function postAptosFullNode<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Sends a request to the Aptos indexer with the specified options.
+ * This function allows you to interact with the Aptos indexer and customize the request using various configurations.
+ *
+ * @param options - The options for the request to the Aptos indexer.
+ * @param options.aptosConfig - Configuration settings specific to the Aptos client and indexer.
+ * @param options.aptosConfig.clientConfig - The client configuration settings.
+ * @param options.aptosConfig.indexerConfig - The indexer configuration settings.
+ * @param options.overrides - Additional overrides for the request.
+ * @param options.overrides.HEADERS - Custom headers to include in the request.
+ */
 declare function postAptosIndexer<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Sends a request to the Aptos faucet to obtain test tokens.
+ * This function modifies the provided configuration to ensure that the API_KEY is not included in the request.
+ *
+ * @param options - The options for the request.
+ * @param options.aptosConfig - The configuration settings for the Aptos client.
+ * @param options.aptosConfig.clientConfig - The client-specific configuration settings.
+ * @param options.aptosConfig.clientConfig.HEADERS - Optional headers to include in the request.
+ * @param options.aptosConfig.faucetConfig - The configuration settings specific to the faucet.
+ * @param options.overrides - Additional overrides for the request configuration.
+ */
 declare function postAptosFaucet<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
- * Makes a post request to the pepper service
+ * Makes a post request to the pepper service.
  *
- * @param options GetAptosRequestOptions
- * @returns AptosResponse
+ * @param options - The options for the request.
+ * @param options.url - The URL to which the request is sent.
+ * @param options.headers - The headers to include in the request.
+ * @param options.body - The body of the request.
+ * @returns A promise that resolves to the response from the pepper service.
  */
 declare function postAptosPepperService<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Sends a request to the Aptos proving service with the specified options.
+ *
+ * @param options - The options for the request to the Aptos proving service.
+ * @param options.type - The type of the request, which should be set to AptosApiType.PROVER.
+ * @param options.data - The data to be included in the request.
+ */
 declare function postAptosProvingService<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 
 export { type PostAptosRequestOptions, type PostRequestOptions, post, postAptosFaucet, postAptosFullNode, postAptosIndexer, postAptosPepperService, postAptosProvingService };