@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/src/transactions/types.ts

@@ -24,6 +24,8 @@ import { Serialized } from "../bcs";
 
 /**
  * Entry function arguments for building a raw transaction using remote ABI, supporting various data types including primitives and arrays.
+ * @group Implementation
+ * @category Transactions
  */
 export type SimpleEntryFunctionArgumentTypes =
   | boolean
@@ -38,6 +40,8 @@ export type SimpleEntryFunctionArgumentTypes =
 
 /**
  * Entry function arguments for building a raw transaction using BCS serialized arguments.
+ * @group Implementation
+ * @category Transactions
  */
 export type EntryFunctionArgumentTypes =
   | Bool
@@ -55,6 +59,8 @@ export type EntryFunctionArgumentTypes =
 
 /**
  * Script function arguments for building raw transactions using BCS serialized arguments.
+ * @group Implementation
+ * @category Transactions
  */
 export type ScriptFunctionArgumentTypes =
   | Bool
@@ -88,11 +94,15 @@ export type ScriptFunctionArgumentTypes =
  * - vector<Type>
  * - address::module::struct
  * - address::module::struct<Type1, Type2>
+ * @group Implementation
+ * @category Transactions
  */
 export type TypeArgument = TypeTag | string;
 
 /**
  * Holds all return interfaces for generating different transaction types.
+ * @group Implementation
+ * @category Transactions
  */
 export type AnyRawTransactionInstance = RawTransaction | MultiAgentRawTransaction | FeePayerRawTransaction;
 
@@ -100,6 +110,8 @@ export type AnyRawTransactionInstance = RawTransaction | MultiAgentRawTransactio
 
 /**
  * Optional options to set when generating a transaction, including a maximum gas amount.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputGenerateTransactionOptions = {
   maxGasAmount?: number;
@@ -111,6 +123,8 @@ export type InputGenerateTransactionOptions = {
 /**
  * The transaction payload type generated from the `generateTransactionPayload()` function, which can be an entry function,
  * script, or multi-signature payload.
+ * @group Implementation
+ * @category Transactions
  */
 export type AnyTransactionPayloadInstance =
   | TransactionPayloadEntryFunction
