fixup!: check default dir if no config file in args

Author: Anyitechs

README.md

@@ -65,7 +65,7 @@ export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
 cargo run --bin ldk-server
 ```
 
-- Using CLI arguments (all optional):
+Interact with the node using CLI:
 ```
 ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
 ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.

ldk-server/src/main.rs

@@ -18,6 +18,7 @@ use std::path::{Path, PathBuf};
 use std::sync::Arc;
 use std::time::{SystemTime, UNIX_EPOCH};
 
+use clap::Parser;
 use hex::DisplayHex;
 use hyper::server::conn::http1;
 use hyper_util::rt::TokioIo;
@@ -36,8 +37,6 @@ use tokio::net::TcpListener;
 use tokio::select;
 use tokio::signal::unix::SignalKind;
 
-use clap::Parser;
-
 use crate::io::events::event_publisher::EventPublisher;
 use crate::io::events::get_event_name;
 #[cfg(feature = "events-rabbitmq")]
@@ -55,10 +54,9 @@ use crate::util::logger::ServerLogger;
 use crate::util::proto_adapter::{forwarded_payment_to_proto, payment_to_proto};
 use crate::util::tls::get_or_generate_tls_config;
 
-const DEFAULT_CONFIG_FILE: &str = "config.toml";
 const API_KEY_FILE: &str = "api_key";
 
