stellar-sdk/com.soneso.stellar.sdk.rpc.requests/SimulateTransactionRequest

SimulateTransactionRequest

@Serializable

data class SimulateTransactionRequest(val transaction: String, val resourceConfig: SimulateTransactionRequest.ResourceConfig? = null, val authMode: SimulateTransactionRequest.AuthMode? = null, val useUpgradedAuth: Boolean = true)

Request for JSON-RPC method simulateTransaction.

Simulates a transaction to preview its effects without submitting it to the network. This is essential for Soroban transactions to calculate resource requirements and auth entries.

Constructors

SimulateTransactionRequest

constructor(transaction: String, resourceConfig: SimulateTransactionRequest.ResourceConfig? = null, authMode: SimulateTransactionRequest.AuthMode? = null, useUpgradedAuth: Boolean = true)

Types

AuthMode

@Serializable

enum AuthMode : Enum<SimulateTransactionRequest.AuthMode>

Authorization mode for simulation.

ResourceConfig

@Serializable

data class ResourceConfig(val instructionLeeway: Long? = null)

Resource configuration for simulation.

Properties

authMode

val authMode: SimulateTransactionRequest.AuthMode?

Authorization mode for simulation. Controls how auth entries are handled.

resourceConfig

val resourceConfig: SimulateTransactionRequest.ResourceConfig?

Optional configuration for resource estimation.

transaction

val transaction: String

Base64-encoded XDR TransactionEnvelope to simulate.

useUpgradedAuth

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

val useUpgradedAuth: Boolean

When true (the default), requests Protocol-27 ADDRESS_V2 auth entries instead of legacy ADDRESS entries in recording modes. The key is serialized on every request, so an explicit false reaches the server as the legacy opt-out. RPC servers below Protocol 27 ignore the flag and still return legacy ADDRESS entries. A payload without the key deserializes to true.

SimulateTransactionRequest

See also

Constructors

Types

Properties