@aptos-labs/ts-sdk 0.0.2 → 0.0.3

package/src/transactions/types.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { AptosConfig } from "../api/aptosConfig";
-import { MoveObject, MoveOption, MoveString, MoveVector } from "../bcs/serializable/moveStructs";
+import { MoveOption, MoveString, MoveVector } from "../bcs/serializable/moveStructs";
 import { Bool, U128, U16, U256, U32, U64, U8 } from "../bcs/serializable/movePrimitives";
 import { FixedBytes } from "../bcs/serializable/fixedBytes";
 import { AccountAddress } from "../core";
@@ -15,9 +15,25 @@ import {
   TransactionPayloadMultisig,
   TransactionPayloadScript,
 } from "./instances";
-import { AnyNumber, HexInput, MoveStructType } from "../types";
-import { TypeTag } from "./typeTag/typeTag";
+import { AnyNumber, HexInput, MoveFunctionGenericTypeParam, MoveStructType } from "../types";
+import { TypeTag } from "./typeTag";
 
+/**
+ * Entry function arguments to be used when building a raw transaction using remote ABI
+ */
+export type SimpleEntryFunctionArgumentTypes =
+  | boolean
+  | number
+  | bigint
+  | string
+  | null // To support optional empty
+  | undefined // To support optional empty
+  | Uint8Array
+  | Array<SimpleEntryFunctionArgumentTypes>;
+
+/**
+ * Entry function arguments to be used when building a raw transaction using BCS serialized arguments
+ */
 export type EntryFunctionArgumentTypes =
   | Bool
   | U8
@@ -27,11 +43,14 @@ export type EntryFunctionArgumentTypes =
   | U128
   | U256
   | AccountAddress
-  | MoveObject
   | MoveVector<EntryFunctionArgumentTypes>
   | MoveOption<EntryFunctionArgumentTypes>
   | MoveString
   | FixedBytes;
+
+/**
+ * Script function arguments to be used when building a raw transaction using BCS serialized arguments
+ */
 export type ScriptFunctionArgumentTypes =
   | Bool
   | U8
@@ -41,7 +60,6 @@ export type ScriptFunctionArgumentTypes =
   | U128
   | U256
   | AccountAddress
-  | MoveObject
   | MoveVector<U8>
   | MoveString
   | FixedBytes;
@@ -56,7 +74,7 @@ export type AnyRawTransactionInstance = RawTransaction | MultiAgentRawTransactio
 /**
  * Optional options to set when generating a transaction
  */
