@aptos-labs/ts-sdk 6.3.1 → 7.0.1

package/dist/api/aptosConfig.js

@@ -0,0 +1,316 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import aptosClient from "@aptos-labs/aptos-client";
+import { NetworkToNodeAPI, NetworkToFaucetAPI, NetworkToIndexerAPI, Network, NetworkToPepperAPI, NetworkToProverAPI, } from "../utils/apiEndpoints.js";
+import { AptosApiType, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_TXN_EXP_SEC_FROM_NOW } from "../utils/const.js";
+import { isBun } from "../utils/helpers.js";
+/**
+ * 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";
+ *
+ * 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);
+ * ```
+ * @group Client
+ */
+export class AptosConfig {
+    /**
+     * The Network that this SDK is associated with. Defaults to DEVNET
+     * @group Client
+     */
+    network;
+    /**
+     * The client instance the SDK uses. Defaults to `@aptos-labs/aptos-client
+     * @group Client
+     */
+    client;
+    /**
+     * The optional hardcoded fullnode URL to send requests to instead of using the network
+     * @group Client
+     */
+    fullnode;
+    /**
+     * The optional hardcoded faucet URL to send requests to instead of using the network
+     * @group Client
+     */
+    faucet;
+    /**
+     * The optional hardcoded pepper service URL to send requests to instead of using the network
+     * @group Client
+     */
+    pepper;
+    /**
+     * The optional hardcoded prover service URL to send requests to instead of using the network
+     * @group Client
+     */
+    prover;
+    /**
+     * The optional hardcoded indexer URL to send requests to instead of using the network
+     * @group Client
+     */
+    indexer;
+    /**
+     * Optional client configurations
+     * @group Client
+     */
+    clientConfig;
+    /**
+     * Optional specific Fullnode configurations
+     * @group Client
+     */
+    fullnodeConfig;
+    /**
+     * Optional specific Indexer configurations
+     * @group Client
+     */
+    indexerConfig;
+    /**
+     * Optional specific Faucet configurations
+     * @group Client
+     */
+    faucetConfig;
+    /**
+     * Optional specific Transaction Generation configurations
+     * @group Client
+     */
+    transactionGenerationConfig;
+    /**
+     * Optional plugin config to override client behavior.
+     * @group Client
+     */
+    pluginConfig;
+    /**
+     * 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);
+     * ```
+     * @group Client
+     */
+    constructor(settings) {
+        // If there are any endpoint overrides, they are custom networks, keep that in mind
+        if (settings?.fullnode || settings?.indexer || settings?.faucet || settings?.pepper || settings?.prover) {
+            if (settings?.network === Network.CUSTOM) {
+                console.info("Note: using CUSTOM network will require queries to lookup ChainId");
+            }
+            else if (!settings?.network) {
+                throw new Error("Custom endpoints require a network to be specified");
+            }
+        }
+        // Warn Bun users about HTTP/2 compatibility issues.
+        // Bun's HTTP/2 support is not fully mature yet, so we recommend disabling it.
+        if (isBun() && settings?.clientConfig?.http2 !== false) {
+            console.warn("[Aptos SDK] Bun does not fully support HTTP/2, which is enabled by default in this SDK. " +
+                "It is recommended to disable HTTP/2 by setting `clientConfig: { http2: false }` in your AptosConfig. " +
+                "For example: new AptosConfig({ network: Network.TESTNET, clientConfig: { http2: false } })");
+        }
+        this.network = settings?.network ?? Network.DEVNET;
+        this.fullnode = settings?.fullnode;
+        this.faucet = settings?.faucet;
+        this.pepper = settings?.pepper;
+        this.prover = settings?.prover;
+        this.indexer = settings?.indexer;
+        // Type assertion needed: @aptos-labs/aptos-client's types don't resolve
+        // correctly under nodenext module resolution
+        this.client = settings?.client ?? { provider: aptosClient };
+        this.clientConfig = settings?.clientConfig ?? {};
+        this.fullnodeConfig = settings?.fullnodeConfig ?? {};
+        this.indexerConfig = settings?.indexerConfig ?? {};
+        this.faucetConfig = settings?.faucetConfig ?? {};
+        this.transactionGenerationConfig = settings?.transactionGenerationConfig ?? {};
+        this.pluginConfig = settings?.pluginSettings
+            ? {
+                ...settings.pluginSettings,
+                IGNORE_TRANSACTION_SUBMITTER: false,
+            }
+            : undefined;
+    }
+    /**
+     * 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.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, AptosApiType } from "@aptos-labs/ts-sdk";
+     *
+     * 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);
+     * ```
+     * @group Client
+     */
+    getRequestUrl(apiType) {
+        switch (apiType) {
+            case AptosApiType.FULLNODE:
+                if (this.fullnode !== undefined)
+                    return this.fullnode;
+                if (this.network === Network.CUSTOM)
+                    throw new Error("Please provide a custom full node url");
+                return NetworkToNodeAPI[this.network];
+            case AptosApiType.FAUCET:
+                if (this.faucet !== undefined)
+                    return this.faucet;
+                if (this.network === Network.TESTNET) {
+                    throw new Error("There is no way to programmatically mint testnet APT, you must use the minting site at https://aptos.dev/network/faucet");
+                }
+                if (this.network === Network.MAINNET) {
+                    throw new Error("There is no mainnet faucet");
+                }
+                if (this.network === Network.CUSTOM)
+                    throw new Error("Please provide a custom faucet url");
+                return NetworkToFaucetAPI[this.network];
+            case AptosApiType.INDEXER:
+                if (this.indexer !== undefined)
+                    return this.indexer;
+                if (this.network === Network.CUSTOM)
+                    throw new Error("Please provide a custom indexer url");
+                return NetworkToIndexerAPI[this.network];
+            case AptosApiType.PEPPER:
+                if (this.pepper !== undefined)
+                    return this.pepper;
+                if (this.network === Network.CUSTOM)
+                    throw new Error("Please provide a custom pepper service url");
+                return NetworkToPepperAPI[this.network];
+            case AptosApiType.PROVER:
+                if (this.prover !== undefined)
+                    return this.prover;
+                if (this.network === Network.CUSTOM)
+                    throw new Error("Please provide a custom prover service url");
+                return NetworkToProverAPI[this.network];
+            default:
+                throw new Error(`apiType ${apiType} is not supported`);
+        }
+    }
+    /**
+     * Checks if the provided URL is a known pepper service endpoint.
+     *
+     * @param url - The URL to check against the known pepper service endpoints.
+     *
+     * @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);
+     * ```
+     * @group Client
+     */
+    isPepperServiceRequest(url) {
+        return NetworkToPepperAPI[this.network] === url;
+    }
+    /**
+     * Checks if the provided URL is a known prover service endpoint.
+     *
+     * @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}`);
+     * ```
+     * @group Client
+     */
+    isProverServiceRequest(url) {
+        return NetworkToProverAPI[this.network] === url;
+    }
+    getDefaultMaxGasAmount() {
+        return this.transactionGenerationConfig?.defaultMaxGasAmount ?? DEFAULT_MAX_GAS_AMOUNT;
+    }
+    getDefaultTxnExpirySecFromNow() {
+        return this.transactionGenerationConfig?.defaultTxnExpirySecFromNow ?? DEFAULT_TXN_EXP_SEC_FROM_NOW;
+    }
+    /**
+     * If you have set a custom transaction submitter, you can use this to determine
+     * whether to use it or not. For example, to stop using the transaction submitter:
+     *
+     * @example
+     * ```
+     * aptos.config.setIgnoreTransactionSubmitter(true);
+     * ```
+     *
+     * @group Client
+     */
+    setIgnoreTransactionSubmitter(ignore) {
+        if (this.pluginConfig) {
+            this.pluginConfig.IGNORE_TRANSACTION_SUBMITTER = ignore;
+        }
+    }
+    /**
+     * If a custom transaction submitter has been specified in the PluginConfig and
+     * IGNORE_TRANSACTION_SUBMITTER is false, this will return a transaction submitter
+     * that should be used instead of the default transaction submission behavior.
+     */
+    getTransactionSubmitter() {
+        if (this.pluginConfig === undefined) {
+            return undefined;
+        }
+        if (this.pluginConfig.IGNORE_TRANSACTION_SUBMITTER === true) {
+            return undefined;
+        }
+        return this.pluginConfig.TRANSACTION_SUBMITTER;
+    }
+}
+//# sourceMappingURL=aptosConfig.js.map

