@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/utils/apiEndpoints.js

@@ -0,0 +1,100 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * @group Implementation
+ * @category Network
+ */
+export const NetworkToIndexerAPI = {
+    mainnet: "https://api.mainnet.aptoslabs.com/v1/graphql",
+    testnet: "https://api.testnet.aptoslabs.com/v1/graphql",
+    devnet: "https://api.devnet.aptoslabs.com/v1/graphql",
+    shelbynet: "https://api.shelbynet.shelby.xyz/v1/graphql",
+    netna: "https://api.netna.staging.aptoslabs.com/v1/graphql",
+    local: "http://127.0.0.1:8090/v1/graphql",
+};
+/**
+ * @group Implementation
+ * @category Network
+ */
+export const NetworkToNodeAPI = {
+    mainnet: "https://api.mainnet.aptoslabs.com/v1",
+    testnet: "https://api.testnet.aptoslabs.com/v1",
+    devnet: "https://api.devnet.aptoslabs.com/v1",
+    shelbynet: "https://api.shelbynet.shelby.xyz/v1",
+    netna: "https://api.netna.staging.aptoslabs.com/v1",
+    local: "http://127.0.0.1:8080/v1",
+};
+/**
+ * @group Implementation
+ * @category Network
+ */
+export const NetworkToFaucetAPI = {
+    devnet: "https://faucet.devnet.aptoslabs.com",
+    shelbynet: "https://faucet.shelbynet.shelby.xyz",
+    netna: "https://faucet-dev-netna-us-central1-410192433417.us-central1.run.app",
+    local: "http://127.0.0.1:8081",
+};
+/**
+ * @group Implementation
+ * @category Network
+ */
+export const NetworkToPepperAPI = {
+    mainnet: "https://api.mainnet.aptoslabs.com/keyless/pepper/v0",
+    testnet: "https://api.testnet.aptoslabs.com/keyless/pepper/v0",
+    devnet: "https://api.devnet.aptoslabs.com/keyless/pepper/v0",
+    shelbynet: "https://api.shelbynet.aptoslabs.com/keyless/pepper/v0",
+    netna: "https://api.devnet.aptoslabs.com/keyless/pepper/v0",
+    // Use the devnet service for local environment
+    local: "https://api.devnet.aptoslabs.com/keyless/pepper/v0",
+};
+/**
+ * @group Implementation
+ * @category Network
+ */
+export const NetworkToProverAPI = {
+    mainnet: "https://api.mainnet.aptoslabs.com/keyless/prover/v0",
+    testnet: "https://api.testnet.aptoslabs.com/keyless/prover/v0",
+    devnet: "https://api.devnet.aptoslabs.com/keyless/prover/v0",
+    shelbynet: "https://api.shelbynet.aptoslabs.com/keyless/prover/v0",
+    netna: "https://api.devnet.aptoslabs.com/keyless/prover/v0",
+    // Use the devnet service for local environment
+    local: "https://api.devnet.aptoslabs.com/keyless/prover/v0",
+};
+/**
+ * Different network environments for connecting to services, ranging from production to development setups.
+ * @group Implementation
+ * @category Network
+ */
+export var Network;
+(function (Network) {
+    Network["MAINNET"] = "mainnet";
+    Network["TESTNET"] = "testnet";
+    Network["DEVNET"] = "devnet";
+    Network["SHELBYNET"] = "shelbynet";
+    Network["NETNA"] = "netna";
+    Network["LOCAL"] = "local";
+    Network["CUSTOM"] = "custom";
+})(Network || (Network = {}));
+/**
+ * @group Implementation
+ * @category Network
+ */
+export const NetworkToChainId = {
+    mainnet: 1,
+    testnet: 2,
+    local: 4,
+};
+/**
+ * @group Implementation
+ * @category Network
+ */
+export const NetworkToNetworkName = {
+    mainnet: Network.MAINNET,
+    testnet: Network.TESTNET,
+    devnet: Network.DEVNET,
+    shelbynet: Network.SHELBYNET,
+    netna: Network.NETNA,
+    local: Network.LOCAL,
+    custom: Network.CUSTOM,
+};
+//# sourceMappingURL=apiEndpoints.js.map

