@aptos-labs/ts-sdk
Version:
Aptos TypeScript SDK
107 lines (104 loc) • 6.34 kB
text/typescript
import { AptosConfig } from '../../api/aptosConfig.mjs';
import { AccountAddressInput } from '../../core/accountAddress.mjs';
import { P as PublicKey } from '../../publicKey-B3XRNhHO.mjs';
import { AccountAuthenticatorEd25519, AccountAuthenticatorSingleKey } from '../authenticator/account.mjs';
import { RawTransaction } from '../instances/rawTransaction.mjs';
import { TransactionPayloadScript, TransactionPayloadEntryFunction, TransactionPayloadMultiSig, EntryFunction } from '../instances/transactionPayload.mjs';
import { SimpleTransaction } from '../instances/simpleTransaction.mjs';
import { MultiAgentTransaction } from '../instances/multiAgentTransaction.mjs';
import { InputScriptData, InputEntryFunctionDataWithRemoteABI, InputMultiSigDataWithRemoteABI, InputEntryFunctionDataWithABI, InputMultiSigDataWithABI, InputViewFunctionDataWithRemoteABI, InputViewFunctionDataWithABI, AnyTransactionPayloadInstance, InputGenerateTransactionOptions, InputGenerateSingleSignerRawTransactionArgs, InputGenerateMultiAgentRawTransactionArgs, InputSimulateTransactionData, InputSubmitTransactionData } from '../types.mjs';
import '../../types/index.mjs';
import '../../utils/apiEndpoints.mjs';
import '../../types/indexer.mjs';
import '../../types/generated/operations.mjs';
import '../../types/generated/types.mjs';
import '../../utils/const.mjs';
import '../../bcs/serializer.mjs';
import '../../core/hex.mjs';
import '../../core/common.mjs';
import '../../bcs/deserializer.mjs';
import '../instances/transactionArgument.mjs';
import '../../core/crypto/signature.mjs';
import '../../core/crypto/ed25519.mjs';
import '../../core/crypto/privateKey.mjs';
import '../../core/crypto/multiEd25519.mjs';
import '../../core/crypto/multiKey.mjs';
import '../../core/crypto/singleKey.mjs';
import '../instances/chainId.mjs';
import '../instances/identifier.mjs';
import '../instances/moduleId.mjs';
import '../typeTag/index.mjs';
import '../../bcs/serializable/moveStructs.mjs';
import '../../bcs/serializable/movePrimitives.mjs';
import '../../bcs/serializable/fixedBytes.mjs';
/**
* We are defining function signatures, each with its specific input and output.
* These are the possible function signature for our `generateTransactionPayload` function.
* When we call our `generateTransactionPayload` function with the relevant type properties,
* Typescript can infer the return type based on the appropriate function overload.
*/
declare function generateTransactionPayload(args: InputScriptData): Promise<TransactionPayloadScript>;
declare function generateTransactionPayload(args: InputEntryFunctionDataWithRemoteABI): Promise<TransactionPayloadEntryFunction>;
declare function generateTransactionPayload(args: InputMultiSigDataWithRemoteABI): Promise<TransactionPayloadMultiSig>;
declare function generateTransactionPayloadWithABI(args: InputEntryFunctionDataWithABI): TransactionPayloadEntryFunction;
declare function generateTransactionPayloadWithABI(args: InputMultiSigDataWithABI): TransactionPayloadMultiSig;
declare function generateViewFunctionPayload(args: InputViewFunctionDataWithRemoteABI): Promise<EntryFunction>;
declare function generateViewFunctionPayloadWithABI(args: InputViewFunctionDataWithABI): EntryFunction;
/**
* Generates a raw transaction
*
* @param args.aptosConfig AptosConfig
* @param args.sender The transaction's sender account address as a hex input
* @param args.payload The transaction payload - can create by using generateTransactionPayload()
*
* @returns RawTransaction
*/
declare function generateRawTransaction(args: {
aptosConfig: AptosConfig;
sender: AccountAddressInput;
payload: AnyTransactionPayloadInstance;
options?: InputGenerateTransactionOptions;
feePayerAddress?: AccountAddressInput;
}): Promise<RawTransaction>;
/**
* We are defining function signatures, each with its specific input and output.
* These are the possible function signature for our `generateTransaction` function.
* When we call our `generateTransaction` function with the relevant type properties,
* Typescript can infer the return type based on the appropriate function overload.
*/
declare function buildTransaction(args: InputGenerateSingleSignerRawTransactionArgs): Promise<SimpleTransaction>;
declare function buildTransaction(args: InputGenerateMultiAgentRawTransactionArgs): Promise<MultiAgentTransaction>;
/**
* Simulate a transaction before signing and submit to chain
*
* @param args.transaction A aptos transaction type to sign
* @param args.signerPublicKey The signer public key
* @param args.secondarySignersPublicKeys optional. The secondary signers public keys if multi signers transaction
* @param args.feePayerPublicKey optional. The fee payer public key is a fee payer (aka sponsored) transaction
* @param args.options optional. SimulateTransactionOptions
*
* @returns A signed serialized transaction that can be simulated
*/
declare function generateSignedTransactionForSimulation(args: InputSimulateTransactionData): Uint8Array;
declare function getAuthenticatorForSimulation(publicKey: PublicKey): AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey;
/**
* Prepare a transaction to be submitted to chain
*
* @param args.transaction A aptos transaction type
* @param args.senderAuthenticator The account authenticator of the transaction sender
* @param args.secondarySignerAuthenticators optional. For when the transaction is a multi signers transaction
*
* @returns A SignedTransaction
*/
declare function generateSignedTransaction(args: InputSubmitTransactionData): Uint8Array;
/**
* Hashes the set of values with a SHA-3 256 hash
* @param input array of UTF-8 strings or Uint8array byte arrays
*/
declare function hashValues(input: (Uint8Array | string)[]): Uint8Array;
/**
* Generates a user transaction hash for the given transaction payload. It must already have an authenticator
* @param args InputSubmitTransactionData
*/
declare function generateUserTransactionHash(args: InputSubmitTransactionData): string;
export { buildTransaction, generateRawTransaction, generateSignedTransaction, generateSignedTransactionForSimulation, generateTransactionPayload, generateTransactionPayloadWithABI, generateUserTransactionHash, generateViewFunctionPayload, generateViewFunctionPayloadWithABI, getAuthenticatorForSimulation, hashValues };