Skip to content

Commit 0dd78ee

Browse files
tnulltnull
authored
Merge pull request #508 from alexanderwiederin/optional-wallet-sync
Allow disabling wallet background syncing
2 parents 2122528 + bbe8b1e commit 0dd78ee

File tree

7 files changed

+105
-75
lines changed

7 files changed

+105
-75
lines changed

‎bindings/ldk_node.udl‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,16 @@ dictionary AnchorChannelsConfig {
1919
u64 per_channel_reserve_sats;
2020
};
2121

22-
dictionary EsploraSyncConfig {
22+
dictionary BackgroundSyncConfig {
2323
u64 onchain_wallet_sync_interval_secs;
2424
u64 lightning_wallet_sync_interval_secs;
2525
u64 fee_rate_cache_update_interval_secs;
2626
};
2727

28+
dictionary EsploraSyncConfig {
29+
BackgroundSyncConfig? background_sync_config;
30+
};
31+
2832
dictionary LSPS2ServiceConfig {
2933
string? require_token;
3034
boolean advertise_service;

‎src/chain/mod.rs‎

Lines changed: 59 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -207,57 +207,68 @@ impl ChainSource {
207207
) {
208208
match self {
209209
Self::Esplora { sync_config, logger, .. } => {
210-
// Setup syncing intervals
211-
let onchain_wallet_sync_interval_secs = sync_config
212-
.onchain_wallet_sync_interval_secs
213-
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
214-
let mut onchain_wallet_sync_interval =
215-
tokio::time::interval(Duration::from_secs(onchain_wallet_sync_interval_secs));
216-
onchain_wallet_sync_interval
217-
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
218-
219-
let fee_rate_cache_update_interval_secs = sync_config
220-
.fee_rate_cache_update_interval_secs
221-
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
222-
let mut fee_rate_update_interval =
223-
tokio::time::interval(Duration::from_secs(fee_rate_cache_update_interval_secs));
224-
// When starting up, we just blocked on updating, so skip the first tick.
225-
fee_rate_update_interval.reset();
226-
fee_rate_update_interval
227-
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
228-
229-
let lightning_wallet_sync_interval_secs = sync_config
230-
.lightning_wallet_sync_interval_secs
231-
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
232-
let mut lightning_wallet_sync_interval =
233-
tokio::time::interval(Duration::from_secs(lightning_wallet_sync_interval_secs));
234-
lightning_wallet_sync_interval
235-
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
210+
// Setup syncing intervals if enabled
211+
if let Some(background_sync_config) = sync_config.background_sync_config {
212+
let onchain_wallet_sync_interval_secs = background_sync_config
213+
.onchain_wallet_sync_interval_secs
214+
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
215+
let mut onchain_wallet_sync_interval = tokio::time::interval(
216+
Duration::from_secs(onchain_wallet_sync_interval_secs),
217+
);
218+
onchain_wallet_sync_interval
219+
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
220+
221+
let fee_rate_cache_update_interval_secs = background_sync_config
222+
.fee_rate_cache_update_interval_secs
223+
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
224+
let mut fee_rate_update_interval = tokio::time::interval(Duration::from_secs(
225+
fee_rate_cache_update_interval_secs,
226+
));
227+
// When starting up, we just blocked on updating, so skip the first tick.
228+
fee_rate_update_interval.reset();
229+
fee_rate_update_interval
230+
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
231+
232+
let lightning_wallet_sync_interval_secs = background_sync_config
233+
.lightning_wallet_sync_interval_secs
234+
.max(WALLET_SYNC_INTERVAL_MINIMUM_SECS);
235+
let mut lightning_wallet_sync_interval = tokio::time::interval(
236+
Duration::from_secs(lightning_wallet_sync_interval_secs),
237+
);
238+
lightning_wallet_sync_interval
239+
.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
236240

237-
// Start the syncing loop.
238-
loop {
239-
tokio::select! {
240-
_ = stop_sync_receiver.changed() => {
241-
log_trace!(
242-
logger,
243-
"Stopping background syncing on-chain wallet.",
244-
);
245-
return;
246-
}
247-
_ = onchain_wallet_sync_interval.tick() => {
248-
let _ = self.sync_onchain_wallet().await;
249-
}
250-
_ = fee_rate_update_interval.tick() => {
251-
let _ = self.update_fee_rate_estimates().await;
252-
}
253-
_ = lightning_wallet_sync_interval.tick() => {
254-
let _ = self.sync_lightning_wallet(
255-
Arc::clone(&channel_manager),
256-
Arc::clone(&chain_monitor),
257-
Arc::clone(&output_sweeper),
258-
).await;
241+
// Start the syncing loop.
242+
loop {
243+
tokio::select! {
244+
_ = stop_sync_receiver.changed() => {
245+
log_trace!(
246+
logger,
247+
"Stopping background syncing on-chain wallet.",
248+
);
249+
return;
250+
}
251+
_ = onchain_wallet_sync_interval.tick() => {
252+
let _ = self.sync_onchain_wallet().await;
253+
}
254+
_ = fee_rate_update_interval.tick() => {
255+
let _ = self.update_fee_rate_estimates().await;
256+
}
257+
_ = lightning_wallet_sync_interval.tick() => {
258+
let _ = self.sync_lightning_wallet(
259+
Arc::clone(&channel_manager),
260+
Arc::clone(&chain_monitor),
261+
Arc::clone(&output_sweeper),
262+
).await;
263+
}
259264
}
260265
}
266+
} else {
267+
// Background syncing is disabled
268+
log_info!(
269+
logger, "Background syncing disabled. Manual syncing required for onchain wallet, lightning wallet, and fee rate updates.",
270+
);
271+
return;
261272
}
262273
},
263274
Self::BitcoindRpc {

‎src/config.rs‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
282282
user_config
283283
}
284284

285-
/// Options related to syncing the Lightning and on-chain wallets via an Esplora backend.
285+
/// Options related to background syncing the Lightning and on-chain wallets.
286286
///
287287
/// ### Defaults
288288
///
@@ -292,22 +292,24 @@ pub(crate) fn default_user_config(config: &Config) -> UserConfig {
292292
/// | `lightning_wallet_sync_interval_secs` | 30 |
293293
/// | `fee_rate_cache_update_interval_secs` | 600 |
294294
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
295-
pub struct EsploraSyncConfig {
295+
pub struct BackgroundSyncConfig {
296296
/// The time in-between background sync attempts of the onchain wallet, in seconds.
297297
///
298-
/// **Note:** A minimum of 10 seconds is always enforced.
298+
/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
299299
pub onchain_wallet_sync_interval_secs: u64,
300+
300301
/// The time in-between background sync attempts of the LDK wallet, in seconds.
301302
///
302-
/// **Note:** A minimum of 10 seconds is always enforced.
303+
/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
303304
pub lightning_wallet_sync_interval_secs: u64,
305+
304306
/// The time in-between background update attempts to our fee rate cache, in seconds.
305307
///
306-
/// **Note:** A minimum of 10 seconds is always enforced.
308+
/// **Note:** A minimum of 10 seconds is enforced when background syncing is enabled.
307309
pub fee_rate_cache_update_interval_secs: u64,
308310
}
309311

310-
impl Default for EsploraSyncConfig {
312+
impl Default for BackgroundSyncConfig {
311313
fn default() -> Self {
312314
Self {
313315
onchain_wallet_sync_interval_secs: DEFAULT_BDK_WALLET_SYNC_INTERVAL_SECS,
@@ -317,6 +319,27 @@ impl Default for EsploraSyncConfig {
317319
}
318320
}
319321

322+
/// Configuration for syncing with an Esplora backend.
323+
///
324+
/// Background syncing is enabled by default, using the default values specified in
325+
/// [`BackgroundSyncConfig`].
326+
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
327+
pub struct EsploraSyncConfig {
328+
/// Background sync configuration.
329+
///
330+
/// If set to `None`, background syncing will be disabled. Users will need to manually
331+
/// sync via `Node::sync_wallets` for the wallets and fee rate updates.
332+
///
333+
/// [`Node::sync_wallets`]: crate::Node::sync_wallets
334+
pub background_sync_config: Option<BackgroundSyncConfig>,
335+
}
336+
337+
impl Default for EsploraSyncConfig {
338+
fn default() -> Self {
339+
Self { background_sync_config: Some(BackgroundSyncConfig::default()) }
340+
}
341+
}
342+
320343
/// Options which apply on a per-channel basis and may change at runtime or based on negotiation
321344
/// with our counterparty.
322345
#[derive(Copy, Clone, Debug, PartialEq, Eq)]

‎src/lib.rs‎

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

‎src/uniffi_types.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
// Make sure to add any re-exported items that need to be used in uniffi below.
1212

1313
pub use crate::config::{
14-
default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
14+
default_config, AnchorChannelsConfig, BackgroundSyncConfig, EsploraSyncConfig,
15+
MaxDustHTLCExposure,
1516
};
1617
pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
1718
pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};

‎tests/common/mod.rs‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,7 @@ pub(crate) fn setup_node(
310310
match chain_source {
311311
TestChainSource::Esplora(electrsd) => {
312312
let esplora_url = format!("http://{}", electrsd.esplora_url.as_ref().unwrap());
313-
let mut sync_config = EsploraSyncConfig::default();
314-
sync_config.onchain_wallet_sync_interval_secs = 100000;
315-
sync_config.lightning_wallet_sync_interval_secs = 100000;
313+
let sync_config = EsploraSyncConfig { background_sync_config: None };
316314
builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
317315
},
318316
TestChainSource::BitcoindRpc(bitcoind) => {

‎tests/integration_tests_rust.rs‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,7 @@ fn multi_hop_sending() {
127127
let mut nodes = Vec::new();
128128
for _ in 0..5 {
129129
let config = random_config(true);
130-
let mut sync_config = EsploraSyncConfig::default();
131-
sync_config.onchain_wallet_sync_interval_secs = 100000;
132-
sync_config.lightning_wallet_sync_interval_secs = 100000;
130+
let sync_config = EsploraSyncConfig { background_sync_config: None };
133131
setup_builder!(builder, config.node_config);
134132
builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
135133
let node = builder.build().unwrap();
@@ -227,9 +225,7 @@ fn start_stop_reinit() {
227225
let test_sync_store: Arc<dyn KVStore + Sync + Send> =
228226
Arc::new(TestSyncStore::new(config.node_config.storage_dir_path.clone().into()));
229227

230-
let mut sync_config = EsploraSyncConfig::default();
231-
sync_config.onchain_wallet_sync_interval_secs = 100000;
232-
sync_config.lightning_wallet_sync_interval_secs = 100000;
228+
let sync_config = EsploraSyncConfig { background_sync_config: None };
233229
setup_builder!(builder, config.node_config);
234230
builder.set_chain_source_esplora(esplora_url.clone(), Some(sync_config));
235231

@@ -1048,9 +1044,7 @@ fn lsps2_client_service_integration() {
10481044

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

1051-
let mut sync_config = EsploraSyncConfig::default();
1052-
sync_config.onchain_wallet_sync_interval_secs = 100000;
1053-
sync_config.lightning_wallet_sync_interval_secs = 100000;
1047+
let sync_config = EsploraSyncConfig { background_sync_config: None };
10541048

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

0 commit comments

Comments
 (0)