initial draft for MEV refund read endpoints - #577
TymKh wants to merge 1 commit into
Conversation
Sorry, something went wrong.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sorry, something went wrong.
|
|
||
| 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)
Sorry, something went wrong.
|
|
||
| ### 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).
Sorry, something went wrong.
| "jsonrpc": "2.0", | ||
| "id": 1, | ||
| "result": { | ||
| "refunds": [ |
There was a problem hiding this comment.
I believe this list should be paginated?
Sorry, something went wrong.
|
|
||
| ### 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?
Sorry, something went wrong.
|
|
||
| ### 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"
Sorry, something went wrong.
This branch was successfully deployed
Reviewers
At least 1 approving review is required to merge this pull request.
Document 5 endpoints to obtain data for MEV refunds (previously refund-api)