Skip to content
This repository was archived by the owner on May 27, 2025. It is now read-only.

Commit 8f8bc6a

Browse files
author
wbnns
committed
Add badges to README
1 parent 3135bb9 commit 8f8bc6a

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,47 @@
11
# Flashblocks Websocket Proxy
22

33
## Overview
4+
45
The Flashblocks Websocket Proxy is a service that subscribes to new Flashblocks from
5-
[rollup-boost](https://github.com/flashbots/rollup-boost) on the sequencer. Then broadcasts them out to any downstream
6+
[rollup-boost](https://github.com/flashbots/rollup-boost) on the sequencer. Then broadcasts them out to any downstream
67
RPC nodes. Minimizing the number of connections to the sequencer and restricting access.
78

89
> ⚠️ **Warning**
9-
>
10+
>
1011
> This is currently alpha software -- deploy at your own risk!
11-
>
12+
>
1213
> Currently, this project is a one-directional generic websocket proxy. It doesn't inspect any data or validate clients.
1314
> This may not always be the case.
1415
16+
<!-- Badge row 1 - status -->
17+
18+
[![GitHub contributors](https://img.shields.io/github/contributors/base/flashblocks-websocket-proxy)](https://github.com/base/flashblocks-websocket-proxy/graphs/contributors)
19+
[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/base/flashblocks-websocket-proxy)](https://github.com/base/flashblocks-websocket-proxy/graphs/contributors)
20+
[![GitHub Stars](https://img.shields.io/github/stars/base/flashblocks-websocket-proxy.svg)](https://github.com/base/flashblocks-websocket-proxy/stargazers)
21+
![GitHub repo size](https://img.shields.io/github/repo-size/base/flashblocks-websocket-proxy)
22+
[![GitHub](https://img.shields.io/github/license/base/flashblocks-websocket-proxy?color=blue)](https://github.com/base/flashblocks-websocket-proxy/blob/master/LICENSE.md)
23+
24+
<!-- Badge row 2 - links and profiles -->
25+
26+
[![Website base.org](https://img.shields.io/website-up-down-green-red/https/base.org.svg)](https://base.org)
27+
[![Blog](https://img.shields.io/badge/blog-up-green)](https://base.mirror.xyz/)
28+
[![Docs](https://img.shields.io/badge/docs-up-green)](https://docs.base.org/)
29+
[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://base.org/discord)
30+
[![Twitter Base](https://img.shields.io/twitter/follow/Base?style=social)](https://twitter.com/Base)
31+
32+
<!-- Badge row 3 - detailed status -->
33+
34+
[![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)
35+
[![GitHub Issues](https://img.shields.io/github/issues-raw/base/flashblocks-websocket-proxy.svg)](https://github.com/base/flashblocks-websocket-proxy/issues)
36+
1537
## For Developers
1638

1739
### Contributing
1840

1941
### Building & Testing
42+
2043
You can build and test the project using [Cargo](https://doc.rust-lang.org/cargo/). Some useful commands are:
44+
2145
```
2246
# Build the project
2347
cargo build
@@ -27,10 +51,10 @@ cargo test --all-features
2751
```
2852

2953
### Deployment
54+
3055
Builds of the websocket proxy [are provided](https://github.com/base/flashblocks-websocket-proxy/pkgs/container/flashblocks-websocket-proxy).
3156
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`.
3257

33-
3458
You can see a full list of parameters by running:
3559

3660
`docker run ghcr.io/base/flashblocks-websocket-proxy:master --help`
@@ -61,4 +85,3 @@ When Redis is enabled, the following features are available:
6185
- More accurate global connection limiting in multi-instance deployments
6286

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

0 commit comments

Comments
 (0)