@aptos-labs/ts-sdk 6.3.0 → 7.0.0

package/dist/client/get.js

@@ -0,0 +1,165 @@
+import { aptosRequest } from "./core.js";
+import { AptosApiType } from "../utils/const.js";
+/**
+ * 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 async function get(options) {
+    const { aptosConfig, overrides, params, contentType, acceptType, path, originMethod, type } = options;
+    const url = aptosConfig.getRequestUrl(type);
+    return aptosRequest({
+        url,
+        method: "GET",
+        originMethod,
+        path,
+        contentType,
+        acceptType,
+        params,
+        overrides: {
+            ...aptosConfig.clientConfig,
+            ...overrides,
+        },
+    }, aptosConfig, options.type);
+}
+/**
+ * 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 async function getAptosFullNode(options) {
+    const { aptosConfig } = options;
+    return get({
+        ...options,
+        type: AptosApiType.FULLNODE,
+        overrides: {
+            ...aptosConfig.clientConfig,
+            ...aptosConfig.fullnodeConfig,
+            ...options.overrides,
+            HEADERS: { ...aptosConfig.clientConfig?.HEADERS, ...aptosConfig.fullnodeConfig?.HEADERS },
+        },
+    });
+}
+/**
+ * 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 async function getAptosPepperService(options) {
+    return get({ ...options, type: AptosApiType.PEPPER });
+}
+/**
+ * This function is a helper for paginating using a function wrapping an API
+ * @group Implementation
+ * @category Client
+ */
+export async function paginateWithCursor(options) {
+    let out = [];
+    let cursor;
+    const requestParams = options.params;
+    do {
+        const response = await getAptosFullNode({
+            aptosConfig: options.aptosConfig,
+            originMethod: options.originMethod,
+            path: options.path,
+            params: requestParams,
+            overrides: options.overrides,
+        });
+        /**
+         * the cursor is a "state key" from the API perspective. Client
+         * should not need to "care" what it represents but just use it
+         * to query the next chunk of data.
+         * @group Implementation
+         * @category Client
+         */
+        cursor = response.headers["x-aptos-cursor"];
+        // Now that we have the cursor (if any), we remove the headers before
+        // adding these to the output of this function.
+        delete response.headers;
+        // Use concat instead of push(...) for better performance with large arrays
+        out = out.concat(response.data);
+        requestParams.start = cursor;
+    } while (cursor !== null && cursor !== undefined);
+    return out;
+}
+/// This function is a helper for paginating using a function wrapping an API using offset instead of start
+export async function paginateWithObfuscatedCursor(options) {
+    let out = [];
+    let cursor;
+    const requestParams = options.params;
+    const totalLimit = requestParams.limit;
+    do {
+        const { response, cursor: newCursor } = await getPageWithObfuscatedCursor({ ...options });
+        /**
+         * the cursor is a "state key" from the API perspective. Client
+         * should not need to "care" what it represents but just use it
+         * to query the next chunk of data.
+         */
+        cursor = newCursor;
+        // Use concat instead of push(...) for better performance with large arrays
+        out = out.concat(response.data);
+        if (options?.params) {
+            options.params.start = cursor;
+        }
+        // Re-evaluate length
+        if (totalLimit !== undefined) {
+            const newLimit = totalLimit - out.length;
+            if (newLimit <= 0) {
+                break;
+            }
+            requestParams.limit = newLimit;
+        }
+    } while (cursor !== null && cursor !== undefined);
+    return out;
+}
+export async function getPageWithObfuscatedCursor(options) {
+    const requestParams = {};
+    // Drop any other values
+    // TODO: Throw error if cursor is not a string
+    if (typeof options.params?.cursor === "string") {
+        requestParams.start = options.params.cursor;
+    }
+    if (typeof options.params?.limit === "number") {
+        requestParams.limit = options.params.limit;
+    }
+    const response = await getAptosFullNode({
+        aptosConfig: options.aptosConfig,
+        originMethod: options.originMethod,
+        path: options.path,
+        params: requestParams,
+        overrides: options.overrides,
+    });
+    /**
+     * the cursor is a "state key" from the API perspective. Client
+     * should not need to "care" what it represents but just use it
+     * to query the next chunk of data.
+     */
+    const cursor = response.headers["x-aptos-cursor"] ?? undefined;
+    return { response, cursor };
+}
+//# sourceMappingURL=get.js.map

