initial draft for MEV refund read endpoints #577
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TymKh
requested review from
odysseus0,
sketsdever,
zeroXbrock and
sukoneck
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
sketsdever
reviewed
Sep 17, 2024
| @@ -869,6 +869,167 @@ If the first address matches the authentication signature, then a response with | |||
|
|
|||
| If the signature is invalid or does not match the first address, an appropriate error will be returned instead. | |||
|
|
|||
| ### MEV Refund JSON-RPC API Documentation | |||
There was a problem hiding this comment.
I would delete this section (lines 872-874) and instead repeat the context on line 874 (APIs are for MEV-Share, not authenticated) in each individual API entry below. The reason is:
- It's not standard to have sub-headings in our API docs today (we can revisit this, but it doesn't match the rest of the docs so would prefer to keep things consistent for now)
- We want all of the context to be mentioned in each entry because a user might navigate directly to one of the API methods and miss this overall heading (in which case it won't be clear that the API they're looking at is for MEV-Share or does not require authentication)
|
|
||
| ### flashbots_getMevRefundsByRecipient | ||
|
|
||
| Retrieves all refunds sent to a specific recipient address. |
There was a problem hiding this comment.
In each of these individual API entries we should:
- Specify that this API is for MEV-Share refunds. Eg. change the text to say "Retrieves all MEV-Share refunds..." where "MEV-Share" could also be a link to https://docs.flashbots.net/flashbots-protect/mev-share
- Specify that the API does not require authentication (I would say "authentication" and not "signature")
(This same comment applies to each new API section below).
| "jsonrpc": "2.0", | ||
| "id": 1, | ||
| "result": { | ||
| "refunds": [ |
There was a problem hiding this comment.
I believe this list should be paginated?
|
|
||
| ### flashbots_getMevRefundsByHash | ||
|
|
||
| Retrieves refunds associated with a specific transaction or `sbundle` hash. |
There was a problem hiding this comment.
Could we add a quick explanation of what an "sbundle" is?
|
|
||
| ### flashbots_getMevRefundTotalByRecipient | ||
|
|
||
| Retrieves the total amount of MEV refunds received by a specific recipient address. |
There was a problem hiding this comment.
"MEV refunds" -> "MEV-Share refunds"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document 5 endpoints to obtain data for MEV refunds (previously refund-api)