@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/cli/move.js

@@ -0,0 +1,364 @@
+import { spawn } from "node:child_process";
+import { platform } from "node:os";
+/**
+ * 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.
+ * @group Implementation
+ * @category CLI
+ */
+export class Move {
+    /**
+     * 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
+     * @group Implementation
+     * @category CLI
+     */
+    async init(args) {
+        const { network, profile, extraArguments, showStdout } = args;
+        const cliArgs = ["aptos", "init", `--network=${network ?? "local"}`, `--profile=${profile ?? "default"}`];
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    /**
+     * 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
+     * @group Implementation
+     * @category CLI
+     */
+    async compile(args) {
+        const { packageDirectoryPath, namedAddresses, extraArguments, showStdout } = args;
+        const cliArgs = ["aptos", "move", "compile", "--package-dir", packageDirectoryPath];
+        const addressesMap = this.parseNamedAddresses(namedAddresses);
+        cliArgs.push(...this.prepareNamedAddresses(addressesMap));
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    /**
+     * 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.
+     * @group Implementation
+     * @category CLI
+     */
+    async test(args) {
+        const { packageDirectoryPath, namedAddresses, extraArguments, showStdout } = args;
+        const cliArgs = ["aptos", "move", "test", "--package-dir", packageDirectoryPath];
+        const addressesMap = this.parseNamedAddresses(namedAddresses);
+        cliArgs.push(...this.prepareNamedAddresses(addressesMap));
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    /**
+     * 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
+     * @group Implementation
+     * @category CLI
+     */
+    async publish(args) {
+        const { packageDirectoryPath, namedAddresses, profile, extraArguments, showStdout } = args;
+        const cliArgs = [
+            "aptos",
+            "move",
+            "publish",
+            "--package-dir",
+            packageDirectoryPath,
+            `--profile=${profile ?? "default"}`,
+        ];
+        const addressesMap = this.parseNamedAddresses(namedAddresses);
+        cliArgs.push(...this.prepareNamedAddresses(addressesMap));
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    /**
+     * 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" \
+     * --profile my_profile \
+     * --assume-yes
+     * @group Implementation
+     * @category CLI
+     */
+    async createObjectAndPublishPackage(args) {
+        const { packageDirectoryPath, addressName, namedAddresses, profile, extraArguments, showStdout } = args;
+        const cliArgs = [
+            "aptos",
+            "move",
+            "create-object-and-publish-package",
+            "--package-dir",
+            packageDirectoryPath,
+            "--address-name",
+            addressName,
+            `--profile=${profile ?? "default"}`,
+        ];
+        const addressesMap = this.parseNamedAddresses(namedAddresses);
+        cliArgs.push(...this.prepareNamedAddresses(addressesMap));
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        const { output } = await this.runCommand(cliArgs, showStdout);
+        return { objectAddress: this.extractAddressFromOutput(output) };
+    }
+    /**
+     * 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
+     * @group Implementation
+     * @category CLI
+     */
+    async upgradeObjectPackage(args) {
+        const { packageDirectoryPath, objectAddress, namedAddresses, profile, extraArguments, showStdout } = args;
+        const cliArgs = [
+            "aptos",
+            "move",
+            "upgrade-object-package",
+            "--package-dir",
+            packageDirectoryPath,
+            "--object-address",
+            objectAddress,
+            `--profile=${profile ?? "default"}`,
+        ];
+        const addressesMap = this.parseNamedAddresses(namedAddresses);
+        cliArgs.push(...this.prepareNamedAddresses(addressesMap));
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    /**
+     * 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
+     * @group Implementation
+     * @category CLI
+     */
+    async buildPublishPayload(args) {
+        const { outputFile, packageDirectoryPath, namedAddresses, extraArguments, showStdout } = args;
+        const cliArgs = [
+            "aptos",
+            "move",
+            "build-publish-payload",
+            "--json-output-file",
+            outputFile,
+            "--package-dir",
+            packageDirectoryPath,
+        ];
+        const addressesMap = this.parseNamedAddresses(namedAddresses);
+        cliArgs.push(...this.prepareNamedAddresses(addressesMap));
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    /**
+     * 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 - 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 The standard output from running the script.
+     * @group Implementation
+     * @category CLI
+     */
+    async runScript(args) {
+        const { compiledScriptPath, profile, extraArguments, showStdout } = args;
+        const cliArgs = [
+            "aptos",
+            "move",
+            "run-script",
+            "--compiled-script-path",
+            compiledScriptPath,
+            `--profile=${profile ?? "default"}`,
+        ];
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    async gasProfile(args) {
+        const { network, transactionId, extraArguments, showStdout } = args;
+        const cliArgs = ["aptos", "move", "replay", "--profile-gas", "--network", network, "--txn-id", transactionId];
+        if (extraArguments) {
+            cliArgs.push(...extraArguments);
+        }
+        return this.runCommand(cliArgs, showStdout);
+    }
+    /**
+     * Run a command with the specified arguments and return the output.
+     *
+     * @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.
+     * @group Implementation
+     * @category CLI
+     */
+    async runCommand(args, showStdout = true) {
+        return new Promise((resolve, reject) => {
+            const isWindows = platform() === "win32";
+            const spawnOptions = isWindows ? { shell: true } : undefined;
+            const childProcess = spawn("npx", args, spawnOptions);
+            let stdout = "";
+            // CLI final stdout is the Result/Error JSON string output
+            // so we need to keep track of the last stdout
+            let lastStdout = "";
+            childProcess.on("error", reject);
+            childProcess.stdout.on("data", (data) => {
+                lastStdout = data.toString();
+                stdout += data.toString();
+            });
+            if (showStdout) {
+                childProcess.stdout.pipe(process.stdout);
+                childProcess.stderr.pipe(process.stderr);
+            }
+            process.stdin.pipe(childProcess.stdin);
+            childProcess.on("close", (code) => {
+                if (code === 0) {
+                    try {
+                        // parse the last stdout as it might be the result
+                        const parsed = JSON.parse(lastStdout);
+                        if (parsed.Error) {
+                            reject(new Error(`Error: ${parsed.Error}`)); // Reject if the "Error" key exists
+                        }
+                        else if (parsed.Result) {
+                            resolve({ result: parsed.Result, output: stdout }); // Resolve if the "Result" key exists
+                        }
+                    }
+                    catch {
+                        // resolve the stdout as it might be just a stdout
+                        resolve({ output: stdout });
+                    }
+                }
+                else {
+                    reject(new Error(`Child process exited with code ${code}`)); // Reject with an error if the child process exits with an error code
+                }
+            });
+        });
+    }
+    /**
+     * Convert named addresses from a Map into an array separated 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"
+     * @group Implementation
+     * @category CLI
+     */
+    prepareNamedAddresses(namedAddresses) {
+        const totalNames = namedAddresses.size;
+        const newArgs = [];
+        if (totalNames === 0) {
+            return newArgs;
+        }
+        newArgs.push("--named-addresses");
+        const names = [];
+        namedAddresses.forEach((value, key) => {
+            const toAppend = `${key}=${value.toString()}`;
+            names.push(toAppend);
+        });
+        newArgs.push(names.join(","));
+        return newArgs;
+    }
+    /**
+     * 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 - 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.
+     * @group Implementation
+     * @category CLI
+     */
+    parseNamedAddresses(namedAddresses) {
+        const addressesMap = new Map();
+        Object.keys(namedAddresses).forEach((key) => {
+            const address = namedAddresses[key];
+            addressesMap.set(key, address);
+        });
+        return addressesMap;
+    }
+    /**
+     * Extracts the object address from the provided output string.
+     *
+     * @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.
+     * @group Implementation
+     * @category CLI
+     */
+    extractAddressFromOutput(output) {
+        const match = output.match("Code was successfully deployed to object address (0x[0-9a-fA-F]+)");
+        if (match) {
+            return match[1];
+        }
+        throw new Error("Failed to extract object address from output");
+    }
+}
+//# sourceMappingURL=move.js.map

package/dist/cli/move.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"move.js","sourceRoot":"","sources":["../../src/cli/move.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAKnC;;;;;;GAMG;AACH,MAAM,OAAO,IAAI;IACf;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,IAKV;QACC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAC9D,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,OAAO,IAAI,OAAO,EAAE,EAAE,aAAa,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC;QAE1G,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAAO,CAAC,IAKb;QACC,MAAM,EAAE,oBAAoB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAClF,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;QAEpF,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;QAE1D,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CAAC,IAKV;QACC,MAAM,EAAE,oBAAoB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAClF,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;QAEjF,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;QAE1D,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAAO,CAAC,IAMb;QACC,MAAM,EAAE,oBAAoB,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAC3F,MAAM,OAAO,GAAG;YACd,OAAO;YACP,MAAM;YACN,SAAS;YACT,eAAe;YACf,oBAAoB;YACpB,aAAa,OAAO,IAAI,SAAS,EAAE;SACpC,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;QAE1D,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,6BAA6B,CAAC,IAOnC;QACC,MAAM,EAAE,oBAAoB,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACxG,MAAM,OAAO,GAAG;YACd,OAAO;YACP,MAAM;YACN,mCAAmC;YACnC,eAAe;YACf,oBAAoB;YACpB,gBAAgB;YAChB,WAAW;YACX,aAAa,OAAO,IAAI,SAAS,EAAE;SACpC,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;QAE1D,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC9D,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAO1B;QACC,MAAM,EAAE,oBAAoB,EAAE,aAAa,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAC1G,MAAM,OAAO,GAAG;YACd,OAAO;YACP,MAAM;YACN,wBAAwB;YACxB,eAAe;YACf,oBAAoB;YACpB,kBAAkB;YAClB,aAAa;YACb,aAAa,OAAO,IAAI,SAAS,EAAE;SACpC,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;QAE1D,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,mBAAmB,CAAC,IAMzB;QACC,MAAM,EAAE,UAAU,EAAE,oBAAoB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAC9F,MAAM,OAAO,GAAG;YACd,OAAO;YACP,MAAM;YACN,uBAAuB;YACvB,oBAAoB;YACpB,UAAU;YACV,eAAe;YACf,oBAAoB;SACrB,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;QAE1D,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,SAAS,CAAC,IAKf;QACC,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACzE,MAAM,OAAO,GAAG;YACd,OAAO;YACP,MAAM;YACN,YAAY;YACZ,wBAAwB;YACxB,kBAAkB;YAClB,aAAa,OAAO,IAAI,SAAS,EAAE;SACpC,CAAC;QAEF,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAKhB;QACC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACpE,MAAM,OAAO,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;QAE9G,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IAEK,KAAK,CAAC,UAAU,CAAC,IAAmB,EAAE,aAAsB,IAAI;QACtE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,SAAS,GAAG,QAAQ,EAAE,KAAK,OAAO,CAAC;YACzC,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC7D,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YACtD,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,0DAA0D;YAC1D,8CAA8C;YAC9C,IAAI,UAAU,GAAG,EAAE,CAAC;YAEpB,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAEjC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBACtC,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC7B,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC5B,CAAC,CAAC,CAAC;YAEH,IAAI,UAAU,EAAE,CAAC;gBACf,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACzC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;YACD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAEvC,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;gBAChC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;oBACf,IAAI,CAAC;wBACH,kDAAkD;wBAClD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;wBACtC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;4BACjB,MAAM,CAAC,IAAI,KAAK,CAAC,UAAU,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,mCAAmC;wBAClF,CAAC;6BAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;4BACzB,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,qCAAqC;wBAC3F,CAAC;oBACH,CAAC;oBAAC,MAAM,CAAC;wBACP,kDAAkD;wBAClD,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,KAAK,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,qEAAqE;gBACpI,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IAEK,qBAAqB,CAAC,cAA2C;QACvE,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC;QACvC,MAAM,OAAO,GAAkB,EAAE,CAAC;QAElC,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAElC,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACpC,MAAM,QAAQ,GAAG,GAAG,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;OAUG;IAEK,mBAAmB,CAAC,cAA8C;QACxE,MAAM,YAAY,GAAG,IAAI,GAAG,EAAE,CAAC;QAE/B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC1C,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YACpC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;OAQG;IAEK,wBAAwB,CAAC,MAAc;QAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,mEAAmE,CAAC,CAAC;QAChG,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;CACF"}

package/dist/client/core.d.ts

@@ -0,0 +1,37 @@
+import { AptosConfig } from "../api/aptosConfig.js";
+import { AptosRequest, AptosResponse, Client, ClientRequest, ClientResponse } from "../types/index.js";
+import { AptosApiType } from "../utils/index.js";
+/**
+ * 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.overrides.http2 - Whether to use HTTP/2 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.
+ * @group Implementation
+ * @category Client
+ */
+export declare function request<Req, Res>(options: ClientRequest<Req>, client: Client): Promise<ClientResponse<Res>>;
+/**
+ * The main function to use when making an API request, returning the response or throwing an AptosApiError on failure.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export declare function aptosRequest<Req extends {}, Res extends {}>(aptosRequestOpts: AptosRequest, aptosConfig: AptosConfig, apiType: AptosApiType): Promise<AptosResponse<Req, Res>>;
+//# sourceMappingURL=core.d.ts.map

package/dist/client/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/client/core.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAEL,YAAY,EACZ,aAAa,EACb,MAAM,EACN,aAAa,EACb,cAAc,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CA6BjH;AAED;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EAC/D,gBAAgB,EAAE,YAAY,EAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAoDlC"}

package/dist/client/core.js

@@ -0,0 +1,116 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { VERSION } from "../version.js";
+import { MimeType, } from "../types/index.js";
+import { AptosApiType } from "../utils/index.js";
+import { getRuntimePlatformTag } from "../utils/runtime.js";
+import { AptosApiError } from "../errors/index.js";
+/**
+ * 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.overrides.http2 - Whether to use HTTP/2 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.
+ * @group Implementation
+ * @category Client
+ */
+export async function request(options, client) {
+    const { url, method, body, contentType, params, overrides, originMethod } = options;
+    const headers = {
+        ...overrides?.HEADERS,
+        "x-aptos-client": `aptos-typescript-sdk/${VERSION}; platform=${getRuntimePlatformTag()}`,
+        "content-type": contentType ?? MimeType.JSON,
+        "x-aptos-typescript-sdk-origin-method": originMethod,
+    };
+    if (overrides?.AUTH_TOKEN) {
+        headers.Authorization = `Bearer ${overrides?.AUTH_TOKEN}`;
+    }
+    if (overrides?.API_KEY) {
+        headers.Authorization = `Bearer ${overrides?.API_KEY}`;
+    }
+    /*
+     * make a call using the @aptos-labs/aptos-client package
+     * {@link https://www.npmjs.com/package/@aptos-labs/aptos-client}
+     */
+    return client.provider({
+        url,
+        method,
+        body,
+        params,
+        headers,
+        overrides,
+        http2: overrides?.http2,
+    });
+}
+/**
+ * The main function to use when making an API request, returning the response or throwing an AptosApiError on failure.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export async function aptosRequest(aptosRequestOpts, aptosConfig, apiType) {
+    const { url, path } = aptosRequestOpts;
+    const fullUrl = path ? `${url}/${path}` : url;
+    const clientResponse = await request({ ...aptosRequestOpts, url: fullUrl }, aptosConfig.client);
+    const aptosResponse = {
+        status: clientResponse.status,
+        statusText: clientResponse.statusText ?? "No status text provided",
+        data: clientResponse.data,
+        headers: clientResponse.headers,
+        config: clientResponse.config,
+        request: clientResponse.request,
+        url: fullUrl,
+    };
+    // Handle case for `Unauthorized` error (i.e. API_KEY error)
+    if (aptosResponse.status === 401) {
+        throw new AptosApiError({ apiType, aptosRequest: aptosRequestOpts, aptosResponse });
+    }
+    // to support both fullnode and indexer responses,
+    // check if it is an indexer query, and adjust response.data
+    if (apiType === AptosApiType.INDEXER) {
+        const indexerResponse = aptosResponse.data;
+        // Only probe for `errors`/`data` keys on actual objects; `in` throws a
+        // `TypeError` on primitives/null and would mask the underlying API error.
+        if (typeof indexerResponse === "object" && indexerResponse !== null) {
+            // Handle Indexer general errors
+            if ("errors" in indexerResponse && indexerResponse.errors) {
+                throw new AptosApiError({
+                    apiType,
+                    aptosRequest: aptosRequestOpts,
+                    aptosResponse,
+                });
+            }
+            if ("data" in indexerResponse) {
+                aptosResponse.data = indexerResponse.data;
+            }
+        }
+    }
+    else if (apiType === AptosApiType.PEPPER || apiType === AptosApiType.PROVER) {
+        if (aptosResponse.status >= 400) {
+            throw new AptosApiError({ apiType, aptosRequest: aptosRequestOpts, aptosResponse });
+        }
+    }
+    if (aptosResponse.status >= 200 && aptosResponse.status < 300) {
+        return aptosResponse;
+    }
+    // We have to explicitly check for all request types, because if the error is a non-indexer error, but
+    // comes from an indexer request (e.g. 404), we'll need to mention it appropriately
+    throw new AptosApiError({ apiType, aptosRequest: aptosRequestOpts, aptosResponse });
+}
+//# sourceMappingURL=core.js.map

package/dist/client/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/client/core.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAOL,QAAQ,GACT,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAW,OAA2B,EAAE,MAAc;IACjF,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IACpF,MAAM,OAAO,GAA6D;QACxE,GAAG,SAAS,EAAE,OAAO;QACrB,gBAAgB,EAAE,wBAAwB,OAAO,cAAc,qBAAqB,EAAE,EAAE;QACxF,cAAc,EAAE,WAAW,IAAI,QAAQ,CAAC,IAAI;QAC5C,sCAAsC,EAAE,YAAY;KACrD,CAAC;IAEF,IAAI,SAAS,EAAE,UAAU,EAAE,CAAC;QAC1B,OAAO,CAAC,aAAa,GAAG,UAAU,SAAS,EAAE,UAAU,EAAE,CAAC;IAC5D,CAAC;IACD,IAAI,SAAS,EAAE,OAAO,EAAE,CAAC;QACvB,OAAO,CAAC,aAAa,GAAG,UAAU,SAAS,EAAE,OAAO,EAAE,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,OAAO,MAAM,CAAC,QAAQ,CAAW;QAC/B,GAAG;QACH,MAAM;QACN,IAAI;QACJ,MAAM;QACN,OAAO;QACP,SAAS;QACT,KAAK,EAAE,SAAS,EAAE,KAAK;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,gBAA8B,EAC9B,WAAwB,EACxB,OAAqB;IAErB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IAC9C,MAAM,cAAc,GAAG,MAAM,OAAO,CAAW,EAAE,GAAG,gBAAgB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAE1G,MAAM,aAAa,GAA4B;QAC7C,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,UAAU,EAAE,cAAc,CAAC,UAAU,IAAI,yBAAyB;QAClE,IAAI,EAAE,cAAc,CAAC,IAAI;QACzB,OAAO,EAAE,cAAc,CAAC,OAAO;QAC/B,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,OAAO,EAAE,cAAc,CAAC,OAAO;QAC/B,GAAG,EAAE,OAAO;KACb,CAAC;IAEF,4DAA4D;IAC5D,IAAI,aAAa,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QACjC,MAAM,IAAI,aAAa,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,kDAAkD;IAClD,4DAA4D;IAC5D,IAAI,OAAO,KAAK,YAAY,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,eAAe,GAAG,aAAa,CAAC,IAAI,CAAC;QAC3C,uEAAuE;QACvE,0EAA0E;QAC1E,IAAI,OAAO,eAAe,KAAK,QAAQ,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;YACpE,gCAAgC;YAChC,IAAI,QAAQ,IAAI,eAAe,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;gBAC1D,MAAM,IAAI,aAAa,CAAC;oBACtB,OAAO;oBACP,YAAY,EAAE,gBAAgB;oBAC9B,aAAa;iBACd,CAAC,CAAC;YACL,CAAC;YACD,IAAI,MAAM,IAAI,eAAe,EAAE,CAAC;gBAC9B,aAAa,CAAC,IAAI,GAAG,eAAe,CAAC,IAAW,CAAC;YACnD,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,OAAO,KAAK,YAAY,CAAC,MAAM,IAAI,OAAO,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;QAC9E,IAAI,aAAa,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAChC,MAAM,IAAI,aAAa,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAED,IAAI,aAAa,CAAC,MAAM,IAAI,GAAG,IAAI,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QAC9D,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,sGAAsG;IACtG,mFAAmF;IACnF,MAAM,IAAI,aAAa,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC,CAAC;AACtF,CAAC"}

package/dist/client/get.d.ts

@@ -0,0 +1,119 @@
+import { AptosConfig } from "../api/aptosConfig.js";
+import { AptosResponse, AnyNumber, ClientConfig, MimeType } from "../types/index.js";
+import { AptosApiType } from "../utils/const.js";
+/**
+ * Options for making a GET request, including configuration for the API client.
+ * @group Implementation
+ * @category Client
+ */
+export type GetRequestOptions = {
+    /**
+     * The config for the API client
+     * @group Implementation
+     * @category Client
+     */
+    aptosConfig: AptosConfig;
+    /**
+     * The type of API endpoint to call e.g. fullnode, indexer, etc
+     * @group Implementation
+     * @category Client
+     */
+    type: AptosApiType;
+    /**
+     * The name of the API method
+     * @group Implementation
+     * @category Client
+     */
+    originMethod: string;
+    /**
+     * The URL path to the API method
+     * @group Implementation
+     * @category Client
+     */
+    path: string;
+    /**
+     * The content type of the request body
+     * @group Implementation
+     * @category Client
+     */
+    contentType?: MimeType;
+    /**
+     * The accepted content type of the response of the API
+     * @group Implementation
+     * @category Client
+     */
+    acceptType?: MimeType;
+    /**
+     * The query parameters for the request
+     * @group Implementation
+     * @category Client
+     */
+    params?: Record<string, string | AnyNumber | boolean | undefined>;
+    /**
+     * Specific client overrides for this request to override aptosConfig
+     * @group Implementation
+     * @category Client
+     */
+    overrides?: ClientConfig;
+};
+/**
+ * Options for making a request to the Aptos API, excluding the "type" field.
+ * @group Implementation
+ * @category Client
+ */
+export type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
+/**
+ * Executes a GET request to retrieve data based on the provided options.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export 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.
+ * @group Implementation
+ * @category Client
+ */
+export declare function getAptosFullNode<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Makes a GET request to the Aptos Pepper service to retrieve data.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export declare function getAptosPepperService<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * This function is a helper for paginating using a function wrapping an API
+ * @group Implementation
+ * @category Client
+ */
+export declare function paginateWithCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<Res>;
+export declare function paginateWithObfuscatedCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<Res>;
+export declare function getPageWithObfuscatedCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<{
+    response: AptosResponse<Req, Res>;
+    cursor: string | undefined;
+}>;
+//# sourceMappingURL=get.d.ts.map

package/dist/client/get.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../src/client/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;;;OAIG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;IAClE;;;;OAIG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAErE;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,GAAG,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EACtD,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAqBlC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,gBAAgB,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EACnE,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAalC;AAED;;;;;;;;;GASG;AACH,wBAAsB,qBAAqB,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EACxE,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAElC;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,SAAS,KAAK,CAAC,EAAE,CAAC,EAC7F,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,GAAG,CAAC,CA4Bd;AAGD,wBAAsB,4BAA4B,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,SAAS,KAAK,CAAC,EAAE,CAAC,EACvG,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,GAAG,CAAC,CA8Bd;AAED,wBAAsB,2BAA2B,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,SAAS,KAAK,CAAC,EAAE,CAAC,EACtG,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC;IAAE,QAAQ,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC,CA2B5E"}