Skip to content

Commit f2c898e

Browse files
committed
docs: updates README to reflect latest changes
- removes mentions of BuilderHelper contract and config - removes deprecated variables around builder helper and chain configs - adds documentation for latest flashbots related configs
1 parent 25ed5fb commit f2c898e

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

README.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,7 @@ When the deadline is reached, the simulator is stopped, and all open simulation
7373

7474
### ✨ Submit Task
7575

76-
If Flashbots endpoint has been configured the Flashbots submit task will prepare a Flashbots bundle out of that Signet block, and then submits that bundle to the Flashbots endpoint.
77-
78-
If a Flashbots endpoint has _not_ been configured, the Builder uses the [builder helper contract] and to craft a rollup block transaction and submits that to the default mempool. This mode of operation is only for testing on private networks and should not be used in production, since it can leak sensitive transaction data from the Signet block.
76+
The Flashbots submit task prepares a Flashbots bundle out of the Signet block and its host transactions and then submits that bundle to the Flashbots endpoint. It sends the hash of the rollup block transaction for to the Metrics task for further tracking.
7977

8078
If the block received from simulation is empty, the submit task will ignore it.
8179

@@ -88,32 +86,29 @@ Finally, if it's non-empty, the submit task attempts to get a signature for the
8886
The Builder is configured via environment variables. The following values are supported for configuration.
8987

9088
Key | Required | Description
91-
----------------------------- | -------- | ----------------------------------------------------------------------------------------
92-
`HOST_CHAIN_ID` | Yes | Host-chain ID (e.g. `3151908`)
93-
`RU_CHAIN_ID` | Yes | Rollup-chain ID (e.g. `14174`)
89+
----------------------------- | -------- | ------------------------------------------------------------------------------
90+
`RUST_LOG` | No | The log level of the builder
91+
`CHAIN_NAME` | No | The chain name ("pecorino", or the corresponding name)
9492
`HOST_RPC_URL` | Yes | RPC endpoint for the host chain
9593
`ROLLUP_RPC_URL` | Yes | RPC endpoint for the rollup chain
96-
`TX_POOL_URL` | Yes | Transaction pool URL (must end with `/`)
97-
`TX_BROADCAST_URLS` | No | Additional endpoints for blob txs (comma-separated, slash required)
98-
`FLASHBOTS_ENDPOINT` | No | Flashbots API to submit blocks to. Defaults to the BuilderHelper submit task if not set.
99-
`ZENITH_ADDRESS` | Yes | Zenith contract address
100-
`BUILDER_HELPER_ADDRESS` | Yes | Builder helper contract address
10194
`QUINCEY_URL` | Yes | Remote sequencer signing endpoint
102-
`BUILDER_PORT` | Yes | HTTP port for the Builder (default: `8080`)
103-
`SEQUENCER_KEY` | Yes | AWS KMS key ID _or_ local private key for sequencer signing
95+
`SEQUENCER_KEY` | No | AWS Key ID _OR_ local private key for the Sequencer; set IFF using local Sequencer signing instead of remote (via `QUINCEY_URL`) Quincey signing
96+
`TX_POOL_URL` | Yes | Transaction pool URL (must end with `/`)
97+
`FLASHBOTS_ENDPOINT` | No | Flashbots API to submit blocks to
98+
`ROLLUP_BLOCK_GAS_LIMIT` | No | Override for rollup block gas limit
99+
`MAX_HOST_GAS_COEFFICIENT` | No | Optional maximum host gas coefficient, as a percentage, to use when building blocks
104100
`BUILDER_KEY` | Yes | AWS KMS key ID _or_ local private key for builder signing
101+
`AWS_ACCESS_KEY_ID` | No | AWS secret access key ID (required if not using `BUILDER_KEY`)
102+
`AWS_SECRET_ACCESS_KEY` | No | AWS secret access key (required if not using `BUILDER_KEY`)
103+
`AWS_DEFAULT_REGION` | No | AWS region for the KMS key in question (required if not using `BUILDER_KEY`)
104+
`BUILDER_PORT` | Yes | HTTP port for the Builder (default: `8080`)
105105
`BUILDER_REWARDS_ADDRESS` | Yes | Address receiving builder rewards
106-
`ROLLUP_BLOCK_GAS_LIMIT` | No | Override for block gas limit
107-
`CONCURRENCY_LIMIT` | No | Max concurrent tasks the simulator uses
106+
`CONCURRENCY_LIMIT` | No | Optional max number of concurrent tasks the simulator uses. Defaults to a system call to determine optimal parallelism
108107
`OAUTH_CLIENT_ID` | Yes | Oauth client ID for the builder
109108
`OAUTH_CLIENT_SECRET` | Yes | Oauth client secret for the builder
110109
`OAUTH_AUTHENTICATE_URL` | Yes | Oauth authenticate URL for the builder for performing OAuth logins
111110
`OAUTH_TOKEN_URL` | Yes | Oauth token URL for the builder to get an Oauth2 access token
112111
`AUTH_TOKEN_REFRESH_INTERVAL` | Yes | The OAuth token refresh interval in seconds.
113-
`CHAIN_NAME` | No | The chain name ("pecorino", or the corresponding name)
114-
`SLOT_OFFSET` | No | Slot timing offset in seconds. Required if `CHAIN_NAME` is not present
115-
`SLOT_DURATION` | No | Slot duration in seconds. Required if `CHAIN_NAME` is not present
116-
`START_TIMESTAMP` | No | UNIX timestamp for slot 0\. Required if `CHAIN_NAME` is not present
117112

118113
--------------------------------------------------------------------------------
119114

@@ -188,5 +183,3 @@ The previous header's basefee is tracked through the build loop and used for gas
188183
## 🪪 License
189184

190185
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
191-
192-
[builder helper contract]: https://github.com/init4tech/helper-contracts/blob/main/src/BuilderHelper.sol

0 commit comments

Comments
 (0)