Skip to content

Commit 843768c

Browse files
authored
new details regarding protect status API (#597)
1 parent 4b0a0cb commit 843768c

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

docs/flashbots-protect/additional-documentation/status-api.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,10 @@ In turn you will receive a JSON response that looks like the following:
3232
"value": ""
3333
},
3434
"fastMode": true, // for backwards compatibility; may be removed in a future version
35-
"seenInMempool": false
35+
"seenInMempool": false,
36+
"simError": "",
37+
"revertReason": "",
38+
"isRevert": false
3639
}
3740
```
3841

@@ -67,6 +70,23 @@ For instance, once a transaction is included, the JSON response will be populate
6770
"value": "10000000000"
6871
},
6972
"fastMode": true, // for backwards compatibility; may be removed in a future version
70-
"seenInMempool": false
73+
"seenInMempool": false,
74+
"isRevert": false
7175
}
7276
```
77+
78+
While your transaction is `PENDING` or `FAILED` we will try to respond with the latest seen simulation error and revert reason if exists.
79+
80+
Below is the table of currently supported `simError` values.
81+
82+
| Sim error | Description |
83+
|------------------------------|---------------------------------------------------------------------------------------------|
84+
| `SimErrorMaxFeePerGasTooLow` | Consensus incompatible tx that wasn't caught on rpc |
85+
| `SimErrorInsufficientFunds` | Insufficient ETH balance to pay for gas |
86+
| `SimErrorNonceTooLow` | Nonce too low |
87+
| `SimErrorNonceTooHigh` | Nonce too high |
88+
| `SimErrorInvalidChainId` | Consensus incompatible tx that wasn't caught on rpc |
89+
| `SimErrorExecutionReverted` | Execution reverted (slippage tolerance exceeded). Check revertReason field for more details |
90+
| `SimErrorOutOfGas` | Ran out of gas during execution (gas limit too low) |
91+
92+
`revertReason` field is a valid utf-8 part of the simulation result. Example: `TRANSFER_FROM_FAILED`, `UniswapV2: INSUFFICIENT_OUTPUT_AMOUNT`

0 commit comments

Comments
 (0)