@aptos-labs/ts-sdk 2.0.1 → 3.1.0

package/src/types/indexer.ts

@@ -34,6 +34,7 @@ import {
   GetNamesQuery,
   GetTableItemsDataQuery,
   GetTableItemsMetadataQuery,
+  GetAccountAddressesForAuthKeyQuery,
 } from "./generated/operations";
 
 /**
@@ -80,6 +81,13 @@ export type GetAccountCollectionsWithOwnedTokenResponse =
  */
 export type GetAccountCoinsDataResponse = GetAccountCoinsDataQuery["current_fungible_asset_balances"];
 
+/**
+ * The account addresses for an authentication key.
+ * @group Implementation
+ * @category Types
+ */
+export type GetAccountAddressesForAuthKeyResponse = GetAccountAddressesForAuthKeyQuery["auth_key_account_addresses"];
+
 /**
  * The response structure for retrieving user transactions from the top of the blockchain.
  * @group Implementation

package/src/types/types.ts

@@ -1,6 +1,8 @@
 // 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";
 
@@ -73,6 +75,35 @@ export enum TransactionPayloadVariants {
   Script = 0,
   EntryFunction = 2,
   Multisig = 3,
+  Payload = 4,
+}
+
+/**
+ * The inner payload type to support orderless transactions and all future transaction types.
+ * {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/mod.rs#L478}
+ */
+export enum TransactionInnerPayloadVariants {
+  V1 = 0,
+}
+
+/**
+ * Executable types for transactions, which can be either a script or an entry function.
+ *
+ * Empty is reserved for Multisig voting transactions, which do not have an executable payload.
+ * {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/mod.rs#L685}
+ */
+export enum TransactionExecutableVariants {
+  Script = 0,
+  EntryFunction = 1,
+  Empty = 2,
+}
+
+/**
+ * Variants of transaction extra configurations, which can include additional settings or parameters.
+ * {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/mod.rs#L737}
+ */
+export enum TransactionExtraConfigVariants {
+  V1 = 0,
 }
 
 /**
@@ -128,6 +159,21 @@ export enum AnyPublicKeyVariant {
   FederatedKeyless = 4,
 }
 
+export function anyPublicKeyVariantToString(variant: AnyPublicKeyVariant): string {
+  switch (variant) {
+    case AnyPublicKeyVariant.Ed25519:
+      return "ed25519";
+    case AnyPublicKeyVariant.Secp256k1:
+      return "secp256k1";
+    case AnyPublicKeyVariant.Keyless:
+      return "keyless";
+    case AnyPublicKeyVariant.FederatedKeyless:
+      return "federated_keyless";
+    default:
+      throw new Error("Unknown public key variant");
+  }
+}
+
 /**
  * Variants of signature types used for cryptographic operations.
  */
@@ -225,6 +271,10 @@ export type AptosSettings = {
   readonly indexerConfig?: IndexerConfig;
 
   readonly faucetConfig?: FaucetConfig;
+
+  readonly transactionGenerationConfig?: TransactionGenerationConfig;
+
+  readonly pluginSettings?: PluginSettings;
 };
 
 /**
@@ -293,6 +343,14 @@ export type FaucetConfig = ClientHeadersType & {
   AUTH_TOKEN?: string;
 };
 
+/**
+ * A configuration object for default parameters for transaction generation.
+ */
+export type TransactionGenerationConfig = {
+  defaultMaxGasAmount?: number;
+  defaultTxnExpirySecFromNow?: number;
+};
+
 /**
  * General type definition for client headers.
  */
@@ -300,6 +358,73 @@ export type ClientHeadersType = {
   HEADERS?: Record<string, string | number | boolean>;
 };
 
