examples: callBundle

Author: metachris

README.md

@@ -11,26 +11,48 @@ Fork of [ethrpc](https://github.com/onrik/ethrpc) with additional [Flashbots RPC
 
 ## Usage
 
+Add library to your project:
+
 `go get github.com/metachris/flashbotsrpc`
 
-```go
-rpc := flashbotsrpc.New("https://relay.flashbots.net")
+Create a new private key here for testing (you probably want to use an existing one):
 
-// Creating a new private key here for testing, you probably want to use an existing one
+```go
 privateKey, _ := crypto.GenerateKey()
+```
+
+#### Simulate transactions with `eth_callBundle`:
+
+```go
+callBundleArgs := flashbotsrpc.FlashbotsCallBundleParam{
+    Txs:              []string{"YOUR_RAW_TX"},
+    BlockNumber:      fmt.Sprintf("0x%x", 13281018),
+    StateBlockNumber: "latest",
+}
+
+result, err := rpc.FlashbotsCallBundle(privateKey, callBundleArgs)
+if err != nil {
+    log.Fatal(err)
+}
+fmt.Printf("%+v\n", result)
+```
+
+#### Get Flashbots user stats:
 
-// flashbots_getUserStats example
-// ------------------------------
+```go
+rpc := flashbotsrpc.New("https://relay.flashbots.net")
 result, err := rpc.FlashbotsGetUserStats(privateKey, 13281018)
 if err != nil {
     log.Fatal(err)
 }
 fmt.Printf("%+v\n", result)
+```
+
+#### Send a transaction bundle to Flashbots with `eth_sendBundle`:
 
-// eth_sendBundle example
-// ----------------------
+```go
 sendBundleArgs := flashbotsrpc.FlashbotsSendBundleRequest{
-    Txs:         []string{"YOUR_HASH"},
+    Txs:         []string{"YOUR_RAW_TX"},
     BlockNumber: fmt.Sprintf("0x%x", 13281018),
 }
 
@@ -41,4 +63,6 @@ if err != nil {
 fmt.Printf("%+v\n", result)
 ```
 
+#### More examples
+
 You can find example code in the [`/examples/` directory](https://github.com/metachris/flashbotsrpc/tree/master/examples).

examples/callBundle/main.go

@@ -0,0 +1,34 @@
+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")
+	opts := flashbotsrpc.FlashbotsCallBundleParam{
+		Txs:              []string{"YOUR_RAW_TX"},
+		BlockNumber:      fmt.Sprintf("0x%x", 13281018),
+		StateBlockNumber: "latest",
+	}
+
+	result, err := rpc.FlashbotsCallBundle(privateKey, opts)
+	if err != nil {
+		if errors.Is(err, flashbotsrpc.ErrRelayErrorResponse) { // user/tx 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", result)
+}

examples/sendbundle/main.go

@@ -16,7 +16,7 @@ func main() {
 	rpc.Debug = true
 
 	sendBundleArgs := flashbotsrpc.FlashbotsSendBundleRequest{
-		Txs:         []string{"YOUR_HASH"},
+		Txs:         []string{"YOUR_RAW_TX"},
 		BlockNumber: fmt.Sprintf("0x%x", 13281018),
 	}