Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lmittmann/flashbots
Package flashbots implements RPC API bindings for the Flashbots relay and mev-geth for use with the w3 package.
https://github.com/lmittmann/flashbots
ethereum flashbots golang mev rpc w3 web3
Last synced: 21 days ago
JSON representation
Package flashbots implements RPC API bindings for the Flashbots relay and mev-geth for use with the w3 package.
- Host: GitHub
- URL: https://github.com/lmittmann/flashbots
- Owner: lmittmann
- License: mit
- Created: 2022-02-09T20:00:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T13:28:16.000Z (about 1 month ago)
- Last Synced: 2024-10-13T19:12:18.201Z (about 1 month ago)
- Topics: ethereum, flashbots, golang, mev, rpc, w3, web3
- Language: Go
- Homepage: https://pkg.go.dev/github.com/lmittmann/flashbots
- Size: 186 KB
- Stars: 34
- Watchers: 5
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flashbots ⚡🤖
[](https://pkg.go.dev/github.com/lmittmann/flashbots)
[](https://goreportcard.com/report/github.com/lmittmann/flashbots)
[](https://coveralls.io/github/lmittmann/flashbots?branch=main)
[](https://github.com/lmittmann/flashbots/releases)
Package flashbots implements RPC API bindings for the Flashbots relay and
[mev-geth](https://github.com/flashbots/mev-geth) for use with the [`w3` package](https://github.com/lmittmann/w3).
## Install
```
go get github.com/lmittmann/flashbots
```
## Getting Started
> [!NOTE]
> Check out the [examples](examples/)!
Connect to the Flashbots relay. The [`w3.Client`](https://pkg.go.dev/github.com/lmittmann/w3#Client)
returned by [`Dial`](https://pkg.go.dev/github.com/lmittmann/flashbots#Dial)
uses the [`AuthTransport`](https://pkg.go.dev/github.com/lmittmann/flashbots#AuthTransport)
to add the `X-Flashbots-Signature` header to every request.
```go
// Private key for request signing.
var prv *ecdsa.PrivateKey
// Connect to Flashbots Relay
client := flashbots.MustDial("https://relay.flashbots.net", prv)
defer client.Close()
// Or… Connect to any RPC endpoint that does not require signed requests
client := w3.MustDial("http://localhost:8545")
defer client.Close()
```
Send a bundle to the Flashbots relay.
```go
bundle := []*types.Transaction{ /* signed transactions… */ }
var bundleHash common.Hash
err := client.Call(
flashbots.SendBundle(&flashbots.SendBundleRequest{
Transactions: bundle,
BlockNumber: big.NewInt(999_999_999),
}).Returns(&bundleHash),
)
```
> [!WARNING]
> The Flashbots relay does not support batch requests. Thus, sending more than
one call in `Client.Call` will result in a server error.
## RPC Methods
List of supported RPC methods.
| Method | Go Code
| :----------------------------- | :-------
| `eth_sendBundle` | `flashbots.SendBundle(r *flashbots.SendBundleRequest).Returns(bundleHash *common.Hash)`
| `eth_callBundle` | `flashbots.CallBundle(r *flashbots.CallBundleRequest).Returns(resp **flashbots.CallBundleResponse)`
| `eth_sendPrivateTransaction` | `flashbots.SendPrivateTx(r *flashbots.SendPrivateTxRequest).Returns(txHash *common.Hash)`
| `eth_cancelPrivateTransaction` | `flashbots.CancelPrivateTx(txHash common.Hash).Returns(success *bool)`
| ~~`flashbots_getUserStats`~~ | ~~`flashbots.UserStats(blockNumber *big.Int).Returns(resp **flashbots.UserStatsResponse)`~~
| ~~`flashbots_getBundleStats`~~ | ~~`flashbots.BundleStats(bundleHash common.Hash, blockNumber *big.Int).Returns(resp **flashbots.BundleStatsResponse)`~~
| `flashbots_getUserStatsV2` | `flashbots.UserStatsV2(blockNumber *big.Int).Returns(resp **flashbots.UserStatsV2Response)`
| `flashbots_getBundleStatsV2` | `flashbots.BundleStatsV2(bundleHash common.Hash, blockNumber *big.Int).Returns(resp **flashbots.BundleStatsV2Response)`