Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into from
Aug 1, 2025
Merged

Refactor chain sourcing logic to make result propagation more robust #599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fb34a27
Move inner code to `sync_lightning_wallet_inner` for Esplora
tnull Jul 31, 2025
c1157a3
Move inner code to `sync_onchain_wallet_inner` for Esplora
tnull Jul 31, 2025
c765545
Move inner code to `sync_lightning_wallet_inner` for Electrum
tnull Jul 31, 2025
128fdfd
Move inner code to `sync_onchain_wallet_inner` for Electrum
tnull Jul 31, 2025
9444bc4
Move inner code to `poll_and_update_listeners_inner`
tnull Jul 31, 2025
a6349a4
Call `periodically_archive_fully_resolved_monitors` for Bitcoind
tnull Jul 31, 2025
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
54 changes: 29 additions & 25 deletions src/chain/bitcoind.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
})?;
}

let res = self
.poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
.await;

self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

res
Comment thread
joostjager marked this conversation as resolved.
}

async fn poll_and_update_listeners_inner(
&self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
output_sweeper: Arc<Sweeper>,
) -> Result<(), Error> {
let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
let chain_tip = if let Some(tip) = latest_chain_tip_opt {
tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
},
Err(e) => {
log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
let res = Err(Error::TxSyncFailed);
self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

@joostjagerjoostjagerAug 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?

@tnulltnullAug 1, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.

@joostjagerjoostjagerAug 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.

@tnulltnullAug 1, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.

@tnulltnullAug 1, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so

return res;
return Err(Error::TxSyncFailed);
},
}
};
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
let chain_listener = ChainListener {
onchain_wallet: Arc::clone(&self.onchain_wallet),
channel_manager: Arc::clone(&channel_manager),
chain_monitor,
chain_monitor: Arc::clone(&chain_monitor),
output_sweeper,
};
let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
now.elapsed().unwrap().as_millis()
);
*self.latest_chain_tip.write().unwrap() = Some(tip);

periodically_archive_fully_resolved_monitors(

@joostjagerjoostjagerAug 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.

@tnulltnullAug 1, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)

@joostjagerjoostjagerAug 1, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.

Arc::clone(&channel_manager),
chain_monitor,
Arc::clone(&self.kv_store),
Arc::clone(&self.logger),
Arc::clone(&self.node_metrics),
)?;
},
Ok(_) => {},
Err(e) => {
log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
let res = Err(Error::TxSyncFailed);
self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
return res;
return Err(Error::TxSyncFailed);
},
}

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
},
Err(e) => {
log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
let res = Err(Error::TxSyncFailed);
self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
return res;
return Err(Error::TxSyncFailed);
},
}

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
write_node_metrics(
&*locked_node_metrics,
Arc::clone(&self.kv_store),
Arc::clone(&self.logger),
);
match write_res {
Ok(()) => (),
Err(e) => {
log_error!(self.logger, "Failed to persist node metrics: {}", e);
let res = Err(Error::PersistenceFailed);
self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
return res;
},
}
)?;
Comment thread
joostjager marked this conversation as resolved.

let res = Ok(());
self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
res
Ok(())
}

pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down
84 changes: 50 additions & 34 deletions src/chain/electrum.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
}

pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
let electrum_client: Arc<ElectrumRuntimeClient> =
if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
Arc::clone(client)
} else {
debug_assert!(
false,
"We should have started the chain source before syncing the onchain wallet"
);
return Err(Error::FeerateEstimationUpdateFailed);
};
let receiver_res = {
let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
})?;
}

let res = self.sync_onchain_wallet_inner().await;

self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

res
}

async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
let electrum_client: Arc<ElectrumRuntimeClient> =
if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
Arc::clone(client)
} else {
debug_assert!(
false,
"We should have started the chain source before syncing the onchain wallet"
);
return Err(Error::FeerateEstimationUpdateFailed);
};
// If this is our first sync, do a full scan with the configured gap limit.
// Otherwise just do an incremental sync.
let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
apply_wallet_update(update_res, now)
};

self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

res
}

