@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/src/types/generated/operations.ts

@@ -1,4 +1,5 @@
-import * as Types from "./types";
+import * as Types from "./types.js";
+import { AnsTokenStandard, SubdomainExpirationPolicy } from "../ans.js";
 
 export type TokenActivitiesFieldsFragment = {
   after_value?: string | null;
@@ -528,10 +529,10 @@ export type GetNamesQuery = {
     expiration_timestamp?: any | null;
     registered_address?: string | null;
     subdomain?: string | null;
-    token_standard?: string | null;
+    token_standard?: AnsTokenStandard | null;
     is_primary?: boolean | null;
     owner_address?: string | null;
-    subdomain_expiration_policy?: any | null;
+    subdomain_expiration_policy?: SubdomainExpirationPolicy | null;
     domain_expiration_timestamp?: any | null;
   }>;
   current_aptos_names_aggregate: { aggregate?: { count: number } | null };

package/src/types/generated/queries.ts

@@ -1,4 +1,4 @@
-import * as Types from "./operations";
+import * as Types from "./operations.js";
 
 import { GraphQLClient, RequestOptions } from "graphql-request";
 type GraphQLClientRequestHeaders = RequestOptions["requestHeaders"];

package/src/types/index.ts

@@ -1,3 +1,3 @@
-export * from "./indexer";
-export * from "./types";
-export * from "./ans";
+export * from "./indexer.js";
+export * from "./types.js";
+export * from "./ans.js";

package/src/types/indexer.ts

@@ -35,7 +35,7 @@ import {
   GetTableItemsDataQuery,
   GetTableItemsMetadataQuery,
   GetAccountAddressesForAuthKeyQuery,
-} from "./generated/operations";
+} from "./generated/operations.js";
 
 /**
  * CUSTOM RESPONSE TYPES FOR THE END USER

package/src/types/types.ts

@@ -1,10 +1,10 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import type { AptosConfig } from "../api";
-import { InputSubmitTransactionData } from "../transactions";
-import { Network } from "../utils/apiEndpoints";
-import { OrderBy, TokenStandard } from "./indexer";
+import type { AptosConfig } from "../api/aptosConfig.js";
+import { InputSubmitTransactionData } from "../transactions/index.js";
+import { Network } from "../utils/apiEndpoints.js";
+import { OrderBy, TokenStandard } from "./indexer.js";
 
 /**
  * Different MIME types used for data interchange in transactions and responses.
@@ -89,6 +89,16 @@ export enum TransactionPayloadVariants {
   EntryFunction = 2,
   Multisig = 3,
   Payload = 4,
+  EncryptedPayload = 5,
+}
+
+/**
+ * Variants for the inner payload of a multisig account transaction.
+ * {@link https://github.com/aptos-labs/aptos-core/blob/main/aptos-move/framework/aptos-framework/sources/multisig_account.move}
+ */
+export enum MultiSigTransactionPayloadVariants {
+  EntryFunction = 0,
+  Script = 1,
 }
 
 /**
@@ -109,6 +119,7 @@ export enum TransactionExecutableVariants {
   Script = 0,
   EntryFunction = 1,
   Empty = 2,
+  Encrypted = 3,
 }
 
 /**
@@ -1095,9 +1106,61 @@ export type DeletedTableData = {
 };
 
 /**
- * The payload for a transaction response, which can be an entry function, script, or multisig payload.
+ * Claimed entry function metadata on encrypted transaction payloads (REST API uses `name` for the optional function identifier).
+ */
+export type ClaimedEntryFunctionResponse = {
+  module: string;
+  name?: string;
+};
+
+/**
+ * Encrypted payload response when the node has not yet decrypted it, or decryption failed.
+ * Narrow on `encrypted_state` to distinguish from {@link DecryptedEncryptedTransactionPayloadResponse}.
  */