@@ -119,12 +133,16 @@ export type AnyTransactionPayloadInstance =
 
 /**
  * The data needed to generate a transaction payload for Entry Function, Script, or Multi Sig types.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputGenerateTransactionPayloadData = InputEntryFunctionData | InputScriptData | InputMultiSigData;
 
 /**
  * The payload for generating a transaction, which can be either script data, entry function data with remote ABI, or
  * multi-signature data.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputGenerateTransactionPayloadDataWithRemoteABI =
   | InputScriptData
@@ -133,6 +151,8 @@ export type InputGenerateTransactionPayloadDataWithRemoteABI =
 
 /**
  * The data needed to generate an Entry Function payload.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputEntryFunctionData = {
   function: MoveFunctionId;
@@ -143,11 +163,15 @@ export type InputEntryFunctionData = {
 
 /**
  * The payload for generating a transaction, which can be either an entry function or a multi-signature transaction.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputGenerateTransactionPayloadDataWithABI = InputEntryFunctionDataWithABI | InputMultiSigDataWithABI;
 
 /**
  * The input data for an entry function, including its associated ABI.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputEntryFunctionDataWithABI = Omit<InputEntryFunctionData, "abi"> & {
   abi: EntryFunctionABI;
@@ -155,6 +179,8 @@ export type InputEntryFunctionDataWithABI = Omit<InputEntryFunctionData, "abi">
 
 /**
  * The data needed to generate a Multi Sig payload, including the multisig address.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputMultiSigDataWithABI = {
   multisigAddress: AccountAddressInput;
@@ -162,10 +188,14 @@ export type InputMultiSigDataWithABI = {
 
 /**
  * Combines input function data with Aptos configuration for remote ABI interactions.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputEntryFunctionDataWithRemoteABI = InputEntryFunctionData & { aptosConfig: AptosConfig };
 /**
  * The data needed to generate a Multi Sig payload
+ * @group Implementation
+ * @category Transactions
  */
 export type InputMultiSigData = {
   multisigAddress: AccountAddressInput;
@@ -173,6 +203,8 @@ export type InputMultiSigData = {
 
 /**
  * The data needed to generate a Multi Sig payload, including the multisig address.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputMultiSigDataWithRemoteABI = {
   multisigAddress: AccountAddressInput;
@@ -180,6 +212,8 @@ export type InputMultiSigDataWithRemoteABI = {
 
 /**
  * The data needed to generate a Script payload.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputScriptData = {
   bytecode: HexInput;
@@ -189,6 +223,8 @@ export type InputScriptData = {
 
 /**
  * The data needed to generate a View Function payload.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputViewFunctionData = {
   function: MoveFunctionId;
@@ -199,6 +235,8 @@ export type InputViewFunctionData = {
 
 /**
  * The data needed to generate a View Function payload in JSON format.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputViewFunctionJsonData = {
   function: MoveFunctionId;
@@ -208,6 +246,8 @@ export type InputViewFunctionJsonData = {
 
 /**
  * The payload sent to the fullnode for a JSON view request.
+ * @group Implementation
+ * @category Transactions
  */
 export type ViewFunctionJsonPayload = {
   function: MoveFunctionId;
@@ -217,16 +257,22 @@ export type ViewFunctionJsonPayload = {
 
 /**
  * Data required to create a view function payload and retrieve the remote ABI, including Aptos configuration.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputViewFunctionDataWithRemoteABI = InputViewFunctionData & { aptosConfig: AptosConfig };
 
 /**
  * Data needed to generate a view function, including the fetched ABI.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputViewFunctionDataWithABI = InputViewFunctionData & { abi: ViewFunctionABI };
 
 /**
  * Data needed for a generic function ABI, applicable to both view and entry functions.
+ * @group Implementation
+ * @category Transactions
  */
 export type FunctionABI = {
   typeParameters: Array<MoveFunctionGenericTypeParam>;
@@ -235,6 +281,8 @@ export type FunctionABI = {
 
 /**
  * Interface for an Entry function's ABI, enabling type checking and input conversion for ABI-based transaction submissions.
+ * @group Implementation
+ * @category Transactions
  */
 export type EntryFunctionABI = FunctionABI & {
   signers?: number;
@@ -242,6 +290,8 @@ export type EntryFunctionABI = FunctionABI & {
 
 /**
  * Interface for a view function's ABI, providing type checking and input conversion for ABI-based transaction submissions.
+ * @group Implementation
+ * @category Transactions
  */
 export type ViewFunctionABI = FunctionABI & {
   returnTypes: Array<TypeTag>;
@@ -255,6 +305,8 @@ export type ViewFunctionABI = FunctionABI & {
  * @param payload - The transaction payload.
  * @param options - Optional transaction generation options.
  * @param feePayerAddress - Optional address of the fee payer.
+ * @group Implementation
+ * @category Transactions
  */
 export interface InputGenerateSingleSignerRawTransactionArgs {
   aptosConfig: AptosConfig;
@@ -273,6 +325,8 @@ export interface InputGenerateSingleSignerRawTransactionArgs {
  * @param secondarySignerAddresses - List of secondary signer addresses.
  * @param options - Optional settings for transaction generation.
  * @param feePayerAddress - Optional address of the fee payer.
+ * @group Implementation
+ * @category Transactions
  */
 export interface InputGenerateMultiAgentRawTransactionArgs {
   aptosConfig: AptosConfig;
@@ -285,6 +339,8 @@ export interface InputGenerateMultiAgentRawTransactionArgs {
 
 /**
  * A unified type for generating various transaction types.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputGenerateRawTransactionArgs =
   | InputGenerateSingleSignerRawTransactionArgs
@@ -292,6 +348,8 @@ export type InputGenerateRawTransactionArgs =
 
 /**
  * Unified type that holds all the return interfaces when generating different transaction types
+ * @group Implementation
+ * @category Transactions
  */
 export type AnyRawTransaction = SimpleTransaction | MultiAgentTransaction;
 
@@ -299,23 +357,33 @@ export type AnyRawTransaction = SimpleTransaction | MultiAgentTransaction;
 
 /**
  * The data required to simulate a transaction, typically generated by `generateTransaction()`.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputSimulateTransactionData = {
   /**
    * The transaction to simulate, probably generated by `generateTransaction()`
+   * @group Implementation
+   * @category Transactions
    */
   transaction: AnyRawTransaction;
   /**
    * For a single signer transaction
+   * @group Implementation
+   * @category Transactions
    * This is optional and can be undefined to skip the public/auth key check during the transaction simulation.
    */
   signerPublicKey?: PublicKey;
   /**
    * For a fee payer or multi-agent transaction that requires additional signers in
+   * @group Implementation
+   * @category Transactions
    */
   secondarySignersPublicKeys?: Array<PublicKey | undefined>;
   /**
    * For a fee payer transaction (aka Sponsored Transaction)
+   * @group Implementation
+   * @category Transactions
    */
   feePayerPublicKey?: PublicKey;
   options?: InputSimulateTransactionOptions;
@@ -323,6 +391,8 @@ export type InputSimulateTransactionData = {
 
 /**
  * Options for simulating a transaction input, including whether to estimate the gas unit price.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputSimulateTransactionOptions = {
   estimateGasUnitPrice?: boolean;
@@ -340,6 +410,8 @@ export type InputSimulateTransactionOptions = {
  * @param options - Optional transaction options.
  * @param withFeePayer - Indicates if the fee payer is included.
  * @param secondarySignerAddresses - Addresses for any secondary signers (not used in single signer transactions).
+ * @group Implementation
+ * @category Transactions
  */
 export interface InputGenerateSingleSignerRawTransactionData {
   sender: AccountAddressInput;
@@ -357,6 +429,8 @@ export interface InputGenerateSingleSignerRawTransactionData {
  * @param secondarySignerAddresses - An array of addresses for secondary signers.
  * @param options - Optional transaction options.
  * @param withFeePayer - Indicates if a fee payer is included.
+ * @group Implementation
+ * @category Transactions
  */
 export interface InputGenerateMultiAgentRawTransactionData {
   sender: AccountAddressInput;
@@ -368,6 +442,8 @@ export interface InputGenerateMultiAgentRawTransactionData {
 
 /**
  * Unified type holding user data input interfaces for generating various transaction types.
+ * @group Implementation
+ * @category Transactions
  */
 export type InputGenerateTransactionData =
   | InputGenerateSingleSignerRawTransactionData
@@ -380,6 +456,8 @@ export type InputGenerateTransactionData =
  * @param senderAuthenticator - The authenticator for the sender's account.
  * @param feePayerAuthenticator - Optional authenticator for the fee payer's account.
  * @param additionalSignersAuthenticators - Optional array of authenticators for additional signers.
+ * @group Implementation
+ * @category Transactions
  */
 export interface InputSubmitTransactionData {
   transaction: AnyRawTransaction;

package/src/types/indexer.ts

@@ -9,6 +9,8 @@
  *
  * These types are used as the return type when making the actual request (usually
  * under the /internal/ folder)
+ * @group Implementation
+ * @category Types
  */
 
 import {
@@ -43,120 +45,166 @@ import {
  *
  * These types are used as the return type when calling a sdk api function
  * that calls the function that queries the server (usually under the /api/ folder)
+ * @group Implementation
+ * @category Types
  */
 export type GetObjectDataQueryResponse = GetObjectDataQuery["current_objects"];
 
 /**
  * The response structure for querying tokens owned by an account.
+ * @group Implementation
+ * @category Types
  */
 export type GetAccountOwnedTokensQueryResponse = GetAccountOwnedTokensQuery["current_token_ownerships_v2"];
 
 /**
  * The response containing the current token ownerships for an account from a specific collection.
+ * @group Implementation
+ * @category Types
  */
 export type GetAccountOwnedTokensFromCollectionResponse =
   GetAccountOwnedTokensFromCollectionQuery["current_token_ownerships_v2"];
 
 /**
  * The response structure for retrieving account collections associated with owned tokens.
+ * @group Implementation
+ * @category Types
  */
 export type GetAccountCollectionsWithOwnedTokenResponse =
   GetAccountCollectionsWithOwnedTokensQuery["current_collection_ownership_v2_view"];
 
 /**
  * The current balances of fungible assets for an account.
+ * @group Implementation
+ * @category Types
  */
 export type GetAccountCoinsDataResponse = GetAccountCoinsDataQuery["current_fungible_asset_balances"];
 
 /**
  * The response structure for retrieving user transactions from the top of the blockchain.
+ * @group Implementation
+ * @category Types
  */
 export type GetChainTopUserTransactionsResponse = GetChainTopUserTransactionsQuery["user_transactions"];
 
 /**
  * The response containing the events from the GetEventsQuery.
+ * @group Implementation
+ * @category Types
  */
 export type GetEventsResponse = GetEventsQuery["events"];
 
 /**
  * The number of active delegators per pool in response to a query.
+ * @group Implementation
+ * @category Types
  */
 export type GetNumberOfDelegatorsResponse = GetNumberOfDelegatorsQuery["num_active_delegator_per_pool"];
 
 /**
  * The response containing the delegated staking activities from the query.
+ * @group Implementation
+ * @category Types
  */
 export type GetDelegatedStakingActivitiesResponse = GetDelegatedStakingActivitiesQuery["delegated_staking_activities"];
 
 /**
  * The response structure for retrieving data from the current collections.
+ * @group Implementation
+ * @category Types
  */
 export type GetCollectionDataResponse = GetCollectionDataQuery["current_collections_v2"][0];
 
 /**
  * The response structure for retrieving token data, containing the current token information.
+ * @group Implementation
+ * @category Types
  */
 export type GetTokenDataResponse = GetTokenDataQuery["current_token_datas_v2"][0];
 
 /**
  * The status of the processor as returned by the GetProcessorStatusQuery.
+ * @group Implementation
+ * @category Types
  */
 export type GetProcessorStatusResponse = GetProcessorStatusQuery["processor_status"];
 
 /**
  * The response containing metadata for a fungible asset.
+ * @group Implementation
+ * @category Types
  */
 export type GetFungibleAssetMetadataResponse = GetFungibleAssetMetadataQuery["fungible_asset_metadata"];
 
 /**
  * The response containing the activities related to fungible assets.
+ * @group Implementation
+ * @category Types
  */
 export type GetFungibleAssetActivitiesResponse = GetFungibleAssetActivitiesQuery["fungible_asset_activities"];
 
 /**
  * The current balances of fungible assets for a specific query.
+ * @group Implementation
+ * @category Types
  */
 export type GetCurrentFungibleAssetBalancesResponse =
   GetCurrentFungibleAssetBalancesQuery["current_fungible_asset_balances"];
 
 /**
  * The response structure for retrieving token activity data.
+ * @group Implementation
+ * @category Types
  */
 export type GetTokenActivityResponse = GetTokenActivityQuery["token_activities_v2"];
 
 /**
  * The response structure for retrieving the current token ownership details.
+ * @group Implementation
+ * @category Types
  */
 export type GetCurrentTokenOwnershipResponse = GetCurrentTokenOwnershipQuery["current_token_ownerships_v2"][0];
 
 /**
  * The response containing the current token ownerships for a user.
+ * @group Implementation
+ * @category Types
  */
 export type GetOwnedTokensResponse = GetCurrentTokenOwnershipQuery["current_token_ownerships_v2"];
 
 /**
  * The response structure for retrieving items from a table.
+ * @group Implementation
+ * @category Types
  */
 export type GetTableItemsDataResponse = GetTableItemsDataQuery["table_items"];
 
 /**
  * The metadata for table items retrieved from a query.
+ * @group Implementation
+ * @category Types
  */
 export type GetTableItemsMetadataResponse = GetTableItemsMetadataQuery["table_metadatas"];
 
 /**
  * The response containing the current Aptos names from the GetNamesQuery.
+ * @group Implementation
+ * @category Types
  */
 export type GetANSNameResponse = GetNamesQuery["current_aptos_names"];
 
 /**
  * A generic type that being passed by each function and holds an
  * array of properties we can sort the query by
+ * @group Implementation
+ * @category Types
  */
 export type OrderBy<T> = Array<{ [K in keyof T]?: OrderByValue }>;
 
 /**
  * Specifies the order direction for sorting, including options for handling null values.
+ * @group Implementation
+ * @category Types
  */
 export type OrderByValue =
   | "asc"
@@ -168,11 +216,15 @@ export type OrderByValue =
 
 /**
  * The token standard to query for, which can be either version "v1" or "v2".
+ * @group Implementation
+ * @category Types
  */
 export type TokenStandard = "v1" | "v2";
 
 /**
  * The GraphQL query to pass into the `queryIndexer` function.
+ * @group Implementation
+ * @category Types
  */
 export type GraphqlQuery = {
   query: string;

package/src/types/keyless.ts

@@ -1,5 +1,7 @@
 /**
  * The payload for a prover request, containing a Base64-encoded JWT.
+ * @group Implementation
+ * @category Types
  */
 export type ProverRequest = {
   jwt_b64: string;
@@ -13,6 +15,8 @@ export type ProverRequest = {
 
 /**
  * The response from the prover containing the proof data.
+ * @group Implementation
+ * @category Types
  */
 export type ProverResponse = {
   proof: { a: string; b: string; c: string };
@@ -22,6 +26,8 @@ export type ProverResponse = {
 
 /**
  * The request payload for fetching data, containing a base64 encoded JWT.
+ * @group Implementation
+ * @category Types
  */
 export type PepperFetchRequest = {
   jwt_b64: number;
@@ -34,11 +40,15 @@ export type PepperFetchRequest = {
 
 /**
  * The response object containing the fetched pepper string.
+ * @group Implementation
+ * @category Types
  */
 export type PepperFetchResponse = { pepper: string; address: string };
 
 /**
  * The response for keyless configuration containing the maximum committed EPK bytes.
+ * @group Implementation
+ * @category Types
  */
 export type KeylessConfigurationResponse = {
   max_commited_epk_bytes: number;
@@ -53,6 +63,8 @@ export type KeylessConfigurationResponse = {
 
 /**
  * The response containing the Groth16 verification key, including the alpha_g1 component.
+ * @group Implementation
+ * @category Types
  */
 export type Groth16VerificationKeyResponse = {
   alpha_g1: string;

package/src/utils/apiEndpoints.ts

@@ -1,6 +1,10 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
+/**
+ * @group Implementation
+ * @category Network
+ */
 export const NetworkToIndexerAPI: Record<string, string> = {
   mainnet: "https://api.mainnet.aptoslabs.com/v1/graphql",
   testnet: "https://api.testnet.aptoslabs.com/v1/graphql",
@@ -8,6 +12,10 @@ export const NetworkToIndexerAPI: Record<string, string> = {
   local: "http://127.0.0.1:8090/v1/graphql",
 };
 
+/**
+ * @group Implementation
+ * @category Network
+ */
 export const NetworkToNodeAPI: Record<string, string> = {
   mainnet: "https://api.mainnet.aptoslabs.com/v1",
   testnet: "https://api.testnet.aptoslabs.com/v1",
@@ -15,13 +23,19 @@ export const NetworkToNodeAPI: Record<string, string> = {
   local: "http://127.0.0.1:8080/v1",
 };
 
+/**
+ * @group Implementation
+ * @category Network
+ */
 export const NetworkToFaucetAPI: Record<string, string> = {
-  mainnet: "https://faucet.mainnet.aptoslabs.com",
-  testnet: "https://faucet.testnet.aptoslabs.com",
   devnet: "https://faucet.devnet.aptoslabs.com",
   local: "http://127.0.0.1:8081",
 };
 
+/**
+ * @group Implementation
+ * @category Network
+ */
 export const NetworkToPepperAPI: Record<string, string> = {
   mainnet: "https://api.mainnet.aptoslabs.com/keyless/pepper/v0",
   testnet: "https://api.testnet.aptoslabs.com/keyless/pepper/v0",
@@ -30,6 +44,10 @@ export const NetworkToPepperAPI: Record<string, string> = {
   local: "https://api.devnet.aptoslabs.com/keyless/pepper/v0",
 };
 
+/**
+ * @group Implementation
+ * @category Network
+ */
 export const NetworkToProverAPI: Record<string, string> = {
   mainnet: "https://api.mainnet.aptoslabs.com/keyless/prover/v0",
   testnet: "https://api.testnet.aptoslabs.com/keyless/prover/v0",
@@ -40,6 +58,8 @@ export const NetworkToProverAPI: Record<string, string> = {
 
 /**
  * Different network environments for connecting to services, ranging from production to development setups.
+ * @group Implementation
+ * @category Network
  */
 export enum Network {
   MAINNET = "mainnet",
@@ -49,12 +69,20 @@ export enum Network {
   CUSTOM = "custom",
 }
 
+/**
+ * @group Implementation
+ * @category Network
+ */
 export const NetworkToChainId: Record<string, number> = {
   mainnet: 1,
   testnet: 2,
   local: 4,
 };
 
+/**
+ * @group Implementation
+ * @category Network
+ */
 export const NetworkToNetworkName: Record<string, Network> = {
   mainnet: Network.MAINNET,
   testnet: Network.TESTNET,