From ad70158429233aeca3e94cf10b0d61ffbeb257e8 Mon Sep 17 00:00:00 2001 From: dancoombs Date: Tue, 25 Feb 2025 10:24:11 -0600 Subject: [PATCH] chore(docs): update docker compose docs, fix entrypoint disable docs --- bin/rundler/src/cli/mod.rs | 8 ++++---- docs/architecture/entry_point.md | 6 +++--- docs/docker.md | 11 ++++++----- test/spec-tests/local/.env | 2 -- 4 files changed, 13 insertions(+), 14 deletions(-) diff --git a/bin/rundler/src/cli/mod.rs b/bin/rundler/src/cli/mod.rs index 038bfaf24..c5ff2b63b 100644 --- a/bin/rundler/src/cli/mod.rs +++ b/bin/rundler/src/cli/mod.rs @@ -364,7 +364,7 @@ pub struct CommonArgs { )] pub disable_entry_point_v0_7: bool, - // Ignored if entry_point_v0_6_enabled is false + // Ignored if disable_entry_point_v0_6 is true // Ignored if entry_point_builders_path is set #[arg( long = "num_builders_v0_6", @@ -375,7 +375,7 @@ pub struct CommonArgs { )] pub num_builders_v0_6: u64, - // Ignored if entry_point_v0_6_enabled is false + // Ignored if disable_entry_point_v0_6 is true // Ignored if entry_point_builders_path is set // The index offset to apply to the builder index #[arg( @@ -387,7 +387,7 @@ pub struct CommonArgs { )] pub builder_index_offset_v0_6: u64, - // Ignored if entry_point_v0_7_enabled is false + // Ignored if disable_entry_point_v0_7 is true // Ignored if entry_point_builders_path is set #[arg( long = "num_builders_v0_7", @@ -398,7 +398,7 @@ pub struct CommonArgs { )] pub num_builders_v0_7: u64, - // Ignored if entry_point_v0_7_enabled is false + // Ignored if disable_entry_point_v0_7 is true // Ignored if entry_point_builders_path is set // The index offset to apply to the builder index #[arg( diff --git a/docs/architecture/entry_point.md b/docs/architecture/entry_point.md index c63e1aebe..1597a8910 100644 --- a/docs/architecture/entry_point.md +++ b/docs/architecture/entry_point.md @@ -9,9 +9,9 @@ Rundler currently supports the most recent two entry point versions: Rundler's entry point support is controlled by the following CLI options: -Enable/disable entry point versions (defaults to both enabled): -- `--entry_point_v0_6_enabled` -- `--entry_point_v0_7_enabled` +Disable entry point versions (defaults to both enabled): +- `--disable_entry_point_v0_6` +- `--disable_entry_point_v0_7` Modify the number of builders (and thus keys) associated with each entry point: - `--num_builders_v0_6` diff --git a/docs/docker.md b/docs/docker.md index 99f6349fc..ab995df34 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -10,11 +10,9 @@ docker buildx build . -t rundler ## Run -Simple full node docker-compose configuration: +Sample full node docker-compose configuration: ``` -version: "3.8" - services: rundler: image: rundler @@ -25,12 +23,15 @@ services: # Metrics port - "8080:8080" environment: - - ENTRY_POINTS=0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789 + - RUST_LOG=INFO + - NETWORK=[YOUR NETWORK HERE] - NODE_HTTP=[YOUR NODE HTTP HERE] - - CHAIN_ID=[YOUR CHAIN ID HERE] - BUILDER_PRIVATE_KEY=[YOUR PRIVATE KEY HERE] + - DISABLE_ENTRY_POINT_V0_6=true ``` +See [CLI docs](./cli.md) for more info on the environment variables. + An example docker-compose configuration running Rundler in its distributed mode can be found [here](../test/spec-tests/remote/docker-compose.yml). ## Cross-Platform Docker Builds with Docker and cross-rs diff --git a/test/spec-tests/local/.env b/test/spec-tests/local/.env index 87b5aa3f3..0f60713fb 100644 --- a/test/spec-tests/local/.env +++ b/test/spec-tests/local/.env @@ -8,6 +8,4 @@ MIN_UNSTAKE_DELAY=2 PRIORITY_FEE_MODE_KIND=base_fee_percent PRIORITY_FEE_MODE_VALUE=0 BUILDER_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 -ENTRY_POINT_V0_6_ENABLED=false -ENTRY_POINT_V0_7_ENABLED=false MAX_VERIFICATION_GAS=10000000