Skip to content

Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tnull merged 1 commit into from
Mar 28, 2025
Merged

Allow disabling wallet background syncing #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
u64 onchain_wallet_sync_interval_secs;
u64 lightning_wallet_sync_interval_secs;
u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
string? require_token;
boolean advertise_service;
Expand Down
107 changes: 59 additions & 48 deletions src/chain/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
) {
match self {
Self::Esplora { sync_config, logger, .. } => {
// Setup syncing intervals
let onchain_wallet_sync_interval_secs = sync_config
.onchain_wallet_sync_interval_secs
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
let mut onchain_wallet_sync_interval =
tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
onchain_wallet_sync_interval
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

let fee_rate_cache_update_interval_secs = sync_config
.fee_rate_cache_update_interval_secs
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
let mut fee_rate_update_interval =
tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
// When starting up, we just blocked on updating, so skip the first tick.
fee_rate_update_interval.reset();
fee_rate_update_interval
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

let lightning_wallet_sync_interval_secs = sync_config
.lightning_wallet_sync_interval_secs
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
let mut lightning_wallet_sync_interval =
tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
lightning_wallet_sync_interval
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
// Setup syncing intervals if enabled
if let Some(background_sync_config) = sync_config.background_sync_config {
let onchain_wallet_sync_interval_secs = background_sync_config
.onchain_wallet_sync_interval_secs
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
let mut onchain_wallet_sync_interval = tokio::time::interval(
Duration::from_secs(onchain_wallet_sync_interval_secs),
);
onchain_wallet_sync_interval
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

let fee_rate_cache_update_interval_secs = background_sync_config
.fee_rate_cache_update_interval_secs
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
fee_rate_cache_update_interval_secs,
));
// When starting up, we just blocked on updating, so skip the first tick.
fee_rate_update_interval.reset();
fee_rate_update_interval
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

let lightning_wallet_sync_interval_secs = background_sync_config
.lightning_wallet_sync_interval_secs
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
let mut lightning_wallet_sync_interval = tokio::time::interval(
Duration::from_secs(lightning_wallet_sync_interval_secs),
);
lightning_wallet_sync_interval
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

// Start the syncing loop.
loop {
tokio::select! {
_ = stop_sync_receiver.changed() => {
log_trace!(
logger,
"Stopping background syncing on-chain wallet.",
);
return;
}
_ = onchain_wallet_sync_interval.tick() => {
let _ = self.sync_onchain_wallet().await;
}
_ = fee_rate_update_interval.tick() => {
let _ = self.update_fee_rate_estimates().await;
}
_ = lightning_wallet_sync_interval.tick() => {
let _ = self.sync_lightning_wallet(
Arc::clone(&channel_manager),
Arc::clone(&chain_monitor),
Arc::clone(&output_sweeper),
).await;
// Start the syncing loop.
loop {
tokio::select! {
_ = stop_sync_receiver.changed() => {
log_trace!(
logger,
"Stopping background syncing on-chain wallet.",
);
return;
}
_ = onchain_wallet_sync_interval.tick() => {
let _ = self.sync_onchain_wallet().await;
}
_ = fee_rate_update_interval.tick() => {
let _ = self.update_fee_rate_estimates().await;
}
_ = lightning_wallet_sync_interval.tick() => {
let _ = self.sync_lightning_wallet(
Arc::clone(&channel_manager),
Arc::clone(&chain_monitor),
Arc::clone(&output_sweeper),
).await;
}
}
}
} else {
// Background syncing is disabled
log_info!(
logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
);
return;
}
},
Self::BitcoindRpc {
Expand Down
35 changes: 29 additions & 6 deletions src/config.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.
///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
/// The time in-between background sync attempts of the onchain wallet, in seconds.
///
/// **Note:** A minimum of 10 seconds is always enforced.
/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
pub onchain_wallet_sync_interval_secs: u64,

/// The time in-between background sync attempts of the LDK wallet, in seconds.
///
/// **Note:** A minimum of 10 seconds is always enforced.
/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
pub lightning_wallet_sync_interval_secs: u64,

/// The time in-between background update attempts to our fee rate cache, in seconds.
///
/// **Note:** A minimum of 10 seconds is always enforced.
/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
fn default() -> Self {
Self {
onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
/// Background sync configuration.
///
/// If set to `None`, background syncing will be disabled. Users will need to manually
/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
///
/// [`Node::sync_wallets`]: crate::Node::sync_wallets
pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.
fn default() -> Self {
Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down
13 changes: 6 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
/// cache.
///
/// **Note:** The wallets are regularly synced in the background, which is configurable via the
/// respective config object, e.g., via
/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
/// sync method is almost always redundant and should be avoided where possible.
/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
/// is almost always redundant when background syncing is enabled and should be avoided where possible.
/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
/// this method must be called manually to keep wallets in sync with the chain state.
///
/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
pub fn sync_wallets(&self) -> Result<(), Error> {
let rt_lock = self.runtime.read().unwrap();
if rt_lock.is_none() {
Expand Down
3 changes: 2 additions & 1 deletion src/uniffi_types.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down
4 changes: 1 addition & 3 deletions tests/common/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
match chain_source {
TestChainSource::Esplora(electrsd) => {
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
let mut sync_config = EsploraSyncConfig::default();
sync_config.onchain_wallet_sync_interval_secs = 100000;
sync_config.lightning_wallet_sync_interval_secs = 100000;
let sync_config = EsploraSyncConfig { background_sync_config: None };
builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
},
TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down
12 changes: 3 additions & 9 deletions tests/integration_tests_rust.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
let mut nodes = Vec::new();
for _ in 0..5 {
let config = random_config(true);
let mut sync_config = EsploraSyncConfig::default();
sync_config.onchain_wallet_sync_interval_secs = 100000;
sync_config.lightning_wallet_sync_interval_secs = 100000;
let sync_config = EsploraSyncConfig { background_sync_config: None };
setup_builder!(builder, config.node_config);
builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
let test_sync_store: Arc<dyn KVStore + Sync + Send> =
Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

let mut sync_config = EsploraSyncConfig::default();
sync_config.onchain_wallet_sync_interval_secs = 100000;
sync_config.lightning_wallet_sync_interval_secs = 100000;
let sync_config = EsploraSyncConfig { background_sync_config: None };
setup_builder!(builder, config.node_config);
builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

let mut sync_config = EsploraSyncConfig::default();
sync_config.onchain_wallet_sync_interval_secs = 100000;
sync_config.lightning_wallet_sync_interval_secs = 100000;
let sync_config = EsploraSyncConfig { background_sync_config: None };

// Setup three nodes: service, client, and payer
let channel_opening_fee_ppm = 10_000;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Allow disabling wallet background syncing by alexanderwiederin · Pull Request #508 · lightningdevkit/ldk-node · GitHub
Skip to content
Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Mar 28, 2025
 Merged


Allow disabling wallet background syncing
#508
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 5 additions & 1 deletion
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
	u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
	u64 onchain_wallet_sync_interval_secs;
	u64 lightning_wallet_sync_interval_secs;
	u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
	BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
	string? require_token;
	boolean advertise_service;
Expand Down

107 changes: 59 additions & 48 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
	) {
 match self {
 Self::Esplora { sync_config, logger, .. } => {
 // Setup syncing intervals
 let onchain_wallet_sync_interval_secs = sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval =
 tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
 // Setup syncing intervals if enabled
 if let Some(background_sync_config) = sync_config.background_sync_config {
 let onchain_wallet_sync_interval_secs = background_sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(onchain_wallet_sync_interval_secs),
 );
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = background_sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
 fee_rate_cache_update_interval_secs,
 ));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = background_sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(lightning_wallet_sync_interval_secs),
 );
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 }
 }
 }
 } else {
 // Background syncing is disabled
 log_info!(
 logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
 );
 return;
 }
 },
 Self::BitcoindRpc {
Expand Down

35 changes: 29 additions & 6 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
	user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.

///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
	/// The time in-between background sync attempts of the onchain wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub onchain_wallet_sync_interval_secs: u64,

	/// The time in-between background sync attempts of the LDK wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub lightning_wallet_sync_interval_secs: u64,

	/// The time in-between background update attempts to our fee rate cache, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
	fn default() -> Self {
 Self {
 onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
	}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
	/// Background sync configuration.
	///
	/// If set to `None`, background syncing will be disabled. Users will need to manually
	/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
	///
	/// [`Node::sync_wallets`]: crate::Node::sync_wallets
	pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.

	fn default() -> Self {
 Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
	}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down

13 changes: 6 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
	/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
	/// cache.
	///
	/// **Note:** The wallets are regularly synced in the background, which is configurable via the
	/// respective config object, e.g., via
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
	/// sync method is almost always redundant and should be avoided where possible.
	/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
	/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
	/// is almost always redundant when background syncing is enabled and should be avoided where possible.
	/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
	/// this method must be called manually to keep wallets in sync with the chain state.
	///
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
	pub fn sync_wallets(&self) -> Result<(), Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand Down

3 changes: 2 additions & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
	default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
	MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down

4 changes: 1 addition & 3 deletions
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
	match chain_source {
 TestChainSource::Esplora(electrsd) => {
 let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 },
 TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down

12 changes: 3 additions & 9 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
	let mut nodes = Vec::new();
	for _ in 0..5 {
 let config = random_config(true);
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 setup_builder!(builder, config.node_config);
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
	let test_sync_store: Arc<dyn KVStore + Sync + Send> =
 Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };
	setup_builder!(builder, config.node_config);
	builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

	let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };

	// Setup three nodes: service, client, and payer
	let channel_opening_fee_ppm = 10_000;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Allow disabling wallet background syncing by alexanderwiederin · Pull Request #508 · lightningdevkit/ldk-node · GitHub
Skip to content
Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Mar 28, 2025
 Merged


Allow disabling wallet background syncing
#508
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 5 additions & 1 deletion
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
	u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
	u64 onchain_wallet_sync_interval_secs;
	u64 lightning_wallet_sync_interval_secs;
	u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
	BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
	string? require_token;
	boolean advertise_service;
Expand Down

107 changes: 59 additions & 48 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
	) {
 match self {
 Self::Esplora { sync_config, logger, .. } => {
 // Setup syncing intervals
 let onchain_wallet_sync_interval_secs = sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval =
 tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
 // Setup syncing intervals if enabled
 if let Some(background_sync_config) = sync_config.background_sync_config {
 let onchain_wallet_sync_interval_secs = background_sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(onchain_wallet_sync_interval_secs),
 );
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = background_sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
 fee_rate_cache_update_interval_secs,
 ));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = background_sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(lightning_wallet_sync_interval_secs),
 );
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 }
 }
 }
 } else {
 // Background syncing is disabled
 log_info!(
 logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
 );
 return;
 }
 },
 Self::BitcoindRpc {
Expand Down

35 changes: 29 additions & 6 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
	user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.

///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
	/// The time in-between background sync attempts of the onchain wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub onchain_wallet_sync_interval_secs: u64,

	/// The time in-between background sync attempts of the LDK wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub lightning_wallet_sync_interval_secs: u64,

	/// The time in-between background update attempts to our fee rate cache, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
	fn default() -> Self {
 Self {
 onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
	}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
	/// Background sync configuration.
	///
	/// If set to `None`, background syncing will be disabled. Users will need to manually
	/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
	///
	/// [`Node::sync_wallets`]: crate::Node::sync_wallets
	pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.

	fn default() -> Self {
 Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
	}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down

13 changes: 6 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
	/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
	/// cache.
	///
	/// **Note:** The wallets are regularly synced in the background, which is configurable via the
	/// respective config object, e.g., via
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
	/// sync method is almost always redundant and should be avoided where possible.
	/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
	/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
	/// is almost always redundant when background syncing is enabled and should be avoided where possible.
	/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
	/// this method must be called manually to keep wallets in sync with the chain state.
	///
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
	pub fn sync_wallets(&self) -> Result<(), Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand Down

3 changes: 2 additions & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
	default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
	MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down

4 changes: 1 addition & 3 deletions
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
	match chain_source {
 TestChainSource::Esplora(electrsd) => {
 let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 },
 TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down

12 changes: 3 additions & 9 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
	let mut nodes = Vec::new();
	for _ in 0..5 {
 let config = random_config(true);
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 setup_builder!(builder, config.node_config);
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
	let test_sync_store: Arc<dyn KVStore + Sync + Send> =
 Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };
	setup_builder!(builder, config.node_config);
	builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

	let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };

	// Setup three nodes: service, client, and payer
	let channel_opening_fee_ppm = 10_000;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Allow disabling wallet background syncing by alexanderwiederin · Pull Request #508 · lightningdevkit/ldk-node · GitHub
Skip to content
Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Mar 28, 2025
 Merged


Allow disabling wallet background syncing
#508
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 5 additions & 1 deletion
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
	u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
	u64 onchain_wallet_sync_interval_secs;
	u64 lightning_wallet_sync_interval_secs;
	u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
	BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
	string? require_token;
	boolean advertise_service;
Expand Down

107 changes: 59 additions & 48 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
	) {
 match self {
 Self::Esplora { sync_config, logger, .. } => {
 // Setup syncing intervals
 let onchain_wallet_sync_interval_secs = sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval =
 tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
 // Setup syncing intervals if enabled
 if let Some(background_sync_config) = sync_config.background_sync_config {
 let onchain_wallet_sync_interval_secs = background_sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(onchain_wallet_sync_interval_secs),
 );
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = background_sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
 fee_rate_cache_update_interval_secs,
 ));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = background_sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(lightning_wallet_sync_interval_secs),
 );
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 }
 }
 }
 } else {
 // Background syncing is disabled
 log_info!(
 logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
 );
 return;
 }
 },
 Self::BitcoindRpc {
Expand Down

35 changes: 29 additions & 6 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
	user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.

///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
	/// The time in-between background sync attempts of the onchain wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub onchain_wallet_sync_interval_secs: u64,

	/// The time in-between background sync attempts of the LDK wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub lightning_wallet_sync_interval_secs: u64,

	/// The time in-between background update attempts to our fee rate cache, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
	fn default() -> Self {
 Self {
 onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
	}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
	/// Background sync configuration.
	///
	/// If set to `None`, background syncing will be disabled. Users will need to manually
	/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
	///
	/// [`Node::sync_wallets`]: crate::Node::sync_wallets
	pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.

	fn default() -> Self {
 Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
	}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down

13 changes: 6 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
	/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
	/// cache.
	///
	/// **Note:** The wallets are regularly synced in the background, which is configurable via the
	/// respective config object, e.g., via
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
	/// sync method is almost always redundant and should be avoided where possible.
	/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
	/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
	/// is almost always redundant when background syncing is enabled and should be avoided where possible.
	/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
	/// this method must be called manually to keep wallets in sync with the chain state.
	///
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
	pub fn sync_wallets(&self) -> Result<(), Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand Down

3 changes: 2 additions & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
	default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
	MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down

4 changes: 1 addition & 3 deletions
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
	match chain_source {
 TestChainSource::Esplora(electrsd) => {
 let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 },
 TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down

12 changes: 3 additions & 9 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
	let mut nodes = Vec::new();
	for _ in 0..5 {
 let config = random_config(true);
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 setup_builder!(builder, config.node_config);
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
	let test_sync_store: Arc<dyn KVStore + Sync + Send> =
 Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };
	setup_builder!(builder, config.node_config);
	builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

	let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };

	// Setup three nodes: service, client, and payer
	let channel_opening_fee_ppm = 10_000;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Allow disabling wallet background syncing by alexanderwiederin · Pull Request #508 · lightningdevkit/ldk-node · GitHub
Skip to content
Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Mar 28, 2025
 Merged


Allow disabling wallet background syncing
#508
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 5 additions & 1 deletion
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
	u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
	u64 onchain_wallet_sync_interval_secs;
	u64 lightning_wallet_sync_interval_secs;
	u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
	BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
	string? require_token;
	boolean advertise_service;
Expand Down

107 changes: 59 additions & 48 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
	) {
 match self {
 Self::Esplora { sync_config, logger, .. } => {
 // Setup syncing intervals
 let onchain_wallet_sync_interval_secs = sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval =
 tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
 // Setup syncing intervals if enabled
 if let Some(background_sync_config) = sync_config.background_sync_config {
 let onchain_wallet_sync_interval_secs = background_sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(onchain_wallet_sync_interval_secs),
 );
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = background_sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
 fee_rate_cache_update_interval_secs,
 ));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = background_sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(lightning_wallet_sync_interval_secs),
 );
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 }
 }
 }
 } else {
 // Background syncing is disabled
 log_info!(
 logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
 );
 return;
 }
 },
 Self::BitcoindRpc {
Expand Down

35 changes: 29 additions & 6 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
	user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.

///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
	/// The time in-between background sync attempts of the onchain wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub onchain_wallet_sync_interval_secs: u64,

	/// The time in-between background sync attempts of the LDK wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub lightning_wallet_sync_interval_secs: u64,

	/// The time in-between background update attempts to our fee rate cache, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
	fn default() -> Self {
 Self {
 onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
	}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
	/// Background sync configuration.
	///
	/// If set to `None`, background syncing will be disabled. Users will need to manually
	/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
	///
	/// [`Node::sync_wallets`]: crate::Node::sync_wallets
	pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.

	fn default() -> Self {
 Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
	}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down

13 changes: 6 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
	/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
	/// cache.
	///
	/// **Note:** The wallets are regularly synced in the background, which is configurable via the
	/// respective config object, e.g., via
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
	/// sync method is almost always redundant and should be avoided where possible.
	/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
	/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
	/// is almost always redundant when background syncing is enabled and should be avoided where possible.
	/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
	/// this method must be called manually to keep wallets in sync with the chain state.
	///
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
	pub fn sync_wallets(&self) -> Result<(), Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand Down

3 changes: 2 additions & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
	default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
	MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down

4 changes: 1 addition & 3 deletions
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
	match chain_source {
 TestChainSource::Esplora(electrsd) => {
 let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 },
 TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down

12 changes: 3 additions & 9 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
	let mut nodes = Vec::new();
	for _ in 0..5 {
 let config = random_config(true);
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 setup_builder!(builder, config.node_config);
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
	let test_sync_store: Arc<dyn KVStore + Sync + Send> =
 Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };
	setup_builder!(builder, config.node_config);
	builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

	let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };

	// Setup three nodes: service, client, and payer
	let channel_opening_fee_ppm = 10_000;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Allow disabling wallet background syncing by alexanderwiederin · Pull Request #508 · lightningdevkit/ldk-node · GitHub
Skip to content
Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Mar 28, 2025
 Merged


Allow disabling wallet background syncing
#508
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 5 additions & 1 deletion
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
	u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
	u64 onchain_wallet_sync_interval_secs;
	u64 lightning_wallet_sync_interval_secs;
	u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
	BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
	string? require_token;
	boolean advertise_service;
Expand Down

107 changes: 59 additions & 48 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
	) {
 match self {
 Self::Esplora { sync_config, logger, .. } => {
 // Setup syncing intervals
 let onchain_wallet_sync_interval_secs = sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval =
 tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
 // Setup syncing intervals if enabled
 if let Some(background_sync_config) = sync_config.background_sync_config {
 let onchain_wallet_sync_interval_secs = background_sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(onchain_wallet_sync_interval_secs),
 );
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = background_sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
 fee_rate_cache_update_interval_secs,
 ));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = background_sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(lightning_wallet_sync_interval_secs),
 );
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 }
 }
 }
 } else {
 // Background syncing is disabled
 log_info!(
 logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
 );
 return;
 }
 },
 Self::BitcoindRpc {
Expand Down

35 changes: 29 additions & 6 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
	user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.

///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
	/// The time in-between background sync attempts of the onchain wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub onchain_wallet_sync_interval_secs: u64,

	/// The time in-between background sync attempts of the LDK wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub lightning_wallet_sync_interval_secs: u64,

	/// The time in-between background update attempts to our fee rate cache, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
	fn default() -> Self {
 Self {
 onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
	}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
	/// Background sync configuration.
	///
	/// If set to `None`, background syncing will be disabled. Users will need to manually
	/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
	///
	/// [`Node::sync_wallets`]: crate::Node::sync_wallets
	pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.

	fn default() -> Self {
 Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
	}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down

13 changes: 6 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
	/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
	/// cache.
	///
	/// **Note:** The wallets are regularly synced in the background, which is configurable via the
	/// respective config object, e.g., via
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
	/// sync method is almost always redundant and should be avoided where possible.
	/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
	/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
	/// is almost always redundant when background syncing is enabled and should be avoided where possible.
	/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
	/// this method must be called manually to keep wallets in sync with the chain state.
	///
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
	pub fn sync_wallets(&self) -> Result<(), Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand Down

3 changes: 2 additions & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
	default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
	MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down

4 changes: 1 addition & 3 deletions
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
	match chain_source {
 TestChainSource::Esplora(electrsd) => {
 let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 },
 TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down

12 changes: 3 additions & 9 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
	let mut nodes = Vec::new();
	for _ in 0..5 {
 let config = random_config(true);
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 setup_builder!(builder, config.node_config);
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
	let test_sync_store: Arc<dyn KVStore + Sync + Send> =
 Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };
	setup_builder!(builder, config.node_config);
	builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

	let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };

	// Setup three nodes: service, client, and payer
	let channel_opening_fee_ppm = 10_000;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Allow disabling wallet background syncing by alexanderwiederin · Pull Request #508 · lightningdevkit/ldk-node · GitHub
Skip to content
Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Mar 28, 2025
 Merged


Allow disabling wallet background syncing
#508
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 5 additions & 1 deletion
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
	u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
	u64 onchain_wallet_sync_interval_secs;
	u64 lightning_wallet_sync_interval_secs;
	u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
	BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
	string? require_token;
	boolean advertise_service;
Expand Down

107 changes: 59 additions & 48 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
	) {
 match self {
 Self::Esplora { sync_config, logger, .. } => {
 // Setup syncing intervals
 let onchain_wallet_sync_interval_secs = sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval =
 tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
 // Setup syncing intervals if enabled
 if let Some(background_sync_config) = sync_config.background_sync_config {
 let onchain_wallet_sync_interval_secs = background_sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(onchain_wallet_sync_interval_secs),
 );
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = background_sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
 fee_rate_cache_update_interval_secs,
 ));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = background_sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(lightning_wallet_sync_interval_secs),
 );
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 }
 }
 }
 } else {
 // Background syncing is disabled
 log_info!(
 logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
 );
 return;
 }
 },
 Self::BitcoindRpc {
Expand Down

35 changes: 29 additions & 6 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
	user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.

///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
	/// The time in-between background sync attempts of the onchain wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub onchain_wallet_sync_interval_secs: u64,

	/// The time in-between background sync attempts of the LDK wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub lightning_wallet_sync_interval_secs: u64,

	/// The time in-between background update attempts to our fee rate cache, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
	fn default() -> Self {
 Self {
 onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
	}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
	/// Background sync configuration.
	///
	/// If set to `None`, background syncing will be disabled. Users will need to manually
	/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
	///
	/// [`Node::sync_wallets`]: crate::Node::sync_wallets
	pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.

	fn default() -> Self {
 Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
	}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down

13 changes: 6 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
	/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
	/// cache.
	///
	/// **Note:** The wallets are regularly synced in the background, which is configurable via the
	/// respective config object, e.g., via
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
	/// sync method is almost always redundant and should be avoided where possible.
	/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
	/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
	/// is almost always redundant when background syncing is enabled and should be avoided where possible.
	/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
	/// this method must be called manually to keep wallets in sync with the chain state.
	///
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
	pub fn sync_wallets(&self) -> Result<(), Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand Down

3 changes: 2 additions & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
	default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
	MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down

4 changes: 1 addition & 3 deletions
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
	match chain_source {
 TestChainSource::Esplora(electrsd) => {
 let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 },
 TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down

12 changes: 3 additions & 9 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
	let mut nodes = Vec::new();
	for _ in 0..5 {
 let config = random_config(true);
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 setup_builder!(builder, config.node_config);
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
	let test_sync_store: Arc<dyn KVStore + Sync + Send> =
 Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };
	setup_builder!(builder, config.node_config);
	builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

	let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };

	// Setup three nodes: service, client, and payer
	let channel_opening_fee_ppm = 10_000;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Allow disabling wallet background syncing by alexanderwiederin · Pull Request #508 · lightningdevkit/ldk-node · GitHub
Skip to content
Allow disabling wallet background syncing#508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Mar 28, 2025
 Merged


Allow disabling wallet background syncing
#508
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 5 additions & 1 deletion
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
	u64 per_channel_reserve_sats;
};

dictionary EsploraSyncConfig {
dictionary BackgroundSyncConfig {
	u64 onchain_wallet_sync_interval_secs;
	u64 lightning_wallet_sync_interval_secs;
	u64 fee_rate_cache_update_interval_secs;
};

dictionary EsploraSyncConfig {
	BackgroundSyncConfig? background_sync_config;
};

dictionary LSPS2ServiceConfig {
	string? require_token;
	boolean advertise_service;
Expand Down

107 changes: 59 additions & 48 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -207,57 +207,68 @@ impl ChainSource {
	) {
 match self {
 Self::Esplora { sync_config, logger, .. } => {
 // Setup syncing intervals
 let onchain_wallet_sync_interval_secs = sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval =
 tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval =
 tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
 // Setup syncing intervals if enabled
 if let Some(background_sync_config) = sync_config.background_sync_config {
 let onchain_wallet_sync_interval_secs = background_sync_config
 .onchain_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut onchain_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(onchain_wallet_sync_interval_secs),
 );
 onchain_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let fee_rate_cache_update_interval_secs = background_sync_config
 .fee_rate_cache_update_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
 fee_rate_cache_update_interval_secs,
 ));
 // When starting up, we just blocked on updating, so skip the first tick.
 fee_rate_update_interval.reset();
 fee_rate_update_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 let lightning_wallet_sync_interval_secs = background_sync_config
 .lightning_wallet_sync_interval_secs
 .max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
 let mut lightning_wallet_sync_interval = tokio::time::interval(
 Duration::from_secs(lightning_wallet_sync_interval_secs),
 );
 lightning_wallet_sync_interval
 .set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);

 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 // Start the syncing loop.
 loop {
 tokio::select! {
 _ = stop_sync_receiver.changed() => {
 log_trace!(
 logger,
 "Stopping background syncing on-chain wallet.",
 );
 return;
 }
 _ = onchain_wallet_sync_interval.tick() => {
 let _ = self.sync_onchain_wallet().await;
 }
 _ = fee_rate_update_interval.tick() => {
 let _ = self.update_fee_rate_estimates().await;
 }
 _ = lightning_wallet_sync_interval.tick() => {
 let _ = self.sync_lightning_wallet(
 Arc::clone(&channel_manager),
 Arc::clone(&chain_monitor),
 Arc::clone(&output_sweeper),
 ).await;
 }
 }
 }
 } else {
 // Background syncing is disabled
 log_info!(
 logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
 );
 return;
 }
 },
 Self::BitcoindRpc {
Expand Down

35 changes: 29 additions & 6 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
	user_config
}

/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
/// Options related to background syncing the Lightning and on-chain wallets.
///
/// ### Defaults
Comment thread
alexanderwiederin marked this conversation as resolved.

///
Expand All@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
/// | `lightning_wallet_sync_interval_secs` | 30 |
/// | `fee_rate_cache_update_interval_secs` | 600 |
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
pub struct BackgroundSyncConfig {
	/// The time in-between background sync attempts of the onchain wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub onchain_wallet_sync_interval_secs: u64,

	/// The time in-between background sync attempts of the LDK wallet, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub lightning_wallet_sync_interval_secs: u64,

	/// The time in-between background update attempts to our fee rate cache, in seconds.
	///
	/// **Note:** A minimum of 10 seconds is always enforced.
	/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
	pub fee_rate_cache_update_interval_secs: u64,
}

impl Default for EsploraSyncConfig {
impl Default for BackgroundSyncConfig {
	fn default() -> Self {
 Self {
 onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
Expand All@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
	}
}

/// Configuration for syncing with an Esplora backend.
///
/// Background syncing is enabled by default, using the default values specified in
/// [`BackgroundSyncConfig`].
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EsploraSyncConfig {
	/// Background sync configuration.
	///
	/// If set to `None`, background syncing will be disabled. Users will need to manually
	/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
	///
	/// [`Node::sync_wallets`]: crate::Node::sync_wallets
	pub background_sync_config: Option<BackgroundSyncConfig>,
}

impl Default for EsploraSyncConfig {
Comment thread
alexanderwiederin marked this conversation as resolved.

	fn default() -> Self {
 Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
	}
}

/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
/// with our counterparty.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
Expand Down

13 changes: 6 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1219,14 +1219,13 @@ impl Node {
	/// Manually sync the LDK and BDK wallets with the current chain state and update the fee rate
	/// cache.
	///
	/// **Note:** The wallets are regularly synced in the background, which is configurable via the
	/// respective config object, e.g., via
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`] and
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]. Therefore, using this blocking
	/// sync method is almost always redundant and should be avoided where possible.
	/// **Note:** The wallets are regularly synced in the background if background syncing is enabled
	/// via [`EsploraSyncConfig::background_sync_config`]. Therefore, using this blocking sync method
	/// is almost always redundant when background syncing is enabled and should be avoided where possible.
	/// However, if background syncing is disabled (i.e., `background_sync_config` is set to `None`),
	/// this method must be called manually to keep wallets in sync with the chain state.
	///
	/// [`EsploraSyncConfig::onchain_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::onchain_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::lightning_wallet_sync_interval_secs`]: crate::config::EsploraSyncConfig::lightning_wallet_sync_interval_secs
	/// [`EsploraSyncConfig::background_sync_config`]: crate::config::EsploraSyncConfig::background_sync_config
	pub fn sync_wallets(&self) -> Result<(), Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand Down

3 changes: 2 additions & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,8 @@
// Make sure to add any re-exported items that need to be used in uniffi below.

pub use crate::config::{
	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
	default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
	MaxDustHTLCExposure,
};
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
Expand Down

4 changes: 1 addition & 3 deletions
tests/common/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
	match chain_source {
 TestChainSource::Esplora(electrsd) => {
 let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 },
 TestChainSource::BitcoindRpc(bitcoind) => {
Expand Down

12 changes: 3 additions & 9 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,9 +127,7 @@ fn multi_hop_sending() {
	let mut nodes = Vec::new();
	for _ in 0..5 {
 let config = random_config(true);
 let mut sync_config = EsploraSyncConfig::default();
 sync_config.onchain_wallet_sync_interval_secs = 100000;
 sync_config.lightning_wallet_sync_interval_secs = 100000;
 let sync_config = EsploraSyncConfig { background_sync_config: None };
 setup_builder!(builder, config.node_config);
 builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
 let node = builder.build().unwrap();
Expand DownExpand Up@@ -227,9 +225,7 @@ fn start_stop_reinit() {
	let test_sync_store: Arc<dyn KVStore + Sync + Send> =
 Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };
	setup_builder!(builder, config.node_config);
	builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));

Expand DownExpand Up@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {

	let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());

	let mut sync_config = EsploraSyncConfig::default();
	sync_config.onchain_wallet_sync_interval_secs = 100000;
	sync_config.lightning_wallet_sync_interval_secs = 100000;
	let sync_config = EsploraSyncConfig { background_sync_config: None };

	// Setup three nodes: service, client, and payer
	let channel_opening_fee_ppm = 10_000;
Expand Down