Simulate Transaction

The output of the transaction will have the exact transaction outputs and events that running an actual signed transaction would have.

This method will use 50 Compute Units.

PreviousSubmit Batch Transactions NextEncode Submission

Last updated 9 months ago

Was this helpful?

Simulate transaction

The output of the transaction will have the exact transaction outputs and events that running an actual signed transaction would have. However, it will not have the associated state hashes, as they are not updated in storage. This can be used to estimate the maximum gas units for a submitted transaction.

To use this, you must:

Create a SignedTransaction with a zero-padded signature.
Submit a SubmitTransactionRequest containing a UserTransactionRequest containing that signature.

To use this endpoint with BCS, you must submit a SignedTransaction encoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.

post

/transactions/simulate

Query parameters

estimate_max_gas_amountboolean

If set to true, the max gas value in the transaction will be ignored and the maximum possible gas will be used

estimate_gas_unit_priceboolean

If set to true, the gas unit price in the transaction will be ignored and the estimated value will be used

estimate_prioritized_gas_unit_priceboolean

If set to true, the transaction will use a higher price than the original estimate.

Body

senderstring · hexrequired

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

sequence_numberstring · uint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

max_gas_amountstring · uint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

gas_unit_pricestring · uint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

expiration_timestamp_secsstring · uint64required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example: 32425224034

payloadobjectrequired

An enum of the possible transaction payloads

signatureobjectrequired

An enum representing the different transaction signatures available

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/transactions/simulate' \
  --header 'Content-Type: application/json' \
  --data '{"sender":"0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ","sequence_number":"32425224034","max_gas_amount":"32425224034","gas_unit_price":"32425224034","expiration_timestamp_secs":"32425224034","payload":{"type":"entry_function_payload","function":"0x1::aptos_coin::transfer","arguments":[],"type_arguments":[null]},"signature":{"type":"ed25519_signature","public_key":"0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ","signature":"0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "}}'

200

400

403

413

500

503

507

application/json

application/x-bcs

[
  {
    "version": "32425224034",
    "hash": "text",
    "state_change_hash": "text",
    "event_root_hash": "text",
    "state_checkpoint_hash": "text",
    "gas_used": "32425224034",
    "success": true,
    "vm_status": "text",
    "accumulator_root_hash": "text",
    "sender": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
    "sequence_number": "32425224034",
    "max_gas_amount": "32425224034",
    "gas_unit_price": "32425224034",
    "expiration_timestamp_secs": "32425224034",
    "payload": {
      "type": "entry_function_payload",
      "function": "0x1::aptos_coin::transfer",
      "arguments": [],
      "type_arguments": [
        null
      ]
    },
    "signature": {
      "type": "ed25519_signature",
      "public_key": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
      "signature": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
    },
    "timestamp": "32425224034",
    "changes": [
      {
        "type": "delete_module",
        "address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
        "state_key_hash": "text",
        "module": "0x1::aptos_coin"
      }
    ],
    "events": [
      {
        "guid": {
          "creation_number": "32425224034",
          "account_address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
        },
        "sequence_number": "32425224034",
        "type": "text",
        "data": null
      }
    ]
  }
]