package/dist/utils/apiEndpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiEndpoints.js","sourceRoot":"","sources":["../../src/utils/apiEndpoints.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAA2B;IACzD,OAAO,EAAE,8CAA8C;IACvD,OAAO,EAAE,8CAA8C;IACvD,MAAM,EAAE,6CAA6C;IACrD,SAAS,EAAE,6CAA6C;IACxD,KAAK,EAAE,oDAAoD;IAC3D,KAAK,EAAE,kCAAkC;CAC1C,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA2B;IACtD,OAAO,EAAE,sCAAsC;IAC/C,OAAO,EAAE,sCAAsC;IAC/C,MAAM,EAAE,qCAAqC;IAC7C,SAAS,EAAE,qCAAqC;IAChD,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,0BAA0B;CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA2B;IACxD,MAAM,EAAE,qCAAqC;IAC7C,SAAS,EAAE,qCAAqC;IAChD,KAAK,EAAE,uEAAuE;IAC9E,KAAK,EAAE,uBAAuB;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA2B;IACxD,OAAO,EAAE,qDAAqD;IAC9D,OAAO,EAAE,qDAAqD;IAC9D,MAAM,EAAE,oDAAoD;IAC5D,SAAS,EAAE,uDAAuD;IAClE,KAAK,EAAE,oDAAoD;IAC3D,+CAA+C;IAC/C,KAAK,EAAE,oDAAoD;CAC5D,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA2B;IACxD,OAAO,EAAE,qDAAqD;IAC9D,OAAO,EAAE,qDAAqD;IAC9D,MAAM,EAAE,oDAAoD;IAC5D,SAAS,EAAE,uDAAuD;IAClE,KAAK,EAAE,oDAAoD;IAC3D,+CAA+C;IAC/C,KAAK,EAAE,oDAAoD;CAC5D,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAN,IAAY,OAQX;AARD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;IACnB,4BAAiB,CAAA;IACjB,kCAAuB,CAAA;IACvB,0BAAe,CAAA;IACf,0BAAe,CAAA;IACf,4BAAiB,CAAA;AACnB,CAAC,EARW,OAAO,KAAP,OAAO,QAQlB;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA2B;IACtD,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,CAAC;CACT,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAA4B;IAC3D,OAAO,EAAE,OAAO,CAAC,OAAO;IACxB,OAAO,EAAE,OAAO,CAAC,OAAO;IACxB,MAAM,EAAE,OAAO,CAAC,MAAM;IACtB,SAAS,EAAE,OAAO,CAAC,SAAS;IAC5B,KAAK,EAAE,OAAO,CAAC,KAAK;IACpB,KAAK,EAAE,OAAO,CAAC,KAAK;IACpB,MAAM,EAAE,OAAO,CAAC,MAAM;CACvB,CAAC"}

