wss://honeycluster.iosimulateSimulates submitting a transaction without actually submitting it. Returns the projected result and metadata.
{
"result": {
"applied": true,
"engine_result": "tesSUCCESS",
"engine_result_code": 0,
"engine_result_message": "The simulated transaction would have been applied."
},
"status": "success",
"type": "response",
"id": 1
}| Field | Type | Description |
|---|---|---|
commandrequired | string | WebSocket command name |
id | object | Client-supplied identifier to correlate requests with responses. |
tx_blob | string | Hex-encoded signed transaction blob. Provide this OR tx_json. |
tx_json | object | Transaction object in JSON format. Provide this OR tx_blob. |
binary | boolean | If true, return data in binary (hex) format instead of JSON. |
api_version | object | API version for the response format. Version 2 is the default for rippled 2.0+. |
{
"command": "simulate",
"id": 1,
"tx_json": {
"TransactionType": "Payment",
"Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"Destination": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
"Amount": "1000000",
"Fee": "12",
"Sequence": 42
}
}| Field | Type | Description |
|---|---|---|
result | object | |
status | enum<string> | Available successerror |
type | string | |
id | stringnumber | Echo of the client-provided correlation ID |
{
"result": {
"applied": true,
"engine_result": "tesSUCCESS",
"engine_result_code": 0,
"engine_result_message": "The simulated transaction would have been applied."
},
"status": "success",
"type": "response",
"id": 1
}