Skip to content

sbundle stats endpoint #557

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

Merged
merged 2 commits into from
Jul 9, 2024
Merged

sbundle stats endpoint #557

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4df0fcf
sbundle stats endpoint
TymKh Jul 8, 2024
a91a77f
add more details
TymKh Jul 9, 2024
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
70 changes: 70 additions & 0 deletions docs/flashbots-auction/advanced/rpc-endpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,6 +768,76 @@ where
- `consideredByBuildersAt`: indicates time at which each builder selected the bundle to be included in the target block
- `sealedByBuildersAt`: indicates time at which each builder sealed a block containing the bundle

### flashbots_getSbundleStats

The `flashbots_getSbundleStats` JSON-RPC method returns stats for a single sbundle. You must provide bundleHash, and the signing address must be the same as the one who submitted the bundle.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Can we define what "sbundle" means? Or link to an existing description?
  2. Nit: Format "bundleHash" as code (ie. using the slash quotes like: bundleHash)

Only bundles not containing backruns are supported
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might not be immediately clear what we mean by this. Could clarify a bit: sbundle stats are only visible for bundles that do contain other users' private transactions. Ie. you cannot view sbundle stats on a bundle which backruns another user in MEV-Share.

(Feel free to reword, I just think it might need a bit more explanation).


```json
{
"jsonrpc": "2.0",
"id": 1,
"method": "flashbots_getSbundleStats",
"params": [
{
bundleHash, // String, returned by the flashbots api when calling eth_sendBundle with builders field or mev_sendBundle
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this returned in addition to or instead of the smart field? Currently our docs say that a smart field is returned when calling eth_sendBundle with builders[]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is returned together with eth_sendBundle response or else it will be hard for searcher to use stats api. So eth_sendBundle api is backward compatible, bundleHash is always returned, in case smart:true returned, searcher should query this endpoint.

}
]
}
```

example response when bundle relay has simulated the bundle and the target block has been reached:

```json
{
"isHighPriority": true,
"isSimulated": true,
"simulatedAt": "2022-10-06T21:36:06.317Z",
"receivedAt": "2022-10-06T21:36:06.250Z",
"consideredByBuildersAt": [
{
"pubkey": "0x81babeec8c9f2bb9c329fd8a3b176032fe0ab5f3b92a3f44d4575a231c7bd9c31d10b6328ef68ed1e8c02a3dbc8e80f9",
"timestamp": "2022-10-06T21:36:06.343Z"
},
{
"pubkey": "0x81beef03aafd3dd33ffd7deb337407142c80fea2690e5b3190cfc01bde5753f28982a7857c96172a75a234cb7bcb994f",
"timestamp": "2022-10-06T21:36:06.394Z"
},
{
"pubkey": "0xa1dead1e65f0a0eee7b5170223f20c8f0cbf122eac3324d61afbdb33a8885ff8cab2ef514ac2c7698ae0d6289ef27fc",
"timestamp": "2022-10-06T21:36:06.322Z"
}
],
"sealedByBuildersAt": [
{
"pubkey": "0x81beef03aafd3dd33ffd7deb337407142c80fea2690e5b3190cfc01bde5753f28982a7857c96172a75a234cb7bcb994f",
"timestamp": "2022-10-06T21:36:07.742Z"
}
]
}
```

Only responds with success when sbundle is already simulated.

When relay has simulated the bundle but the target block (or maxBlock) has not been reached:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: specify "the bundle relay" so we don't confuse with MEV-Boost relay.


```json
{
"isSimulated": true,
"isHighPriority": true,
"simulatedAt": "2022-10-06T21:36:06.317Z",
"receivedAt": "2022-10-06T21:36:06.250Z"
}
```

where

- `isSimulated`: boolean representing whether the bundle gets simulated. All other fields will be omitted except simulated field if API didn't receive bundle
- `simulatedAt`: time at which the bundle gets simulated
- `receivedAt`: time at which the bundle API received the bundle
- `consideredByBuildersAt`: indicates time at which each builder selected the bundle to be included in the target block
- `sealedByBuildersAt`: indicates time at which each builder sealed a block containing the bundle

### API Response

- All method supports JSON-RPC standards for success response and not supported for error response(V2 methods are exceptions).
Expand Down
Loading