pub(crate) async fn sync_lightning_wallet(
&self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
output_sweeper: Arc<Sweeper>,
) -> Result<(), Error> {
let electrum_client: Arc<ElectrumRuntimeClient> =
if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
Arc::clone(client)
} else {
debug_assert!(
false,
"We should have started the chain source before syncing the lightning wallet"
);
return Err(Error::TxSyncFailed);
};

let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
];

let receiver_res = {
let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
})?;
}

let res =
self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

res
}

async fn sync_lightning_wallet_inner(
&self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
output_sweeper: Arc<Sweeper>,
) -> Result<(), Error> {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
];

let electrum_client: Arc<ElectrumRuntimeClient> =
if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
Arc::clone(client)
} else {
debug_assert!(
false,
"We should have started the chain source before syncing the lightning wallet"
);
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;

if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
)?;
}

self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

res
}

Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into

from

Aug 1, 2025
 Merged


Refactor chain sourcing logic to make result propagation more robust
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fb34a27

Move inner code to `sync_lightning_wallet_inner` for Esplora


tnull Jul 31, 2025
c1157a3

Move inner code to `sync_onchain_wallet_inner` for Esplora


tnull Jul 31, 2025
c765545

Move inner code to `sync_lightning_wallet_inner` for Electrum


tnull Jul 31, 2025
128fdfd

Move inner code to `sync_onchain_wallet_inner` for Electrum


tnull Jul 31, 2025
9444bc4

Move inner code to `poll_and_update_listeners_inner`


tnull Jul 31, 2025
a6349a4

Call `periodically_archive_fully_resolved_monitors` for Bitcoind


tnull Jul 31, 2025

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


54 changes: 29 additions & 25 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
	BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
 })?;
 }

 let res = self
 .poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
 .await;

 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
Comment thread
joostjager marked this conversation as resolved.

	}

	async fn poll_and_update_listeners_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
 let chain_tip = if let Some(tip) = latest_chain_tip_opt {
 tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so
 return res;
 return Err(Error::TxSyncFailed);
 },
 }
 };
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
 let chain_listener = ChainListener {
 onchain_wallet: Arc::clone(&self.onchain_wallet),
 channel_manager: Arc::clone(&channel_manager),
 chain_monitor,
 chain_monitor: Arc::clone(&chain_monitor),
 output_sweeper,
 };
 let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
 now.elapsed().unwrap().as_millis()
 );
 *self.latest_chain_tip.write().unwrap() = Some(tip);

 periodically_archive_fully_resolved_monitors(
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)
@joostjagerjoostjagerAug 1, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.
 Arc::clone(&channel_manager),
 chain_monitor,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 Arc::clone(&self.node_metrics),
 )?;
 },
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
 locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
 locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
 write_node_metrics(
 &*locked_node_metrics,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 );
 match write_res {
 Ok(()) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to persist node metrics: {}", e);
 let res = Err(Error::PersistenceFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 },
 }
 )?;
Comment thread
joostjager marked this conversation as resolved.


 let res = Ok(());
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 res
 Ok(())
	}

	pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down

84 changes: 50 additions & 34 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
	}

	pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 let receiver_res = {
 let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
 })?;
 }

 let res = self.sync_onchain_wallet_inner().await;

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 // If this is our first sync, do a full scan with the configured gap limit.
 // Otherwise just do an incremental sync.
 let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
 apply_wallet_update(update_res, now)
 };

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	pub(crate) async fn sync_lightning_wallet(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let receiver_res = {
 let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
 })?;
 }

 let res =
 self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_lightning_wallet_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let res = electrum_client.sync_confirmables(confirmables).await;

 if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
 )?;
 }

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

Expand Down
Loading
Loading

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

Skip to content
Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into

from

Aug 1, 2025
 Merged


Refactor chain sourcing logic to make result propagation more robust
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fb34a27

Move inner code to `sync_lightning_wallet_inner` for Esplora


tnull Jul 31, 2025
c1157a3

Move inner code to `sync_onchain_wallet_inner` for Esplora


tnull Jul 31, 2025
c765545

Move inner code to `sync_lightning_wallet_inner` for Electrum


tnull Jul 31, 2025
128fdfd

Move inner code to `sync_onchain_wallet_inner` for Electrum


tnull Jul 31, 2025
9444bc4