-export type TransactionPayloadResponse = EntryFunctionPayloadResponse | ScriptPayloadResponse | MultisigPayloadResponse;
+export type EncryptedEncryptedTransactionPayloadResponse = {
+  type: string;
+  encrypted_state: "encrypted" | "failed_decryption";
+  payload_hash: string;
+  ciphertext: string;
+  claimed_entry_fun: ClaimedEntryFunctionResponse | null;
+  /** Ledger epoch hint for the encryption key used on the wire (aptos-core `EncryptedInner.encryption_epoch`). */
+  encryption_epoch?: string;
+  /** Present when `encrypted_state` is `failed_decryption`. Not yet surfaced by the REST API; reserved for future use. */
+  decryption_failure_reason?: string;
+};
+
+/**
+ * Encrypted payload response after the node has successfully decrypted it.
+ * Narrow on `encrypted_state === "decrypted"` to access `decrypted_payload`.
+ */
+export type DecryptedEncryptedTransactionPayloadResponse = {
+  type: string;
+  encrypted_state: "decrypted";
+  payload_hash: string;
+  ciphertext: string;
+  claimed_entry_fun: ClaimedEntryFunctionResponse | null;
+  decrypted_payload: EntryFunctionPayloadResponse | ScriptPayloadResponse | MultisigPayloadResponse;
+  decryption_nonce: string;
+  encryption_epoch?: string;
+};
+
+/**
+ * Encrypted transaction payload as returned by the API. Discriminate on `encrypted_state`:
+ * - `"encrypted"` / `"failed_decryption"` → {@link EncryptedEncryptedTransactionPayloadResponse}
+ * - `"decrypted"` → {@link DecryptedEncryptedTransactionPayloadResponse}
+ */
+export type EncryptedTransactionPayloadResponse =
+  | EncryptedEncryptedTransactionPayloadResponse
+  | DecryptedEncryptedTransactionPayloadResponse;
+
+/**
+ * The payload for a transaction response, which can be an entry function, script, multisig, or encrypted payload.
+ */
+export type TransactionPayloadResponse =
+  | EntryFunctionPayloadResponse
+  | ScriptPayloadResponse
+  | MultisigPayloadResponse
+  | EncryptedTransactionPayloadResponse;
 
 /**
  * The response payload for an entry function, containing the type of the entry.
@@ -1674,6 +1737,11 @@ export type LedgerInfo = {
    * software version used by the API endpoint.
    */
   git_hash?: string;
+  /**
+   * Hex-encoded encryption key for encrypted transactions.
+   * Present when the node supports encrypted transaction submission.
+   */
+  encryption_key?: string;
 };
 
 /**

package/src/utils/const.ts

@@ -37,6 +37,14 @@ export const DEFAULT_MAX_GAS_AMOUNT = 2000000;
  */
 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.
  *
