@aptos-labs/ts-sdk 1.29.1 → 1.31.0

package/src/types/indexer.ts

@@ -46,31 +46,107 @@ import {
  */
 export type GetObjectDataQueryResponse = GetObjectDataQuery["current_objects"];
 
+/**
+ * The response structure for querying tokens owned by an account.
+ */
 export type GetAccountOwnedTokensQueryResponse = GetAccountOwnedTokensQuery["current_token_ownerships_v2"];
 
+/**
+ * The response containing the current token ownerships for an account from a specific collection.
+ */
 export type GetAccountOwnedTokensFromCollectionResponse =
   GetAccountOwnedTokensFromCollectionQuery["current_token_ownerships_v2"];
+
+/**
+ * The response structure for retrieving account collections associated with owned tokens.
+ */
 export type GetAccountCollectionsWithOwnedTokenResponse =
   GetAccountCollectionsWithOwnedTokensQuery["current_collection_ownership_v2_view"];
+
+/**
+ * The current balances of fungible assets for an account.
+ */
 export type GetAccountCoinsDataResponse = GetAccountCoinsDataQuery["current_fungible_asset_balances"];
+
+/**
+ * The response structure for retrieving user transactions from the top of the blockchain.
+ */
 export type GetChainTopUserTransactionsResponse = GetChainTopUserTransactionsQuery["user_transactions"];
+
+/**
+ * The response containing the events from the GetEventsQuery.
+ */
 export type GetEventsResponse = GetEventsQuery["events"];
 
+/**
+ * The number of active delegators per pool in response to a query.
+ */
 export type GetNumberOfDelegatorsResponse = GetNumberOfDelegatorsQuery["num_active_delegator_per_pool"];
+
+/**
+ * The response containing the delegated staking activities from the query.
+ */
 export type GetDelegatedStakingActivitiesResponse = GetDelegatedStakingActivitiesQuery["delegated_staking_activities"];
+
+/**
+ * The response structure for retrieving data from the current collections.
+ */
 export type GetCollectionDataResponse = GetCollectionDataQuery["current_collections_v2"][0];
+
+/**
+ * The response structure for retrieving token data, containing the current token information.
+ */
 export type GetTokenDataResponse = GetTokenDataQuery["current_token_datas_v2"][0];
+
+/**
+ * The status of the processor as returned by the GetProcessorStatusQuery.
+ */
 export type GetProcessorStatusResponse = GetProcessorStatusQuery["processor_status"];
+
+/**
+ * The response containing metadata for a fungible asset.
+ */
 export type GetFungibleAssetMetadataResponse = GetFungibleAssetMetadataQuery["fungible_asset_metadata"];
+
+/**
+ * The response containing the activities related to fungible assets.
+ */
 export type GetFungibleAssetActivitiesResponse = GetFungibleAssetActivitiesQuery["fungible_asset_activities"];
+
+/**
+ * The current balances of fungible assets for a specific query.
+ */
 export type GetCurrentFungibleAssetBalancesResponse =
   GetCurrentFungibleAssetBalancesQuery["current_fungible_asset_balances"];
+
+/**
+ * The response structure for retrieving token activity data.
+ */
 export type GetTokenActivityResponse = GetTokenActivityQuery["token_activities_v2"];
+
+/**
+ * The response structure for retrieving the current token ownership details.
+ */
 export type GetCurrentTokenOwnershipResponse = GetCurrentTokenOwnershipQuery["current_token_ownerships_v2"][0];
+
+/**
+ * The response containing the current token ownerships for a user.
+ */
 export type GetOwnedTokensResponse = GetCurrentTokenOwnershipQuery["current_token_ownerships_v2"];
+
+/**
+ * The response structure for retrieving items from a table.
+ */
 export type GetTableItemsDataResponse = GetTableItemsDataQuery["table_items"];
+
+/**
+ * The metadata for table items retrieved from a query.
+ */
 export type GetTableItemsMetadataResponse = GetTableItemsMetadataQuery["table_metadatas"];
 
+/**
+ * The response containing the current Aptos names from the GetNamesQuery.
+ */
 export type GetANSNameResponse = GetNamesQuery["current_aptos_names"];
 
 /**
@@ -78,6 +154,10 @@ export type GetANSNameResponse = GetNamesQuery["current_aptos_names"];
  * array of properties we can sort the query by
  */
 export type OrderBy<T> = Array<{ [K in keyof T]?: OrderByValue }>;
+
+/**
+ * Specifies the order direction for sorting, including options for handling null values.
+ */
 export type OrderByValue =
   | "asc"
   | "asc_nulls_first"
@@ -87,12 +167,12 @@ export type OrderByValue =
   | "desc_nulls_last";
 
 /**
- * Refers to the token standard we want to query for
+ * The token standard to query for, which can be either version "v1" or "v2".
  */
 export type TokenStandard = "v1" | "v2";
 
 /**
- * The graphql query type to pass into the `queryIndexer` function
+ * The GraphQL query to pass into the `queryIndexer` function.
  */
 export type GraphqlQuery = {
   query: string;

package/src/types/keyless.ts

@@ -1,3 +1,6 @@
+/**
+ * The payload for a prover request, containing a Base64-encoded JWT.
+ */
 export type ProverRequest = {
   jwt_b64: string;
   epk: string;
@@ -7,11 +10,19 @@ export type ProverRequest = {
   uid_key: string;
   pepper: string;
 };
+
+/**
+ * The response from the prover containing the proof data.
+ */
 export type ProverResponse = {
   proof: { a: string; b: string; c: string };
   public_inputs_hash: string;
   training_wheels_signature: string;
 };
+
+/**
+ * The request payload for fetching data, containing a base64 encoded JWT.
+ */
 export type PepperFetchRequest = {
   jwt_b64: number;
   epk: string;
@@ -20,8 +31,15 @@ export type PepperFetchRequest = {
   uid_key: string;
   derivation_path: string;
 };
+
+/**
+ * The response object containing the fetched pepper string.
+ */
 export type PepperFetchResponse = { pepper: string; address: string };
 
+/**
+ * The response for keyless configuration containing the maximum committed EPK bytes.
+ */
 export type KeylessConfigurationResponse = {
   max_commited_epk_bytes: number;
   max_exp_horizon_secs: string;
@@ -33,6 +51,9 @@ export type KeylessConfigurationResponse = {
   training_wheels_pubkey: { vec: string[] };
 };
 
+/**
+ * The response containing the Groth16 verification key, including the alpha_g1 component.
+ */
 export type Groth16VerificationKeyResponse = {
   alpha_g1: string;
   beta_g2: string;

package/src/utils/apiEndpoints.ts

@@ -38,6 +38,9 @@ export const NetworkToProverAPI: Record<string, string> = {
   local: "https://api.devnet.aptoslabs.com/keyless/prover/v0",
 };
 
+/**
+ * Different network environments for connecting to services, ranging from production to development setups.
+ */
 export enum Network {
   MAINNET = "mainnet",
   TESTNET = "testnet",

package/src/utils/const.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- * Type of API endpoint for request routing
+ * Types of API endpoints used for routing requests in the Aptos network.
  */
 export enum AptosApiType {
   FULLNODE = "Fullnode",
@@ -50,9 +50,7 @@ export const RAW_TRANSACTION_SALT = "APTOS::RawTransaction";
 export const RAW_TRANSACTION_WITH_DATA_SALT = "APTOS::RawTransactionWithData";
 
 /**
- * The list of supported Processor types for our indexer api.
- *
- * These can be found from the processor_status table in the indexer database.
+ * 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}
  */
 export enum ProcessorType {

package/src/utils/helpers.ts

@@ -5,8 +5,10 @@ import { decode } from "js-base64";
 import { MoveStructId } from "../types";
 
 /**
- * Sleep the current thread for the given amount of time
- * @param timeMs time in milliseconds to sleep
+ * 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.
  */
 export async function sleep(timeMs: number): Promise<null> {
   return new Promise((resolve) => {
@@ -16,6 +18,12 @@ export async function sleep(timeMs: number): Promise<null> {
 
 export const nowInSeconds = () => Math.floor(Date.now() / 1000);
 
+/**
+ * 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.
+ */
 export function floorToWholeHour(timestampInSeconds: number): number {
   const date = new Date(timestampInSeconds * 1000);
   // Reset minutes and seconds to zero
@@ -25,6 +33,13 @@ export function floorToWholeHour(timestampInSeconds: number): number {
   return Math.floor(date.getTime() / 1000);
 }
 
+/**
+ * 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.
+ */
 export function base64UrlDecode(base64Url: string): string {
   // Replace base64url-specific characters
   const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
@@ -36,27 +51,27 @@ export function base64UrlDecode(base64Url: string): string {
 
 /**
  * Amount is represented in the smallest unit format on chain, this function converts
- * a human readable amount format to the smallest unit format
+ * a human-readable amount format to the smallest unit format
  * @example
- * human readable amount format: 500
+ * human-readable amount format: 500
  * on chain amount format when decimal is 8: 50000000000
  *
- * @param value The value in human readable format
+ * @param value The value in human-readable format
  * @param decimal The token decimal
- * @returns The value is smallest units
+ * @returns The value in the smallest units
  */
 export const convertAmountFromHumanReadableToOnChain = (value: number, decimal: number) => value * 10 ** decimal;
 
 /**
  * Amount is represented in the smallest unit format on chain, this function converts
- * the smallest unit format to a human readable amount format
+ * the smallest unit format to a human-readable amount format
  * @example
- * human readable amount format: 500
+ * human-readable amount format: 500
  * on chain amount format when decimal is 8: 50000000000
  *
- * @param value The value in human readable format
+ * @param value The value in human-readable format
  * @param decimal The token decimal
- * @returns The value is smallest units
+ * @returns The value in the smallest units
  */
 export const convertAmountFromOnChainToHumanReadable = (value: number, decimal: number) => value / 10 ** decimal;
 

package/src/utils/memoize.ts

@@ -8,12 +8,14 @@
 const cache = new Map<string, { value: any; timestamp: number }>();
 
 /**
- * A memoize high order function to cache async function response
+ * 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 An async function to cache the result of
- * @param key The provided cache key
- * @param ttlMs time-to-live in milliseconds for cached data
- * @returns the cached or latest result
+ * @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.
  */
 export function memoizeAsync<T>(
   func: (...args: any[]) => Promise<T>,
@@ -40,12 +42,12 @@ export function memoizeAsync<T>(
 }
 
 /**
- * A memoize high order function to cache function response
+ * Caches the result of a function call to improve performance on subsequent calls with the same arguments.
  *
- * @param func A function to cache the result of
- * @param key The provided cache key
- * @param ttlMs time-to-live in milliseconds for cached data
- * @returns the cached or latest result
+ * @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.
  */
 export function memoize<T>(func: (...args: any[]) => T, key: string, ttlMs?: number): (...args: any[]) => T {
   return (...args: any[]) => {

package/src/utils/normalizeBundle.ts

@@ -4,15 +4,21 @@
 import { Deserializer, Serializable } from "../bcs";
 
 export 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.
+   */
   deserialize(deserializer: Deserializer): T;
 };
 
 /**
- * Utility function that serializes and deserialize an object back into the same bundle as the sdk.
- * This is a workaround to have the `instanceof` operator work when input objects come from a different
- * bundle.
- * @param cls The class of the object to normalize
- * @param value the instance to normalize
+ * 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.
  */
 export function normalizeBundle<T extends Serializable>(cls: DeserializableClass<T>, value: T) {
   const serializedBytes = value.bcsToBytes();

package/src/version.ts

@@ -6,4 +6,4 @@
  *
  * hardcoded for now, we would want to have it injected dynamically
  */
-export const VERSION = "1.29.1";
+export const VERSION = "1.31.0";

package/dist/common/chunk-HBPH2AD3.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utils/helpers.ts"],"names":["decode","sleep","timeMs","resolve","nowInSeconds","floorToWholeHour","timestampInSeconds","date","base64UrlDecode","base64Url","base64","paddedBase64","convertAmountFromHumanReadableToOnChain","value","decimal","convertAmountFromOnChainToHumanReadable","hexToAscii","hex","str","n","parseEncodedStruct","structObj","account_address","module_name","struct_name","moduleName","structName","isEncodedStruct"],"mappings":"wMAGA,OAAS,UAAAA,MAAc,YAOvB,eAAsBC,EAAMC,EAA+B,CACzD,OAAO,IAAI,QAASC,GAAY,CAC9B,WAAWA,EAASD,CAAM,CAC5B,CAAC,CACH,CAEO,IAAME,EAAe,IAAM,KAAK,MAAM,KAAK,IAAI,EAAI,GAAI,EAEvD,SAASC,EAAiBC,EAAoC,CACnE,IAAMC,EAAO,IAAI,KAAKD,EAAqB,GAAI,EAE/C,OAAAC,EAAK,WAAW,CAAC,EACjBA,EAAK,WAAW,CAAC,EACjBA,EAAK,gBAAgB,CAAC,EACf,KAAK,MAAMA,EAAK,QAAQ,EAAI,GAAI,CACzC,CAEO,SAASC,EAAgBC,EAA2B,CAEzD,IAAMC,EAASD,EAAU,QAAQ,KAAM,GAAG,EAAE,QAAQ,KAAM,GAAG,EAEvDE,EAAeD,EAAS,KAAK,UAAU,GAAI,EAAKA,EAAO,OAAS,GAAM,CAAC,EAE7E,OADsBV,EAAOW,CAAY,CAE3C,CAaO,IAAMC,EAA0C,CAACC,EAAeC,IAAoBD,EAAQ,IAAMC,EAa5FC,EAA0C,CAACF,EAAeC,IAAoBD,EAAQ,IAAMC,EAUnGE,EAAcC,GAAgB,CAClC,IAAIC,EAAM,GACV,QAASC,EAAI,EAAGA,EAAIF,EAAI,OAAQE,GAAK,EACnCD,GAAO,OAAO,aAAa,SAASD,EAAI,UAAUE,EAAGA,EAAI,CAAC,EAAG,EAAE,CAAC,EAElE,OAAOD,CACT,EAiBaE,EAAsBC,GAIf,CAElB,GAAM,CAAE,gBAAAC,EAAiB,YAAAC,EAAa,YAAAC,CAAY,EAAIH,EAChDI,EAAaT,EAAWO,CAAW,EACnCG,EAAaV,EAAWQ,CAAW,EACzC,MAAO,GAAGF,CAAe,KAAKG,CAAU,KAAKC,CAAU,EACzD,EAWaC,EACXN,GAMA,OAAOA,GAAc,UACrB,CAAC,MAAM,QAAQA,CAAS,GACxBA,IAAc,MACd,oBAAqBA,GACrB,gBAAiBA,GACjB,gBAAiBA,GACjB,OAAOA,EAAU,iBAAoB,UACrC,OAAOA,EAAU,aAAgB,UACjC,OAAOA,EAAU,aAAgB","sourcesContent":["// Copyright © Aptos Foundation\n// SPDX-License-Identifier: Apache-2.0\n\nimport { decode } from \"js-base64\";\nimport { MoveStructId } from \"../types\";\n\n/**\n * Sleep the current thread for the given amount of time\n * @param timeMs time in milliseconds to sleep\n */\nexport async function sleep(timeMs: number): Promise<null> {\n  return new Promise((resolve) => {\n    setTimeout(resolve, timeMs);\n  });\n}\n\nexport const nowInSeconds = () => Math.floor(Date.now() / 1000);\n\nexport function floorToWholeHour(timestampInSeconds: number): number {\n  const date = new Date(timestampInSeconds * 1000);\n  // Reset minutes and seconds to zero\n  date.setMinutes(0);\n  date.setSeconds(0);\n  date.setMilliseconds(0);\n  return Math.floor(date.getTime() / 1000);\n}\n\nexport function base64UrlDecode(base64Url: string): string {\n  // Replace base64url-specific characters\n  const base64 = base64Url.replace(/-/g, \"+\").replace(/_/g, \"/\");\n  // Pad the string with '=' characters if needed\n  const paddedBase64 = base64 + \"==\".substring(0, (3 - (base64.length % 3)) % 3);\n  const decodedString = decode(paddedBase64);\n  return decodedString;\n}\n\n/**\n * Amount is represented in the smallest unit format on chain, this function converts\n * a human readable amount format to the smallest unit format\n * @example\n * human readable amount format: 500\n * on chain amount format when decimal is 8: 50000000000\n *\n * @param value The value in human readable format\n * @param decimal The token decimal\n * @returns The value is smallest units\n */\nexport const convertAmountFromHumanReadableToOnChain = (value: number, decimal: number) => value * 10 ** decimal;\n\n/**\n * Amount is represented in the smallest unit format on chain, this function converts\n * the smallest unit format to a human readable amount format\n * @example\n * human readable amount format: 500\n * on chain amount format when decimal is 8: 50000000000\n *\n * @param value The value in human readable format\n * @param decimal The token decimal\n * @returns The value is smallest units\n */\nexport const convertAmountFromOnChainToHumanReadable = (value: number, decimal: number) => value / 10 ** decimal;\n\n/**\n * Convert a hex string to an ascii string with the `0x` prefix.\n *\n * `0x6170746f735f636f696e` --> `aptos_coin`\n *\n * @param hex The hex string to convert (e.g. `0x6170746f735f636f696e`)\n * @returns The ascii string\n */\nconst hexToAscii = (hex: string) => {\n  let str = \"\";\n  for (let n = 2; n < hex.length; n += 2) {\n    str += String.fromCharCode(parseInt(hex.substring(n, n + 2), 16));\n  }\n  return str;\n};\n\n/**\n * Convert an encoded struct to a MoveStructId.\n *\n * @example\n * const structObj = {\n *   account_address: \"0x1\",\n *   module_name: \"0x6170746f735f636f696e\",\n *   struct_name: \"0x4170746f73436f696e\",\n * };\n * // structId is \"0x1::aptos_coin::AptosCoin\"\n * const structId = parseEncodedStruct(structObj);\n *\n * @param structObj The struct with account_address, module_name, and struct_name properties\n * @returns The MoveStructId\n */\nexport const parseEncodedStruct = (structObj: {\n  account_address: string;\n  module_name: string;\n  struct_name: string;\n}): MoveStructId => {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  const { account_address, module_name, struct_name } = structObj;\n  const moduleName = hexToAscii(module_name);\n  const structName = hexToAscii(struct_name);\n  return `${account_address}::${moduleName}::${structName}`;\n};\n\n/**\n * Determines whether the given object is an encoded struct type with the following properties:\n * - account_address: string\n * - module_name: string\n * - struct_name: string\n *\n * @param structObj The object to check\n * @returns Whether the object is an encoded struct type\n */\nexport const isEncodedStruct = (\n  structObj: any,\n): structObj is {\n  account_address: string;\n  module_name: string;\n  struct_name: string;\n} =>\n  typeof structObj === \"object\" &&\n  !Array.isArray(structObj) &&\n  structObj !== null &&\n  \"account_address\" in structObj &&\n  \"module_name\" in structObj &&\n  \"struct_name\" in structObj &&\n  typeof structObj.account_address === \"string\" &&\n  typeof structObj.module_name === \"string\" &&\n  typeof structObj.struct_name === \"string\";\n"]}