Add README

ultrasoundmoney · Sep 26, 2023 · 72cf18b · 72cf18b
1 parent fbc4789
commit 72cf18b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# Reth based Block Validator Api
+Reth rpc extension to add an endpoint for validation of builder submissions as received by a relay.
+
+## Get Started
+Run extended reth full node with the added rpc endpoint with:
+`RUST_LOG=info cargo run -- node --full --metrics 127.0.0.1:9001 --http --enable-ext`
+
+## Test it
+While there are no automated tests yet you can execute a manual test using the provided testdata:
+`curl --location 'localhost:8545/' --header 'Content-Type: application/json' --data @test/data/rpc_payload.json`
+
+