package/dist/utils/const.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Types of API endpoints used for routing requests in the Aptos network.
+ * @group Implementation
+ * @category Utils
+ */
+export declare enum AptosApiType {
+    FULLNODE = "Fullnode",
+    INDEXER = "Indexer",
+    FAUCET = "Faucet",
+    PEPPER = "Pepper",
+    PROVER = "Prover"
+}
+/**
+ * The default max gas amount when none is given.
+ *
+ * This is the maximum number of gas units that will be used by a transaction before being rejected.
+ *
+ * Note that max gas amount varies based on the transaction.  A larger transaction will go over this
+ * default gas amount, and the value will need to be changed for the specific transaction.
+ * @group Implementation
+ * @category Utils
+ */
+export declare const DEFAULT_MAX_GAS_AMOUNT = 2000000;
+/**
+ * The minimum max gas amount that the SDK will allow for a transaction.
+ *
+ * This value acts as a floor to prevent transactions from being built with a max gas amount
+ * below the network's minimum transaction gas units, which would cause
+ * MAX_GAS_UNITS_BELOW_MIN_TRANSACTION_GAS_UNITS errors.
+ * @group Implementation
+ * @category Utils
+ */
+export declare const MIN_MAX_GAS_AMOUNT = 2000;
+/**
+ * Minimum gas unit price (Octas per gas unit) for encrypted transactions.
+ * Encrypted transactions require 2× the network base minimum (100) because validators
+ * bear the decryption compute cost (aptos-core `encrypted_txn_min_price_per_gas_unit`,
+ * RELEASE_V1_45+). The node rejects encrypted submissions below this price.
+ */
+export declare const MIN_ENCRYPTED_TXN_GAS_UNIT_PRICE = 200;
+/**
+ * The default transaction expiration seconds from now.
+ *
+ * This time is how long until the blockchain nodes will reject the transaction.
+ *
+ * Note that the transaction expiration time varies based on network connection and network load.  It may need to be
+ * increased for the transaction to be processed.
+ * @group Implementation
+ * @category Utils
+ */
+export declare const DEFAULT_TXN_EXP_SEC_FROM_NOW = 20;
+/**
+ * The default number of seconds to wait for a transaction to be processed.
+ *
+ * This time is the amount of time that the SDK will wait for a transaction to be processed when waiting for
+ * the results of the transaction.  It may take longer based on network connection and network load.
+ * @group Implementation
+ * @category Utils
+ */
+export declare const DEFAULT_TXN_TIMEOUT_SEC = 20;
+/**
+ * The default gas currency for the network.
+ * @group Implementation
+ * @category Utils
+ */
+export declare const APTOS_COIN = "0x1::aptos_coin::AptosCoin";
+/**
+ * @group Implementation
+ * @category Utils
+ */
+export declare const APTOS_FA = "0x000000000000000000000000000000000000000000000000000000000000000a";
+/**
+ * @group Implementation
+ * @category Utils
+ */
+export declare const RAW_TRANSACTION_SALT = "APTOS::RawTransaction";
+/**
+ * @group Implementation
+ * @category Utils
+ */
+export declare const RAW_TRANSACTION_WITH_DATA_SALT = "APTOS::RawTransactionWithData";
+export declare const ACCOUNT_ABSTRACTION_SIGNING_DATA_SALT = "APTOS::AASigningData";
+/**
+ * Supported processor types for the indexer API, sourced from the processor_status table in the indexer database.
+ * {@link https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql}
+ * @group Implementation
+ * @category Utils
+ */
+export declare enum ProcessorType {
+    ACCOUNT_RESTORATION_PROCESSOR = "account_restoration_processor",
+    ACCOUNT_TRANSACTION_PROCESSOR = "account_transactions_processor",
+    DEFAULT = "default_processor",
+    EVENTS_PROCESSOR = "events_processor",
+    FUNGIBLE_ASSET_PROCESSOR = "fungible_asset_processor",
+    STAKE_PROCESSOR = "stake_processor",
+    TOKEN_V2_PROCESSOR = "token_v2_processor",
+    USER_TRANSACTION_PROCESSOR = "user_transaction_processor",
+    OBJECT_PROCESSOR = "objects_processor"
+}
+/**
+ * Regular expression pattern for Firebase Auth issuer URLs
+ * Matches URLs in the format: https://securetoken.google.com/[project-id]
+ * where project-id can contain letters, numbers, hyphens, and underscores
+ */
+export declare const FIREBASE_AUTH_ISS_PATTERN: RegExp;
+/**
+ * Shared TextEncoder instance for string serialization to avoid repeated instantiation.
+ *
+ * The explicit structural type prevents TypeScript from inferring `import("util").TextEncoder`
+ * (from `@types/node`) into the emitted `.d.ts`, which would force every SDK consumer to
+ * have `@types/node` installed. The SDK is runtime-agnostic (browser/Node/Bun/Deno/RN), so
+ * we expose only the minimal shape the SDK actually uses.
+ */
+export declare const TEXT_ENCODER: {
+    encode(input: string): Uint8Array;
+};
+//# sourceMappingURL=const.d.ts.map