package/dist/api/aptosConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aptosConfig.js","sourceRoot":"","sources":["../../src/api/aptosConfig.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,WAAW,MAAM,0BAA0B,CAAC;AAYnD,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,OAAO,EACP,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACM,OAAO,CAAU;IAE1B;;;OAGG;IACM,MAAM,CAAS;IAExB;;;OAGG;IACM,QAAQ,CAAU;IAE3B;;;OAGG;IACM,MAAM,CAAU;IAEzB;;;OAGG;IACM,MAAM,CAAU;IAEzB;;;OAGG;IACM,MAAM,CAAU;IAEzB;;;OAGG;IACM,OAAO,CAAU;IAE1B;;;OAGG;IACM,YAAY,CAAgB;IAErC;;;OAGG;IACM,cAAc,CAAkB;IAEzC;;;OAGG;IACM,aAAa,CAAiB;IAEvC;;;OAGG;IACM,YAAY,CAAgB;IAErC;;;OAGG;IACM,2BAA2B,CAA+B;IAEnE;;;OAGG;IACK,YAAY,CAAgB;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,YAAY,QAAwB;QAClC,mFAAmF;QACnF,IAAI,QAAQ,EAAE,QAAQ,IAAI,QAAQ,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,IAAI,QAAQ,EAAE,MAAM,IAAI,QAAQ,EAAE,MAAM,EAAE,CAAC;YACxG,IAAI,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;gBACzC,OAAO,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;YACpF,CAAC;iBAAM,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;QAED,oDAAoD;QACpD,8EAA8E;QAC9E,IAAI,KAAK,EAAE,IAAI,QAAQ,EAAE,YAAY,EAAE,KAAK,KAAK,KAAK,EAAE,CAAC;YACvD,OAAO,CAAC,IAAI,CACV,0FAA0F;gBACxF,uGAAuG;gBACvG,4FAA4F,CAC/F,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,QAAQ,EAAE,QAAQ,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,QAAQ,EAAE,MAAM,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,QAAQ,EAAE,MAAM,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,QAAQ,EAAE,MAAM,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,OAAO,CAAC;QACjC,wEAAwE;QACxE,6CAA6C;QAC7C,IAAI,CAAC,MAAM,GAAG,QAAQ,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;QAC5D,IAAI,CAAC,YAAY,GAAG,QAAQ,EAAE,YAAY,IAAI,EAAE,CAAC;QACjD,IAAI,CAAC,cAAc,GAAG,QAAQ,EAAE,cAAc,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,aAAa,GAAG,QAAQ,EAAE,aAAa,IAAI,EAAE,CAAC;QACnD,IAAI,CAAC,YAAY,GAAG,QAAQ,EAAE,YAAY,IAAI,EAAE,CAAC;QACjD,IAAI,CAAC,2BAA2B,GAAG,QAAQ,EAAE,2BAA2B,IAAI,EAAE,CAAC;QAC/E,IAAI,CAAC,YAAY,GAAG,QAAQ,EAAE,cAAc;YAC1C,CAAC,CAAC;gBACE,GAAG,QAAQ,CAAC,cAAc;gBAC1B,4BAA4B,EAAE,KAAK;aACpC;YACH,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,aAAa,CAAC,OAAqB;QACjC,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,YAAY,CAAC,QAAQ;gBACxB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;oBAAE,OAAO,IAAI,CAAC,QAAQ,CAAC;gBACtD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM;oBAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC9F,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxC,KAAK,YAAY,CAAC,MAAM;gBACtB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;oBAAE,OAAO,IAAI,CAAC,MAAM,CAAC;gBAClD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC;oBACrC,MAAM,IAAI,KAAK,CACb,yHAAyH,CAC1H,CAAC;gBACJ,CAAC;gBACD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC;oBACrC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;gBAChD,CAAC;gBACD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM;oBAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBAC3F,OAAO,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1C,KAAK,YAAY,CAAC,OAAO;gBACvB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;oBAAE,OAAO,IAAI,CAAC,OAAO,CAAC;gBACpD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM;oBAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;gBAC5F,OAAO,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3C,KAAK,YAAY,CAAC,MAAM;gBACtB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;oBAAE,OAAO,IAAI,CAAC,MAAM,CAAC;gBAClD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM;oBAAE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBACnG,OAAO,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1C,KAAK,YAAY,CAAC,MAAM;gBACtB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;oBAAE,OAAO,IAAI,CAAC,MAAM,CAAC;gBAClD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,MAAM;oBAAE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBACnG,OAAO,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1C;gBACE,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,mBAAmB,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,sBAAsB,CAAC,GAAW;QAChC,OAAO,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,sBAAsB,CAAC,GAAW;QAChC,OAAO,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC;IAClD,CAAC;IAED,sBAAsB;QACpB,OAAO,IAAI,CAAC,2BAA2B,EAAE,mBAAmB,IAAI,sBAAsB,CAAC;IACzF,CAAC;IAED,6BAA6B;QAC3B,OAAO,IAAI,CAAC,2BAA2B,EAAE,0BAA0B,IAAI,4BAA4B,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IACH,6BAA6B,CAAC,MAAe;QAC3C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,uBAAuB;QACrB,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,4BAA4B,KAAK,IAAI,EAAE,CAAC;YAC5D,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC;IACjD,CAAC;CACF"}