package/dist/client/get.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../src/client/get.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAiEjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CACvB,OAA0B;IAE1B,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACtG,MAAM,GAAG,GAAG,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAE5C,OAAO,YAAY,CACjB;QACE,GAAG;QACH,MAAM,EAAE,KAAK;QACb,YAAY;QACZ,IAAI;QACJ,WAAW;QACX,UAAU;QACV,MAAM;QACN,SAAS,EAAE;YACT,GAAG,WAAW,CAAC,YAAY;YAC3B,GAAG,SAAS;SACb;KACF,EACD,WAAW,EACX,OAAO,CAAC,IAAI,CACb,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAA+B;IAE/B,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhC,OAAO,GAAG,CAAW;QACnB,GAAG,OAAO;QACV,IAAI,EAAE,YAAY,CAAC,QAAQ;QAC3B,SAAS,EAAE;YACT,GAAG,WAAW,CAAC,YAAY;YAC3B,GAAG,WAAW,CAAC,cAAc;YAC7B,GAAG,OAAO,CAAC,SAAS;YACpB,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,cAAc,EAAE,OAAO,EAAE;SAC1F;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAA+B;IAE/B,OAAO,GAAG,CAAW,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,OAA+B;IAE/B,IAAI,GAAG,GAAQ,EAAoB,CAAC;IACpC,IAAI,MAA0B,CAAC;IAC/B,MAAM,aAAa,GAAG,OAAO,CAAC,MAA4C,CAAC;IAC3E,GAAG,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAW;YAChD,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,MAAM,EAAE,aAAa;YACrB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC,CAAC;QACH;;;;;;WAMG;QACH,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC5C,qEAAqE;QACrE,+CAA+C;QAC/C,OAAO,QAAQ,CAAC,OAAO,CAAC;QACxB,2EAA2E;QAC3E,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAQ,CAAC;QACvC,aAAa,CAAC,KAAK,GAAG,MAAM,CAAC;IAC/B,CAAC,QAAQ,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE;IAClD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,2GAA2G;AAC3G,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,OAA+B;IAE/B,IAAI,GAAG,GAAQ,EAAoB,CAAC;IACpC,IAAI,MAA0B,CAAC;IAC/B,MAAM,aAAa,GAAG,OAAO,CAAC,MAA4C,CAAC;IAC3E,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC;IACvC,GAAG,CAAC;QACF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,2BAA2B,CAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAEpG;;;;WAIG;QACH,MAAM,GAAG,SAAS,CAAC;QACnB,2EAA2E;QAC3E,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAQ,CAAC;QACvC,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;QAChC,CAAC;QAED,qBAAqB;QACrB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC;YACzC,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;gBAClB,MAAM;YACR,CAAC;YACD,aAAa,CAAC,KAAK,GAAG,QAAQ,CAAC;QACjC,CAAC;IACH,CAAC,QAAQ,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE;IAClD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,OAA+B;IAE/B,MAAM,aAAa,GAAuC,EAAE,CAAC;IAE7D,wBAAwB;IACxB,8CAA8C;IAC9C,IAAI,OAAO,OAAO,CAAC,MAAM,EAAE,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/C,aAAa,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9C,CAAC;IACD,IAAI,OAAO,OAAO,CAAC,MAAM,EAAE,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9C,aAAa,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;IAC7C,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAW;QAChD,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;IAEH;;;;OAIG;IACH,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,SAAS,CAAC;IAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AAC9B,CAAC"}

package/dist/client/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./core.js";
+export * from "./get.js";
+export * from "./post.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAGA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}

package/dist/client/index.js

@@ -0,0 +1,6 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+export * from "./core.js";
+export * from "./get.js";
+export * from "./post.js";
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}

package/dist/client/post.d.ts

