Skip to content
rainshowerLabsPublic

About

the wd40 of ethereum load balancers

Resources

Security policy

Stars

367 stars

Watchers

6 watching

Forks

Repository files navigation

Blutgang - the wd40 of ethereum load balancers

blutgang_gm

Join the discussion on our discord, telegram, or matrix!

Blutgang is a blazing fast, caching, minimalistic load balancer designed with Ethereum's JSON-RPC in mind. Historical RPC queries are cached in a local database, bypassing the need for slow, repeating calls to your node.

For more info about blutgang and how to use it, please check out the wiki.

How to run

For detailed instructions on how to use blutgang, please read the wiki.

Using cargo

To install blutgang via cargo, run the following command:

cargo install blutgang

Once done, grab the example_config.toml from this repository, modify it to your liking, and start blutgang with it.

From source

Clone the repository, and find the example_config.toml file. Edit it to your liking, and run cargo run --release -- -c example_config.toml.

If you want to use command line arguments instead, please run cargo run --release -- --help for more info. Keep in mind that the recommended way to run blutgang is via a config file.

Max performance

If you need the absolute maximum performance from blutgang, compile it using the command below:

RUSTFLAGS='-C target-cpu=native' cargo build --profile maxperf

Docker

The official docker image is available on dockerhub.
You must provide a config file to the docker container, as well as expose the port specified. Example:

docker run -v /full/path/to/config.toml:/app/config.toml --network host makemake1337/blutgang

The container runs as an unprivileged user (uid 10001) and creates its cache in /app. To keep the cache between runs, mount a named volume there, e.g. -v blutgang-data:/app. A host directory mounted instead must be writable by uid 10001.

Nix

Using Flakes and the nix-community/ethereum.nix overlay:

nix run github:nix-community/ethereum.nix#blutgang -- --help

Testing

cargo test

The end-to-end tests in tests/ start real anvil nodes and run blutgang in front of them. Install anvil with foundryup, or point ANVIL_BIN at the binary. Without anvil these tests are skipped; set BLUTGANG_REQUIRE_ANVIL=1 to make them fail instead, as CI does.

Load testing scripts

spam.py (HTTP) and spam_ws.py (WebSocket) hammer a blutgang instance listening on 127.0.0.1:3000. Their dependencies are managed with uv, so there's no need to create a virtualenv by hand:

uv run spam.py
uv run spam_ws.py

Benchmarks

Benchmarks were performed with a Ryzen 7 2700X, NVME SSD, and default Ubuntu 23.04 kernel. Same RPC endpoints were used

time sothis --source_rpc http://localhost:3000 --mode call_track --contract_address 0x1c479675ad559DC151F6Ec7ed3FbF8ceE79582B6 --origin_block 17885300 --terminal_block 17892269 --calldata 0x06f13056 --query_interval 20

Figure_1 Figure_2

Acknowledgements

Blutgang is standing on the shoulders of giants. Thank you to all the contributors of the projects above!

About

the wd40 of ethereum load balancers

Resources

Security policy

Stars

367 stars

Watchers

6 watching

Forks

Releases

Packages

Used by

Contributors

Languages