Skip to content

Commit dea907e

Browse files
authored
chore(README): update README env vars (#128)
* chore(README): update README env vars These were out of date. Some were missing, and the `RU_RPC_URL` is now `ROLLUP_RPC_URL`. * nit
1 parent 12a90c3 commit dea907e

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

README.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -71,26 +71,31 @@ Finally, if it's non-empty, the submit task attempts to get a signature for the
7171

7272
The Builder is configured via environment variables. The following values are supported for configuration.
7373

74-
| Key | Required | Description |
75-
| ------------------------- | -------- | ------------------------------------------------------------------- |
76-
| `HOST_CHAIN_ID` | Yes | Host-chain ID (e.g. `3151908`) |
77-
| `RU_CHAIN_ID` | Yes | Rollup-chain ID (e.g. `14174`) |
78-
| `TX_POOL_URL` | Yes | Transaction pool URL (must end with `/`) |
79-
| `HOST_RPC_URL` | Yes | RPC endpoint for the host chain |
80-
| `RU_RPC_URL` | Yes | RPC endpoint for the rollup chain |
81-
| `TX_BROADCAST_URLS` | No | Additional endpoints for blob txs (comma-separated, slash required) |
82-
| `ZENITH_ADDRESS` | Yes | Zenith contract address |
83-
| `BUILDER_HELPER_ADDRESS` | Yes | Builder helper contract address |
84-
| `QUINCEY_URL` | Yes | Remote sequencer signing endpoint |
85-
| `BUILDER_PORT` | Yes | HTTP port for the Builder (default: `8080`) |
86-
| `SEQUENCER_KEY` | Yes | AWS KMS key ID _or_ local private key for sequencer signing |
87-
| `BUILDER_KEY` | Yes | AWS KMS key ID _or_ local private key for builder signing |
88-
| `BUILDER_REWARDS_ADDRESS` | Yes | Address receiving builder rewards |
89-
| `ROLLUP_BLOCK_GAS_LIMIT` | No | Override for block gas limit |
90-
| `CONCURRENCY_LIMIT` | Yes | Max concurrent tasks the simulator uses |
91-
| `SLOT_OFFSET` | Yes | Slot timing offset in seconds |
92-
| `SLOT_DURATION` | Yes | Slot duration in seconds |
93-
| `START_TIMESTAMP` | Yes | UNIX timestamp for slot 0 |
74+
| Key | Required | Description |
75+
| ----------------------------- | -------- | ------------------------------------------------------------------- |
76+
| `HOST_CHAIN_ID` | Yes | Host-chain ID (e.g. `3151908`) |
77+
| `RU_CHAIN_ID` | Yes | Rollup-chain ID (e.g. `14174`) |
78+
| `HOST_RPC_URL` | Yes | RPC endpoint for the host chain |
79+
| `ROLLUP_RPC_URL` | Yes | RPC endpoint for the rollup chain |
80+
| `TX_POOL_URL` | Yes | Transaction pool URL (must end with `/`) |
81+
| `TX_BROADCAST_URLS` | No | Additional endpoints for blob txs (comma-separated, slash required) |
82+
| `ZENITH_ADDRESS` | Yes | Zenith contract address |
83+
| `BUILDER_HELPER_ADDRESS` | Yes | Builder helper contract address |
84+
| `QUINCEY_URL` | Yes | Remote sequencer signing endpoint |
85+
| `BUILDER_PORT` | Yes | HTTP port for the Builder (default: `8080`) |
86+
| `SEQUENCER_KEY` | Yes | AWS KMS key ID _or_ local private key for sequencer signing |
87+
| `BUILDER_KEY` | Yes | AWS KMS key ID _or_ local private key for builder signing |
88+
| `BUILDER_REWARDS_ADDRESS` | Yes | Address receiving builder rewards |
89+
| `ROLLUP_BLOCK_GAS_LIMIT` | No | Override for block gas limit |
90+
| `CONCURRENCY_LIMIT` | No | Max concurrent tasks the simulator uses |
91+
| `OAUTH_CLIENT_ID` | Yes | Oauth client ID for the builder |
92+
| `OAUTH_CLIENT_SECRET` | Yes | Oauth client secret for the builder |
93+
| `OAUTH_AUTHENTICATE_URL` | Yes | Oauth authenticate URL for the builder for performing OAuth logins |
94+
| `OAUTH_TOKEN_URL` | Yes | Oauth token URL for the builder to get an Oauth2 access token |
95+
| `AUTH_TOKEN_REFRESH_INTERVAL` | Yes | The OAuth token refresh interval in seconds. |
96+
| `SLOT_OFFSET` | Yes | Slot timing offset in seconds |
97+
| `SLOT_DURATION` | Yes | Slot duration in seconds |
98+
| `START_TIMESTAMP` | Yes | UNIX timestamp for slot 0 |
9499

95100
---
96101

0 commit comments

Comments
 (0)