package/dist/api/coin.d.ts

@@ -0,0 +1,77 @@
+import { AccountAddressInput } from "../core/index.js";
+import { SimpleTransaction } from "../transactions/instances/simpleTransaction.js";
+import { InputGenerateTransactionOptions } from "../transactions/types.js";
+import { AnyNumber, MoveStructId } from "../types/index.js";
+import { AptosConfig } from "./aptosConfig.js";
+/**
+ * A class to handle all `Coin` operations.
+ * @group Coin
+ */
+export declare class Coin {
+    readonly config: AptosConfig;
+    /**
+     * 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
+     * ```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);
+     * ```
+     * @group Coin
+     */
+    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 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);
+     * ```
+     * @group Coin
+     */
+    transferCoinTransaction(args: {
+        sender: AccountAddressInput;
+        recipient: AccountAddressInput;
+        amount: AnyNumber;
+        coinType?: MoveStructId;
+        options?: InputGenerateTransactionOptions;
+    }): Promise<SimpleTransaction>;
+}
+//# sourceMappingURL=coin.d.ts.map

package/dist/api/coin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coin.d.ts","sourceRoot":"","sources":["../../src/api/coin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAC;AACnF,OAAO,EAAE,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;GAGG;AACH,qBAAa,IAAI;IAsBH,QAAQ,CAAC,MAAM,EAAE,WAAW;IArBxC;;;;;;;;;;;;;;;;;;;;OAoBG;gBACkB,MAAM,EAAE,WAAW;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,uBAAuB,CAAC,IAAI,EAAE;QAClC,MAAM,EAAE,mBAAmB,CAAC;QAC5B,SAAS,EAAE,mBAAmB,CAAC;QAC/B,MAAM,EAAE,SAAS,CAAC;QAClB,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,OAAO,CAAC,EAAE,+BAA+B,CAAC;KAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAG/B"}

package/dist/api/coin.js

@@ -0,0 +1,73 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { transferCoinTransaction } from "../internal/coin.js";
+/**
+ * A class to handle all `Coin` operations.
+ * @group Coin
+ */
+export class Coin {
+    config;
+    /**
+     * 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
+     * ```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);
+     * ```
+     * @group Coin
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * 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 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);
+     * ```
+     * @group Coin
+     */
+    async transferCoinTransaction(args) {
+        return transferCoinTransaction({ aptosConfig: this.config, ...args });
+    }
+}
+//# sourceMappingURL=coin.js.map

package/dist/api/coin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coin.js","sourceRoot":"","sources":["../../src/api/coin.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAM9D;;;GAGG;AACH,MAAM,OAAO,IAAI;IAsBM;IArBrB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,uBAAuB,CAAC,IAM7B;QACC,OAAO,uBAAuB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}