package/dist/utils/const.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.d.ts","sourceRoot":"","sources":["../../src/utils/const.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB,UAAU,CAAC;AAE9C;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,MAAM,CAAC;AAEpD;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,KAAK,CAAC;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,UAAU,+BAA+B,CAAC;AACvD;;;GAGG;AACH,eAAO,MAAM,QAAQ,uEAAuE,CAAC;AAC7F;;;GAGG;AACH,eAAO,MAAM,oBAAoB,0BAA0B,CAAC;AAC5D;;;GAGG;AACH,eAAO,MAAM,8BAA8B,kCAAkC,CAAC;AAE9E,eAAO,MAAM,qCAAqC,yBAAyB,CAAC;AAE5E;;;;;GAKG;AACH,oBAAY,aAAa;IACvB,6BAA6B,kCAAkC;IAC/D,6BAA6B,mCAAmC;IAChE,OAAO,sBAAsB;IAC7B,gBAAgB,qBAAqB;IAErC,wBAAwB,6BAA6B;IACrD,eAAe,oBAAoB;IAEnC,kBAAkB,uBAAuB;IACzC,0BAA0B,+BAA+B;IACzD,gBAAgB,sBAAsB;CACvC;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,QAAyD,CAAC;AAEhG;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,EAAE;IAAE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAA;CAAsB,CAAC"}

package/dist/utils/const.js

