@aptos-labs/ts-sdk 0.0.4 → 0.0.5

package/dist/esm/transactions/types.d.ts

@@ -0,0 +1,253 @@
+import { AptosConfig } from '../api/aptosConfig.js';
+import { MoveVector, MoveOption, MoveString } from '../bcs/serializable/moveStructs.js';
+import { Bool, U8, U16, U32, U64, U128, U256 } from '../bcs/serializable/movePrimitives.js';
+import { FixedBytes } from '../bcs/serializable/fixedBytes.js';
+import { AccountAddress, AccountAddressInput } from '../core/accountAddress.js';
+import { PublicKey } from '../core/crypto/asymmetricCrypto.js';
+import { AnyNumber, MoveStructType, HexInput, MoveFunctionGenericTypeParam } from '../types/index.js';
+import { RawTransaction, MultiAgentRawTransaction, FeePayerRawTransaction } from './instances/rawTransaction.js';
+import { AccountAuthenticator } from './authenticator/account.js';
+import { TransactionPayloadEntryFunction, TransactionPayloadScript, TransactionPayloadMultisig } from './instances/transactionPayload.js';
+import { TypeTag } from './typeTag/index.js';
+import '../utils/apiEndpoints.js';
+import '../utils/const.js';
+import '../types/indexer.js';
+import '../types/generated/operations.js';
+import '../types/generated/types.js';
+import '../bcs/serializer.js';
+import '../core/hex.js';
+import '../core/common.js';
+import '../bcs/deserializer.js';
+import './instances/transactionArgument.js';
+import './instances/chainId.js';
+import './instances/identifier.js';
+import './instances/moduleId.js';
+import '../core/crypto/anyPublicKey.js';
+import '../core/crypto/anySignature.js';
+import '../core/crypto/ed25519.js';
+import '../core/crypto/multiEd25519.js';
+import '../core/crypto/multiKey.js';
+
+/**
+ * Entry function arguments to be used when building a raw transaction using remote ABI
+ */
+declare type SimpleEntryFunctionArgumentTypes = boolean | number | bigint | string | null | undefined | Uint8Array | Array<SimpleEntryFunctionArgumentTypes>;
+/**
+ * Entry function arguments to be used when building a raw transaction using BCS serialized arguments
+ */
+declare type EntryFunctionArgumentTypes = Bool | U8 | U16 | U32 | U64 | U128 | U256 | AccountAddress | MoveVector<EntryFunctionArgumentTypes> | MoveOption<EntryFunctionArgumentTypes> | MoveString | FixedBytes;
+/**
+ * Script function arguments to be used when building a raw transaction using BCS serialized arguments
+ */
+declare type ScriptFunctionArgumentTypes = Bool | U8 | U16 | U32 | U64 | U128 | U256 | AccountAddress | MoveVector<U8> | MoveString | FixedBytes;
+/**
+ * Type that holds all raw transaction instances Aptos SDK supports
+ */
+declare type AnyRawTransactionInstance = RawTransaction | MultiAgentRawTransaction | FeePayerRawTransaction;
+/**
+ * Optional options to set when generating a transaction
+ */
+declare type InputGenerateTransactionOptions = {
+    maxGasAmount?: AnyNumber;
+    gasUnitPrice?: AnyNumber;
+    expireTimestamp?: AnyNumber;
+    accountSequenceNumber?: AnyNumber;
+};
+/**
+ * The generated transaction payload type that was produces from `generateTransactionPayload()` function.
+ */
+declare type AnyTransactionPayloadInstance = TransactionPayloadEntryFunction | TransactionPayloadScript | TransactionPayloadMultisig;
+/**
+ * Unified type for the data needed to generate a transaction payload of types:
+ * Entry Function | Script | Multi Sig
+ */
+declare type InputGenerateTransactionPayloadData = InputEntryFunctionData | InputScriptData | InputMultiSigData;
+declare type InputGenerateTransactionPayloadDataWithRemoteABI = (InputScriptData & {
+    aptosConfig?: undefined;
+}) | InputEntryFunctionDataWithRemoteABI | InputMultiSigDataWithRemoteABI;
+/**
+ * The data needed to generate an Entry Function payload
+ */
+declare type InputEntryFunctionData = {
+    function: MoveStructType;
+    typeArguments?: Array<TypeTag | string>;
+    functionArguments: Array<EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes>;
+};
+declare type InputEntryFunctionDataWithRemoteABI = InputEntryFunctionData & {
+    aptosConfig: AptosConfig;
+};
+/**
+ * The data needed to generate a Multi Sig payload
+ */
+declare type InputMultiSigData = {
+    multisigAddress: AccountAddress;
+} & InputEntryFunctionData;
+/**
+ * The data needed to generate a Multi Sig payload
+ */
+declare type InputMultiSigDataWithRemoteABI = {
+    multisigAddress: AccountAddressInput;
+} & InputEntryFunctionDataWithRemoteABI;
+/**
+ * The data needed to generate a Script payload
+ */
+declare 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.
+ */
+declare 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
+ */
+interface InputGenerateSingleSignerRawTransactionArgs {
+    aptosConfig: AptosConfig;
+    sender: AccountAddressInput;
+    payload: AnyTransactionPayloadInstance;
+    feePayerAddress?: undefined;
+    secondarySignerAddresses?: undefined;
+    options?: InputGenerateTransactionOptions;
+}
+/**
+ * Interface of the arguments to generate a fee payer transaction.
+ * Used to provide to `generateTransaction()` method in the transaction builder flow
+ */
+interface InputGenerateFeePayerRawTransactionArgs {
+    aptosConfig: AptosConfig;
+    sender: AccountAddressInput;
+    payload: AnyTransactionPayloadInstance;
+    feePayerAddress: AccountAddressInput;
+    secondarySignerAddresses?: AccountAddressInput[];
+    options?: InputGenerateTransactionOptions;
+}
+/**
+ * Interface of the arguments to generate a multi-agent transaction.
+ * Used to provide to `generateTransaction()` method in the transaction builder flow
+ */
+interface InputGenerateMultiAgentRawTransactionArgs {
+    aptosConfig: AptosConfig;
+    sender: AccountAddressInput;
+    payload: AnyTransactionPayloadInstance;
+    secondarySignerAddresses: AccountAddressInput[];
+    feePayerAddress?: undefined;
+    options?: InputGenerateTransactionOptions;
+}
+/**
+ * Unified type that holds all the interfaces to generate different transaction types
+ */
+declare type InputGenerateRawTransactionArgs = InputGenerateSingleSignerRawTransactionArgs | InputGenerateFeePayerRawTransactionArgs | InputGenerateMultiAgentRawTransactionArgs;
+/**
+ * Interface that holds the return data when generating a single signer transaction
+ *
+ * @param rawTransaction a bcs serialized raw transaction
+ */
+interface InputSingleSignerTransaction {
+    rawTransaction: RawTransaction;
+    feePayerAddress?: undefined;
+    secondarySignerAddresses?: undefined;
+}
+/**
+ * Interface that holds the return data when generating a fee payer transaction
+ *
+ * @param rawTransaction a bcs serialized raw transaction
+ * @param secondarySignerAddresses optional. secondary signer addresses for multi-agent transaction
+ * @param feePayerAddress fee payer address for a fee payer transaction (aka Sponsored Transaction)
+ */
+interface InputFeePayerTransaction {
+    rawTransaction: RawTransaction;
+    feePayerAddress: AccountAddress;
+    secondarySignerAddresses?: AccountAddress[];
+}
+/**
+ * Interface that holds the return data when generating a multi-agent transaction.
+ *
+ * @param rawTransaction a bcs serialized raw transaction
+ * @param secondarySignerAddresses secondary signer addresses for multi-agent transaction
+ */
+interface InputMultiAgentTransaction {
+    rawTransaction: RawTransaction;
+    secondarySignerAddresses: AccountAddress[];
+    feePayerAddress?: undefined;
+}
+/**
+ * Unified type that holds all the return interfaces when generating different transaction types
+ */
+declare type AnyRawTransaction = InputSingleSignerTransaction | InputFeePayerTransaction | InputMultiAgentTransaction;
+declare type InputSimulateTransactionData = {
+    /**
+     * The transaction to simulate, probably generated by `generateTransaction()`
+     */
+    transaction: AnyRawTransaction;
+    /**
+     * For a single signer transaction
+     */
+    signerPublicKey: PublicKey;
+    /**
+     * For a fee payer or multi-agent transaction that requires additional signers in
+     */
+    secondarySignersPublicKeys?: Array<PublicKey>;
+    /**
+     * For a fee payer transaction (aka Sponsored Transaction)
+     */
+    feePayerPublicKey?: PublicKey;
+    options?: InputSimulateTransactionOptions;
+};
+declare type InputSimulateTransactionOptions = {
+    estimateGasUnitPrice?: boolean;
+    estimateMaxGasAmount?: boolean;
+    estimatePrioritizedGasUnitPrice?: boolean;
+};
+/**
+ * Interface that holds the user data input when generating a single signer transaction
+ */
+interface InputGenerateSingleSignerRawTransactionData {
+    sender: AccountAddressInput;
+    hasFeePayer?: undefined;
+    secondarySignerAddresses?: undefined;
+    options?: InputGenerateTransactionOptions;
+    data: InputGenerateTransactionPayloadData;
+}
+/**
+ * Interface that holds the user data input when generating a fee payer transaction
+ */
+interface InputGenerateFeePayerRawTransactionData {
+    sender: AccountAddressInput;
+    hasFeePayer: true;
+    secondarySignerAddresses?: AccountAddressInput[];
+    options?: InputGenerateTransactionOptions;
+    data: InputGenerateTransactionPayloadData;
+}
+/**
+ * Interface that holds the user data input when generating a multi-agent transaction
+ */
+interface InputGenerateMultiAgentRawTransactionData {
+    sender: AccountAddressInput;
+    secondarySignerAddresses: AccountAddressInput[];
+    hasFeePayer?: undefined;
+    options?: InputGenerateTransactionOptions;
+    data: InputGenerateTransactionPayloadData;
+}
+/**
+ * Unified type that holds all the user data input interfaces when generating different transaction types
+ */
+declare type InputGenerateTransactionData = InputGenerateMultiAgentRawTransactionData | InputGenerateFeePayerRawTransactionData | InputGenerateSingleSignerRawTransactionData;
+/**
+ * Interface that holds the user data input when submitting a transaction
+ */
+interface InputSubmitTransactionData {
+    transaction: AnyRawTransaction;
+    senderAuthenticator: AccountAuthenticator;
+    feePayerAuthenticator?: AccountAuthenticator;
+    additionalSignersAuthenticators?: Array<AccountAuthenticator>;
+}
+
+export { AnyRawTransaction, AnyRawTransactionInstance, AnyTransactionPayloadInstance, EntryFunctionABI, EntryFunctionArgumentTypes, InputEntryFunctionData, InputEntryFunctionDataWithRemoteABI, InputFeePayerTransaction, InputGenerateFeePayerRawTransactionArgs, InputGenerateFeePayerRawTransactionData, InputGenerateMultiAgentRawTransactionArgs, InputGenerateMultiAgentRawTransactionData, InputGenerateRawTransactionArgs, InputGenerateSingleSignerRawTransactionArgs, InputGenerateSingleSignerRawTransactionData, InputGenerateTransactionData, InputGenerateTransactionOptions, InputGenerateTransactionPayloadData, InputGenerateTransactionPayloadDataWithRemoteABI, InputMultiAgentTransaction, InputMultiSigData, InputMultiSigDataWithRemoteABI, InputScriptData, InputSimulateTransactionData, InputSimulateTransactionOptions, InputSingleSignerTransaction, InputSubmitTransactionData, ScriptFunctionArgumentTypes, SimpleEntryFunctionArgumentTypes };

package/dist/esm/transactions/types.mjs

@@ -0,0 +1,2 @@
+import"../chunk-V3MBJJTL.mjs";
+//# sourceMappingURL=types.mjs.map

package/dist/esm/transactions/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}