Sitelet https://github.com/init4tech/builder/commit/475bcfaa4b5cc3c99e5a1b3a9eeff36c87510355
Skip to content

Commit 475bcfa

Browse files
init4samwiseclaude
init4samwise
and
claude
authored
docs: polish README for mainnet readiness (#245)
Add CI and license badges, convert config table to standard markdown format, and fix typos (signin → signing, Oauth → OAuth). Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ecb388a commit 475bcfa

1 file changed

Lines changed: 28 additions & 25 deletions

File tree

‎README.md‎

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![Rust CI](https://github.com/init4tech/builder/actions/workflows/rust-ci.yml/badge.svg)](https://github.com/init4tech/builder/actions/workflows/rust-ci.yml)
2+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
3+
14
# The Signet Block Builder
25

36
The Builder simulates bundles and transactions against the latest chain state to create valid Signet rollup blocks and submits them to the configured host chain as an [EIP-4844 transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-4844.md).
@@ -85,31 +88,31 @@ Finally, if it's non-empty, the submit task attempts to get a signature for the
8588

8689
The Builder is configured via environment variables. The following values are supported for configuration.
8790

88-
Key | Required | Description
89-
----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------
90-
`RUST_LOG` | No | The log level of the builder
91-
`CHAIN_NAME` | No | The chain name ("pecorino", or the corresponding name)
92-
`HOST_RPC_URL` | Yes | RPC endpoint for the host chain
93-
`ROLLUP_RPC_URL` | Yes | RPC endpoint for the rollup chain
94-
`QUINCEY_URL` | Yes | Remote sequencer signing endpoint
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
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
100-
`BUILDER_KEY` | Yes | AWS KMS key ID _or_ local private key for builder signin
101-
`BLOCK_QUERY_CUTOFF_BUFFER` | Yes | Number of milliseconds before the end of the slot to stop querying for new transactions and start the block signing and submission process
102-
`AWS_ACCESS_KEY_ID` | No | AWS secret access key ID (required if not using `BUILDER_KEY`)
103-
`AWS_SECRET_ACCESS_KEY` | No | AWS secret access key (required if not using `BUILDER_KEY`)
104-
`AWS_DEFAULT_REGION` | No | AWS region for the KMS key in question (required if not using `BUILDER_KEY`)
105-
`BUILDER_PORT` | Yes | HTTP port for the Builder (default: `8080`)
106-
`BUILDER_REWARDS_ADDRESS` | Yes | Address receiving builder rewards
107-
`CONCURRENCY_LIMIT` | No | Optional max number of concurrent tasks the simulator uses. Defaults to a system call to determine optimal parallelism
108-
`OAUTH_CLIENT_ID` | Yes | Oauth client ID for the builder
109-
`OAUTH_CLIENT_SECRET` | Yes | Oauth client secret for the builder
110-
`OAUTH_AUTHENTICATE_URL` | Yes | Oauth authenticate URL for the builder for performing OAuth logins
111-
`OAUTH_TOKEN_URL` | Yes | Oauth token URL for the builder to get an Oauth2 access token
112-
`AUTH_TOKEN_REFRESH_INTERVAL` | Yes | The OAuth token refresh interval in seconds.
91+
| Key | Required | Description |
92+
| --- | --- | --- |
93+
| `RUST_LOG` | No | The log level of the builder |
94+
| `CHAIN_NAME` | No | The chain name ("pecorino", or the corresponding name) |
95+
| `HOST_RPC_URL` | Yes | RPC endpoint for the host chain |
96+
| `ROLLUP_RPC_URL` | Yes | RPC endpoint for the rollup chain |
97+
| `QUINCEY_URL` | Yes | Remote sequencer signing endpoint |
98+
| `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 |
99+
| `TX_POOL_URL` | Yes | Transaction pool URL |
100+
| `FLASHBOTS_ENDPOINT` | No | Flashbots API to submit blocks to |
101+
| `ROLLUP_BLOCK_GAS_LIMIT` | No | Override for rollup block gas limit |
102+
| `MAX_HOST_GAS_COEFFICIENT` | No | Optional maximum host gas coefficient, as a percentage, to use when building blocks |
103+
| `BUILDER_KEY` | Yes | AWS KMS key ID _or_ local private key for builder signing |
104+
| `BLOCK_QUERY_CUTOFF_BUFFER` | Yes | Number of milliseconds before the end of the slot to stop querying for new transactions and start the block signing and submission process |
105+
| `AWS_ACCESS_KEY_ID` | No | AWS secret access key ID (required if not using `BUILDER_KEY`) |
106+
| `AWS_SECRET_ACCESS_KEY` | No | AWS secret access key (required if not using `BUILDER_KEY`) |
107+
| `AWS_DEFAULT_REGION` | No | AWS region for the KMS key in question (required if not using `BUILDER_KEY`) |
108+
| `BUILDER_PORT` | Yes | HTTP port for the Builder (default: `8080`) |
109+
| `BUILDER_REWARDS_ADDRESS` | Yes | Address receiving builder rewards |
110+
| `CONCURRENCY_LIMIT` | No | Optional max number of concurrent tasks the simulator uses. Defaults to a system call to determine optimal parallelism |
111+
| `OAUTH_CLIENT_ID` | Yes | OAuth client ID for the builder |
112+
| `OAUTH_CLIENT_SECRET` | Yes | OAuth client secret for the builder |
113+
| `OAUTH_AUTHENTICATE_URL` | Yes | OAuth authenticate URL for the builder for performing OAuth logins |
114+
| `OAUTH_TOKEN_URL` | Yes | OAuth token URL for the builder to get an OAuth2 access token |
115+
| `AUTH_TOKEN_REFRESH_INTERVAL` | Yes | The OAuth token refresh interval in seconds |
113116

114117
--------------------------------------------------------------------------------
115118

0 commit comments

Comments
 (0)