@@ -0,0 +1,121 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Types of API endpoints used for routing requests in the Aptos network.
+ * @group Implementation
+ * @category Utils
+ */
+export var AptosApiType;
+(function (AptosApiType) {
+    AptosApiType["FULLNODE"] = "Fullnode";
+    AptosApiType["INDEXER"] = "Indexer";
+    AptosApiType["FAUCET"] = "Faucet";
+    AptosApiType["PEPPER"] = "Pepper";
+    AptosApiType["PROVER"] = "Prover";
+})(AptosApiType || (AptosApiType = {}));
+/**
+ * The default max gas amount when none is given.
+ *
+ * This is the maximum number of gas units that will be used by a transaction before being rejected.
+ *
+ * Note that max gas amount varies based on the transaction.  A larger transaction will go over this
+ * default gas amount, and the value will need to be changed for the specific transaction.
+ * @group Implementation
+ * @category Utils
+ */
+export const DEFAULT_MAX_GAS_AMOUNT = 2000000;
+/**
+ * The minimum max gas amount that the SDK will allow for a transaction.
+ *
+ * This value acts as a floor to prevent transactions from being built with a max gas amount
+ * below the network's minimum transaction gas units, which would cause
+ * MAX_GAS_UNITS_BELOW_MIN_TRANSACTION_GAS_UNITS errors.
+ * @group Implementation
+ * @category Utils
+ */
+export const MIN_MAX_GAS_AMOUNT = 2000;
+/**
+ * Minimum gas unit price (Octas per gas unit) for encrypted transactions.
+ * Encrypted transactions require 2× the network base minimum (100) because validators
+ * bear the decryption compute cost (aptos-core `encrypted_txn_min_price_per_gas_unit`,
+ * RELEASE_V1_45+). The node rejects encrypted submissions below this price.
+ */
+export const MIN_ENCRYPTED_TXN_GAS_UNIT_PRICE = 200;
+/**
+ * The default transaction expiration seconds from now.
+ *
+ * This time is how long until the blockchain nodes will reject the transaction.
+ *
+ * Note that the transaction expiration time varies based on network connection and network load.  It may need to be
+ * increased for the transaction to be processed.
+ * @group Implementation
+ * @category Utils
+ */
+export const DEFAULT_TXN_EXP_SEC_FROM_NOW = 20;
+/**
+ * The default number of seconds to wait for a transaction to be processed.
+ *
+ * This time is the amount of time that the SDK will wait for a transaction to be processed when waiting for
+ * the results of the transaction.  It may take longer based on network connection and network load.
+ * @group Implementation
+ * @category Utils
+ */
+export const DEFAULT_TXN_TIMEOUT_SEC = 20;
+/**
+ * The default gas currency for the network.
+ * @group Implementation
+ * @category Utils
+ */
+export const APTOS_COIN = "0x1::aptos_coin::AptosCoin";
+/**
+ * @group Implementation
+ * @category Utils
+ */
+export const APTOS_FA = "0x000000000000000000000000000000000000000000000000000000000000000a";
+/**
+ * @group Implementation
+ * @category Utils
+ */
+export const RAW_TRANSACTION_SALT = "APTOS::RawTransaction";
+/**
+ * @group Implementation
+ * @category Utils
+ */
+export const RAW_TRANSACTION_WITH_DATA_SALT = "APTOS::RawTransactionWithData";
+export const ACCOUNT_ABSTRACTION_SIGNING_DATA_SALT = "APTOS::AASigningData";
+/**
+ * Supported processor types for the indexer API, sourced from the processor_status table in the indexer database.
+ * {@link https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql}
+ * @group Implementation
+ * @category Utils
+ */
+export var ProcessorType;
+(function (ProcessorType) {
+    ProcessorType["ACCOUNT_RESTORATION_PROCESSOR"] = "account_restoration_processor";
+    ProcessorType["ACCOUNT_TRANSACTION_PROCESSOR"] = "account_transactions_processor";
+    ProcessorType["DEFAULT"] = "default_processor";
+    ProcessorType["EVENTS_PROCESSOR"] = "events_processor";
+    // Fungible asset processor also handles coins
+    ProcessorType["FUNGIBLE_ASSET_PROCESSOR"] = "fungible_asset_processor";
+    ProcessorType["STAKE_PROCESSOR"] = "stake_processor";
+    // Token V2 processor replaces Token processor (not only for digital assets)
+    ProcessorType["TOKEN_V2_PROCESSOR"] = "token_v2_processor";
+    ProcessorType["USER_TRANSACTION_PROCESSOR"] = "user_transaction_processor";
+    ProcessorType["OBJECT_PROCESSOR"] = "objects_processor";
+})(ProcessorType || (ProcessorType = {}));
+/**
+ * Regular expression pattern for Firebase Auth issuer URLs
+ * Matches URLs in the format: https://securetoken.google.com/[project-id]
+ * where project-id can contain letters, numbers, hyphens, and underscores
+ */
+export const FIREBASE_AUTH_ISS_PATTERN = /^https:\/\/securetoken\.google\.com\/[a-zA-Z0-9-_]+$/;
+/**
+ * Shared TextEncoder instance for string serialization to avoid repeated instantiation.
+ *
+ * The explicit structural type prevents TypeScript from inferring `import("util").TextEncoder`
+ * (from `@types/node`) into the emitted `.d.ts`, which would force every SDK consumer to
+ * have `@types/node` installed. The SDK is runtime-agnostic (browser/Node/Bun/Deno/RN), so
+ * we expose only the minimal shape the SDK actually uses.
+ */
+export const TEXT_ENCODER = new TextEncoder();
+//# sourceMappingURL=const.js.map

package/dist/utils/const.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.js","sourceRoot":"","sources":["../../src/utils/const.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC;;;;GAIG;AACH,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;AACnB,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE9C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,GAAG,CAAC;AAEpD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAE/C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAE1C;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,4BAA4B,CAAC;AACvD;;;GAGG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,oEAAoE,CAAC;AAC7F;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,uBAAuB,CAAC;AAC5D;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,+BAA+B,CAAC;AAE9E,MAAM,CAAC,MAAM,qCAAqC,GAAG,sBAAsB,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,gFAA+D,CAAA;IAC/D,iFAAgE,CAAA;IAChE,8CAA6B,CAAA;IAC7B,sDAAqC,CAAA;IACrC,8CAA8C;IAC9C,sEAAqD,CAAA;IACrD,oDAAmC,CAAA;IACnC,4EAA4E;IAC5E,0DAAyC,CAAA;IACzC,0EAAyD,CAAA;IACzD,uDAAsC,CAAA;AACxC,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,sDAAsD,CAAC;AAEhG;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAA0C,IAAI,WAAW,EAAE,CAAC"}

package/dist/utils/helpers.d.ts

