https://github.com/base/flashblocks-websocket-proxy

A websocket proxy for distributing Flashblocks
https://github.com/base/flashblocks-websocket-proxy

Last synced: 10 months ago
JSON representation

A websocket proxy for distributing Flashblocks

• Host: GitHub
• URL: https://github.com/base/flashblocks-websocket-proxy
• Owner: base
• Created: 2025-02-23T21:11:12.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-05-07T17:35:37.000Z (about 1 year ago)
• Last Synced: 2025-05-07T18:40:07.768Z (about 1 year ago)
• Language: Rust
• Size: 85.9 KB
• Stars: 7
• Watchers: 12
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Flashblocks Websocket Proxy

> ⚠️ **Warning**

>

> This is currently alpha software -- deploy at your own risk!

>

> Currently, this project is a one-directional generic websocket proxy. It doesn't inspect any data or validate clients.

> This may not always be the case.

## Overview

The Flashblocks Websocket Proxy is a service that subscribes to new Flashblocks from

[rollup-boost](https://github.com/flashbots/rollup-boost) on the sequencer. Then broadcasts them out to any downstream

RPC nodes. Minimizing the number of connections to the sequencer and restricting access.

[![GitHub contributors](https://img.shields.io/github/contributors/base/flashblocks-websocket-proxy)](https://github.com/base/flashblocks-websocket-proxy/graphs/contributors)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/base/flashblocks-websocket-proxy)](https://github.com/base/flashblocks-websocket-proxy/graphs/contributors)

[![GitHub Stars](https://img.shields.io/github/stars/base/flashblocks-websocket-proxy.svg)](https://github.com/base/flashblocks-websocket-proxy/stargazers)

![GitHub repo size](https://img.shields.io/github/repo-size/base/flashblocks-websocket-proxy)

[![GitHub](https://img.shields.io/github/license/base/flashblocks-websocket-proxy?color=blue)](https://github.com/base/flashblocks-websocket-proxy/blob/master/LICENSE.md)

[![Website base.org](https://img.shields.io/website-up-down-green-red/https/base.org.svg)](https://base.org)

[![Blog](https://img.shields.io/badge/blog-up-green)](https://base.mirror.xyz/)

[![Docs](https://img.shields.io/badge/docs-up-green)](https://docs.base.org/)

[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://base.org/discord)

[![Twitter Base](https://img.shields.io/twitter/follow/Base?style=social)](https://twitter.com/Base)

[![GitHub pull requests by-label](https://img.shields.io/github/issues-pr-raw/base/flashblocks-websocket-proxy)](https://github.com/base/flashblocks-websocket-proxy/pulls)

[![GitHub Issues](https://img.shields.io/github/issues-raw/base/flashblocks-websocket-proxy.svg)](https://github.com/base/flashblocks-websocket-proxy/issues)

## For Developers

### Contributing

### Building & Testing

You can build and test the project using [Cargo](https://doc.rust-lang.org/cargo/). Some useful commands are:

```

# Build the project

cargo build

# Run all the tests (requires local version of redis to be installed)

cargo test --all-features

```

### Deployment

Builds of the websocket proxy [are provided](https://github.com/base/flashblocks-websocket-proxy/pkgs/container/flashblocks-websocket-proxy).

The only configuration required is the rollup-boost URL to proxy. You can set this via an env var `UPSTREAM_WS` or a flag `--upstream-ws`.

You can see a full list of parameters by running:

`docker run ghcr.io/base/flashblocks-websocket-proxy:master --help`

### Redis Integration

The proxy supports distributed rate limiting with Redis. This is useful when running multiple instances of the proxy behind a load balancer, as it allows rate limits to be enforced across all instances.

To enable Redis integration, use the following parameters:

- `--redis-url` - Redis connection URL (e.g., `redis://localhost:6379`)

- `--redis-key-prefix` - Prefix for Redis keys (default: `flashblocks`)

Example:

```bash

docker run ghcr.io/base/flashblocks-websocket-proxy:master \

  --upstream-ws wss://your-sequencer-endpoint \

  --redis-url redis://redis:6379 \

  --global-connections-limit 1000 \

  --per-ip-connections-limit 10

```

When Redis is enabled, the following features are available:

- Distributed rate limiting across multiple proxy instances

- Connection tracking persists even if the proxy instance restarts

- More accurate global connection limiting in multi-instance deployments

If the Redis connection fails, the proxy will automatically fall back to in-memory rate limiting.