Implement flashbots_getBundleStats (metachris#9)

* Implement flashbots_getBundleStats

* Add FlashbotsGetBundleStats example

* Handle error in the FlashbotsGetBundleStats example

Author: Jeiwan

examples/getbundlestats/main.go

@@ -0,0 +1,51 @@
+package main
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/metachris/flashbotsrpc"
+)
+
+var privateKey, _ = crypto.GenerateKey() // creating a new private key for testing. you probably want to use an existing key.
+// var privateKey, _ = crypto.HexToECDSA("YOUR_PRIVATE_KEY")
+
+func main() {
+	rpc := flashbotsrpc.New("https://relay.flashbots.net")
+	rpc.Debug = true
+
+	sendBundleArgs := flashbotsrpc.FlashbotsSendBundleRequest{
+		Txs:         []string{"YOUR_RAW_TX"},
+		BlockNumber: fmt.Sprintf("0x%x", 13281018),
+	}
+
+	result, err := rpc.FlashbotsSendBundle(privateKey, sendBundleArgs)
+	if err != nil {
+		if errors.Is(err, flashbotsrpc.ErrRelayErrorResponse) {
+			// ErrRelayErrorResponse means it's a standard Flashbots relay error response, so probably a user error, rather than JSON or network error
+			fmt.Println(err.Error())
+		} else {
+			fmt.Printf("error: %+v\n", err)
+		}
+		return
+	}
+
+	getBundleStatsArgs := flashbotsrpc.FlashbotsGetBundleStatsParam{
+		BlockNumber: fmt.Sprintf("0x%x", 13281018),
+		BundleHash:  result.BundleHash,
+	}
+	bundleStats, err := rpc.FlashbotsGetBundleStats(privateKey, getBundleStatsArgs)
+	if err != nil {
+		if errors.Is(err, flashbotsrpc.ErrRelayErrorResponse) {
+			// ErrRelayErrorResponse means it's a standard Flashbots relay error response, so probably a user error, rather than JSON or network error
+			fmt.Println(err.Error())
+		} else {
+			fmt.Printf("error: %+v\n", err)
+		}
+		return
+	}
+
+	// Print result
+	fmt.Printf("%+v\n", bundleStats)
+}

flashbotsrpc.go

@@ -640,6 +640,15 @@ func (rpc *FlashbotsRPC) FlashbotsSendBundle(privKey *ecdsa.PrivateKey, param Fl
 	return res, err
 }
 