@@ -0,0 +1,155 @@
+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 POST request, including the API client configuration.
+ * @group Implementation
+ * @category Client
+ */
+export type PostRequestOptions = {
+    /**
+     * 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>;
+    /**
+     * The body of the request, should match the content type of the request
+     * @group Implementation
+     * @category Client
+     */
+    body?: any;
+    /**
+     * Specific client overrides for this request to override aptosConfig
+     * @group Implementation
+     * @category Client
+     */
+    overrides?: ClientConfig;
+};
+/**
+ * Options for posting a request to Aptos, excluding the type field.
+ * @group Implementation
+ * @category Client
+ */
+export type PostAptosRequestOptions = Omit<PostRequestOptions, "type">;
+/**
+ * Executes a POST request to the specified URL with the provided options.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export 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.
+ * @group Implementation
+ * @category Client
+ */
+export 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.
+ * @group Implementation
+ * @category Client
+ */
+export 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.
+ *
+ * Note that only devnet has a publicly accessible faucet. For testnet, you must use
+ * the minting page at https://aptos.dev/network/faucet.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export declare function postAptosFaucet<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * Makes a post request to the pepper service.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export 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.
+ * @group Implementation
+ * @category Client
+ */
+export declare function postAptosProvingService<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+//# sourceMappingURL=post.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"post.d.ts","sourceRoot":"","sources":["../../src/client/post.ts"],"names":[],"mappings":"AAGA,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,kBAAkB,GAAG;IAC/B;;;;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,IAAI,CAAC,EAAE,GAAG,CAAC;IACX;;;;OAIG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,IAAI,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EACvD,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAmBlC;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EACpE,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAalC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,gBAAgB,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EACnE,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAalC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,eAAe,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EAClE,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAqBlC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,sBAAsB,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EACzE,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAElC;AAED;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAAC,GAAG,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE,EAC1E,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAElC"}

package/dist/client/post.js