Move inner code to `poll_and_update_listeners_inner`


tnull Jul 31, 2025
a6349a4

Call `periodically_archive_fully_resolved_monitors` for Bitcoind


tnull Jul 31, 2025

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


54 changes: 29 additions & 25 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
	BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
 })?;
 }

 let res = self
 .poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
 .await;

 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
Comment thread
joostjager marked this conversation as resolved.

	}

	async fn poll_and_update_listeners_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
 let chain_tip = if let Some(tip) = latest_chain_tip_opt {
 tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so
 return res;
 return Err(Error::TxSyncFailed);
 },
 }
 };
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
 let chain_listener = ChainListener {
 onchain_wallet: Arc::clone(&self.onchain_wallet),
 channel_manager: Arc::clone(&channel_manager),
 chain_monitor,
 chain_monitor: Arc::clone(&chain_monitor),
 output_sweeper,
 };
 let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
 now.elapsed().unwrap().as_millis()
 );
 *self.latest_chain_tip.write().unwrap() = Some(tip);

 periodically_archive_fully_resolved_monitors(
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)
@joostjagerjoostjagerAug 1, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.
 Arc::clone(&channel_manager),
 chain_monitor,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 Arc::clone(&self.node_metrics),
 )?;
 },
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
 locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
 locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
 write_node_metrics(
 &*locked_node_metrics,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 );
 match write_res {
 Ok(()) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to persist node metrics: {}", e);
 let res = Err(Error::PersistenceFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 },
 }
 )?;
Comment thread
joostjager marked this conversation as resolved.


 let res = Ok(());
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 res
 Ok(())
	}

	pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down

84 changes: 50 additions & 34 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
	}

	pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 let receiver_res = {
 let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
 })?;
 }

 let res = self.sync_onchain_wallet_inner().await;

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 // If this is our first sync, do a full scan with the configured gap limit.
 // Otherwise just do an incremental sync.
 let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
 apply_wallet_update(update_res, now)
 };

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	pub(crate) async fn sync_lightning_wallet(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let receiver_res = {
 let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
 })?;
 }

 let res =
 self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_lightning_wallet_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let res = electrum_client.sync_confirmables(confirmables).await;

 if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
 )?;
 }

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

Expand Down
Loading
Loading

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

Skip to content
Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into

from

Aug 1, 2025
 Merged


Refactor chain sourcing logic to make result propagation more robust
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fb34a27

Move inner code to `sync_lightning_wallet_inner` for Esplora


tnull Jul 31, 2025
c1157a3

Move inner code to `sync_onchain_wallet_inner` for Esplora


tnull Jul 31, 2025
c765545

Move inner code to `sync_lightning_wallet_inner` for Electrum


tnull Jul 31, 2025
128fdfd

Move inner code to `sync_onchain_wallet_inner` for Electrum


tnull Jul 31, 2025
9444bc4

Move inner code to `poll_and_update_listeners_inner`


tnull Jul 31, 2025
a6349a4

Call `periodically_archive_fully_resolved_monitors` for Bitcoind


tnull Jul 31, 2025

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


54 changes: 29 additions & 25 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
	BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
 })?;
 }

 let res = self
 .poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
 .await;

 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
Comment thread
joostjager marked this conversation as resolved.

	}

	async fn poll_and_update_listeners_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
 let chain_tip = if let Some(tip) = latest_chain_tip_opt {
 tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so
 return res;
 return Err(Error::TxSyncFailed);
 },
 }
 };
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
 let chain_listener = ChainListener {
 onchain_wallet: Arc::clone(&self.onchain_wallet),
 channel_manager: Arc::clone(&channel_manager),
 chain_monitor,
 chain_monitor: Arc::clone(&chain_monitor),
 output_sweeper,
 };
 let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
 now.elapsed().unwrap().as_millis()
 );
 *self.latest_chain_tip.write().unwrap() = Some(tip);

 periodically_archive_fully_resolved_monitors(
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)
@joostjagerjoostjagerAug 1, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.
 Arc::clone(&channel_manager),
 chain_monitor,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 Arc::clone(&self.node_metrics),
 )?;
 },
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
 locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
 locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
 write_node_metrics(
 &*locked_node_metrics,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 );
 match write_res {
 Ok(()) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to persist node metrics: {}", e);
 let res = Err(Error::PersistenceFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 },
 }
 )?;