+func (rpc *FlashbotsRPC) FlashbotsGetBundleStats(privKey *ecdsa.PrivateKey, param FlashbotsGetBundleStatsParam) (res FlashbotsGetBundleStatsResponse, err error) {
+	rawMsg, err := rpc.CallWithFlashbotsSignature("flashbots_getBundleStats", privKey, param)
+	if err != nil {
+		return res, err
+	}
+	err = json.Unmarshal(rawMsg, &res)
+	return res, err
+}
+
 // Simulate a full Ethereum block. numTx is the maximum number of tx to include, used for troubleshooting (default: 0 - all transactions)
 func (rpc *FlashbotsRPC) FlashbotsSimulateBlock(privKey *ecdsa.PrivateKey, block *types.Block, maxTx int) (res FlashbotsCallBundleResponse, err error) {
 	if rpc.Debug {

flashbotsrpc_test.go

@@ -1,14 +1,17 @@
 package flashbotsrpc
 
 import (
+	"crypto/ecdsa"
 	"errors"
 	"fmt"
 	"io/ioutil"
 	"math/big"
 	"net/http"
 	"strconv"
 	"testing"
+	"time"
 
+	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/jarcoal/httpmock"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
@@ -17,7 +20,8 @@ import (
 
 type FlashbotsRPCTestSuite struct {
 	suite.Suite
-	rpc *FlashbotsRPC
+	rpc     *FlashbotsRPC
+	privKey *ecdsa.PrivateKey
 }
 
 func (s *FlashbotsRPCTestSuite) registerResponse(result string, callback func([]byte)) {
@@ -62,6 +66,9 @@ func (s *FlashbotsRPCTestSuite) paramsEqual(body []byte, expected string) {
 func (s *FlashbotsRPCTestSuite) SetupSuite() {
 	s.rpc = NewFlashbotsRPC("http://127.0.0.1:8545", WithHttpClient(http.DefaultClient), WithLogger(nil), WithDebug(false))
 
+	privateKey, _ := crypto.GenerateKey()
+	s.privKey = privateKey
+
 	httpmock.Activate()
 }
 
@@ -1148,6 +1155,44 @@ func (s *FlashbotsRPCTestSuite) TestEthUninstallFilter() {
 	s.Require().Equal(boolRes, uninstall)
 }
 
+func (s *FlashbotsRPCTestSuite) TestFlashbotsGetBundleStats() {
+	params := FlashbotsGetBundleStatsParam{
+		BlockNumber: "0x7a69",
+		BundleHash:  "0xdeadc0de",
+	}
+
+	s.registerResponseError(errors.New("Error"))
+	_, err := s.rpc.FlashbotsGetBundleStats(s.privKey, params)
+	s.Require().NotNil(err)
+
+	response := `{
+  "isSimulated": true,
+  "isSentToMiners": true,
+  "isHighPriority": true,
+  "simulatedAt": "2021-08-06T21:36:06.317Z",
+  "submittedAt": "2021-08-06T21:36:06.250Z",
+  "sentToMinersAt": "2021-08-06T21:36:06.343Z"
+}`
+
+	s.registerResponse(response, func(body []byte) {
+		s.methodEqual(body, "flashbots_getBundleStats")
+		s.paramsEqual(body, `[{"blockNumber": "0x7a69", "bundleHash": "0xdeadc0de"}]`)
+	})
+
+	bundleStats, err := s.rpc.FlashbotsGetBundleStats(s.privKey, params)
+	s.Require().Nil(err)
+
+	expected := FlashbotsGetBundleStatsResponse{
+		IsSimulated:    true,
+		IsSentToMiners: true,
+		IsHighPriority: true,
+		SimulatedAt:    time.Date(2021, 8, 6, 21, 36, 6, 317000000, time.UTC),
+		SubmittedAt:    time.Date(2021, 8, 6, 21, 36, 6, 250000000, time.UTC),
+		SentToMinersAt: time.Date(2021, 8, 6, 21, 36, 6, 343000000, time.UTC),
+	}
+	s.Require().Equal(expected, bundleStats)
+}
+
 func TestFlashbotsRPCTestSuite(t *testing.T) {
 	suite.Run(t, new(FlashbotsRPCTestSuite))
 }

types.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"encoding/json"
 	"math/big"
+	"time"
 	"unsafe"
 
 	"github.com/pkg/errors"
@@ -385,6 +386,20 @@ type FlashbotsSendBundleRequest struct {
 	RevertingTxs *[]string `json:"revertingTxHashes,omitempty"` // (Optional) Array[String], A list of tx hashes that are allowed to revert
 }
 
+type FlashbotsGetBundleStatsParam struct {
+	BlockNumber string `json:"blockNumber"` // String, a hex encoded block number for which this bundle is valid on
+	BundleHash  string `json:"bundleHash"`  // String, returned by the flashbots api when calling eth_sendBundle
+}
+
+type FlashbotsGetBundleStatsResponse struct {
+	IsSimulated    bool      `json:"isSimulated"`
+	IsSentToMiners bool      `json:"isSentToMiners"`
+	IsHighPriority bool      `json:"isHighPriority"`
+	SimulatedAt    time.Time `json:"simulatedAt"`
+	SubmittedAt    time.Time `json:"submittedAt"`
+	SentToMinersAt time.Time `json:"sentToMinersAt"`
+}
+
 type FlashbotsSendBundleResponse struct {
 	BundleHash string `json:"bundleHash"`
 }