Skip to content

Commit 65c81dc

Browse files
authored
Create README.md
1 parent e16bc7b commit 65c81dc

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Rustic Builder
2+
3+
## Overview
4+
5+
A simple mock builder implementation that serves local mempool transactions from an Ethereum node through the Builder API flow.
6+
It works as a wrapper over Lighthouse's [mock-builder](https://github.com/sigp/lighthouse/blob/unstable/beacon_node/execution_layer/src/test_utils/mock_builder.rs) which is used for lighthouse tests. This means that as Lighthouse implements support for new forks, the builder automatically gets support for the fork by just pointing it to the right lighthouse commit.
7+
8+
The name references both its implementation language (Rust) and its rustic nature - serving farm-to-table payloads from your local execution client.
9+
10+
## Installation
11+
12+
```
13+
cargo build --release
14+
```
15+
16+
## Usage
17+
18+
Needs a fully synced ethereum node (Beacon node + Execution client)
19+
20+
Example usage
21+
```
22+
./target/release/rustic-builder --execution-endpoint http://localhost:8551 --beacon-node http://localhost:5052 --jwt-secret jwt.hex --port 8560
23+
```

0 commit comments

Comments
 (0)