Comment thread
joostjager marked this conversation as resolved.


 let res = Ok(());
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 res
 Ok(())
	}

	pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down

84 changes: 50 additions & 34 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
	}

	pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 let receiver_res = {
 let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
 })?;
 }

 let res = self.sync_onchain_wallet_inner().await;

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 // If this is our first sync, do a full scan with the configured gap limit.
 // Otherwise just do an incremental sync.
 let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
 apply_wallet_update(update_res, now)
 };

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	pub(crate) async fn sync_lightning_wallet(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let receiver_res = {
 let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
 })?;
 }

 let res =
 self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_lightning_wallet_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let res = electrum_client.sync_confirmables(confirmables).await;

 if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
 )?;
 }

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

Expand Down
Loading
Loading

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

Skip to content
Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into

from

Aug 1, 2025
 Merged


Refactor chain sourcing logic to make result propagation more robust
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fb34a27

Move inner code to `sync_lightning_wallet_inner` for Esplora


tnull Jul 31, 2025
c1157a3

Move inner code to `sync_onchain_wallet_inner` for Esplora


tnull Jul 31, 2025
c765545

Move inner code to `sync_lightning_wallet_inner` for Electrum


tnull Jul 31, 2025
128fdfd

Move inner code to `sync_onchain_wallet_inner` for Electrum


tnull Jul 31, 2025
9444bc4

Move inner code to `poll_and_update_listeners_inner`


tnull Jul 31, 2025
a6349a4

Call `periodically_archive_fully_resolved_monitors` for Bitcoind


tnull Jul 31, 2025

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


54 changes: 29 additions & 25 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
	BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
 })?;
 }

 let res = self
 .poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
 .await;

 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
Comment thread
joostjager marked this conversation as resolved.

	}

	async fn poll_and_update_listeners_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
 let chain_tip = if let Some(tip) = latest_chain_tip_opt {
 tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so
 return res;
 return Err(Error::TxSyncFailed);
 },
 }
 };
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
 let chain_listener = ChainListener {
 onchain_wallet: Arc::clone(&self.onchain_wallet),
 channel_manager: Arc::clone(&channel_manager),
 chain_monitor,
 chain_monitor: Arc::clone(&chain_monitor),
 output_sweeper,
 };
 let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
 now.elapsed().unwrap().as_millis()
 );
 *self.latest_chain_tip.write().unwrap() = Some(tip);

 periodically_archive_fully_resolved_monitors(
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)
@joostjagerjoostjagerAug 1, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.
 Arc::clone(&channel_manager),
 chain_monitor,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 Arc::clone(&self.node_metrics),
 )?;
 },
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
 locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
 locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
 write_node_metrics(
 &*locked_node_metrics,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 );
 match write_res {
 Ok(()) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to persist node metrics: {}", e);
 let res = Err(Error::PersistenceFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 },
 }
 )?;
Comment thread
joostjager marked this conversation as resolved.


 let res = Ok(());
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 res
 Ok(())
	}

	pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down

84 changes: 50 additions & 34 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
	}

	pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 let receiver_res = {
 let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
 })?;
 }

 let res = self.sync_onchain_wallet_inner().await;

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 // If this is our first sync, do a full scan with the configured gap limit.
 // Otherwise just do an incremental sync.
 let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
 apply_wallet_update(update_res, now)
 };

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	pub(crate) async fn sync_lightning_wallet(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let receiver_res = {
 let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
 })?;
 }

 let res =
 self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_lightning_wallet_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let res = electrum_client.sync_confirmables(confirmables).await;

 if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
 )?;
 }

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into

from

Aug 1, 2025
 Merged


Refactor chain sourcing logic to make result propagation more robust
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fb34a27

Move inner code to `sync_lightning_wallet_inner` for Esplora


tnull Jul 31, 2025
c1157a3

Move inner code to `sync_onchain_wallet_inner` for Esplora


tnull Jul 31, 2025
c765545

Move inner code to `sync_lightning_wallet_inner` for Electrum


tnull Jul 31, 2025
128fdfd

