@moveindustries/ts-sdk 5.1.4

package/dist/esm/utils/helpers.d.mts

@@ -0,0 +1,174 @@
+import { dr as MoveStructId, ds as MoveFunctionId, t as AccountAddress } from '../accountAddress-CNXtapt1.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import './apiEndpoints.mjs';
+import './const.mjs';
+import '../core/common.mjs';
+
+/**
+ * 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
+ */
+declare function sleep(timeMs: number): Promise<null>;
+/**
+ * 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
+ */
+declare function getErrorMessage(error: unknown): string;
+/**
+ * @group Implementation
+ * @category Utils
+ */
+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
+ */
+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
+ */
+declare function base64UrlDecode(base64Url: string): string;
+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
+ */
+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
+ */
+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
+ */
+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
+ */
+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
+ */
+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
+ */
+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
+ */
+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
+ */
+declare function pairedFaMetadataAddress(coinType: `0x${string}::${string}::${string}`): AccountAddress;
+
+export { base64UrlDecode, base64UrlToBytes, convertAmountFromHumanReadableToOnChain, convertAmountFromOnChainToHumanReadable, floorToWholeHour, getErrorMessage, getFunctionParts, isEncodedStruct, isValidFunctionInfo, nowInSeconds, pairedFaMetadataAddress, parseEncodedStruct, sleep, truncateAddress };

package/dist/esm/utils/helpers.mjs

@@ -0,0 +1,2 @@
+import{a,b,c,d,e,f,g,h,i,j,k,l,m,n}from"../chunk-WFAH73WN.mjs";import"../chunk-Y6YW4BAZ.mjs";import"../chunk-DS6QB6HG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import"../chunk-KDMSOCZY.mjs";export{e as base64UrlDecode,f as base64UrlToBytes,g as convertAmountFromHumanReadableToOnChain,h as convertAmountFromOnChainToHumanReadable,d as floorToWholeHour,b as getErrorMessage,k as getFunctionParts,j as isEncodedStruct,l as isValidFunctionInfo,c as nowInSeconds,n as pairedFaMetadataAddress,i as parseEncodedStruct,a as sleep,m as truncateAddress};
+//# sourceMappingURL=helpers.mjs.map

package/dist/esm/utils/helpers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/utils/index.d.mts

@@ -0,0 +1,9 @@
+export { Network, NetworkToChainId, NetworkToFaucetAPI, NetworkToIndexerAPI, NetworkToNetworkName, NetworkToNodeAPI, NetworkToPepperAPI, NetworkToProverAPI } from './apiEndpoints.mjs';
+export { ACCOUNT_ABSTRACTION_SIGNING_DATA_SALT, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, FIREBASE_AUTH_ISS_PATTERN, MOVEMENT_COIN, MOVEMENT_FA, MovementApiType, ProcessorType, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT } from './const.mjs';
+export { DeserializableClass, normalizeBundle } from './normalizeBundle.mjs';
+export { base64UrlDecode, base64UrlToBytes, convertAmountFromHumanReadableToOnChain, convertAmountFromOnChainToHumanReadable, floorToWholeHour, getErrorMessage, getFunctionParts, isEncodedStruct, isValidFunctionInfo, nowInSeconds, pairedFaMetadataAddress, parseEncodedStruct, sleep, truncateAddress } from './helpers.mjs';
+import '../accountAddress-CNXtapt1.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import '../core/common.mjs';

package/dist/esm/utils/index.mjs