@@ -0,0 +1,151 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { aptosRequest } from "./core.js";
+import { AptosApiType } from "../utils/const.js";
+/**
+ * Executes a POST request to the specified URL with the provided options.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export async function post(options) {
+    const { type, originMethod, path, body, acceptType, contentType, params, aptosConfig, overrides } = options;
+    const url = aptosConfig.getRequestUrl(type);
+    return aptosRequest({
+        url,
+        method: "POST",
+        originMethod,
+        path,
+        body,
+        contentType,
+        acceptType,
+        params,
+        overrides,
+    }, aptosConfig, options.type);
+}
+/**
+ * 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.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosFullNode(options) {
+    const { aptosConfig } = options;
+    return post({
+        ...options,
+        type: AptosApiType.FULLNODE,
+        overrides: {
+            ...aptosConfig.clientConfig,
+            ...aptosConfig.fullnodeConfig,
+            ...options.overrides,
+            HEADERS: { ...aptosConfig.clientConfig?.HEADERS, ...aptosConfig.fullnodeConfig?.HEADERS },
+        },
+    });
+}
+/**
+ * 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.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosIndexer(options) {
+    const { aptosConfig } = options;
+    return post({
+        ...options,
+        type: AptosApiType.INDEXER,
+        overrides: {
+            ...aptosConfig.clientConfig,
+            ...aptosConfig.indexerConfig,
+            ...options.overrides,
+            HEADERS: { ...aptosConfig.clientConfig?.HEADERS, ...aptosConfig.indexerConfig?.HEADERS },
+        },
+    });
+}
+/**
+ * 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.
+ *
+ * Note that only devnet has a publicly accessible faucet. For testnet, you must use
+ * the minting page at https://aptos.dev/network/faucet.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosFaucet(options) {
+    const { aptosConfig } = options;
+    // Faucet does not support API_KEY
+    // Create a new object with the desired modification
+    const modifiedAptosConfig = {
+        ...aptosConfig,
+        clientConfig: { ...aptosConfig.clientConfig },
+    };
+    // Delete API_KEY config
+    delete modifiedAptosConfig?.clientConfig?.API_KEY;
+    return post({
+        ...options,
+        type: AptosApiType.FAUCET,
+        overrides: {
+            ...modifiedAptosConfig.clientConfig,
+            ...modifiedAptosConfig.faucetConfig,
+            ...options.overrides,
+            HEADERS: { ...modifiedAptosConfig.clientConfig?.HEADERS, ...modifiedAptosConfig.faucetConfig?.HEADERS },
+        },
+    });
+}
+/**
+ * Makes a post request to the pepper service.
+ *
+ * @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.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosPepperService(options) {
+    return post({ ...options, type: AptosApiType.PEPPER });
+}
+/**
+ * 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.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosProvingService(options) {
+    return post({ ...options, type: AptosApiType.PROVER });
+}
+//# sourceMappingURL=post.js.map

package/dist/client/post.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"post.js","sourceRoot":"","sources":["../../src/client/post.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAuEjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,OAA2B;IAE3B,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAC5G,MAAM,GAAG,GAAG,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAE5C,OAAO,YAAY,CACjB;QACE,GAAG;QACH,MAAM,EAAE,MAAM;QACd,YAAY;QACZ,IAAI;QACJ,IAAI;QACJ,WAAW;QACX,UAAU;QACV,MAAM;QACN,SAAS;KACV,EACD,WAAW,EACX,OAAO,CAAC,IAAI,CACb,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAgC;IAEhC,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhC,OAAO,IAAI,CAAW;QACpB,GAAG,OAAO;QACV,IAAI,EAAE,YAAY,CAAC,QAAQ;QAC3B,SAAS,EAAE;YACT,GAAG,WAAW,CAAC,YAAY;YAC3B,GAAG,WAAW,CAAC,cAAc;YAC7B,GAAG,OAAO,CAAC,SAAS;YACpB,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,cAAc,EAAE,OAAO,EAAE;SAC1F;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAgC;IAEhC,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhC,OAAO,IAAI,CAAW;QACpB,GAAG,OAAO;QACV,IAAI,EAAE,YAAY,CAAC,OAAO;QAC1B,SAAS,EAAE;YACT,GAAG,WAAW,CAAC,YAAY;YAC3B,GAAG,WAAW,CAAC,aAAa;YAC5B,GAAG,OAAO,CAAC,SAAS;YACpB,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,aAAa,EAAE,OAAO,EAAE;SACzF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAgC;IAEhC,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAChC,kCAAkC;IAClC,oDAAoD;IACpD,MAAM,mBAAmB,GAAG;QAC1B,GAAG,WAAW;QACd,YAAY,EAAE,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE;KAC9C,CAAC;IACF,wBAAwB;IACxB,OAAO,mBAAmB,EAAE,YAAY,EAAE,OAAO,CAAC;IAElD,OAAO,IAAI,CAAW;QACpB,GAAG,OAAO;QACV,IAAI,EAAE,YAAY,CAAC,MAAM;QACzB,SAAS,EAAE;YACT,GAAG,mBAAmB,CAAC,YAAY;YACnC,GAAG,mBAAmB,CAAC,YAAY;YACnC,GAAG,OAAO,CAAC,SAAS;YACpB,OAAO,EAAE,EAAE,GAAG,mBAAmB,CAAC,YAAY,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,YAAY,EAAE,OAAO,EAAE;SACxG;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAgC;IAEhC,OAAO,IAAI,CAAW,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;AACnE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,OAAgC;IAEhC,OAAO,IAAI,CAAW,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;AACnE,CAAC"}

package/dist/core/account/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./utils/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/core/account/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/account/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/core/account/index.js

@@ -0,0 +1,2 @@
+export * from "./utils/index.js";
+//# sourceMappingURL=index.js.map

package/dist/core/account/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/account/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/core/account/utils/address.d.ts

@@ -0,0 +1,47 @@
+import { AccountAddress } from "../../accountAddress.js";
+/**
+ * Creates an object address from creator address and seed
+ *
+ * @param creatorAddress The object creator account address
+ * @param seed The seed in either Uint8Array | string type
+ *
+ * @returns The object account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export declare const createObjectAddress: (creatorAddress: AccountAddress, seed: Uint8Array | string) => AccountAddress;
+/**
+ * Creates a resource address from creator address and seed
+ *
+ * @param creatorAddress The creator account address
+ * @param seed The seed in either Uint8Array | string type
+ *
+ * @returns The resource account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export declare const createResourceAddress: (creatorAddress: AccountAddress, seed: Uint8Array | string) => AccountAddress;
+/**
+ * Creates a user derived object address from source address and derive_from address
+ *
+ * @param sourceAddress The source account address
+ * @param deriveFromAddress The address to derive from
+ *
+ * @returns The user derived object address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export declare const createUserDerivedObjectAddress: (sourceAddress: AccountAddress, deriveFromAddress: AccountAddress) => AccountAddress;
+/**
+ * Creates a token object address from creator address, collection name and token name
+ *
+ * @param creatorAddress The token creator account address
+ * @param collectionName The collection name
+ * @param tokenName The token name
+ *
+ * @returns The token account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export declare const createTokenAddress: (creatorAddress: AccountAddress, collectionName: string, tokenName: string) => AccountAddress;
+//# sourceMappingURL=address.d.ts.map

package/dist/core/account/utils/address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../../../../src/core/account/utils/address.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAIzD;;;;;;;;;GASG;AACH,eAAO,MAAM,mBAAmB,GAAI,gBAAgB,cAAc,EAAE,MAAM,UAAU,GAAG,MAAM,KAAG,cAO/F,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,GAAI,gBAAgB,cAAc,EAAE,MAAM,UAAU,GAAG,MAAM,KAAG,cAQjG,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,8BAA8B,GACzC,eAAe,cAAc,EAC7B,mBAAmB,cAAc,KAChC,cAOF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,GAC7B,gBAAgB,cAAc,EAC9B,gBAAgB,MAAM,EACtB,WAAW,MAAM,KAChB,cAGF,CAAC"}

package/dist/core/account/utils/address.js

@@ -0,0 +1,68 @@
+import { sha3_256 } from "@noble/hashes/sha3.js";
+import { AccountAddress } from "../../accountAddress.js";
+import { DeriveScheme } from "../../../types/index.js";
+import { TEXT_ENCODER } from "../../../utils/const.js";
+/**
+ * Creates an object address from creator address and seed
+ *
+ * @param creatorAddress The object creator account address
+ * @param seed The seed in either Uint8Array | string type
+ *
+ * @returns The object account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export const createObjectAddress = (creatorAddress, seed) => {
+    const creatorBytes = creatorAddress.bcsToBytes();
+    const seedBytes = typeof seed === "string" ? TEXT_ENCODER.encode(seed) : seed;
+    const bytes = new Uint8Array([...creatorBytes, ...seedBytes, DeriveScheme.DeriveObjectAddressFromSeed]);
+    return new AccountAddress(sha3_256(bytes));
+};
+/**
+ * Creates a resource address from creator address and seed
+ *
+ * @param creatorAddress The creator account address
+ * @param seed The seed in either Uint8Array | string type
+ *
+ * @returns The resource account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export const createResourceAddress = (creatorAddress, seed) => {
+    const creatorBytes = creatorAddress.bcsToBytes();
+    const seedBytes = typeof seed === "string" ? TEXT_ENCODER.encode(seed) : seed;
+    const bytes = new Uint8Array([...creatorBytes, ...seedBytes, DeriveScheme.DeriveResourceAccountAddress]);
+    return new AccountAddress(sha3_256(bytes));
+};
+/**
+ * Creates a user derived object address from source address and derive_from address
+ *
+ * @param sourceAddress The source account address
+ * @param deriveFromAddress The address to derive from
+ *
+ * @returns The user derived object address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export const createUserDerivedObjectAddress = (sourceAddress, deriveFromAddress) => {
+    const sourceBytes = sourceAddress.bcsToBytes();
+    const deriveFromBytes = deriveFromAddress.bcsToBytes();
+    const bytes = new Uint8Array([...sourceBytes, ...deriveFromBytes, DeriveScheme.DeriveObjectAddressFromObject]);
+    return new AccountAddress(sha3_256(bytes));
+};
+/**
+ * Creates a token object address from creator address, collection name and token name
+ *
+ * @param creatorAddress The token creator account address
+ * @param collectionName The collection name
+ * @param tokenName The token name
+ *
+ * @returns The token account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
+export const createTokenAddress = (creatorAddress, collectionName, tokenName) => {
+    const seed = `${collectionName}::${tokenName}`;
+    return createObjectAddress(creatorAddress, seed);
+};
+//# sourceMappingURL=address.js.map

package/dist/core/account/utils/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../../../src/core/account/utils/address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,cAA8B,EAAE,IAAyB,EAAkB,EAAE;IAC/G,MAAM,YAAY,GAAG,cAAc,CAAC,UAAU,EAAE,CAAC;IACjD,MAAM,SAAS,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE9E,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,SAAS,EAAE,YAAY,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAExG,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,cAA8B,EAAE,IAAyB,EAAkB,EAAE;IACjH,MAAM,YAAY,GAAG,cAAc,CAAC,UAAU,EAAE,CAAC;IAEjD,MAAM,SAAS,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE9E,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,SAAS,EAAE,YAAY,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAEzG,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,aAA6B,EAC7B,iBAAiC,EACjB,EAAE;IAClB,MAAM,WAAW,GAAG,aAAa,CAAC,UAAU,EAAE,CAAC;IAC/C,MAAM,eAAe,GAAG,iBAAiB,CAAC,UAAU,EAAE,CAAC;IAEvD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,WAAW,EAAE,GAAG,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAE/G,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,cAA8B,EAC9B,cAAsB,EACtB,SAAiB,EACD,EAAE;IAClB,MAAM,IAAI,GAAG,GAAG,cAAc,KAAK,SAAS,EAAE,CAAC;IAC/C,OAAO,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;AACnD,CAAC,CAAC"}

package/dist/core/account/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./address.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/core/account/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/account/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}