@@ -112,5 +120,10 @@ export const FIREBASE_AUTH_ISS_PATTERN = /^https:\/\/securetoken\.google\.com\/[
 
 /**
  * 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();
+export const TEXT_ENCODER: { encode(input: string): Uint8Array } = new TextEncoder();

package/src/utils/helpers.ts

@@ -1,10 +1,10 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { Base64, decode } from "js-base64";
-import { MoveFunctionId, MoveStructId } from "../types";
-import { AccountAddress } from "../core/accountAddress";
-import { createObjectAddress } from "../core/account/utils/address";
+import { MoveFunctionId, MoveStructId } from "../types/index.js";
+import { AccountAddress } from "../core/accountAddress.js";
+import { createObjectAddress } from "../core/account/utils/address.js";
+import { TEXT_ENCODER } from "./const.js";
 
 /**
  * Checks if the current runtime environment is Bun.
@@ -23,6 +23,17 @@ export 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 function getEnvVar(name: string): string | undefined {
+  return typeof process !== "undefined" ? process.env?.[name] : undefined;
+}
+
 /**
  * Logs a warning message to the console only in development environments.
  * This function helps reduce information leakage in production while maintaining
@@ -55,7 +66,7 @@ export function warnIfDevelopment(message: string): void {
  * @group Implementation
  * @category Utils
  */
-export async function sleep(timeMs: number): Promise<null> {
+export async function sleep(timeMs: number): Promise<void> {
   return new Promise((resolve) => {
     setTimeout(resolve, timeMs);
   });
@@ -106,23 +117,52 @@ export function floorToWholeHour(timestampInSeconds: number): number {
  * @category Utils
  */
 export function base64UrlDecode(base64Url: string): string {
-  // Replace base64url-specific characters
-  const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
-  // Pad the string with '=' characters if needed
-  const paddedBase64 = base64 + "==".substring(0, (3 - (base64.length % 3)) % 3);
-  const decodedString = decode(paddedBase64);
-  return decodedString;
+  // Decode the bytes, then interpret as UTF-8. `atob` alone returns a Latin-1 binary
+  // string which corrupts any non-ASCII characters in JWT headers/payloads.
+  return new TextDecoder("utf-8").decode(base64UrlToBytes(base64Url));
+}
+
+/**
+ * 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 function base64UrlEncode(input: string | Uint8Array): string {
+  const bytes = typeof input === "string" ? TEXT_ENCODER.encode(input) : input;
+  // btoa requires a Latin-1 string. Build it in chunks of 8 KiB so we avoid
+  // `String.fromCharCode(...hugeArray)` call-stack overflows while still
+  // keeping conversion linear-time (concatenating per-byte is O(n^2) in many
+  // engines).
+  const CHUNK = 0x8000;
+  let binary = "";
+  if (bytes.length <= CHUNK) {
+    binary = String.fromCharCode.apply(null, bytes as unknown as number[]);
+  } else {
+    const parts: string[] = [];
+    for (let i = 0; i < bytes.length; i += CHUNK) {
+      const chunk = bytes.subarray(i, i + CHUNK);
+      parts.push(String.fromCharCode.apply(null, chunk as unknown as number[]));
+    }
+    binary = parts.join("");
+  }
+  return btoa(binary).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
 }
 
 export function base64UrlToBytes(base64Url: string): Uint8Array {
-  // Convert Base64Url to Base64
-  let base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
-  // Add padding if needed
-  while (base64.length % 4 !== 0) {
-    base64 += "=";
+  // Convert base64url to standard base64, then decode with universal atob.
+  // Standard base64 encodes 3 bytes as 4 chars, so the decoded input length
+  // must be a multiple of 4 — pad with `=` based on `length % 4`.
+  const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
+  const padded = base64 + "===".substring(0, (4 - (base64.length % 4)) % 4);
+  const binary = atob(padded);
+  const bytes = new Uint8Array(binary.length);
+  for (let i = 0; i < binary.length; i++) {
+    bytes[i] = binary.charCodeAt(i);
   }
-  // Use js-base64 to convert base64 to Uint8Array
-  return Base64.toUint8Array(base64);
+  return bytes;
 }
 
 /**

package/src/utils/index.ts

@@ -1,4 +1,4 @@
-export * from "./apiEndpoints";
-export * from "./const";
-export * from "./normalizeBundle";
-export * from "./helpers";
+export * from "./apiEndpoints.js";
+export * from "./const.js";
+export * from "./normalizeBundle.js";
+export * from "./helpers.js";

package/src/utils/normalizeBundle.ts

@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { Deserializer, Serializable } from "../bcs";
+import { Deserializer, Serializable } from "../bcs/index.js";
 /**
  * @group Implementation
  * @category Utils

package/src/utils/runtime.ts

@@ -0,0 +1,86 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Runtime detection utilities. Kept out of the `utils` barrel on purpose —
+ * these are internal implementation details used to populate the
+ * `x-aptos-client` telemetry header and are not part of the public SDK API.
+ *
+ * Consumers that need to branch on the current runtime should inspect
+ * `globalThis` themselves (e.g. `typeof Bun !== "undefined"`) rather than
+ * relying on these helpers.
+ *
+ * @internal
+ */
+
+/**
+ * Identifier for the JavaScript runtime the SDK is currently running in.
+ * Used for telemetry (e.g. the `x-aptos-client` header).
+ *
+ * @internal
+ */
+export type RuntimePlatform = "node" | "browser" | "bun" | "deno" | "react-native" | "unknown";
+
+/**
+ * Detects the JavaScript runtime the SDK is currently running in.
+ *
+ * Detection precedence (most specific first): react-native, deno, bun, browser, node.
+ * Falls back to "unknown" if detection fails or the environment is hostile.
+ *
+ * @internal
+ */
+export function getRuntimePlatform(): RuntimePlatform {
+  try {
+    const g = globalThis as any;
+    if (typeof g.navigator !== "undefined" && g.navigator.product === "ReactNative") {
+      return "react-native";
+    }
+    if (typeof g.Deno !== "undefined") return "deno";
+    if (typeof g.Bun !== "undefined") return "bun";
+    if (typeof g.window !== "undefined" && typeof g.document !== "undefined") return "browser";
+    if (g.process?.versions?.node) return "node";
+  } catch {
+    // Fall through to "unknown" in hostile environments.
+  }
+  return "unknown";
+}
+
+/**
+ * Returns a compact runtime tag for the `x-aptos-client` telemetry header.
+ * Node, Bun, and Deno expose their engine version cheaply and synchronously;
+ * browsers do not (userAgent is already forwarded as `User-Agent`), and React
+ * Native's JS-engine version is not reachable from `src/` without a
+ * platform-specific import.
+ *
+ * Shape examples:
+ *   - "node/22.12.0"
+ *   - "bun/1.1.38"
+ *   - "deno/2.1.4"
+ *   - "browser" | "react-native" | "unknown" (no version suffix)
+ *
+ * @internal
+ */
+export function getRuntimePlatformTag(): string {
+  const platform = getRuntimePlatform();
+  try {
+    const g = globalThis as any;
+    switch (platform) {
+      case "node": {
+        const v = g.process?.versions?.node;
+        return v ? `node/${v}` : "node";
+      }
+      case "bun": {
+        const v = g.Bun?.version ?? g.process?.versions?.bun;
+        return v ? `bun/${v}` : "bun";
+      }
+      case "deno": {
+        const v = g.Deno?.version?.deno;
+        return v ? `deno/${v}` : "deno";
+      }
+      default:
+        return platform;
+    }
+  } catch {
+    return platform;
+  }
+}

package/src/version.ts

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