Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.23 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.23 KB

Flashblocks Websocket Proxy

Overview

The Flashblocks Websocket Proxy is a service that subscribes to new Flashblocks from 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.

⚠️ 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.

For Developers

Contributing

Building & Testing

You can build and test the project using Cargo. Some useful commands are:

# Build the project
cargo build

# Run all the tests
cargo test --all-features

Deployment

Builds of the websocket proxy are provided. 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