Move inner code to `sync_onchain_wallet_inner` for Electrum


tnull Jul 31, 2025
9444bc4

Move inner code to `poll_and_update_listeners_inner`


tnull Jul 31, 2025
a6349a4

Call `periodically_archive_fully_resolved_monitors` for Bitcoind


tnull Jul 31, 2025

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


54 changes: 29 additions & 25 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
	BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
 })?;
 }

 let res = self
 .poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
 .await;

 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
Comment thread
joostjager marked this conversation as resolved.

	}

	async fn poll_and_update_listeners_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
 let chain_tip = if let Some(tip) = latest_chain_tip_opt {
 tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so
 return res;
 return Err(Error::TxSyncFailed);
 },
 }
 };
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
 let chain_listener = ChainListener {
 onchain_wallet: Arc::clone(&self.onchain_wallet),
 channel_manager: Arc::clone(&channel_manager),
 chain_monitor,
 chain_monitor: Arc::clone(&chain_monitor),
 output_sweeper,
 };
 let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
 now.elapsed().unwrap().as_millis()
 );
 *self.latest_chain_tip.write().unwrap() = Some(tip);

 periodically_archive_fully_resolved_monitors(
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)
@joostjagerjoostjagerAug 1, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.
 Arc::clone(&channel_manager),
 chain_monitor,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 Arc::clone(&self.node_metrics),
 )?;
 },
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
 locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
 locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
 write_node_metrics(
 &*locked_node_metrics,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 );
 match write_res {
 Ok(()) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to persist node metrics: {}", e);
 let res = Err(Error::PersistenceFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 },
 }
 )?;
Comment thread
joostjager marked this conversation as resolved.


 let res = Ok(());
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 res
 Ok(())
	}

	pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down

84 changes: 50 additions & 34 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
	}

	pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 let receiver_res = {
 let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
 })?;
 }

 let res = self.sync_onchain_wallet_inner().await;

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 // If this is our first sync, do a full scan with the configured gap limit.
 // Otherwise just do an incremental sync.
 let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
 apply_wallet_update(update_res, now)
 };

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	pub(crate) async fn sync_lightning_wallet(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let receiver_res = {
 let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
 })?;
 }

 let res =
 self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_lightning_wallet_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let res = electrum_client.sync_confirmables(confirmables).await;

 if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
 )?;
 }

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into

from

Aug 1, 2025
 Merged


Refactor chain sourcing logic to make result propagation more robust
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fb34a27

Move inner code to `sync_lightning_wallet_inner` for Esplora


tnull Jul 31, 2025
c1157a3

Move inner code to `sync_onchain_wallet_inner` for Esplora


tnull Jul 31, 2025
c765545

Move inner code to `sync_lightning_wallet_inner` for Electrum


tnull Jul 31, 2025
128fdfd

Move inner code to `sync_onchain_wallet_inner` for Electrum


tnull Jul 31, 2025
9444bc4

Move inner code to `poll_and_update_listeners_inner`


tnull Jul 31, 2025
a6349a4

Call `periodically_archive_fully_resolved_monitors` for Bitcoind


tnull Jul 31, 2025

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


54 changes: 29 additions & 25 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
	BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
 })?;
 }

 let res = self
 .poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
 .await;

 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
Comment thread
joostjager marked this conversation as resolved.

	}

	async fn poll_and_update_listeners_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
 let chain_tip = if let Some(tip) = latest_chain_tip_opt {
 tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so
 return res;
 return Err(Error::TxSyncFailed);
 },
 }
 };
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
 let chain_listener = ChainListener {
 onchain_wallet: Arc::clone(&self.onchain_wallet),
 channel_manager: Arc::clone(&channel_manager),
 chain_monitor,
 chain_monitor: Arc::clone(&chain_monitor),
 output_sweeper,
 };
 let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
 now.elapsed().unwrap().as_millis()
 );
 *self.latest_chain_tip.write().unwrap() = Some(tip);

 periodically_archive_fully_resolved_monitors(
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)
@joostjagerjoostjagerAug 1, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.
 Arc::clone(&channel_manager),
 chain_monitor,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 Arc::clone(&self.node_metrics),
 )?;
 },
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
 locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
 locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
 write_node_metrics(
 &*locked_node_metrics,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 );
 match write_res {
 Ok(()) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to persist node metrics: {}", e);
 let res = Err(Error::PersistenceFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 },
 }
 )?;
