Merge branch 'main' into unified-binary

Author: jclapis

.gitignore

@@ -16,3 +16,11 @@ targets.json
 .idea/
 logs
 .vscode/
+
+# Nix
+.direnv/
+.devenv/
+devenv.*
+devenv.lock
+.devenv.flake.nix
+.envrc

Cargo.lock

@@ -51,6 +51,7 @@ lazy_static = "1.5.0"
 lh_eth2 = { package = "eth2", git = "https://github.com/sigp/lighthouse", tag = "v8.0.0-rc.0" }
 lh_eth2_keystore = { package = "eth2_keystore", git = "https://github.com/sigp/lighthouse", tag = "v8.0.0-rc.0" }
 lh_types = { package = "types", git = "https://github.com/sigp/lighthouse", tag = "v8.0.0-rc.0" }
+notify = "8.2.0"
 parking_lot = "0.12.3"
 pbkdf2 = "0.12.2"
 prometheus = "0.14.0"

Cargo.toml

@@ -67,10 +67,10 @@ async fn main() -> Result<()> {
 /// Run the PBS service
 async fn run_pbs_service() -> Result<()> {
     let _guard = initialize_tracing_log(PBS_SERVICE_NAME, LogsSettings::from_env_config()?);
-    let pbs_config = load_pbs_config().await?;
+    let (pbs_config, config_path) = load_pbs_config(None).await?;
 
     PbsService::init_metrics(pbs_config.chain)?;
-    let state = PbsState::new(pbs_config);
+    let state = PbsState::new(pbs_config, config_path);
     let server = PbsService::run::<_, DefaultBuilderApi>(state);
 
     tokio::select! {
@@ -112,3 +112,19 @@ async fn run_init(config_path: PathBuf, output_path: PathBuf) -> Result<()> {
     print_logo();
     handle_docker_init(config_path, output_path).await
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn version_has_v_prefix() {
+        assert!(VERSION.starts_with('v'), "VERSION should start with 'v', got: {VERSION}");
+    }
+
+    #[test]
+    fn parse_init_subcommand() {
+        Cli::try_parse_from(["commit-boost", "init", "--config", "/tmp/config.toml"])
+            .expect("should parse init subcommand");
+    }
+}

bin/commit-boost.rs

@@ -55,9 +55,13 @@ extra_validation_enabled = false
 # Execution Layer RPC url to use for extra validation
 # OPTIONAL
 # rpc_url = "https://ethereum-holesky-rpc.publicnode.com"
-# URL of the SSV API server to use, if you have a mux that targets an SSV node operator
-# OPTIONAL, DEFAULT: "https://api.ssv.network/api/v4"
-# ssv_api_url = "https://api.ssv.network/api/v4"
+# URL of your local SSV node API endpoint, if you have a mux that targets an SSV node operator
+# OPTIONAL, DEFAULT: "http://localhost:16000/v1/"
+# ssv_node_api_url = "http://localhost:16000/v1/"
+# URL of the public SSV API server, if you have a mux that targets an SSV node operator. This is used as
+# a fallback if the user's own SSV node is not reachable.
+# OPTIONAL, DEFAULT: "https://api.ssv.network/api/v4/"
+# ssv_public_api_url = "https://api.ssv.network/api/v4/"
 # Timeout for any HTTP requests sent from the PBS module to other services, in seconds
 # OPTIONAL, DEFAULT: 10
 http_timeout_seconds = 10

config.example.toml

@@ -30,6 +30,7 @@ lazy_static.workspace = true
 lh_eth2.workspace = true
 lh_eth2_keystore.workspace = true
 lh_types.workspace = true
+notify.workspace = true
 pbkdf2.workspace = true
 rand.workspace = true
 rayon.workspace = true

crates/common/Cargo.toml

@@ -16,7 +16,7 @@ pub struct LogsSettings {
 
 impl LogsSettings {
     pub fn from_env_config() -> Result<Self> {
-        let mut config = CommitBoostConfig::from_env_path()?;
+        let (mut config, _) = CommitBoostConfig::from_env_path()?;
 
         // Override log dir path if env var is set
         if let Some(log_dir) = load_optional_env_var(LOGS_DIR_ENV) {

crates/common/src/config/log.rs

@@ -56,14 +56,14 @@ impl CommitBoostConfig {
     }
 
     pub fn from_file(path: &PathBuf) -> Result<Self> {
-        let config: Self = load_from_file(path)?;
+        let (config, _): (Self, _) = load_from_file(path)?;
         Ok(config)
     }
 
     // When loading the config from the environment, it's important that every path
     // is replaced with the correct value if the config is loaded inside a container
-    pub fn from_env_path() -> Result<Self> {
-        let helper_config: HelperConfig = load_file_from_env(CONFIG_ENV)?;
+    pub fn from_env_path() -> Result<(Self, PathBuf)> {
+        let (helper_config, config_path): (HelperConfig, PathBuf) = load_file_from_env(CONFIG_ENV)?;
 
         let chain = match helper_config.chain {
             ChainLoader::Path { path, genesis_time_secs } => {
@@ -109,13 +109,13 @@ impl CommitBoostConfig {
             logs: helper_config.logs,
         };
 
-        Ok(config)
+        Ok((config, config_path))
     }
 
     /// Returns the path to the chain spec file if any
     pub fn chain_spec_file(path: &PathBuf) -> Option<PathBuf> {
         match load_from_file::<_, ChainConfig>(path) {
-            Ok(config) => {
+            Ok((config, _)) => {
                 if let ChainLoader::Path { path, genesis_time_secs: _ } = config.chain {
                     Some(path)
                 } else {

crates/common/src/config/mod.rs

@@ -82,7 +82,7 @@ pub fn load_commit_module_config<T: DeserializeOwned>() -> Result<StartCommitMod
     }
 
     // load module config including the extra data (if any)
-    let cb_config: StubConfig<T> = load_file_from_env(CONFIG_ENV)?;
+    let (cb_config, _): (StubConfig<T>, _) = load_file_from_env(CONFIG_ENV)?;
 
     // find all matching modules config
     let matches: Vec<ThisModuleConfig<T>> = cb_config
@@ -148,7 +148,7 @@ pub fn load_builder_module_config<T: DeserializeOwned>() -> eyre::Result<StartBu
     }
 
     // load module config including the extra data (if any)
-    let cb_config: StubConfig<T> = load_file_from_env(CONFIG_ENV)?;
+    let (cb_config, _): (StubConfig<T>, _) = load_file_from_env(CONFIG_ENV)?;
 
     // find all matching modules config
     let matches: Vec<ThisModuleConfig<T>> = cb_config