+/**
+ * Config for plugins. This can be used to override certain client behavior.
+ */
+export type PluginConfig = {
+  /**
+   * If given, this will be used for submitting transactions instead of the default
+   * implementation (which submits transactions directly via a node).
+   */
+  TRANSACTION_SUBMITTER?: TransactionSubmitter;
+
+  /**
+   * If true, we won't use the TRANSACTION_SUBMITTER if set.
+   */
+  IGNORE_TRANSACTION_SUBMITTER?: boolean;
+};
+
+export type PluginSettings = Omit<PluginConfig, "IGNORE_TRANSACTION_SUBMITTER">;
+
+/**
+ * You can implement this interface and set it in {@link PluginSettings} when building a
+ * client to override the default transaction submission behavior. This is useful if
+ * you'd like to submit transactions via a gas station for example.
+ *
+ * @example
+ * ```typescript
+ * class MyGasStationClient implements TransactionSubmitter {
+ *   async submitTransaction(
+ *     args: { aptosConfig: AptosConfig } & InputSubmitTransactionData,
+ *   ): Promise<PendingTransactionResponse> {
+ *     // TODO: Implement the logic to submit the transaction to the gas station
+ *   }
+ * }
+ *
+ * const network = Network.MAINNET;
+ * const myGasStationClient = new MyGasStationClient(network);
+ * const config = new AptosConfig({
+ *   network,
+ *   pluginConfig: {
+ *     transactionSubmitter: myGasStationClient,
+ *   },
+ * });
+ * const aptos = new Aptos(config);
+ * ```
+ */
+export interface TransactionSubmitter {
+  /**
+   * Submit a transaction to the Aptos blockchain or something that will do it on your
+   * behalf, for example a gas station. See the comments of {@link TransactionSubmitter} for more.
+   *
+   * @param args - The arguments for submitting the transaction.
+   * @param args.aptosConfig - The configuration for connecting to the Aptos network.
+   * @param args.transaction - The Aptos transaction data to be submitted.
+   * @param args.senderAuthenticator - The account authenticator of the transaction sender.
+   * @param args.secondarySignerAuthenticators - Optional. Authenticators for additional signers in a multi-signer transaction.
+   * @param args.pluginParams - Optional. Additional parameters for the plugin.
+   * @param args.transactionSubmitter - Optional. An override for the transaction submitter.
+   *
+   * @returns PendingTransactionResponse - The response containing the status of the submitted transaction.
+   * @group Implementation
+   */
+  submitTransaction(
+    args: {
+      aptosConfig: AptosConfig;
+    } & Omit<InputSubmitTransactionData, "transactionSubmitter">,
+  ): Promise<PendingTransactionResponse>;
+}
+
 /**
  * Represents a client for making requests to a service provider.
  *
@@ -593,6 +718,7 @@ export type UserTransactionResponse = {
   changes: Array<WriteSetChange>;
   sender: string;
   sequence_number: string;
+  replay_protection_nonce: string;
   max_gas_amount: string;
   gas_unit_price: string;
   expiration_timestamp_secs: string;
@@ -962,7 +1088,8 @@ export type TransactionSignature =
   | TransactionSecp256k1Signature
   | TransactionMultiEd25519Signature
   | TransactionMultiAgentSignature
-  | TransactionFeePayerSignature;
+  | TransactionFeePayerSignature
+  | TransactionSingleSenderSignature;
 
 /**
  * Determine if the provided signature is an Ed25519 signature.
@@ -972,8 +1099,8 @@ export type TransactionSignature =
  * @param signature - The transaction signature to be checked.
  * @returns A boolean indicating whether the signature is an Ed25519 signature.
  */
-export function isEd25519Signature(signature: TransactionSignature): signature is TransactionFeePayerSignature {
-  return "signature" in signature && signature.signature === "ed25519_signature";
+export function isEd25519Signature(signature: TransactionSignature): signature is TransactionEd25519Signature {
+  return "signature" in signature && signature.type === "ed25519_signature";
 }
 
 /**
@@ -1018,6 +1145,18 @@ export function isMultiEd25519Signature(
   return signature.type === "multi_ed25519_signature";
 }
 
+/**
+ * Determine if the provided signature is of type "single_sender".
+ *
+ * @param signature - The transaction signature to check.
+ * @returns A boolean indicating whether the signature is a single-sender signature.
+ */
+export function isSingleSenderSignature(
+  signature: TransactionSignature,
+): signature is TransactionSingleSenderSignature {
+  return signature.type === "single_sender";
+}
+
 /**
  * The signature for a transaction using the Ed25519 algorithm.
  */
@@ -1036,6 +1175,15 @@ export type TransactionSecp256k1Signature = {
   signature: "secp256k1_ecdsa_signature";
 };
 
+/**
+ * The structure for a multi-signature transaction using Ed25519.
+ */
+export type TransactionSingleSenderSignature = {
+  type: "single_sender";
+  public_key: { value: string; type: string };
+  signature: { value: string; type: string };
+};
+
 /**
  * The structure for a multi-signature transaction using Ed25519.
  */

package/src/utils/const.ts

@@ -77,6 +77,7 @@ export const RAW_TRANSACTION_WITH_DATA_SALT = "APTOS::RawTransactionWithData";
  * @category Utils
  */
 export enum ProcessorType {
+  ACCOUNT_RESTORATION_PROCESSOR = "account_restoration_processor",
   ACCOUNT_TRANSACTION_PROCESSOR = "account_transactions_processor",
   DEFAULT = "default_processor",
   EVENTS_PROCESSOR = "events_processor",

package/src/version.ts

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