Comment thread
joostjager marked this conversation as resolved.


 let res = Ok(());
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 res
 Ok(())
	}

	pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down

84 changes: 50 additions & 34 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
	}

	pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 let receiver_res = {
 let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
 })?;
 }

 let res = self.sync_onchain_wallet_inner().await;

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 // If this is our first sync, do a full scan with the configured gap limit.
 // Otherwise just do an incremental sync.
 let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
 apply_wallet_update(update_res, now)
 };

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	pub(crate) async fn sync_lightning_wallet(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let receiver_res = {
 let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
 })?;
 }

 let res =
 self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_lightning_wallet_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let res = electrum_client.sync_confirmables(confirmables).await;

 if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
 )?;
 }

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

Expand Down
Loading
Loading

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

Skip to content
Refactor chain sourcing logic to make result propagation more robust#599

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 6 commits into

from

Aug 1, 2025
 Merged


Refactor chain sourcing logic to make result propagation more robust
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fb34a27

Move inner code to `sync_lightning_wallet_inner` for Esplora


tnull Jul 31, 2025
c1157a3

Move inner code to `sync_onchain_wallet_inner` for Esplora


tnull Jul 31, 2025
c765545

Move inner code to `sync_lightning_wallet_inner` for Electrum


tnull Jul 31, 2025
128fdfd

Move inner code to `sync_onchain_wallet_inner` for Electrum


tnull Jul 31, 2025
9444bc4

Move inner code to `poll_and_update_listeners_inner`


tnull Jul 31, 2025
a6349a4

Call `periodically_archive_fully_resolved_monitors` for Bitcoind


tnull Jul 31, 2025

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


54 changes: 29 additions & 25 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
// accordance with one or both of these licenses.

use super::WalletSyncStatus;
use super::{periodically_archive_fully_resolved_monitors, WalletSyncStatus};

use crate::config::{
	BitcoindRestClientConfig, Config, FEE_RATE_CACHE_UPDATE_TIMEOUT_SECS, TX_BROADCAST_TIMEOUT_SECS,
Expand DownExpand Up@@ -306,6 +306,19 @@ impl BitcoindChainSource {
 })?;
 }

 let res = self
 .poll_and_update_listeners_inner(channel_manager, chain_monitor, output_sweeper)
 .await;

 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
Comment thread
joostjager marked this conversation as resolved.

	}

	async fn poll_and_update_listeners_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let latest_chain_tip_opt = self.latest_chain_tip.read().unwrap().clone();
 let chain_tip = if let Some(tip) = latest_chain_tip_opt {
 tip
Expand All@@ -317,9 +330,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cleanup here, does that mean that the previous commit would send redundant updates?
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean? We previously propagated manually whenever erroring out. But now we can just bubble up the error as we'll propagate to subscribers in the wrapping method.
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but before the change in this commit (this specific commit), was the propagate method being called twice? I am wondering if all commits in the stack are leaving the code in a correct state.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, that might be true. Happy to squash the cleanup if you prefer.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now went ahead and did so
 return res;
 return Err(Error::TxSyncFailed);
 },
 }
 };
