From e8c0cf19fc36a6783ee46b152bfa50d039704470 Mon Sep 17 00:00:00 2001
From: sketsdever <sheak0519@gmail.com>
Date: Fri, 4 Oct 2024 16:17:27 -0400
Subject: [PATCH] Unpaginated MEV refund APIs (#583)

* Add MEV refund aggregate APIs

* Add docs for getMevRefundsByHash

* Explain sbundle hash
---
 .../advanced/rpc-endpoint.mdx                 | 93 +++++++++++++++++++
 1 file changed, 93 insertions(+)

diff --git a/docs/flashbots-auction/advanced/rpc-endpoint.mdx b/docs/flashbots-auction/advanced/rpc-endpoint.mdx
index 414bcd9a..ad220ac8 100644
--- a/docs/flashbots-auction/advanced/rpc-endpoint.mdx
+++ b/docs/flashbots-auction/advanced/rpc-endpoint.mdx
@@ -948,6 +948,99 @@ 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.
 
+### flashbots_getMevRefundTotalByRecipient
+
+Returns the total amount of [MEV refunds](/flashbots-protect/mev-refunds) that have been paid to a specific recipient address. This API not require authentication.
+
+#### Request
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "method": "flashbots_getMevRefundTotalByRecipient",
+  "params": ["0xDCDDAE87EDF1D9F62AE2F3A66EB2018ACD0B2508"]
+}
+```
+
+#### Response
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "total": "0xeff5f44e097dcfac"
+  }
+}
+```
+
+Note: The total is returned as a hexadecimal string representing the amount in wei.
+
+### flashbots_getMevRefundTotalBySender
+
+Returns the total amount of [MEV refunds](/flashbots-protect/mev-refunds) that have been generated on transactions or bundles from a specific sender address. The sender is the `tx.origin` for individual transactions or bundles of size 1, or the Flashbots signer for bundles of size > 1. It may be different from the recipient if the recipient has been delegated to another address.
+
+This API does not require authentication.
+
+#### Request
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "method": "flashbots_getMevRefundTotalBySender",
+  "params": ["0xDCDDAE87EDF1D9F62AE2F3A66EB2018ACD0B2508"]
+}
+```
+
+#### Response
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "total": "0x4a817c800"
+  }
+}
+```
+
+### flashbots_getMevRefundsByHash
+
+Returns detailed information about the [MEV refunds](/flashbots-protect/mev-refunds) generated by a specific transaction or sbundle hash. An sbundle hash is a bundle hash for a bundle that was submitted to MEV-Share via `mev_sendBundle`. This API does not require authentication.
+
+#### Request
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "method": "flashbots_getMevRefundsByHash",
+  "params": ["0x8A29C254B498E0757FF93B3E8424225DC441C24AC5C6A2F8CC9925D36E0CDB86"]
+}
+```
+
+#### Response
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "refunds": [
+      {
+        "txHash": "0xeb81e87b450f83a5e1a08033ea51bbb6a4b5b706eb629fbb1ed8e81d173207fe",
+        "amount": "0x95dc82ca0cb6b",
+        "recipient": "0xa34c84ed07fdf0c92858e364cfcdfa1e47fe5369"
+      }
+    ]
+  }
+}
+```
+
+Note: The total is returned as a hexadecimal string representing the amount in wei.
+
 ### API Response
 
 - All method supports JSON-RPC standards for success response and not supported for error response(V2 methods are exceptions).