update readme (#49)

* update readme * add bundle movement (#50) * Add builder diagram Co-authored-by: Bhakiyaraj Kalimuthu <bhakiya.kalimuthu@gmail.com> Co-authored-by: Mateusz Morusiewicz <11313015+Ruteri@users.noreply.github.com>
flashbots · Jul 6, 2023 · 072036c · 072036c
1 parent f795515
commit 072036c
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -147,23 +147,34 @@ Local relay is enabled by default and overwrites remote relay data. This is only
 * Does not accept external blocks
 * Does not have payload cache, only the latest block is available
 
-## Usage
+# Usage
 
 To get an idea of how the file should look like you can use the `dumpconfig` subcommand to
 export your existing configuration:
 
-Builder API options:
+Builder-related options:
 ```
 $ geth --help
 BUILDER API OPTIONS:
-  --builder.secret_key value               Builder key used for signing blocks (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11") [$BUILDER_SECRET_KEY]
-  --builder.relay_secret_key value         Builder local relay API key used for signing headers (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11") [$BUILDER_RELAY_SECRET_KEY]
-  --builder.listen_addr value              Listening address for builder endpoint (default: ":28545") [$BUILDER_LISTEN_ADDR]
-  --builder.genesis_fork_version value     Genesis fork version. For kiln use 0x70000069 (default: "0x00000000") [$BUILDER_GENESIS_FORK_VERSION]
-  --builder.bellatrix_fork_version value   Bellatrix fork version. For kiln use 0x70000071 (default: "0x02000000") [$BUILDER_BELLATRIX_FORK_VERSION]
-  --builder.genesis_validators_root value  Genesis validators root of the network. For kiln use 0x99b09fcd43e5905236c370f184056bec6e6638cfc31a323b304fc4aa789cb4ad (default: "0x0000000000000000000000000000000000000000000000000000000000000000") [$BUILDER_GENESIS_VALIDATORS_ROOT]
-  --builder.beacon_endpoint value          Beacon endpoint to connect to for beacon chain data (default: "http://127.0.0.1:5052") [$BUILDER_BEACON_ENDPOINT]
-  --builder.remote_relay_endpoint value    Relay endpoint to connect to for validator registration data, if not provided will expose validator registration locally [$BUILDER_REMOTE_RELAY_ENDPOINT]
+    --builder                      (default: false)
+          Enable the builder
+    --builder.beacon_endpoint value (default: "http://127.0.0.1:5052")
+    --builder.bellatrix_fork_version value (default: "0x02000000")
+    --builder.dry-run              (default: false)
+    --builder.genesis_fork_version value (default: "0x00000000")
+    --builder.genesis_validators_root value (default: "0x0000000000000000000000000000000000000000000000000000000000000000")
+    --builder.listen_addr value    (default: ":28545")
+          Listening address for builder endpoint [$BUILDER_LISTEN_ADDR]
+    --builder.local_relay          (default: false)
+    --builder.no_bundle_fetcher    (default: false)
+    --builder.relay_secret_key value (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11")
+    --builder.remote_relay_endpoint value
+    --builder.secret_key value     (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11")
+    --builder.validator_checks     (default: false)
+    --builder.validation_blacklist value
+    --miner.algotype value         (default: "mev-geth")
+    --miner.blocklist value
+    --miner.extradata value
 ```
 
 This will start `geth` in snap-sync mode with a DB memory allowance of 1GB, as the

diff --git a/docs/builder/builder-diagram.png b/docs/builder/builder-diagram.png