Skip to content

Commit 971694b

Browse files
committed
update readme with flashbots endpoint
1 parent 04b3b96 commit 971694b

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ The Builder is configured via environment variables. The following values are su
7979
| `ROLLUP_RPC_URL` | Yes | RPC endpoint for the rollup chain |
8080
| `TX_POOL_URL` | Yes | Transaction pool URL (must end with `/`) |
8181
| `TX_BROADCAST_URLS` | No | Additional endpoints for blob txs (comma-separated, slash required) |
82+
| `FLASHBOTS_ENDPOINT` | No | Flashbots API to submit blocks to. |
8283
| `ZENITH_ADDRESS` | Yes | Zenith contract address |
8384
| `BUILDER_HELPER_ADDRESS` | Yes | Builder helper contract address |
8485
| `QUINCEY_URL` | Yes | Remote sequencer signing endpoint |
@@ -87,7 +88,7 @@ The Builder is configured via environment variables. The following values are su
8788
| `BUILDER_KEY` | Yes | AWS KMS key ID _or_ local private key for builder signing |
8889
| `BUILDER_REWARDS_ADDRESS` | Yes | Address receiving builder rewards |
8990
| `ROLLUP_BLOCK_GAS_LIMIT` | No | Override for block gas limit |
90-
| `CONCURRENCY_LIMIT` | No | Max concurrent tasks the simulator uses |
91+
| `CONCURRENCY_LIMIT` | No | Max concurrent tasks the simulator uses |
9192
| `OAUTH_CLIENT_ID` | Yes | Oauth client ID for the builder |
9293
| `OAUTH_CLIENT_SECRET` | Yes | Oauth client secret for the builder |
9394
| `OAUTH_AUTHENTICATE_URL` | Yes | Oauth authenticate URL for the builder for performing OAuth logins |
@@ -135,13 +136,13 @@ A binary (`bin/submit_transaction.rs`) for continously sending very small transa
135136

136137
The following values are available for configuring the transaction sender:
137138

138-
| Key | Required | Description |
139-
| ------------------- | -------- | ------------------------------------------------ |
140-
| `RPC_URL` | Yes | RPC endpoint used for sending the transaction |
141-
| `RECIPIENT_ADDRESS` | Yes | Address to which the transaction is sent |
142-
| `SLEEP_TIME` | Yes | Optional delay (in ms) between transactions |
143-
| `SIGNER_CHAIN_ID` | Yes | Chain ID used for signing |
144-
| `SIGNER_KEY` | Yes | Signing key used to sign the transaction |
139+
| Key | Required | Description |
140+
| ------------------- | -------- | --------------------------------------------- |
141+
| `RPC_URL` | Yes | RPC endpoint used for sending the transaction |
142+
| `RECIPIENT_ADDRESS` | Yes | Address to which the transaction is sent |
143+
| `SLEEP_TIME` | Yes | Optional delay (in ms) between transactions |
144+
| `SIGNER_CHAIN_ID` | Yes | Chain ID used for signing |
145+
| `SIGNER_KEY` | Yes | Signing key used to sign the transaction |
145146

146147
The transaction submitter is located at `bin/submit_transaction.rs`.
147148

@@ -155,13 +156,13 @@ A binary (`bin/submit_order.rs`) for continuously sending small example orders f
155156

156157
The following values need to be configured:
157158

158-
| Key | Required | Description |
159-
| ------------------- | -------- | ------------------------------------------------ |
160-
| `RPC_URL` | Yes | RPC endpoint used for sending the transaction |
161-
| `SEND_TO_ROLLUP` | Yes | Whether to make a rollup order (RU-RU) or host order (RU-HOST) |
162-
| `SLEEP_TIME` | Yes | Optional delay (in ms) between transactions |
163-
| `SIGNER_CHAIN_ID` | Yes | Chain ID used for signing |
164-
| `SIGNER_KEY` | Yes | Signing key used to sign the transaction |
159+
| Key | Required | Description |
160+
| ----------------- | -------- | -------------------------------------------------------------- |
161+
| `RPC_URL` | Yes | RPC endpoint used for sending the transaction |
162+
| `SEND_TO_ROLLUP` | Yes | Whether to make a rollup order (RU-RU) or host order (RU-HOST) |
163+
| `SLEEP_TIME` | Yes | Optional delay (in ms) between transactions |
164+
| `SIGNER_CHAIN_ID` | Yes | Chain ID used for signing |
165+
| `SIGNER_KEY` | Yes | Signing key used to sign the transaction |
165166

166167
Run the order submitter with `cargo run --bin order-submitter`
167168

0 commit comments

Comments
 (0)