chore: allow empty relays list in the config (#344)

Author: jclapis

crates/common/src/config/mod.rs

@@ -26,6 +26,7 @@ pub use utils::*;
 #[derive(Debug, Deserialize, Serialize)]
 pub struct CommitBoostConfig {
     pub chain: Chain,
+    #[serde(default)]
     pub relays: Vec<RelayConfig>,
     pub pbs: StaticPbsConfig,
     #[serde(flatten)]

crates/common/src/config/pbs.rs

@@ -229,6 +229,14 @@ pub async fn load_pbs_config() -> Result<PbsModuleConfig> {
     let config = CommitBoostConfig::from_env_path()?;
     config.validate().await?;
 
+    // Make sure relays isn't empty - since the config is still technically valid if
+    // there are no relays for things like Docker compose generation, this check
+    // isn't in validate().
+    ensure!(
+        !config.relays.is_empty(),
+        "At least one relay must be configured to run the PBS service"
+    );
+
     // use endpoint from env if set, otherwise use default host and port
     let endpoint = if let Some(endpoint) = load_optional_env_var(PBS_ENDPOINT_ENV) {
         endpoint.parse()?

tests/tests/config.rs

@@ -170,3 +170,15 @@ async fn test_validate_missing_rpc_url() -> Result<()> {
         .contains("rpc_url is required if extra_validation_enabled is true"));
     Ok(())
 }
+
+#[tokio::test]
+async fn test_validate_config_with_no_relays() -> Result<()> {
+    // Create a config with no relays
+    let mut config = load_happy_config().await?;
+    config.relays.clear();
+
+    // Make sure it validates correctly
+    let result = config.validate().await;
+    assert!(result.is_ok());
+    Ok(())
+}