Allow configuring electrum/esplora sync configs

Author: benthecarman

ldk-server/src/main.rs

@@ -23,7 +23,7 @@ use hex::DisplayHex;
 use hyper::server::conn::http1;
 use hyper_util::rt::TokioIo;
 use ldk_node::bitcoin::Network;
-use ldk_node::config::Config;
+use ldk_node::config::{BackgroundSyncConfig, Config, ElectrumSyncConfig, EsploraSyncConfig};
 use ldk_node::entropy::NodeEntropy;
 use ldk_node::lightning::ln::channelmanager::PaymentId;
 use ldk_node::{Builder, Event, Node};
@@ -72,6 +72,24 @@ pub fn get_default_data_dir() -> Option<PathBuf> {
 	}
 }
 
+fn build_background_sync_config(
+	onchain_wallet_sync_interval_secs: Option<u64>,
+	lightning_wallet_sync_interval_secs: Option<u64>,
+) -> Option<BackgroundSyncConfig> {
+	if onchain_wallet_sync_interval_secs.is_none() && lightning_wallet_sync_interval_secs.is_none()
+	{
+		return None;
+	}
+	let mut bg = BackgroundSyncConfig::default();
+	if let Some(interval) = onchain_wallet_sync_interval_secs {
+		bg.onchain_wallet_sync_interval_secs = interval;
+	}
+	if let Some(interval) = lightning_wallet_sync_interval_secs {
+		bg.lightning_wallet_sync_interval_secs = interval;
+	}
+	Some(bg)
+}
+
 fn main() {
 	let args_config = ArgsConfig::parse();
 
@@ -155,11 +173,32 @@ fn main() {
 		ChainSource::Rpc { rpc_host, rpc_port, rpc_user, rpc_password } => {
 			builder.set_chain_source_bitcoind_rpc(rpc_host, rpc_port, rpc_user, rpc_password);
 		},
-		ChainSource::Electrum { server_url } => {
-			builder.set_chain_source_electrum(server_url, None);
+		ChainSource::Electrum {
+			server_url,
+			onchain_wallet_sync_interval_secs,
+			lightning_wallet_sync_interval_secs,
+		} => {
+			let sync_config = build_background_sync_config(
+				onchain_wallet_sync_interval_secs,
+				lightning_wallet_sync_interval_secs,
+			)
+			.map(|bg| ElectrumSyncConfig {
+				background_sync_config: Some(bg),
+				..Default::default()
+			});
+			builder.set_chain_source_electrum(server_url, sync_config);
 		},
-		ChainSource::Esplora { server_url } => {
-			builder.set_chain_source_esplora(server_url, None);
+		ChainSource::Esplora {
+			server_url,
+			onchain_wallet_sync_interval_secs,
+			lightning_wallet_sync_interval_secs,
+		} => {
+			let sync_config = build_background_sync_config(
+				onchain_wallet_sync_interval_secs,
+				lightning_wallet_sync_interval_secs,
+			)
+			.map(|bg| EsploraSyncConfig { background_sync_config: Some(bg), ..Default::default() });
+			builder.set_chain_source_esplora(server_url, sync_config);
 		},
 	}
 

ldk-server/src/util/config.rs

@@ -62,9 +62,22 @@ pub struct TlsConfig {
 
 #[derive(Debug, PartialEq, Eq)]
 pub enum ChainSource {
-	Rpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
-	Electrum { server_url: String },
-	Esplora { server_url: String },
+	Rpc {
+		rpc_host: String,
+		rpc_port: u16,
+		rpc_user: String,
+		rpc_password: String,
+	},
+	Electrum {
+		server_url: String,
+		onchain_wallet_sync_interval_secs: Option<u64>,
+		lightning_wallet_sync_interval_secs: Option<u64>,
+	},
+	Esplora {
+		server_url: String,
+		onchain_wallet_sync_interval_secs: Option<u64>,
+		lightning_wallet_sync_interval_secs: Option<u64>,
+	},
 }
 
 /// A builder for `Config`.
@@ -79,6 +92,8 @@ struct ConfigBuilder {
 	storage_dir_path: Option<String>,
 	electrum_url: Option<String>,
 	esplora_url: Option<String>,
+	onchain_wallet_sync_interval_secs: Option<u64>,
+	lightning_wallet_sync_interval_secs: Option<u64>,
 	bitcoind_rpc_address: Option<String>,
 	bitcoind_rpc_user: Option<String>,
 	bitcoind_rpc_password: Option<String>,
@@ -116,10 +131,22 @@ impl ConfigBuilder {
 
 		if let Some(electrum) = toml.electrum {
 			self.electrum_url = Some(electrum.server_url);
+			self.onchain_wallet_sync_interval_secs = electrum
+				.onchain_wallet_sync_interval_secs
+				.or(self.onchain_wallet_sync_interval_secs);
+			self.lightning_wallet_sync_interval_secs = electrum
+				.lightning_wallet_sync_interval_secs
+				.or(self.lightning_wallet_sync_interval_secs);
 		}
 
 		if let Some(esplora) = toml.esplora {
 			self.esplora_url = Some(esplora.server_url);
+			self.onchain_wallet_sync_interval_secs = esplora
+				.onchain_wallet_sync_interval_secs
+				.or(self.onchain_wallet_sync_interval_secs);
+			self.lightning_wallet_sync_interval_secs = esplora
+				.lightning_wallet_sync_interval_secs
+				.or(self.lightning_wallet_sync_interval_secs);
 		}
 
 		if let Some(log) = toml.log {
@@ -269,9 +296,17 @@ impl ConfigBuilder {
 
 			ChainSource::Rpc { rpc_host, rpc_port, rpc_user, rpc_password }
 		} else if let Some(url) = self.electrum_url {
-			ChainSource::Electrum { server_url: url }
+			ChainSource::Electrum {
+				server_url: url,
+				onchain_wallet_sync_interval_secs: self.onchain_wallet_sync_interval_secs,
+				lightning_wallet_sync_interval_secs: self.lightning_wallet_sync_interval_secs,
+			}
 		} else if let Some(url) = self.esplora_url {
-			ChainSource::Esplora { server_url: url }
+			ChainSource::Esplora {
+				server_url: url,
+				onchain_wallet_sync_interval_secs: self.onchain_wallet_sync_interval_secs,
+				lightning_wallet_sync_interval_secs: self.lightning_wallet_sync_interval_secs,
+			}
 		} else {
 			return Err(io::Error::new(io::ErrorKind::InvalidInput, "No valid Chain Source configured. Provide Bitcoind RPC, Electrum, or Esplora details."));
 		};
@@ -391,11 +426,15 @@ struct BitcoindConfig {
 #[derive(Deserialize, Serialize)]
 struct ElectrumConfig {
 	server_url: String,
+	onchain_wallet_sync_interval_secs: Option<u64>,
+	lightning_wallet_sync_interval_secs: Option<u64>,
 }
 
 #[derive(Deserialize, Serialize)]
 struct EsploraConfig {
 	server_url: String,
+	onchain_wallet_sync_interval_secs: Option<u64>,
+	lightning_wallet_sync_interval_secs: Option<u64>,
 }
 
 #[derive(Deserialize, Serialize)]
@@ -805,7 +844,7 @@ mod tests {
 		fs::write(storage_path.join(config_file_name), toml_config).unwrap();
 		let config = load_config(&args_config).unwrap();
 
-		let ChainSource::Electrum { server_url } = config.chain_source else {
+		let ChainSource::Electrum { server_url, .. } = config.chain_source else {
 			panic!("unexpected chain source");
 		};