@@ -0,0 +1,203 @@
+import { MoveFunctionId, MoveStructId } from "../types/index.js";
+import { AccountAddress } from "../core/accountAddress.js";
+/**
+ * Checks if the current runtime environment is Bun.
+ * This is useful for detecting Bun-specific compatibility issues.
+ *
+ * @returns true if running in Bun, false otherwise.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function isBun(): boolean;
+/**
+ * Read an environment variable in a runtime-agnostic way. Returns `undefined` when
+ * `process.env` is not available (browsers, some bundlers) or the variable is unset.
+ *
+ * @group Implementation
+ * @category Utils
+ */
+export declare function getEnvVar(name: string): string | undefined;
+/**
+ * Logs a warning message to the console only in development environments.
+ * This function helps reduce information leakage in production while maintaining
+ * helpful warnings during development.
+ *
+ * @param message - The warning message to log.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function warnIfDevelopment(message: string): void;
+/**
+ * Sleep for the specified amount of time in milliseconds.
+ * This function can be used to introduce delays in asynchronous operations.
+ *
+ * @param timeMs - The time in milliseconds to sleep.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function sleep(timeMs: number): Promise<void>;
+/**
+ * Get the error message from an unknown error.
+ *
+ * @param error The error to get the message from
+ * @returns The error message
+ * @group Implementation
+ * @category Utils
+ */
+export declare function getErrorMessage(error: unknown): string;
+/**
+ * @group Implementation
+ * @category Utils
+ */
+export declare const nowInSeconds: () => number;
+/**
+ * Floors the given timestamp to the nearest whole hour.
+ * This function is useful for normalizing timestamps to hourly intervals.
+ *
+ * @param timestampInSeconds - The timestamp in seconds to be floored.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function floorToWholeHour(timestampInSeconds: number): number;
+/**
+ * Decodes a base64 URL-encoded string into its original form.
+ * This function is useful for converting base64 URL-encoded data back to a readable format.
+ *
+ * @param base64Url - The base64 URL-encoded string to decode.
+ * @returns The decoded string.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function base64UrlDecode(base64Url: string): string;
+/**
+ * Encode a string or byte array as a base64url string (RFC 4648 §5) with no padding.
+ *
+ * @param input - The data to encode. Strings are interpreted as UTF-8.
+ * @returns The base64url-encoded string.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function base64UrlEncode(input: string | Uint8Array): string;
+export declare function base64UrlToBytes(base64Url: string): Uint8Array;
+/**
+ * Amount is represented in the smallest unit format on chain, this function converts
+ * a human-readable amount format to the smallest unit format
+ * @example
+ * human-readable amount format: 500
+ * on chain amount format when decimal is 8: 50000000000
+ *
+ * @param value The value in human-readable format
+ * @param decimal The token decimal
+ * @returns The value in the smallest units
+ * @group Implementation
+ * @category Utils
+ */
+export declare const convertAmountFromHumanReadableToOnChain: (value: number, decimal: number) => number;
+/**
+ * Amount is represented in the smallest unit format on chain, this function converts
+ * the smallest unit format to a human-readable amount format
+ * @example
+ * human-readable amount format: 500
+ * on chain amount format when decimal is 8: 50000000000
+ *
+ * @param value The value in human-readable format
+ * @param decimal The token decimal
+ * @returns The value in the smallest units
+ * @group Implementation
+ * @category Utils
+ */
+export declare const convertAmountFromOnChainToHumanReadable: (value: number, decimal: number) => number;
+/**
+ * Convert an encoded struct to a MoveStructId.
+ *
+ * @example
+ * const structObj = {
+ *   account_address: "0x1",
+ *   module_name: "0x6170746f735f636f696e",
+ *   struct_name: "0x4170746f73436f696e",
+ * };
+ * // structId is "0x1::aptos_coin::AptosCoin"
+ * const structId = parseEncodedStruct(structObj);
+ *
+ * @param structObj The struct with account_address, module_name, and struct_name properties
+ * @returns The MoveStructId
+ * @group Implementation
+ * @category Utils
+ */
+export declare const parseEncodedStruct: (structObj: {
+    account_address: string;
+    module_name: string;
+    struct_name: string;
+}) => MoveStructId;
+/**
+ * Determines whether the given object is an encoded struct type with the following properties:
+ * - account_address: string
+ * - module_name: string
+ * - struct_name: string
+ *
+ * @param structObj The object to check
+ * @returns Whether the object is an encoded struct type
+ * @group Implementation
+ * @category Utils
+ */
+export declare const isEncodedStruct: (structObj: any) => structObj is {
+    account_address: string;
+    module_name: string;
+    struct_name: string;
+};
+/**
+ * Splits a function identifier into its constituent parts: module address, module name, and function name.
+ * This function helps in validating and extracting details from a function identifier string.
+ *
+ * @param functionArg - The function identifier string in the format "moduleAddress::moduleName::functionName".
+ * @returns An object containing the module address, module name, and function name.
+ * @throws Error if the function identifier does not contain exactly three parts.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function getFunctionParts(functionArg: MoveFunctionId): {
+    moduleAddress: string;
+    moduleName: string;
+    functionName: string;
+};
+/**
+ * Validates the provided function information.
+ *
+ * @param functionInfo - The function information to validate.
+ * @returns Whether the function information is valid.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function isValidFunctionInfo(functionInfo: string): boolean;
+/**
+ * Truncates the provided wallet address at the middle with an ellipsis.
+ *
+ * @param address - The wallet address to truncate.
+ * @param start - The number of characters to show at the beginning of the address.
+ * @param end - The number of characters to show at the end of the address.
+ * @returns The truncated address.
+ * @group Implementation
+ * @category Utils
+ */
+export declare function truncateAddress(address: string, start?: number, end?: number): string;
+/**
+ * Calculates the paired FA metadata address for a given coin type.
+ * This function is tolerant of various address formats in the coin type string,
+ * including complex nested types.
+ *
+ * @example
+ * // All these formats are valid and will produce the same result:
+ * pairedFaMetadataAddress("0x1::aptos_coin::AptosCoin")  // simple form
+ * pairedFaMetadataAddress("0x0000000000000000000000000000000000000000000000000000000000000001::aptos_coin::AptosCoin")  // long form
+ * pairedFaMetadataAddress("0x00001::aptos_coin::AptosCoin")  // with leading zeros
+ * pairedFaMetadataAddress("0x1::coin::Coin<0x1412::a::struct<0x0001::aptos_coin::AptosCoin>>")  // nested type parameters
+ *
+ * @param coinType - The coin type string in any of these formats:
+ *   - Short form address: "0x1::aptos_coin::AptosCoin"
+ *   - Long form address: "0x0000000000000000000000000000000000000000000000000000000000000001::aptos_coin::AptosCoin"
+ *   - With leading zeros: "0x00001::aptos_coin::AptosCoin"
+ *   - With nested types: "0x1::coin::Coin<0x1412::a::struct<0x0001::aptos_coin::AptosCoin>>"
+ * @returns The calculated metadata address as an AccountAddress instance
+ */
+export declare function pairedFaMetadataAddress(coinType: `0x${string}::${string}::${string}`): AccountAddress;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/utils/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAI3D;;;;;;;GAOG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAO/B;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAavD;AAED;;;;;;;GAOG;AACH,wBAAsB,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIzD;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEtD;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,cAAsC,CAAC;AAEhE;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAOnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAIzD;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAmBlE;AAED,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,CAY9D;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uCAAuC,GAAI,OAAO,MAAM,EAAE,SAAS,MAAM,WAA0B,CAAC;AAEjH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uCAAuC,GAAI,OAAO,MAAM,EAAE,SAAS,MAAM,WAA0B,CAAC;AAoBjH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,KAAG,YAKH,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,WAAW,GAAG,KACb,SAAS,IAAI;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CAUqB,CAAC;AAE5C;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,cAAc;;;;EAS3D;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAGjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,EAAE,GAAG,GAAE,MAAU,UAElF;AAsBD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,KAAK,MAAM,KAAK,MAAM,KAAK,MAAM,EAAE,GAAG,cAAc,CAOrG"}