@@ -0,0 +1,2 @@
+import"../chunk-HGLO5LDS.mjs";import{a as H}from"../chunk-ANTEUWH6.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6NO4QKAO.mjs";import"../chunk-FS5ZJKO7.mjs";import"../chunk-UVP74ONT.mjs";import"../chunk-XCURF77K.mjs";import"../chunk-RXHPS4IU.mjs";import{a as l,b as m,c as n,d as o,e as p,f as q,g as r,h as s,i as t,j as u,k as v,l as w,m as x,n as y}from"../chunk-WFAH73WN.mjs";import"../chunk-Y6YW4BAZ.mjs";import"../chunk-DS6QB6HG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import{a as z,b as A,c as B,d as C,e as D,f as E,g as F,h as G}from"../chunk-PZ233FIY.mjs";import{a,b,c,d,e,f,g,h,i,j,k}from"../chunk-VW3WBAAD.mjs";import"../chunk-KDMSOCZY.mjs";export{i as ACCOUNT_ABSTRACTION_SIGNING_DATA_SALT,b as DEFAULT_MAX_GAS_AMOUNT,c as DEFAULT_TXN_EXP_SEC_FROM_NOW,d as DEFAULT_TXN_TIMEOUT_SEC,k as FIREBASE_AUTH_ISS_PATTERN,e as MOVEMENT_COIN,f as MOVEMENT_FA,a as MovementApiType,E as Network,F as NetworkToChainId,B as NetworkToFaucetAPI,z as NetworkToIndexerAPI,G as NetworkToNetworkName,A as NetworkToNodeAPI,C as NetworkToPepperAPI,D as NetworkToProverAPI,j as ProcessorType,g as RAW_TRANSACTION_SALT,h as RAW_TRANSACTION_WITH_DATA_SALT,p as base64UrlDecode,q as base64UrlToBytes,r as convertAmountFromHumanReadableToOnChain,s as convertAmountFromOnChainToHumanReadable,o as floorToWholeHour,m as getErrorMessage,v as getFunctionParts,u as isEncodedStruct,w as isValidFunctionInfo,H as normalizeBundle,n as nowInSeconds,y as pairedFaMetadataAddress,t as parseEncodedStruct,l as sleep,x as truncateAddress};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/utils/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/utils/memoize.d.mts

@@ -0,0 +1,26 @@
+/**
+ * A memoize higher-order function to cache the response of an async function.
+ * This function helps to improve performance by avoiding repeated calls to the same async function with the same arguments
+ * within a specified time-to-live (TTL).
+ *
+ * @param func The async function to cache the result of.
+ * @param key The cache key used to store the result.
+ * @param ttlMs The time-to-live in milliseconds for cached data.
+ * @returns The cached or latest result.
+ * @group Implementation
+ * @category Utils
+ */
+declare function memoizeAsync<T>(func: (...args: any[]) => Promise<T>, key: string, ttlMs?: number): (...args: any[]) => Promise<T>;
+/**
+ * Caches the result of a function call to improve performance on subsequent calls with the same arguments.
+ *
+ * @param key - The key to cache on, all accesses by this key will return the cached value.
+ * @param func - The function whose result will be cached.
+ * @param ttlMs - The time-to-live in milliseconds for cached data.
+ * @returns A memoized version of the provided function that returns the cached result if available and within TTL.
+ * @group Implementation
+ * @category Utils
+ */
+declare function memoize<T>(func: (...args: any[]) => T, key: string, ttlMs?: number): (...args: any[]) => T;
+
+export { memoize, memoizeAsync };

package/dist/esm/utils/memoize.mjs

@@ -0,0 +1,2 @@
+import{a,b}from"../chunk-5ZKA765G.mjs";import"../chunk-KDMSOCZY.mjs";export{b as memoize,a as memoizeAsync};
+//# sourceMappingURL=memoize.mjs.map

package/dist/esm/utils/memoize.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/utils/normalizeBundle.d.mts

@@ -0,0 +1,35 @@
+import { o as Serializable, a as Deserializer } from '../accountAddress-CNXtapt1.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import './apiEndpoints.mjs';
+import './const.mjs';
+import '../core/common.mjs';
+
+/**
+ * @group Implementation
+ * @category Utils
+ */
+type DeserializableClass<T extends Serializable> = {
+    /**
+     * Deserializes a serialized object using the provided deserializer.
+     * This function allows you to reconstruct an object from its serialized form.
+     *
+     * @param deserializer - An instance of the Deserializer used to read the serialized data.
+     * @group Implementation
+     * @category Utils
+     */
+    deserialize(deserializer: Deserializer): T;
+};
+/**
+ * Normalizes an instance of a class by deserializing it from its byte representation.
+ * This function allows the `instanceof` operator to work correctly when the input objects originate from a different bundle.
+ *
+ * @param cls - The class of the object to normalize.
+ * @param value - The instance to normalize.
+ * @group Implementation
+ * @category Utils
+ */
+declare function normalizeBundle<T extends Serializable>(cls: DeserializableClass<T>, value: T): T;
+
+export { type DeserializableClass, normalizeBundle };

package/dist/esm/utils/normalizeBundle.mjs

@@ -0,0 +1,2 @@
+import{a}from"../chunk-ANTEUWH6.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6NO4QKAO.mjs";import"../chunk-FS5ZJKO7.mjs";import"../chunk-UVP74ONT.mjs";import"../chunk-XCURF77K.mjs";import"../chunk-RXHPS4IU.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as normalizeBundle};
+//# sourceMappingURL=normalizeBundle.mjs.map

