Multi client (#344)

Co-authored-by: Diogo Santos <[email protected]>

Author: KaloyanTanev

.env.sample.holesky

@@ -4,53 +4,108 @@
 # Overrides network for all the relevant services.
 NETWORK=holesky
 
-# Enables builder api for lodestar VC and charon services.
+# Execution layer client to be used in a DV setup. Uncomment only the desired client.
+EL=el-nethermind
+
+# Consensus layer client to be used in a DV setup. Uncomment only the desired client.
+CL=cl-lighthouse
+#CL=cl-grandine
+
+# Validator client to be used in a DV setup. Uncomment only the desired client.
+VC=vc-lodestar
+#VC=vc-nimbus
+#VC=vc-prysm
+#VC=vc-teku
+
+# MEV client to be used in a DV setup. Uncomment only the desired client.
+MEV=mev-mevboost
+#MEV=mev-commitboost
+
+# Do not edit. These profiles and files dictate Docker which client types and from where to start for execution, consensus, validator and MEV.
+# The actual adjustable values are specified above
+COMPOSE_PROFILES=${EL},${CL},${VC},${MEV}
+COMPOSE_FILE=compose-el.yml:compose-cl.yml:compose-vc.yml:compose-mev.yml:docker-compose.yml
+
+# Enables Builder API.
 #BUILDER_API_ENABLED=
-#BUILDER_SELECTION=
 
-######### Nethermind Config #########
+######### Execution Layer Config #########
 
-# Nethermind docker container image version, e.g. `latest` or `1.25.3`.
+# EL host exposed IPs and ports.
+#EL_PORT_P2P=
+#EL_IP_HTTP=
+#EL_PORT_HTTP=
+#EL_IP_ENGINE=
+#EL_PORT_ENGINE=
+
+# Nethermind docker container image version.
 # See available tags https://hub.docker.com/r/nethermind/nethermind/tags
 #NETHERMIND_VERSION=
 
-# Nethermind host exposed ip and ports
-#NETHERMIND_PORT_P2P=
-#NETHERMIND_IP_HTTP=
-#NETHERMIND_PORT_HTTP=
-#NETHERMIND_IP_ENGINE=
-#NETHERMIND_PORT_ENGINE=
-
 # Nethermind ancient barrier allows you to specify how many old block bodies and receipts you want to store.
 #NETHERMIND_ANCIENT_BODIES_BARRIER=
 #NETHERMIND_ANCIENT_RECEIPTS_BARRIER=
 
-######### Lighthouse Config #########
+######### Consensus Layer Config #########
 
-# Lighthouse beacon node docker container image version, e.g. `latest` or `v4.6.0`.
+# CL beacon node host exposed ports.
+#CL_PORT_P2P=
+
+# Lighthouse becon node checkpoint sync URL used by consensus layer to fast sync.
+LIGHTHOUSE_CHECKPOINT_SYNC_URL=https://checkpoint-sync.holesky.ethpandaops.io/
+
+# Lighthouse beacon node docker container image version.
 # See available tags https://hub.docker.com/r/sigp/lighthouse/tags.
-#LIGHTHOUSE_VERSION=
+#CL_LIGHTHOUSE_VERSION=
 
-# Lighthouse beacon node host exposed ports
-#LIGHTHOUSE_PORT_P2P=
+# Grandine beacon node docker container image version.
+# See available tags https://hub.docker.com/r/sifrai/grandine/tags.
+#CL_GRANDINE_VERSION=
 
-# Checkpoint sync url used by lighthouse to fast sync.
-# See available options https://eth-clients.github.io/checkpoint-sync-endpoints/.
-# If the given url errors, try replacing it with an alternative url like https://sync-mainnet.beaconcha.in/.
-LIGHTHOUSE_CHECKPOINT_SYNC_URL=https://checkpoint-sync.holesky.ethpandaops.io/
+######### Validator Client Config #########
 
-######### Lodestar Config #########
+# Override prometheus metrics port for validator client.
+#VC_PORT_METRICS=
 
-# Lodestar validator client docker container image version, e.g. `latest` or `v1.20.1`.
+# Lodestar validator client docker container image version.
 # See available tags https://hub.docker.com/r/chainsafe/lodestar/tags
-#LODESTAR_VERSION=
+#VC_LODESTAR_VERSION=
+
+#VC_LODESTAR_BUILDER_SELECTION=
+
+# Nimbus validator client docker container image version.
+# See available tags https://hub.docker.com/r/statusim/nimbus-validator-client/tags
+#VC_NIMBUS_VERSION=
+
+# Prysm validator client docker container image version.
+# See available tags https://hub.docker.com/r/offchainlabs/prysm-validator/tags
+#VC_PRYSM_VERSION=
+
+# Teku validator client docker container image version.
+# See available tags https://hub.docker.com/r/consensys/teku/tags
+#VC_TEKU_VERSION=
+
+######### MEV Config #########
+
+# MEV timeouts.
+# N.B.: Commit-boost uses TOML configuration instead of env variables. Configure those at commit-boost/.
+#MEV_TIMEOUT_GETHEADER=
+#MEV_TIMEOUT_GETPAYLOAD=
+#MEV_TIMEOUT_REGVAL=
 
-# Override prometheus metrics port for lodestar validator client.
-#LODESTAR_PORT_METRICS=
+# Comma separated list of MEV relays. You can choose public relays from https://enchanted-direction-844.notion.site/6d369eb33f664487800b0dedfe32171e?v=d255247c822c409f99c498aeb6a4e51d.
+# N.B.: Commit-boost uses TOML configuration instead of env variables. Configure those at commit-boost/.
+MEV_RELAYS=https://0xab78bf8c781c58078c3beb5710c57940874dd96aef2835e7742c866b4c7c0406754376c2c8285a36c630346aa5c5f833@holesky.aestus.live,https://0xb1559beef7b5ba3127485bbbb090362d9f497ba64e177ee2c8e7db74746306efad687f2cf8574e38d70067d40ef136dc@relay-stag.ultrasound.money,https://0xaa58208899c6105603b74396734a6263cc7d947f444f396a90f7b7d3e65d102aec7e5e5291b27e08d02c50a050825c2f@holesky.titanrelay.xyz
+
+# MEV-Boost docker container image version.
+#MEV_MEVBOOST_VERSION=
+
+# Commit-Boost docker container image version.
+#MEV_COMMITBOOST_VERSION=
 
 ######### Charon Config #########
 
-# Charon docker container image version, e.g. `latest` or `v1.0.1`.
+# Charon docker container image version.
 # See available tags https://hub.docker.com/r/obolnetwork/charon/tags.
 #CHARON_VERSION=
 
@@ -60,15 +115,19 @@ LIGHTHOUSE_CHECKPOINT_SYNC_URL=https://checkpoint-sync.holesky.ethpandaops.io/
 # Connect to one or more external beacon nodes. Use a comma separated list excluding spaces.
 #CHARON_BEACON_NODE_ENDPOINTS=
 
-# Increase the duration charon will wait for requests to the beacon node
+# Supply optional HTTP headers during beacon node requests. These headers are sent to all primary and fallback endpoints, be sure to rely on trusted BNs only.
+#CHARON_BEACON_NODE_HEADERS=
+
+# Specify one or more fallback beacon node endpoints, which are called in the case that the primary beacon nodes are offline or unhealthy.
+# Use fallback beacon nodes sparingly, particularly if latency is high, which can impact DV cluster performance.
+#CHARON_FALLBACK_BEACON_NODE_ENDPOINTS=
+
+# Increase the duration charon will wait for requests to the beacon node.
 #CHARON_BEACON_NODE_TIMEOUT=
 
-# Increase the duration charon will wait while publishing data to the beacon node
+# Increase the duration charon will wait while publishing data to the beacon node.
 #CHARON_BEACON_NODE_SUBMIT_TIMEOUT=
 
-# A list of beacon nodes to use if the primary list are offline or unhealthy.
-#CHARON_FALLBACK_BEACON_NODE_ENDPOINTS=
-
 # The address of the execution engine JSON-RPC API. 
 #CHARON_EXECUTION_CLIENT_RPC_ENDPOINT=
 
@@ -84,44 +143,32 @@ LIGHTHOUSE_CHECKPOINT_SYNC_URL=https://checkpoint-sync.holesky.ethpandaops.io/
 # Loki log aggregation server addresses. Disable loki log aggregation by setting an empty address.
 #CHARON_LOKI_ADDRESSES=
 
-# Charon Cluster Name. Mandatory to send logs with Promtail
+# Charon Cluster Name. Mandatory to send logs with Promtail.
 #CLUSTER_NAME=
 
-# Charon Cluster Peer. Mandatory to send logs with Promtail
+# Charon Cluster Peer. Mandatory to send logs with Promtail.
 #CLUSTER_PEER=
 
-# Nickname to identify this charon node on monitoring (max 32 characters)
+# Nickname to identify this charon node on monitoring (max 32 characters).
 #CHARON_NICKNAME=
 
 # Docker network of running charon node. See `docker network ls`.
 #CHARON_DOCKER_NETWORK=
 
-# Charon host exposed ports
+# Charon host exposed ports.
 #CHARON_PORT_P2P_TCP=
 
-######### MEV-Boost Config #########
-
-# MEV-Boost docker container image version, e.g. `latest` or `1.7.0`.
-#MEVBOOST_VERSION=
-
-# MEV-Boost docker container image name, e.g. flashbots/mev-boost.
-#MEVBOOST_IMAGE=
-
-# Comma separated list of MEV-Boost relays.
-# You can choose public relays from https://enchanted-direction-844.notion.site/6d369eb33f664487800b0dedfe32171e?v=d255247c822c409f99c498aeb6a4e51d.
-#MEVBOOST_RELAYS=https://0xab78bf8c781c58078c3beb5710c57940874dd96aef2835e7742c866b4c7c0406754376c2c8285a36c630346aa5c5f833@holesky.aestus.live,https://0xb1559beef7b5ba3127485bbbb090362d9f497ba64e177ee2c8e7db74746306efad687f2cf8574e38d70067d40ef136dc@relay-stag.ultrasound.money,https://0xaa58208899c6105603b74396734a6263cc7d947f444f396a90f7b7d3e65d102aec7e5e5291b27e08d02c50a050825c2f@holesky.titanrelay.xyz
-
 ######### Monitoring Config #########
 
-# Grafana docker container image version, e.g. `latest` or `10.4.2`.
+# Grafana docker container image version.
 # See available tags https://github.com/grafana/grafana/releases.
 #GRAFANA_VERSION=
 
-# Grafana host exposed ip and port.
+# Grafana host exposed IP and port.
 #MONITORING_IP_GRAFANA=
 #MONITORING_PORT_GRAFANA=
 
-# Prometheus docker container image version, e.g. `latest` or `v2.50.1`.
+# Prometheus docker container image version.
 # See available tags https://github.com/prometheus/prometheus/releases.
 #PROMETHEUS_VERSION=
 
@@ -131,30 +178,37 @@ LIGHTHOUSE_CHECKPOINT_SYNC_URL=https://checkpoint-sync.holesky.ethpandaops.io/
 # Prometheus service owner used to uniquely identify user from which metrics are pushed.
 #SERVICE_OWNER=charon_user
 
+# Uncomment these if you have log exporting with Promtail
+# and want to disable log export on a particular container.
+#EL_NETHERMIND_PROMTAIL_MONITORED=false
+#CL_LIGHTHOUSE_PROMTAIL_MONITORED=false
+#CL_GRANDINE_PROMTAIL_MONITORED=false
+#CHARON_PROMTAIL_MONITORED=false
+#VC_LODESTAR_PROMTAIL_MONITORED=false
+#VC_NIMBUS_PROMTAIL_MONITORED=false
+#VC_PRYSM_PROMTAIL_MONITORED=false
+#VC_TEKU_PROMTAIL_MONITORED=false
+#MEV_MEV_BOOST_PROMTAIL_MONITORED=false
+#MEV_COMMIT_BOOST_PROMTAIL_MONITORED=false
+#EJECTOR_PROMTAIL_MONITORED=false
+#DV_EXIT_PROMTAIL_MONITORED=false
+
 ######### Debug Config #########
 
 # This applies to compose-debug.yml only.
 
-# Prometheus Node exporter docker container image version, e.g. `latest` or `1.6.0`.
+# Prometheus Node exporter docker container image version.
 # See available tags https://hub.docker.com/r/bitnami/node-exporter/tags.
 #NODE_EXPORTER_VERSION=
 
-# Grafana Tempo docker container image version, e.g. `latest` or `2.7.1`.
+# Grafana Tempo docker container image version.
 # Use Grafana Explore to access Tempo data.
 # See available tags https://hub.docker.com/r/grafana/tempo/tags.
 #TEMPO_VERSION=
 
-# Grafana Loki docker container image version, e.g. `latest` or `2.8.2`.
+# Grafana Loki docker container image version.
 # See available tags https://hub.docker.com/r/grafana/loki/tags.
 #LOKI_VERSION=
 
-# Uncomment these if you have log exporting with Promtail
-# and want to disable log export on a particular container.
-
-# NETHERMIND_PROMTAIL_MONITORED=false
-# LIGHTHOUSE_PROMTAIL_MONITORED=false
-# CHARON_PROMTAIL_MONITORED=false
-# LODESTAR_PROMTAIL_MONITORED=false
-# MEV_BOOST_PROMTAIL_MONITORED=false
-# EJECTOR_PROMTAIL_MONITORED=false
-# DV_EXIT_PROMTAIL_MONITORED=false
+# Loki host exposed port.
+#MONITORING_PORT_LOKI=