-export type GenerateTransactionOptions = {
+export type InputGenerateTransactionOptions = {
   maxGasAmount?: AnyNumber;
   gasUnitPrice?: AnyNumber;
   expireTimestamp?: AnyNumber;
@@ -66,7 +84,7 @@ export type GenerateTransactionOptions = {
 /**
  * The generated transaction payload type that was produces from `generateTransactionPayload()` function.
  */
-export type TransactionPayload =
+export type AnyTransactionPayloadInstance =
   | TransactionPayloadEntryFunction
   | TransactionPayloadScript
   | TransactionPayloadMultisig;
@@ -75,86 +93,109 @@ export type TransactionPayload =
  * Unified type for the data needed to generate a transaction payload of types:
  * Entry Function | Script | Multi Sig
  */
-export type GenerateTransactionPayloadData = EntryFunctionData | ScriptData | MultiSigData;
+export type InputGenerateTransactionPayloadData = InputEntryFunctionData | InputScriptData | InputMultiSigData;
+
+export type InputGenerateTransactionPayloadDataWithRemoteABI =
+  | (InputScriptData & { aptosConfig?: undefined })
+  | InputEntryFunctionDataWithRemoteABI
+  | InputMultiSigDataWithRemoteABI;
 
 /**
  * The data needed to generate an Entry Function payload
  */
-export type EntryFunctionData = {
+export type InputEntryFunctionData = {
   function: MoveStructType;
   typeArguments?: Array<TypeTag>;
-  functionArguments: Array<EntryFunctionArgumentTypes>;
+  functionArguments: Array<EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes>;
 };
 
+export type InputEntryFunctionDataWithRemoteABI = InputEntryFunctionData & { aptosConfig: AptosConfig };
 /**
  * The data needed to generate a Multi Sig payload
  */
-export type MultiSigData = {
+export type InputMultiSigData = {
   multisigAddress: AccountAddress;
-} & EntryFunctionData;
+} & InputEntryFunctionData;
+
+/**
+ * The data needed to generate a Multi Sig payload
+ */
+export type InputMultiSigDataWithRemoteABI = {
+  multisigAddress: AccountAddress | string;
+} & InputEntryFunctionDataWithRemoteABI;
 
 /**
  * The data needed to generate a Script payload
  */
-export type ScriptData = {
+export type InputScriptData = {
   bytecode: HexInput;
   typeArguments?: Array<TypeTag>;
   functionArguments: Array<ScriptFunctionArgumentTypes>;
 };
 
+/**
+ * Interface of an Entry function's ABI.
+ *
+ * This is used to provide type checking and simple input conversion on ABI based transaction submission.
+ */
+export type EntryFunctionABI = {
+  typeParameters: Array<MoveFunctionGenericTypeParam>;
+  parameters: Array<TypeTag>;
+};
+
 /**
  * Interface of the arguments to generate a single signer transaction.
  * Used to provide to `generateTransaction()` method in the transaction builder flow
  */
-export interface GenerateSingleSignerRawTransactionArgs {
+export interface InputGenerateSingleSignerRawTransactionArgs {
   aptosConfig: AptosConfig;
   sender: HexInput;
-  payload: TransactionPayload;
+  payload: AnyTransactionPayloadInstance;
   feePayerAddress?: undefined;
   secondarySignerAddresses?: undefined;
-  options?: GenerateTransactionOptions;
+  options?: InputGenerateTransactionOptions;
 }
 
 /**
  * Interface of the arguments to generate a fee payer transaction.
  * Used to provide to `generateTransaction()` method in the transaction builder flow
  */
-export interface GenerateFeePayerRawTransactionArgs {
+export interface InputGenerateFeePayerRawTransactionArgs {
   aptosConfig: AptosConfig;
   sender: HexInput;
-  payload: TransactionPayload;
+  payload: AnyTransactionPayloadInstance;
   feePayerAddress: HexInput;
   secondarySignerAddresses?: HexInput[];
-  options?: GenerateTransactionOptions;
+  options?: InputGenerateTransactionOptions;
 }
 
 /**
  * Interface of the arguments to generate a multi-agent transaction.
  * Used to provide to `generateTransaction()` method in the transaction builder flow
  */
-export interface GenerateMultiAgentRawTransactionArgs {
+export interface InputGenerateMultiAgentRawTransactionArgs {
   aptosConfig: AptosConfig;
   sender: HexInput;
-  payload: TransactionPayload;
+  payload: AnyTransactionPayloadInstance;
   secondarySignerAddresses: HexInput[];
   feePayerAddress?: undefined;
-  options?: GenerateTransactionOptions;
+  options?: InputGenerateTransactionOptions;
 }
 
 /**
  * Unified type that holds all the interfaces to generate different transaction types
  */
-export type GenerateRawTransactionArgs =
-  | GenerateSingleSignerRawTransactionArgs
-  | GenerateFeePayerRawTransactionArgs
-  | GenerateMultiAgentRawTransactionArgs;
+export type InputGenerateRawTransactionArgs =
+  | InputGenerateSingleSignerRawTransactionArgs
+  | InputGenerateFeePayerRawTransactionArgs
+  | InputGenerateMultiAgentRawTransactionArgs;
 
 /**
  * Interface that holds the return data when generating a single signer transaction
  *
  * @param rawTransaction a bcs serialized raw transaction
  */
-export interface SingleSignerTransaction {
+export interface InputSingleSignerTransaction {
   rawTransaction: Uint8Array;
   feePayerAddress?: undefined;
   secondarySignerAddresses?: undefined;
@@ -167,7 +208,7 @@ export interface SingleSignerTransaction {
  * @param secondarySignerAddresses optional. secondary signer addresses for multi-agent transaction
  * @param feePayerAddress fee payer address for a fee payer transaction (aka Sponsored Transaction)
  */
-export interface FeePayerTransaction {
+export interface InputFeePayerTransaction {
   rawTransaction: Uint8Array;
   feePayerAddress: AccountAddress;
   secondarySignerAddresses?: AccountAddress[];
@@ -179,7 +220,7 @@ export interface FeePayerTransaction {
  * @param rawTransaction a bcs serialized raw transaction
  * @param secondarySignerAddresses secondary signer addresses for multi-agent transaction
  */
-export interface MultiAgentTransaction {
+export interface InputMultiAgentTransaction {
   rawTransaction: Uint8Array;
   secondarySignerAddresses: AccountAddress[];
   feePayerAddress?: undefined;
@@ -188,11 +229,11 @@ export interface MultiAgentTransaction {
 /**
  * Unified type that holds all the return interfaces when generating different transaction types
  */
-export type AnyRawTransaction = SingleSignerTransaction | FeePayerTransaction | MultiAgentTransaction;
+export type AnyRawTransaction = InputSingleSignerTransaction | InputFeePayerTransaction | InputMultiAgentTransaction;
 
 // TRANSACTION SIMULATION TYPES //
 
-export type SimulateTransactionData = {
+export type InputSimulateTransactionData = {
   /**
    * The transaction to simulate, probably generated by `generateTransaction()`
    */
@@ -209,10 +250,10 @@ export type SimulateTransactionData = {
    * For a fee payer transaction (aka Sponsored Transaction)
    */
   feePayerPublicKey?: PublicKey;
-  options?: SimulateTransactionOptions;
+  options?: InputSimulateTransactionOptions;
 };
 
-export type SimulateTransactionOptions = {
+export type InputSimulateTransactionOptions = {
   estimateGasUnitPrice?: boolean;
   estimateMaxGasAmount?: boolean;
   estimatePrioritizedGasUnitPrice?: boolean;
@@ -223,40 +264,40 @@ export type SimulateTransactionOptions = {
 /**
  * Interface that holds the user data input when generating a single signer transaction
  */
-export interface GenerateSingleSignerRawTransactionInput {
+export interface InputGenerateSingleSignerRawTransactionData {
   sender: HexInput;
   feePayerAddress?: undefined;
   secondarySignerAddresses?: undefined;
-  options?: GenerateTransactionOptions;
-  data: GenerateTransactionPayloadData;
+  options?: InputGenerateTransactionOptions;
+  data: InputGenerateTransactionPayloadData;
 }
 
 /**
  * Interface that holds the user data input when generating a fee payer transaction
  */
-export interface GenerateFeePayerRawTransactionInput {
+export interface InputGenerateFeePayerRawTransactionData {
   sender: HexInput;
   feePayerAddress: HexInput;
   secondarySignerAddresses?: HexInput[];
-  options?: GenerateTransactionOptions;
-  data: GenerateTransactionPayloadData;
+  options?: InputGenerateTransactionOptions;
+  data: InputGenerateTransactionPayloadData;
 }
 
 /**
  * Interface that holds the user data input when generating a multi-agent transaction
  */
-export interface GenerateMultiAgentRawTransactionInput {
+export interface InputGenerateMultiAgentRawTransactionData {
   sender: HexInput;
   secondarySignerAddresses: HexInput[];
   feePayerAddress?: undefined;
-  options?: GenerateTransactionOptions;
-  data: GenerateTransactionPayloadData;
+  options?: InputGenerateTransactionOptions;
+  data: InputGenerateTransactionPayloadData;
 }
 
 /**
  * Unified type that holds all the user data input interfaces when generating different transaction types
  */
-export type GenerateTransactionInput =
-  | GenerateMultiAgentRawTransactionInput
-  | GenerateFeePayerRawTransactionInput
-  | GenerateSingleSignerRawTransactionInput;
+export type InputGenerateTransactionData =
+  | InputGenerateMultiAgentRawTransactionData
+  | InputGenerateFeePayerRawTransactionData
+  | InputGenerateSingleSignerRawTransactionData;

package/src/types/index.ts

@@ -26,7 +26,7 @@ export enum MimeType {
 export type HexInput = string | Uint8Array;
 
 /**
- * Script transaction arguments enum as they are represented in Rust
+ * TypeTag enum as they are represented in Rust
  * {@link https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-core/types/src/language_storage.rs#L27}
  */
 export enum TypeTagVariants {
@@ -41,6 +41,8 @@ export enum TypeTagVariants {
   U16 = 8,
   U32 = 9,
   U256 = 10,
+  Reference = 254, // This is specifically a placeholder and does not represent a real type
+  Generic = 255, // This is specifically a placeholder and does not represent a real type
 }
 
 /**
@@ -87,7 +89,7 @@ export enum TransactionAuthenticatorVariant {
   MultiEd25519 = 1,
   MultiAgent = 2,
   FeePayer = 3,
-  SingleSenderTransactionAuthenticator = 4,
+  SingleSender = 4,
 }
 
 /**
@@ -248,7 +250,7 @@ export type GasEstimation = {
 };
 
 export type MoveResource = {
-  type: MoveResourceType;
+  type: MoveStructType;
   data: {};
 };
 
@@ -517,7 +519,7 @@ export type TransactionPayloadResponse = EntryFunctionPayloadResponse | ScriptPa
 
 export type EntryFunctionPayloadResponse = {
   type: string;
-  function: MoveResourceType;
+  function: MoveStructType;
   /**
    * Type arguments of the function
    */
@@ -678,12 +680,11 @@ export type MoveUint128Type = string;
 export type MoveUint256Type = string;
 export type MoveAddressType = string;
 export type MoveObjectType = string;
-export type MoveStructType = `${string}::${string}::${string}`;
 export type MoveOptionType = MoveType | null | undefined;
 /**
- * String representation of a on-chain Move struct type.
+ * This is the format for a fully qualified struct, resource, or entry function in Move.
  */
-export type MoveResourceType = `${string}::${string}::${string}`;
+export type MoveStructType = `${string}::${string}::${string}`;
 
 export type MoveType =
   | boolean
@@ -892,7 +893,7 @@ export type Block = {
  */
 export type ViewRequestData = {
   function: MoveStructType;
-  typeArguments?: Array<MoveResourceType>;
+  typeArguments?: Array<MoveStructType>;
   functionArguments?: Array<MoveValue>;
 };
 
@@ -901,14 +902,14 @@ export type ViewRequestData = {
 /**
  * View request for the Move view function API
  *
- * `type MoveResourceType = ${string}::${string}::${string}`;
+ * `type MoveStructType = ${string}::${string}::${string}`;
  */
 export type ViewRequest = {
-  function: MoveResourceType;
+  function: MoveStructType;
   /**
    * Type arguments of the function
    */
-  type_arguments: Array<MoveResourceType>;
+  type_arguments: Array<MoveStructType>;
   /**
    * Arguments of the function
    */
@@ -947,6 +948,8 @@ export enum SigningScheme {
    * For SingleKey ecdsa
    */
   SingleKey = 2,
+
+  MultiKey = 3,
 }
 
 export enum SigningSchemeInput {
@@ -954,10 +957,6 @@ export enum SigningSchemeInput {
    * For Ed25519PublicKey
    */
   Ed25519 = 0,
-  /**
-   * For MultiEd25519PublicKey
-   */
-  MultiEd25519 = 1,
   /**
    * For Secp256k1Ecdsa
    */
@@ -990,6 +989,9 @@ export enum DeriveScheme {
   DeriveResourceAccountAddress = 255,
 }
 
+/**
+ * Option properties to pass for waitForTransaction() function
+ */
 export type WaitForTransactionOptions = {
   timeoutSecs?: number;
   checkSuccess?: boolean;
@@ -1002,7 +1004,7 @@ export type WaitForTransactionOptions = {
  * In this case `legacy` is always true
  */
 export type GenerateAccountWithLegacyKey = {
-  scheme?: SigningSchemeInput.Ed25519 | SigningSchemeInput.MultiEd25519;
+  scheme?: SigningSchemeInput.Ed25519;
   legacy: true;
 };