Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new details regarding protect status API #597

Merged
merged 1 commit into from
Jan 17, 2025
Merged

new details regarding protect status API #597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/flashbots-protect/additional-documentation/status-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ In turn you will receive a JSON response that looks like the following:
"value": ""
},
"fastMode": true, // for backwards compatibility; may be removed in a future version
"seenInMempool": false
"seenInMempool": false,
"simError": "",
"revertReason": "",
"isRevert": false
}
```

Expand Down Expand Up @@ -67,6 +70,23 @@ For instance, once a transaction is included, the JSON response will be populate
"value": "10000000000"
},
"fastMode": true, // for backwards compatibility; may be removed in a future version
"seenInMempool": false
"seenInMempool": false,
"isRevert": false
}
```

While your transaction is `PENDING` or `FAILED` we will try to respond with the latest seen simulation error and revert reason if exists.

Below is the table of currently supported `simError` values.

| Sim error | Description |
|------------------------------|---------------------------------------------------------------------------------------------|
| `SimErrorMaxFeePerGasTooLow` | Consensus incompatible tx that wasn't caught on rpc |
| `SimErrorInsufficientFunds` | Insufficient ETH balance to pay for gas |
| `SimErrorNonceTooLow` | Nonce too low |
| `SimErrorNonceTooHigh` | Nonce too high |
| `SimErrorInvalidChainId` | Consensus incompatible tx that wasn't caught on rpc |
| `SimErrorExecutionReverted` | Execution reverted (slippage tolerance exceeded). Check revertReason field for more details |
| `SimErrorOutOfGas` | Ran out of gas during execution (gas limit too low) |

`revertReason` field is a valid utf-8 part of the simulation result. Example: `TRANSFER_FROM_FAILED`, `UniswapV2: INSUFFICIENT_OUTPUT_AMOUNT`
Loading