-fn get_default_data_dir() -> Option<PathBuf> {
+pub fn get_default_data_dir() -> Option<PathBuf> {
 	#[cfg(target_os = "macos")]
 	{
 		#[allow(deprecated)] // todo can remove once we update MSRV to 1.87+
@@ -75,50 +73,14 @@ fn get_default_data_dir() -> Option<PathBuf> {
 	}
 }
 
-fn get_default_config_path() -> Option<PathBuf> {
-	get_default_data_dir().map(|data_dir| data_dir.join(DEFAULT_CONFIG_FILE))
-}
-
-const USAGE_GUIDE: &str = "Usage: ldk-server [config_path]
-
-If no config path is provided, ldk-server will look for a config file at:
-  Linux:   ~/.ldk-server/config.toml
-  macOS:   ~/Library/Application Support/ldk-server/config.toml
-  Windows: %APPDATA%\\ldk-server\\config.toml";
-
 fn main() {
-	let args: Vec<String> = std::env::args().collect();
-
-	let config_path: PathBuf = if args.len() < 2 {
-		match get_default_config_path() {
-			Some(path) => path,
-			None => {
-				eprintln!("Unable to determine home directory for default config path.");
-				eprintln!("{USAGE_GUIDE}");
-				std::process::exit(-1);
-			},
-		}
-	} else {
-		let arg = args[1].as_str();
-		if arg == "-h" || arg == "--help" {
-			println!("{USAGE_GUIDE}");
-			std::process::exit(0);
-		}
-		PathBuf::from(arg)
-	};
-
-	if fs::File::open(&config_path).is_err() {
-		eprintln!("Unable to access configuration file: {}", config_path.display());
-		std::process::exit(-1);
-	}
-
 	let args_config = ArgsConfig::parse();
 
 	let mut ldk_node_config = Config::default();
 	let config_file = match load_config(&args_config) {
 		Ok(config) => config,
 		Err(e) => {
-			eprintln!("Invalid configuration: {}", e);
+			eprintln!("Invalid configuration: {e}");
 			std::process::exit(-1);
 		},
 	};

ldk-server/src/util/config.rs

@@ -8,6 +8,7 @@
 // licenses.
 
 use std::net::SocketAddr;
+use std::path::PathBuf;
 use std::str::FromStr;
 use std::{fs, io};
 
@@ -19,6 +20,14 @@ use ldk_node::liquidity::LSPS2ServiceConfig;
 use log::LevelFilter;
 use serde::{Deserialize, Serialize};
 
+use crate::get_default_data_dir;
+
+const DEFAULT_CONFIG_FILE: &str = "config.toml";
+
+fn get_default_config_path() -> Option<PathBuf> {
+	get_default_data_dir().map(|data_dir| data_dir.join(DEFAULT_CONFIG_FILE))
+}
+
 /// Configuration for LDK Server.
 #[derive(Debug)]
 pub struct Config {
@@ -44,7 +53,7 @@ pub struct TlsConfig {
 	pub hosts: Vec<String>,
 }
 
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, Eq)]
 pub enum ChainSource {
 	Rpc { rpc_address: SocketAddr, rpc_user: String, rpc_password: String },
 	Electrum { server_url: String },
@@ -457,7 +466,12 @@ impl From<LSPS2ServiceTomlConfig> for LSPS2ServiceConfig {
 }
 
 #[derive(Parser, Debug)]
-#[command(version, about = "LDK Server Configuration", long_about = None)]
+#[command(
+	version,
+	about = "LDK Server Configuration",
+	long_about = None,
+	override_usage = "ldk-server [config_path]"
+)]
 pub struct ArgsConfig {
 	#[arg(required = false)]
 	config_file: Option<String>,
@@ -493,9 +507,15 @@ pub struct ArgsConfig {
 pub fn load_config(args: &ArgsConfig) -> io::Result<Config> {
 	let mut builder = ConfigBuilder::default();
 
-	if let Some(path) = &args.config_file {
-		let content = fs::read_to_string(path).map_err(|e| {
-			io::Error::new(e.kind(), format!("Failed to read config file '{}': {}", path, e))
+	let config_file = if let Some(path) = &args.config_file {
+		Some(PathBuf::from(path))
+	} else {
+		get_default_config_path().filter(|path| path.exists())
+	};
+
+	if let Some(path) = config_file {
+		let content = fs::read_to_string(&path).map_err(|e| {
+			io::Error::new(e.kind(), format!("Failed to read config file '{:?}': {}", path, e))
 		})?;
 		let toml_config: TomlConfig = toml::from_str(&content).map_err(|e| {
 			io::Error::new(
@@ -505,19 +525,6 @@ pub fn load_config(args: &ArgsConfig) -> io::Result<Config> {
 		})?;
 
 		builder.merge_toml(toml_config);
-	} else {
-		#[cfg(any(feature = "events-rabbitmq", feature = "experimental-lsps2-support"))]
-		return Err(io::Error::new(
-			io::ErrorKind::InvalidInput,
-			format!(
-				"To use the `{}` feature, you must provide a configuration file.",
-				if cfg!(feature = "events-rabbitmq") {
-					"events-rabbitmq"
-				} else {
-					"experimental-lsps2-support"
-				}
-			),
-		));
 	}
 
 	builder.merge_args(args);
@@ -537,12 +544,13 @@ fn missing_field_err(field: &str) -> io::Error {
 
 #[cfg(test)]
 mod tests {
+	use std::str::FromStr;
+
 	use ldk_node::bitcoin::Network;
 	use ldk_node::lightning::ln::msgs::SocketAddress;
 
 	use super::*;
 	use crate::util::config::{load_config, ArgsConfig};
-	use std::str::FromStr;
 	const DEFAULT_CONFIG: &str = r#"
 				[node]
 				network = "regtest"
@@ -1064,7 +1072,7 @@ mod tests {
 
 	#[test]
 	#[cfg(feature = "events-rabbitmq")]
-	fn test_error_if_rabbitmq_feature_without_config_file() {
+	fn test_error_if_rabbitmq_feature_without_valid_config_file() {
 		let args_config = ArgsConfig {
 			config_file: None,
 			node_network: None,
@@ -1081,15 +1089,11 @@ mod tests {
 		assert!(result.is_err());
 		let err = result.unwrap_err();
 		assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
-		assert_eq!(
-			err.to_string(),
-			"To use the `events-rabbitmq` feature, you must provide a configuration file."
-		);
 	}
 
 	#[test]
 	#[cfg(feature = "experimental-lsps2-support")]
-	fn test_error_if_lsps2_feature_without_config_file() {
+	fn test_error_if_lsps2_feature_without_valid_config_file() {
 		let args_config = ArgsConfig {
 			config_file: None,
 			node_network: None,
@@ -1106,6 +1110,5 @@ mod tests {
 		assert!(result.is_err());
 		let err = result.unwrap_err();
 		assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
-		assert_eq!(err.to_string(), "To use the `experimental-lsps2-support` feature, you must provide a configuration file.");
 	}
 }