Merge pull request #74 from getAlby/chore/remove-custom-enable-background-sync-config

chore: replace custom ENABLE_BACKGROUND_SYNC config option

Author: rolznz

src/chain/mod.rs

@@ -360,22 +360,28 @@ impl ChainSource {
 	) {
 		match self {
 			Self::Esplora { sync_config, logger, .. } => {
-				if let Some(background_sync_config) = sync_config.background_sync_config.as_ref() {
-					self.start_tx_based_sync_loop(
+				if let Some(_background_sync_config) = sync_config.background_sync_config.as_ref() {
+					// Alby: background sync is disabled - sanity check
+					/*self.start_tx_based_sync_loop(
 						stop_sync_receiver,
 						channel_manager,
 						chain_monitor,
 						output_sweeper,
 						background_sync_config,
 						Arc::clone(&logger),
 					)
-					.await
+					.await*/
+					log_error!(
+						logger,
+						"Alby LDK-node default background syncing should be disabled. This must not happen!",
+					);
 				} else {
 					// Background syncing is disabled
-					log_info!(
+					// Alby: expected background syncing to be disabled
+					/*log_info!(
 						logger,
 						"Background syncing is disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
-					);
+					);*/
 					return;
 				}
 			},

src/config.rs

@@ -30,9 +30,6 @@ const DEFAULT_FEE_RATE_CACHE_UPDATE_INTERVAL_SECS: u64 = 60 * 10;
 const DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER: u64 = 3;
 const DEFAULT_ANCHOR_PER_CHANNEL_RESERVE_SATS: u64 = 25_000;
 
-// Enable background syncing of fee rates, onchain and lightning wallet
-pub(crate) const ENABLE_BACKGROUND_SYNC: bool = false;
-
 /// The default log level.
 pub const DEFAULT_LOG_LEVEL: LogLevel = LogLevel::Debug;
 

src/lib.rs

@@ -128,8 +128,8 @@ pub use builder::NodeBuilder as Builder;
 
 use chain::ChainSource;
 use config::{
-	default_user_config, may_announce_channel, ChannelConfig, Config, ENABLE_BACKGROUND_SYNC,
-	NODE_ANN_BCAST_INTERVAL, PEER_RECONNECTION_INTERVAL, RGS_SYNC_INTERVAL,
+	default_user_config, may_announce_channel, ChannelConfig, Config, NODE_ANN_BCAST_INTERVAL,
+	PEER_RECONNECTION_INTERVAL, RGS_SYNC_INTERVAL,
 };
 use connection::ConnectionManager;
 use event::{EventHandler, EventQueue};
@@ -255,25 +255,17 @@ impl Node {
 			runtime_ref.block_on(async move { chain_source.update_fee_rate_estimates().await })
 		})?;
 
-		// Alby: disable default background sync
-		if ENABLE_BACKGROUND_SYNC {
-			// Spawn background task continuously syncing onchain, lightning, and fee rate cache.
-			let stop_sync_receiver = self.stop_sender.subscribe();
-			let chain_source = Arc::clone(&self.chain_source);
-			let sync_cman = Arc::clone(&self.channel_manager);
-			let sync_cmon = Arc::clone(&self.chain_monitor);
-			let sync_sweeper = Arc::clone(&self.output_sweeper);
-			runtime.spawn(async move {
-				chain_source
-					.continuously_sync_wallets(
-						stop_sync_receiver,
-						sync_cman,
-						sync_cmon,
-						sync_sweeper,
-					)
-					.await;
-			});
-		}
+		// Spawn background task continuously syncing onchain, lightning, and fee rate cache.
+		let stop_sync_receiver = self.stop_sender.subscribe();
+		let chain_source = Arc::clone(&self.chain_source);
+		let sync_cman = Arc::clone(&self.channel_manager);
+		let sync_cmon = Arc::clone(&self.chain_monitor);
+		let sync_sweeper = Arc::clone(&self.output_sweeper);
+		runtime.spawn(async move {
+			chain_source
+				.continuously_sync_wallets(stop_sync_receiver, sync_cman, sync_cmon, sync_sweeper)
+				.await;
+		});
 
 		if self.gossip_source.is_rgs() {
 			let gossip_source = Arc::clone(&self.gossip_source);