Expand All@@ -329,7 +340,7 @@ impl BitcoindChainSource {
 let chain_listener = ChainListener {
 onchain_wallet: Arc::clone(&self.onchain_wallet),
 channel_manager: Arc::clone(&channel_manager),
 chain_monitor,
 chain_monitor: Arc::clone(&chain_monitor),
 output_sweeper,
 };
 let mut spv_client =
Expand All@@ -344,13 +355,19 @@ impl BitcoindChainSource {
 now.elapsed().unwrap().as_millis()
 );
 *self.latest_chain_tip.write().unwrap() = Some(tip);

 periodically_archive_fully_resolved_monitors(
@joostjagerjoostjagerAug 1, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context question: channel manager already knows the best block and I assume it is updated somehow, but still we need an external trigger here to archive? It seems responsibility is now with two units instead of one.
@tnulltnullAug 1, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far we left when/how to archive to the users in LDK. I guess we could consider making it part of the background processor eventually, but I don't think ChannelManager could do it (in absence of KVStore access, etc)
@joostjagerjoostjagerAug 1, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I was confused a bit about the two sources of block information being used (here the connection event, and then the height in cm). But if this is how it is done for now, it's ok.
 Arc::clone(&channel_manager),
 chain_monitor,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 Arc::clone(&self.node_metrics),
 )?;
 },
 Ok(_) => {},
 Err(e) => {
 log_error!(self.logger, "Failed to poll for chain data: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -376,9 +393,7 @@ impl BitcoindChainSource {
 },
 Err(e) => {
 log_error!(self.logger, "Failed to poll for mempool transactions: {:?}", e);
 let res = Err(Error::TxSyncFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 return Err(Error::TxSyncFailed);
 },
 }

Expand All@@ -388,24 +403,13 @@ impl BitcoindChainSource {
 locked_node_metrics.latest_lightning_wallet_sync_timestamp = unix_time_secs_opt;
 locked_node_metrics.latest_onchain_wallet_sync_timestamp = unix_time_secs_opt;

let write_res = write_node_metrics(
 write_node_metrics(
 &*locked_node_metrics,
 Arc::clone(&self.kv_store),
 Arc::clone(&self.logger),
 );
 match write_res {
 Ok(()) => (),
 Err(e) => {
 log_error!(self.logger, "Failed to persist node metrics: {}", e);
 let res = Err(Error::PersistenceFailed);
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 return res;
 },
 }
 )?;
Comment thread
joostjager marked this conversation as resolved.


 let res = Ok(());
 self.wallet_polling_status.lock().unwrap().propagate_result_to_subscribers(res);
 res
 Ok(())
	}

	pub(super) async fn update_fee_rate_estimates(&self) -> Result<(), Error> {
Expand Down

84 changes: 50 additions & 34 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,16 +103,6 @@ impl ElectrumChainSource {
	}

	pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 let receiver_res = {
 let mut status_lock = self.onchain_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -126,6 +116,24 @@ impl ElectrumChainSource {
 })?;
 }

 let res = self.sync_onchain_wallet_inner().await;

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_onchain_wallet_inner(&self) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the onchain wallet"
 );
 return Err(Error::FeerateEstimationUpdateFailed);
 };
 // If this is our first sync, do a full scan with the configured gap limit.
 // Otherwise just do an incremental sync.
 let incremental_sync =
Expand DownExpand Up@@ -179,35 +187,13 @@ impl ElectrumChainSource {
 apply_wallet_update(update_res, now)
 };

 self.onchain_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	pub(crate) async fn sync_lightning_wallet(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let receiver_res = {
 let mut status_lock = self.lightning_wallet_sync_status.lock().unwrap();
 status_lock.register_or_subscribe_pending_sync()
Expand All@@ -221,6 +207,38 @@ impl ElectrumChainSource {
 })?;
 }

 let res =
 self.sync_lightning_wallet_inner(channel_manager, chain_monitor, output_sweeper).await;

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

	async fn sync_lightning_wallet_inner(
 &self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
 output_sweeper: Arc<Sweeper>,
	) -> Result<(), Error> {
 let sync_cman = Arc::clone(&channel_manager);
 let sync_cmon = Arc::clone(&chain_monitor);
 let sync_sweeper = Arc::clone(&output_sweeper);
 let confirmables = vec![
 sync_cman as Arc<dyn Confirm + Sync + Send>,
 sync_cmon as Arc<dyn Confirm + Sync + Send>,
 sync_sweeper as Arc<dyn Confirm + Sync + Send>,
 ];

 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
 } else {
 debug_assert!(
 false,
 "We should have started the chain source before syncing the lightning wallet"
 );
 return Err(Error::TxSyncFailed);
 };

 let res = electrum_client.sync_confirmables(confirmables).await;

 if let Ok(_) = res {
Expand All@@ -245,8 +263,6 @@ impl ElectrumChainSource {
 )?;
 }

 self.lightning_wallet_sync_status.lock().unwrap().propagate_result_to_subscribers(res);

 res
	}

Expand Down
Loading
Loading