package/dist/esm/utils/normalizeBundle.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/version.d.mts

@@ -0,0 +1,8 @@
+/**
+ * The current version of the SDK
+ *
+ * hardcoded for now, we would want to have it injected dynamically
+ */
+declare const VERSION = "5.1.4";
+
+export { VERSION };

package/dist/esm/version.mjs

@@ -0,0 +1,2 @@
+import{a}from"./chunk-PCESRJYO.mjs";import"./chunk-KDMSOCZY.mjs";export{a as VERSION};
+//# sourceMappingURL=version.mjs.map

package/dist/esm/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@moveindustries/ts-sdk",
+  "description": "Movement TypeScript SDK",
+  "packageManager": "pnpm@8.15.1",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "bugs": {
+    "url": "https://github.com/moveindustires/movement-ts-sdk/issues/new/choose"
+  },
+  "homepage": "https://moveindustries.github.io/movement-ts-sdk/",
+  "main": "dist/common/index.js",
+  "module": "dist/esm/index.mjs",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "require": {
+        "types": "./dist/common/index.d.ts",
+        "default": "./dist/common/index.js"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      }
+    },
+    "./dist/common/cli/index.js": "./dist/common/cli/index.js",
+    "./dist/esm/cli/index.mjs": "./dist/esm/cli/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@moveindustries/movement-cli": "^1.0.2",
+    "@moveindustries/movement-client": "^2.0.0",
+    "@noble/curves": "^1.9.0",
+    "@noble/hashes": "^1.5.0",
+    "@scure/bip32": "^1.4.0",
+    "@scure/bip39": "^1.3.0",
+    "eventemitter3": "^5.0.1",
+    "js-base64": "^3.7.7",
+    "jwt-decode": "^4.0.0",
+    "poseidon-lite": "^0.2.0"
+  },
+  "devDependencies": {
+    "@babel/traverse": "^7.28.4",
+    "@cucumber/cucumber": "^12.2.0",
+    "@eslint/eslintrc": "^3.3.1",
+    "@graphql-codegen/cli": "^6.0.0",
+    "@graphql-codegen/import-types-preset": "^3.0.1",
+    "@graphql-codegen/typescript": "^5.0.0",
+    "@graphql-codegen/typescript-graphql-request": "^6.3.0",
+    "@graphql-codegen/typescript-operations": "^5.0.0",
+    "@types/base-64": "^1.0.2",
+    "@types/jest": "^29.5.14",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/node": "^24.3.1",
+    "@typescript-eslint/eslint-plugin": "^8.43.0",
+    "@typescript-eslint/parser": "^8.43.0",
+    "dotenv": "^16.4.7",
+    "eslint": "^9.35.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "graphql": "^16.11.0",
+    "globals": "^16.4.0",
+    "graphql-request": "^7.2.0",
+    "jest": "^29.7.0",
+    "jsonwebtoken": "^9.0.2",
+    "prettier": "^3.6.2",
+    "tree-kill": "^1.2.2",
+    "ts-jest": "^29.4.1",
+    "ts-loader": "^9.5.4",
+    "tsup": "^8.5.0",
+    "typedoc": "^0.28.12",
+    "typedoc-plugin-missing-exports": "^4.1.0",
+    "typescript": "^5.8.3"
+  },
+  "version": "5.1.4",
+  "scripts": {
+    "build:clean": "rm -rf dist",
+    "build": "pnpm build:clean && tsup",
+    "_fmt": "prettier 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.js' 'examples/**/*.ts' 'confidential-assets/**/*.ts' 'eslint.config.cjs'",
+    "fmt": "pnpm _fmt --write",
+    "lint": "eslint '**/*.{cts,mts,ts}'",
+    "test": "pnpm jest",
+    "unit-test": "pnpm jest tests/unit",
+    "e2e-test": "pnpm jest tests/e2e",
+    "indexer-codegen": "graphql-codegen --config ./src/types/codegen.yaml && pnpm fmt",
+    "doc": "scripts/generateDocs.sh",
+    "check-version": "scripts/checkVersion.sh",
+    "update-version": "scripts/updateVersion.sh && pnpm doc",
+    "spec": "pnpm build && pnpm _spec",
+    "_spec": "cucumber-js -p default"
+  }
+}