web3-flashbots.py
Project description
This library works by injecting flashbots as a new module in the Web3.py instance, which allows submitting "bundles" of transactions directly to miners. This is done by also creating a middleware which captures calls to eth_sendBundle
and eth_callBundle
, and sends them to an RPC endpoint which you have specified, which corresponds to mev-geth
.
To apply correct headers we use the flashbot
method which injects the correct header on POST.
Quickstart
from eth_account.signers.local import LocalAccount
from web3 import Web3, HTTPProvider
from flashbots import flashbot
from eth_account.account import Account
import os
ETH_ACCOUNT_SIGNATURE: LocalAccount = Account.from_key(os.environ.get("ETH_SIGNATURE_KEY"))
w3 = Web3(HTTPProvider("http://localhost:8545"))
flashbot(w3, ETH_ACCOUNT_SIGNATURE)
Now the w3.flashbots.sendBundle
method should be available to you. Look in examples/simple.py for usage examples.
Testnet
To use an ethereum testnet, add the appropriate testnet relay RPC to the flashbot
function arguments.
flashbot(w3, ETH_ACCOUNT_SIGNATURE, "https://relay-holesky.flashbots.net")
Check flashbots docs for up-to-date URLs.
Development and testing
Install poetry
Poetry will automatically fix your venv and all packages needed.
poetry install
Tips: PyCharm has a poetry plugin
Simple Testnet Example
See examples/simple.py for environment variable definitions.
poetry shell
ETH_SENDER_KEY=<sender_private_key> \nPROVIDER_URL=https://eth-holesky.alchemyapi.io/v2/<alchemy_key> \nETH_SIGNER_KEY=<signer_private_key> \npython examples/simple.py
Linting
It's advisable to run black with default rules for linting
sudo pip install black # Black should be installed with a global entrypoint
black .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flashbots-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64f09f6fbb1ba97d8d0ca307bcc204f734a24d01ea59ce94037510d539c737b3 |
|
MD5 | 2c213a676758edabde9ee5ba8ff9c9e2 |
|
BLAKE2b-256 | 996b9c309eb0b43ef0f773ba5561a7e1bb33960a926ee8cfbd2cb5667c9b9a9e |