simulateTransaction

This function is used to simulate a transaction before submitting it to the Aptos blockchain.

Usage


import { AptosJSProClient } from "@aptos-labs/js-pro";
 
const client = new AptosJSProClient({
  /* ... */
});
 
const transaction = await client.buildTransaction({
  data: {
    function: "0x1::aptos_account::transfer",
    functionArguments: [account.accountAddress, 100],
  },
});
 
const simulationResult = await client.simulateTransaction({ transaction });

Parameters

The simulateTransaction function has two types of parameters: SimulateSimpleTransactionParameters or SimulateMultiAgentTransactionParameters.

SimulateSimpleTransactionParameters

Name	Type	Default
`signerPublicKey`	`PublicKey`
`transaction`	`AnyRawTransaction`
`feePayerPublicKey`	`PublicKey`
`options`	`InputSimulateTransactionOptions`
`network`	`NetworkInfo` The network to use for the request. If not set, the network of the `AptosJSProClient` instance will be used.

SimulateMultiAgentTransactionParameters

Name	Type	Default
`signerPublicKey`	`PublicKey`
`transaction`	`AnyRawTransaction`
`secondarySignersPublicKeys`	`(PublicKey \| undefined)[]`
`feePayerPublicKey`	`PublicKey`
`options`	`InputSimulateTransactionOptions`
`network`	`NetworkInfo` The network to use for the request. If not set, the network of the `AptosJSProClient` instance will be used.

Return Type

Name	Type	Default
`type`	`TransactionResponseType.User`
`version`	`string`
`hash`	`string`
`state_change_hash`	`string`
`event_root_hash`	`string`
`state_checkpoint_hash`	`string \| null`
`gas_used`	`string`
`success`	`boolean` Whether the transaction was successful
`vm_status`	`string` The VM status of the transaction, can tell useful information in a failure
`accumulator_root_hash`	`string`
`changes`	`WriteSetChange[]` Final state of resources changed by the transaction
`sender`	`string`
`sequence_number`	`string`
`replay_protection_nonce`	`string`
`max_gas_amount`	`string`
`gas_unit_price`	`string`
`expiration_timestamp_secs`	`string`
`payload`	`TransactionPayloadResponse`
`signature`	`TransactionSignature`
`events`	`Event[]` Events generated by the transaction
`timestamp`	`string`