Skip to content

Commit

Permalink
chore(docs): update docker compose docs, fix entrypoint disable docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dancoombs committed Feb 25, 2025
1 parent a09df4a commit ad70158
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
8 changes: 4 additions & 4 deletions bin/rundler/src/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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(
Expand All @@ -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",
Expand All @@ -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(
Expand Down
6 changes: 3 additions & 3 deletions docs/architecture/entry_point.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
11 changes: 6 additions & 5 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 0 additions & 2 deletions test/spec-tests/local/.env
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit ad70158

Please sign in to comment.