diff --git a/docs/flashbots-protect/additional-documentation/status-api.md b/docs/flashbots-protect/additional-documentation/status-api.md index fff1195a..9def529f 100644 --- a/docs/flashbots-protect/additional-documentation/status-api.md +++ b/docs/flashbots-protect/additional-documentation/status-api.md @@ -4,14 +4,7 @@ title: Transaction Status API Transactions that you submit to Flashbots Protect won't be observable in the public mempool. However, you can use our status API to check the status of your transactions. The URL for doing so is: `https://protect.flashbots.net/tx/YOUR_TX_HASH_HERE`, and you can also use Etherscan as you normally would for transactions. They will show the status of your transaction from the status API as well. -The Transaction Status API is also available on test networks. Below is a table of URLs for accessing the API across different networks: - -| Network | URL | -| -------- | -------------------------------------------------- | -| Mainnet | `https://protect.flashbots.net/tx/` | -| Sepolia | `https://protect-sepolia.flashbots.net/tx/` | - - +The status API covers transactions sent through the Protect RPC, and keeps each transaction for 45 minutes after it was received. After that it returns `UNKNOWN`. In turn you will receive a JSON response that looks like the following: @@ -21,13 +14,13 @@ In turn you will receive a JSON response that looks like the following: "hash": "YOUR_TX_HASH", "maxBlockNumber": 13543898, "transaction": { - "from": "", - "to": "", - "gasLimit": "", - "maxFeePerGas": "", - "maxPriorityFeePerGas": "", - "nonce": "", - "value": "" + "from": "0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8", + "to": "0xac03bb73b6a9e108530aff4df5077c2b3d481e5a", + "gasLimit": "21000", + "maxFeePerGas": "300", + "maxPriorityFeePerGas": "10", + "nonce": "41", + "value": "10000000000" }, "fastMode": true, // for backwards compatibility; may be removed in a future version "seenInMempool": false, @@ -45,13 +38,13 @@ Below is a table of status codes that can be returned: | `INCLUDED` | The transaction was included on-chain | | `FAILED` | The transaction was submitted for 25 blocks and failed to be included on-chain | | `CANCELLED` | The transaction was cancelled by the user and not included on-chain | -| `UNKNOWN` | The transaction was not received | +| `UNKNOWN` | The transaction was not received, or was received more than 45 minutes ago | ## Privacy -The `transaction` fields are disclosed only for transactions with an `INCLUDED` status to maintain privacy for trades that are pending, failed, or cancelled. These fields will remain empty for transactions with `PENDING`, `FAILED`, `UNKNOWN`, or `CANCELLED` statuses. Protect fast mode transactions are an exception to this rule as TEE searchers will receive all fields (without signature) for all transactions, including reverted or failed transactions, with a 5 minute delay for troubleshooting and debugging purposes. +For Protect fast mode transactions, TEE searchers will receive all fields (without signature) for all transactions, including reverted or failed transactions, with a 5 minute delay for troubleshooting and debugging purposes. The TEE environment serves as a frontrunning countermeasure. You can learn more at [flashbots-images](https://github.com/flashbots/flashbots-images). -For instance, once a transaction is included, the JSON response will be populated with data for all fields: +Once a transaction is included, the JSON response looks like the following: ```json { @@ -79,12 +72,13 @@ 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) | +| `MaxFeePerGasTooLow` | Consensus incompatible tx that wasn't caught on rpc | +| `InsufficientFunds` | Insufficient ETH balance to pay for gas | +| `NonceTooLow` | Nonce too low | +| `NonceTooHigh` | Nonce too high | +| `InvalidChainIdForSigner` | Consensus incompatible tx that wasn't caught on rpc | +| `ExecutionReverted` | Execution reverted (slippage tolerance exceeded). Check revertReason field for more details | +| `OutOfGas` | Ran out of gas during execution (gas limit too low) | +| `Other` | Any other simulation error | `revertReason` field is a valid utf-8 part of the simulation result. Example: `TRANSFER_FROM_FAILED`, `UniswapV2: INSUFFICIENT_OUTPUT_AMOUNT` diff --git a/docs/flashbots-protect/quick-start.mdx b/docs/flashbots-protect/quick-start.mdx index 9d2e87f4..f7a078e7 100644 --- a/docs/flashbots-protect/quick-start.mdx +++ b/docs/flashbots-protect/quick-start.mdx @@ -70,12 +70,11 @@ You can also add Flashbots Protect RPC manually in MetaMask by following these s ![mm_rpc](/img/mm_rpc.png) -Below is the list of Flashbots Protect RPCs we currently support across Ethereum mainnet and testnets: +Below is the Flashbots Protect RPC we currently support on Ethereum mainnet: | Network | URL | | ------- | ------------------------------------ | | Mainnet | `https://rpc.flashbots.net/fast` | -| Sepolia | `https://rpc-sepolia.flashbots.net/` | ## Stuck transactions