Update setup instructions in README.md for custom network and Docker fix

.dockerignore

@@ -4,3 +4,4 @@
 audits/
 images/
 **/target/
+logs/

.env

@@ -0,0 +1,3 @@
+RELAY_KEY=
+METRICS_PORT=9500
+OUT_DIR=<protobuf_output_dir>

Cargo.toml

@@ -83,6 +83,7 @@ thiserror = "1.0.49"
 uuid = { version = "1.5", features = ["fast-rng", "v4"] }
 prometheus = "0.13.4"
 lazy_static = "1.5.0"
+dotenvy = "0.15.7"
 
 # Broadcasting
 fiber = { git = "https://github.com/chainbound/fiber-rs.git", tag = "v0.5.1" }

Dockerfile

@@ -54,7 +54,8 @@ RUN apt-get install -y ca-certificates
 
 WORKDIR /app
 
-COPY --from=helix /app/helix-cmd* ./
+# the binary requires config.yml for startup
+COPY --from=helix /app/helix-cmd* /app/config.yml ./
 
 # set the startup command to run your binary
-ENTRYPOINT ["/app/helix-cmd"]
+ENTRYPOINT ["/app/helix-cmd"]

README.md

@@ -86,7 +86,9 @@ The relay can be run locally for development, or configured for staging and prod
 $ docker build -t helix_mev_relayer -f local.Dockerfile .
 
 # Run the container
-$ docker run --name helix_mev_relayer helix_mev_relayer
+$ docker run -e RELAY_KEY=<your_relay_key> \
+  -e METRICS_PORT=<your_prometheus_server_port> \
+  --name helix_mev_relayer helix_mev_relayer
 ```
 
 #### Staging or Production-Ready setup
@@ -100,13 +102,26 @@ $ docker build \
   --build-arg REPO_NAME=<your_repo_name> \
   -t helix_mev_relayer .
 
-$ docker run --name helix_mev_relayer helix_mev_relayer
+$ docker run -e RELAY_KEY=<your_relay_key> \
+  -e METRICS_PORT=<your_prometheus_server_port> \
+  --name helix_mev_relayer helix_mev_relayer
 ```
 
 ### Configuration
 
 [config.yml](./config.yml) contains options for the relay.
 
+### Network configuration
+The relay can be run using testnets (e.g `Sepolia`, `Holesky`). For custom network setups, simply update the `config.network_config` field. 
+A custom setup would look like this:
+
+```yaml
+  network_config: !Custom
+  dir_path: custom_dir # path to the directory where chain data is stored
+  genesis_validator_root: '0x0000000000000000000000000000000000000000000000000000000000000000'
+  genesis_time: 1578009600 # the network's genesis time (Unix timestamp)
+```
+
 ### Databases
 The relay relies on postgres database for persistent storage. Ensure you point the `config.postgres` settings to a database with `timescaledb` extension installed and enabled.
 

crates/cmd/Cargo.toml

@@ -21,5 +21,6 @@ futures.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
 tracing-appender.workspace = true
+dotenvy.workspace = true
 
 num_cpus = "1.16.0"

crates/cmd/src/main.rs

@@ -86,6 +86,7 @@ async fn run() {
 }
 
 fn main() {
+    let _ = dotenvy::dotenv();
     let num_cpus = num_cpus::get();
     let worker_threads = num_cpus;
     let max_blocking_threads = num_cpus / 2;

local.Dockerfile

@@ -39,7 +39,8 @@ RUN apt-get install -y ca-certificates
 
 WORKDIR /app
 
-COPY --from=helix /app/helix-cmd* ./
+# the binary requires config.yml for startup
+COPY --from=helix /app/helix-cmd* /app/config.yml ./
 
 # set the startup command to run your binary
 ENTRYPOINT ["/app/helix-cmd"]