Skip to content

Commit 6887523

Browse files
dvushbhakiyakalimuthuRuteri
authored andcommitted
update readme (flashbots#49)
* update readme * add bundle movement (flashbots#50) * Add builder diagram Co-authored-by: Bhakiyaraj Kalimuthu <[email protected]> Co-authored-by: Mateusz Morusiewicz <[email protected]>
1 parent 6ca8f42 commit 6887523

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -147,23 +147,34 @@ Local relay is enabled by default and overwrites remote relay data. This is only
147147
* Does not accept external blocks
148148
* Does not have payload cache, only the latest block is available
149149

150-
## Usage
150+
# Usage
151151

152152
To get an idea of how the file should look like you can use the `dumpconfig` subcommand to
153153
export your existing configuration:
154154

155-
Builder API options:
155+
Builder-related options:
156156
```
157157
$ geth --help
158158
BUILDER API OPTIONS:
159-
--builder.secret_key value Builder key used for signing blocks (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11") [$BUILDER_SECRET_KEY]
160-
--builder.relay_secret_key value Builder local relay API key used for signing headers (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11") [$BUILDER_RELAY_SECRET_KEY]
161-
--builder.listen_addr value Listening address for builder endpoint (default: ":28545") [$BUILDER_LISTEN_ADDR]
162-
--builder.genesis_fork_version value Genesis fork version. For kiln use 0x70000069 (default: "0x00000000") [$BUILDER_GENESIS_FORK_VERSION]
163-
--builder.bellatrix_fork_version value Bellatrix fork version. For kiln use 0x70000071 (default: "0x02000000") [$BUILDER_BELLATRIX_FORK_VERSION]
164-
--builder.genesis_validators_root value Genesis validators root of the network. For kiln use 0x99b09fcd43e5905236c370f184056bec6e6638cfc31a323b304fc4aa789cb4ad (default: "0x0000000000000000000000000000000000000000000000000000000000000000") [$BUILDER_GENESIS_VALIDATORS_ROOT]
165-
--builder.beacon_endpoint value Beacon endpoint to connect to for beacon chain data (default: "http://127.0.0.1:5052") [$BUILDER_BEACON_ENDPOINT]
166-
--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]
159+
--builder (default: false)
160+
Enable the builder
161+
--builder.beacon_endpoint value (default: "http://127.0.0.1:5052")
162+
--builder.bellatrix_fork_version value (default: "0x02000000")
163+
--builder.dry-run (default: false)
164+
--builder.genesis_fork_version value (default: "0x00000000")
165+
--builder.genesis_validators_root value (default: "0x0000000000000000000000000000000000000000000000000000000000000000")
166+
--builder.listen_addr value (default: ":28545")
167+
Listening address for builder endpoint [$BUILDER_LISTEN_ADDR]
168+
--builder.local_relay (default: false)
169+
--builder.no_bundle_fetcher (default: false)
170+
--builder.relay_secret_key value (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11")
171+
--builder.remote_relay_endpoint value
172+
--builder.secret_key value (default: "0x2fc12ae741f29701f8e30f5de6350766c020cb80768a0ff01e6838ffd2431e11")
173+
--builder.validator_checks (default: false)
174+
--builder.validation_blacklist value
175+
--miner.algotype value (default: "mev-geth")
176+
--miner.blocklist value
177+
--miner.extradata value
167178
```
168179

169180
This will start `geth` in snap-sync mode with a DB memory allowance of 1GB, as the

docs/builder/builder-diagram.png

2.8 MB
Loading

0 commit comments

Comments
 (0)