Skip to content

Wait on all background tasks to finish (or abort)#612

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 4 commits into from
Aug 14, 2025
Merged

Wait on all background tasks to finish (or abort) #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ff4890
Add test that drops the node in an async context
tnull Aug 14, 2025
b7c0704
Have `ChainSource` hold `tx_broadcaster` reference
tnull Aug 14, 2025
6b9d899
Move continuous tx broadcast processing loop to `ChainSource`
tnull Aug 14, 2025
17a45dd
Wait on all background tasks to finish (or abort)
tnull Aug 14, 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
4 changes: 4 additions & 0 deletions src/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

let (stop_sender, _) = tokio::sync::watch::channel(());
let background_processor_task = Mutex::new(None);
let background_tasks = Mutex::new(None);
let cancellable_background_tasks = Mutex::new(None);

Ok(Node {
runtime,
stop_sender,
background_processor_task,
background_tasks,
cancellable_background_tasks,
config,
wallet,
chain_source,
Expand Down
76 changes: 32 additions & 44 deletions src/chain/bitcoind.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
onchain_wallet: Arc<Wallet>,
wallet_polling_status: Mutex<WalletSyncStatus>,
fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>,
kv_store: Arc<DynStore>,
config: Arc<Config>,
logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
pub(crate) fn new_rpc(
rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Self {
let api_client = Arc::new(BitcoindClient::new_rpc(
rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
onchain_wallet,
wallet_polling_status,
fee_estimator,
tx_broadcaster,
kv_store,
config,
logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
pub(crate) fn new_rest(
rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Self {
let api_client = Arc::new(BitcoindClient::new_rest(
rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
wallet_polling_status,
onchain_wallet,
fee_estimator,
tx_broadcaster,
kv_store,
config,
logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
Ok(())
}

pub(crate) async fn process_broadcast_queue(&self) {
pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
// While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
// features, we should eventually switch to use `submitpackage` via the
// `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
// transactions.
let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
while let Some(next_package) = receiver.recv().await {
for tx in &next_package {
let txid = tx.compute_txid();
let timeout_fut = tokio::time::timeout(
Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
self.api_client.broadcast_transaction(tx),
);
match timeout_fut.await {
Ok(res) => match res {
Ok(id) => {
debug_assert_eq!(id, txid);
log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
},
for tx in &package {
let txid = tx.compute_txid();
let timeout_fut = tokio::time::timeout(
Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
self.api_client.broadcast_transaction(tx),
);
match timeout_fut.await {
Ok(res) => match res {
Ok(id) => {
debug_assert_eq!(id, txid);
log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
},
}
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
},
}
}
}
Expand Down
18 changes: 6 additions & 12 deletions src/chain/electrum.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>,
kv_store: Arc<DynStore>,
config: Arc<Config>,
logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
pub(super) fn new(
server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
node_metrics: Arc<RwLock<NodeMetrics>>,
fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Self {
let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
onchain_wallet_sync_status,
lightning_wallet_sync_status,
fee_estimator,
tx_broadcaster,
kv_store,
config,
logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
Ok(())
}

pub(crate) async fn process_broadcast_queue(&self) {
pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
let electrum_client: Arc<ElectrumRuntimeClient> =
if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
return;
};

let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
while let Some(next_package) = receiver.recv().await {
for tx in next_package {
electrum_client.broadcast(tx).await;
}
for tx in package {
electrum_client.broadcast(tx).await;
}
}
}
Expand Down
131 changes: 63 additions & 68 deletions src/chain/esplora.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>,
kv_store: Arc<DynStore>,
config: Arc<Config>,
logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
pub(crate) fn new(
server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Self {
// FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
// `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
tx_sync,
lightning_wallet_sync_status,
fee_estimator,
tx_broadcaster,
kv_store,
config,
logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
Ok(())
}

pub(crate) async fn process_broadcast_queue(&self) {
let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
while let Some(next_package) = receiver.recv().await {
for tx in &next_package {
let txid = tx.compute_txid();
let timeout_fut = tokio::time::timeout(
Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
self.esplora_client.broadcast(tx),
);
match timeout_fut.await {
Ok(res) => match res {
Ok(()) => {
log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
},
Err(e) => match e {
esplora_client::Error::HttpResponse { status, message } => {
if status == 400 {
// Log 400 at lesser level, as this often just means bitcoind already knows the
// transaction.
// FIXME: We can further differentiate here based on the error
// message which will be available with rust-esplora-client 0.7 and
// later.
log_trace!(
self.logger,
"Failed to broadcast due to HTTP connection error: {}",
message
);
} else {
log_error!(
self.logger,
"Failed to broadcast due to HTTP connection error: {} - {}",
status,
message
);
}
pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
for tx in &package {
let txid = tx.compute_txid();
let timeout_fut = tokio::time::timeout(
Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
self.esplora_client.broadcast(tx),
);
match timeout_fut.await {
Ok(res) => match res {
Ok(()) => {
log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
},
Err(e) => match e {
esplora_client::Error::HttpResponse { status, message } => {
if status == 400 {
// Log 400 at lesser level, as this often just means bitcoind already knows the
// transaction.
// FIXME: We can further differentiate here based on the error
// message which will be available with rust-esplora-client 0.7 and
// later.
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
"Failed to broadcast due to HTTP connection error: {}",
message
);
},
_ => {
} else {
log_error!(
self.logger,
"Failed to broadcast transaction {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
"Failed to broadcast due to HTTP connection error: {} - {}",
status,
message
);
},
}
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
},
_ => {
log_error!(
self.logger,
"Failed to broadcast transaction {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
},
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
},
}
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
},
}
}
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Wait on all background tasks to finish (or abort) by tnull · Pull Request #612 · lightningdevkit/ldk-node · GitHub
Skip to content
Wait on all background tasks to finish (or abort)#612

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

from

Aug 14, 2025
 Merged


Wait on all background tasks to finish (or abort)
#612
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3ff4890

Add test that drops the node in an async context


tnull Aug 14, 2025
b7c0704

Have `ChainSource` hold `tx_broadcaster` reference


tnull Aug 14, 2025
6b9d899

Move continuous tx broadcast processing loop to `ChainSource`


tnull Aug 14, 2025
17a45dd

Wait on all background tasks to finish (or abort)


tnull Aug 14, 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


4 changes: 4 additions & 0 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

	let (stop_sender, _) = tokio::sync::watch::channel(());
	let background_processor_task = Mutex::new(None);
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	Ok(Node {
 runtime,
 stop_sender,
 background_processor_task,
 background_tasks,
 cancellable_background_tasks,
 config,
 wallet,
 chain_source,
Expand Down

76 changes: 32 additions & 44 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
	onchain_wallet: Arc<Wallet>,
	wallet_polling_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rpc(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rpc(
 rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
 onchain_wallet,
 wallet_polling_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rest(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rest(
 rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
 wallet_polling_status,
 onchain_wallet,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 // While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
 // features, we should eventually switch to use `submitpackage` via the
 // `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
 // transactions.
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 }
	}
Expand Down

18 changes: 6 additions & 12 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
	onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
	pub(super) fn new(
 server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
 let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
 onchain_wallet_sync_status,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
 return;
 };

 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in next_package {
 electrum_client.broadcast(tx).await;
 }
 for tx in package {
 electrum_client.broadcast(tx).await;
 }
	}
}
Expand Down

131 changes: 63 additions & 68 deletions
src/chain/esplora.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
	tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
	pub(crate) fn new(
 server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 // FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
 // `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
 tx_sync,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {}",
 message
 );
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 }
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {}",
message
 );
 },
 _ => {
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 },
 }
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 _ => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 },
	Err(e) => {
 log_error!(
 self.logger,
	"Failed to broadcast transaction due to timeout {}: {}",
	txid,
	e
);
	log_trace!(
 self.logger,
	"Failed broadcast transaction bytes: {}",
	log_bytes!(tx.encode())
);
},
 }
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
 },
 }
 }
	}
Expand Down
Loading
Loading

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

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

from

Aug 14, 2025
 Merged


Wait on all background tasks to finish (or abort)
#612
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3ff4890

Add test that drops the node in an async context


tnull Aug 14, 2025
b7c0704

Have `ChainSource` hold `tx_broadcaster` reference


tnull Aug 14, 2025
6b9d899

Move continuous tx broadcast processing loop to `ChainSource`


tnull Aug 14, 2025
17a45dd

Wait on all background tasks to finish (or abort)


tnull Aug 14, 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


4 changes: 4 additions & 0 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

	let (stop_sender, _) = tokio::sync::watch::channel(());
	let background_processor_task = Mutex::new(None);
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	Ok(Node {
 runtime,
 stop_sender,
 background_processor_task,
 background_tasks,
 cancellable_background_tasks,
 config,
 wallet,
 chain_source,
Expand Down

76 changes: 32 additions & 44 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
	onchain_wallet: Arc<Wallet>,
	wallet_polling_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rpc(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rpc(
 rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
 onchain_wallet,
 wallet_polling_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rest(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rest(
 rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
 wallet_polling_status,
 onchain_wallet,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 // While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
 // features, we should eventually switch to use `submitpackage` via the
 // `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
 // transactions.
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 }
	}
Expand Down

18 changes: 6 additions & 12 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
	onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
	pub(super) fn new(
 server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
 let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
 onchain_wallet_sync_status,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
 return;
 };

 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in next_package {
 electrum_client.broadcast(tx).await;
 }
 for tx in package {
 electrum_client.broadcast(tx).await;
 }
	}
}
Expand Down

131 changes: 63 additions & 68 deletions
src/chain/esplora.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
	tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
	pub(crate) fn new(
 server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 // FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
 // `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
 tx_sync,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {}",
 message
 );
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 }
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {}",
message
 );
 },
 _ => {
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 },
 }
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 _ => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 },
	Err(e) => {
 log_error!(
 self.logger,
	"Failed to broadcast transaction due to timeout {}: {}",
	txid,
	e
);
	log_trace!(
 self.logger,
	"Failed broadcast transaction bytes: {}",
	log_bytes!(tx.encode())
);
},
 }
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
 },
 }
 }
	}
Expand Down
Loading
Loading

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

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

from

Aug 14, 2025
 Merged


Wait on all background tasks to finish (or abort)
#612
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3ff4890

Add test that drops the node in an async context


tnull Aug 14, 2025
b7c0704

Have `ChainSource` hold `tx_broadcaster` reference


tnull Aug 14, 2025
6b9d899

Move continuous tx broadcast processing loop to `ChainSource`


tnull Aug 14, 2025
17a45dd

Wait on all background tasks to finish (or abort)


tnull Aug 14, 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


4 changes: 4 additions & 0 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

	let (stop_sender, _) = tokio::sync::watch::channel(());
	let background_processor_task = Mutex::new(None);
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	Ok(Node {
 runtime,
 stop_sender,
 background_processor_task,
 background_tasks,
 cancellable_background_tasks,
 config,
 wallet,
 chain_source,
Expand Down

76 changes: 32 additions & 44 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
	onchain_wallet: Arc<Wallet>,
	wallet_polling_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rpc(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rpc(
 rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
 onchain_wallet,
 wallet_polling_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rest(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rest(
 rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
 wallet_polling_status,
 onchain_wallet,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 // While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
 // features, we should eventually switch to use `submitpackage` via the
 // `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
 // transactions.
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 }
	}
Expand Down

18 changes: 6 additions & 12 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
	onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
	pub(super) fn new(
 server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
 let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
 onchain_wallet_sync_status,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
 return;
 };

 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in next_package {
 electrum_client.broadcast(tx).await;
 }
 for tx in package {
 electrum_client.broadcast(tx).await;
 }
	}
}
Expand Down

131 changes: 63 additions & 68 deletions
src/chain/esplora.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
	tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
	pub(crate) fn new(
 server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 // FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
 // `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
 tx_sync,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {}",
 message
 );
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 }
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {}",
message
 );
 },
 _ => {
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 },
 }
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 _ => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 },
	Err(e) => {
 log_error!(
 self.logger,
	"Failed to broadcast transaction due to timeout {}: {}",
	txid,
	e
);
	log_trace!(
 self.logger,
	"Failed broadcast transaction bytes: {}",
	log_bytes!(tx.encode())
);
},
 }
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
 },
 }
 }
	}
Expand Down
Loading
Loading

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

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

from

Aug 14, 2025
 Merged


Wait on all background tasks to finish (or abort)
#612
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3ff4890

Add test that drops the node in an async context


tnull Aug 14, 2025
b7c0704

Have `ChainSource` hold `tx_broadcaster` reference


tnull Aug 14, 2025
6b9d899

Move continuous tx broadcast processing loop to `ChainSource`


tnull Aug 14, 2025
17a45dd

Wait on all background tasks to finish (or abort)


tnull Aug 14, 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


4 changes: 4 additions & 0 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

	let (stop_sender, _) = tokio::sync::watch::channel(());
	let background_processor_task = Mutex::new(None);
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	Ok(Node {
 runtime,
 stop_sender,
 background_processor_task,
 background_tasks,
 cancellable_background_tasks,
 config,
 wallet,
 chain_source,
Expand Down

76 changes: 32 additions & 44 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
	onchain_wallet: Arc<Wallet>,
	wallet_polling_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rpc(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rpc(
 rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
 onchain_wallet,
 wallet_polling_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rest(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rest(
 rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
 wallet_polling_status,
 onchain_wallet,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 // While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
 // features, we should eventually switch to use `submitpackage` via the
 // `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
 // transactions.
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 }
	}
Expand Down

18 changes: 6 additions & 12 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
	onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
	pub(super) fn new(
 server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
 let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
 onchain_wallet_sync_status,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
 return;
 };

 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in next_package {
 electrum_client.broadcast(tx).await;
 }
 for tx in package {
 electrum_client.broadcast(tx).await;
 }
	}
}
Expand Down

131 changes: 63 additions & 68 deletions
src/chain/esplora.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
	tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
	pub(crate) fn new(
 server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 // FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
 // `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
 tx_sync,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {}",
 message
 );
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 }
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {}",
message
 );
 },
 _ => {
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 },
 }
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 _ => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 },
	Err(e) => {
 log_error!(
 self.logger,
	"Failed to broadcast transaction due to timeout {}: {}",
	txid,
	e
);
	log_trace!(
 self.logger,
	"Failed broadcast transaction bytes: {}",
	log_bytes!(tx.encode())
);
},
 }
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
 },
 }
 }
	}
Expand Down
Loading
Loading

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

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

from

Aug 14, 2025
 Merged


Wait on all background tasks to finish (or abort)
#612
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3ff4890

Add test that drops the node in an async context


tnull Aug 14, 2025
b7c0704

Have `ChainSource` hold `tx_broadcaster` reference


tnull Aug 14, 2025
6b9d899

Move continuous tx broadcast processing loop to `ChainSource`


tnull Aug 14, 2025
17a45dd

Wait on all background tasks to finish (or abort)


tnull Aug 14, 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


4 changes: 4 additions & 0 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

	let (stop_sender, _) = tokio::sync::watch::channel(());
	let background_processor_task = Mutex::new(None);
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	Ok(Node {
 runtime,
 stop_sender,
 background_processor_task,
 background_tasks,
 cancellable_background_tasks,
 config,
 wallet,
 chain_source,
Expand Down

76 changes: 32 additions & 44 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
	onchain_wallet: Arc<Wallet>,
	wallet_polling_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rpc(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rpc(
 rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
 onchain_wallet,
 wallet_polling_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rest(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rest(
 rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
 wallet_polling_status,
 onchain_wallet,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 // While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
 // features, we should eventually switch to use `submitpackage` via the
 // `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
 // transactions.
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 }
	}
Expand Down

18 changes: 6 additions & 12 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
	onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
	pub(super) fn new(
 server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
 let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
 onchain_wallet_sync_status,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
 return;
 };

 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in next_package {
 electrum_client.broadcast(tx).await;
 }
 for tx in package {
 electrum_client.broadcast(tx).await;
 }
	}
}
Expand Down

131 changes: 63 additions & 68 deletions
src/chain/esplora.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
	tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
	pub(crate) fn new(
 server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 // FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
 // `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
 tx_sync,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {}",
 message
 );
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 }
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {}",
message
 );
 },
 _ => {
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 },
 }
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 _ => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 },
	Err(e) => {
 log_error!(
 self.logger,
	"Failed to broadcast transaction due to timeout {}: {}",
	txid,
	e
);
	log_trace!(
 self.logger,
	"Failed broadcast transaction bytes: {}",
	log_bytes!(tx.encode())
);
},
 }
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
 },
 }
 }
	}
Expand Down
Loading
Loading

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

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

from

Aug 14, 2025
 Merged


Wait on all background tasks to finish (or abort)
#612
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3ff4890

Add test that drops the node in an async context


tnull Aug 14, 2025
b7c0704

Have `ChainSource` hold `tx_broadcaster` reference


tnull Aug 14, 2025
6b9d899

Move continuous tx broadcast processing loop to `ChainSource`


tnull Aug 14, 2025
17a45dd

Wait on all background tasks to finish (or abort)


tnull Aug 14, 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


4 changes: 4 additions & 0 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

	let (stop_sender, _) = tokio::sync::watch::channel(());
	let background_processor_task = Mutex::new(None);
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	Ok(Node {
 runtime,
 stop_sender,
 background_processor_task,
 background_tasks,
 cancellable_background_tasks,
 config,
 wallet,
 chain_source,
Expand Down

76 changes: 32 additions & 44 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
	onchain_wallet: Arc<Wallet>,
	wallet_polling_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rpc(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rpc(
 rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
 onchain_wallet,
 wallet_polling_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rest(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rest(
 rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
 wallet_polling_status,
 onchain_wallet,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 // While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
 // features, we should eventually switch to use `submitpackage` via the
 // `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
 // transactions.
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 }
	}
Expand Down

18 changes: 6 additions & 12 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
	onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
	pub(super) fn new(
 server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
 let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
 onchain_wallet_sync_status,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
 return;
 };

 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in next_package {
 electrum_client.broadcast(tx).await;
 }
 for tx in package {
 electrum_client.broadcast(tx).await;
 }
	}
}
Expand Down

131 changes: 63 additions & 68 deletions
src/chain/esplora.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
	tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
	pub(crate) fn new(
 server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 // FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
 // `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
 tx_sync,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {}",
 message
 );
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 }
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {}",
message
 );
 },
 _ => {
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 },
 }
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 _ => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 },
	Err(e) => {
 log_error!(
 self.logger,
	"Failed to broadcast transaction due to timeout {}: {}",
	txid,
	e
);
	log_trace!(
 self.logger,
	"Failed broadcast transaction bytes: {}",
	log_bytes!(tx.encode())
);
},
 }
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
 },
 }
 }
	}
Expand Down
Loading
Loading

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

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

from

Aug 14, 2025
 Merged


Wait on all background tasks to finish (or abort)
#612
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3ff4890

Add test that drops the node in an async context


tnull Aug 14, 2025
b7c0704

Have `ChainSource` hold `tx_broadcaster` reference


tnull Aug 14, 2025
6b9d899

Move continuous tx broadcast processing loop to `ChainSource`


tnull Aug 14, 2025
17a45dd

Wait on all background tasks to finish (or abort)


tnull Aug 14, 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


4 changes: 4 additions & 0 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1632,11 +1632,15 @@ fn build_with_store_internal(

	let (stop_sender, _) = tokio::sync::watch::channel(());
	let background_processor_task = Mutex::new(None);
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	Ok(Node {
 runtime,
 stop_sender,
 background_processor_task,
 background_tasks,
 cancellable_background_tasks,
 config,
 wallet,
 chain_source,
Expand Down

76 changes: 32 additions & 44 deletions
src/chain/bitcoind.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::chaininterface::ConfirmationTarget as LdkConfirmationTarget;
Expand DownExpand Up@@ -54,7 +54,6 @@ pub(super) struct BitcoindChainSource {
	onchain_wallet: Arc<Wallet>,
	wallet_polling_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -65,8 +64,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rpc(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rpc(
 rpc_host.clone(),
Expand All@@ -85,7 +84,6 @@ impl BitcoindChainSource {
 onchain_wallet,
 wallet_polling_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand All@@ -96,9 +94,8 @@ impl BitcoindChainSource {
	pub(crate) fn new_rest(
 rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 rest_client_config: BitcoindRestClientConfig, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 kv_store: Arc<DynStore>, config: Arc<Config>, rest_client_config: BitcoindRestClientConfig,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let api_client = Arc::new(BitcoindClient::new_rest(
 rest_client_config.rest_host,
Expand All@@ -120,7 +117,6 @@ impl BitcoindChainSource {
 wallet_polling_status,
 onchain_wallet,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -530,53 +526,45 @@ impl BitcoindChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 // While it's a bit unclear when we'd be able to lean on Bitcoin Core >v28
 // features, we should eventually switch to use `submitpackage` via the
 // `rust-bitcoind-json-rpc` crate rather than just broadcasting individual
 // transactions.
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.api_client.broadcast_transaction(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(id) => {
 debug_assert_eq!(id, txid);
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_error!(self.logger, "Failed to broadcast transaction {}: {}", txid, e);
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 },
 Err(e) => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction due to timeout {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 }
 }
	}
Expand Down

18 changes: 6 additions & 12 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand DownExpand Up@@ -56,7 +56,6 @@ pub(super) struct ElectrumChainSource {
	onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -66,9 +65,8 @@ pub(super) struct ElectrumChainSource {
impl ElectrumChainSource {
	pub(super) fn new(
 server_url: String, sync_config: ElectrumSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
 fee_estimator: Arc<OnchainFeeEstimator>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let electrum_runtime_status = RwLock::new(ElectrumRuntimeStatus::new());
 let onchain_wallet_sync_status = Mutex::new(WalletSyncStatus::Completed);
Expand All@@ -81,7 +79,6 @@ impl ElectrumChainSource {
 onchain_wallet_sync_status,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger: Arc::clone(&logger),
Expand DownExpand Up@@ -302,7 +299,7 @@ impl ElectrumChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 let electrum_client: Arc<ElectrumRuntimeClient> =
 if let Some(client) = self.electrum_runtime_status.read().unwrap().client().as_ref() {
 Arc::clone(client)
Expand All@@ -311,11 +308,8 @@ impl ElectrumChainSource {
 return;
 };

 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in next_package {
 electrum_client.broadcast(tx).await;
 }
 for tx in package {
 electrum_client.broadcast(tx).await;
 }
	}
}
Expand Down

131 changes: 63 additions & 68 deletions
src/chain/esplora.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

use lightning::chain::{Confirm, Filter, WatchedOutput};
Expand All@@ -30,7 +30,7 @@ use bdk_esplora::EsploraAsyncExt;

use esplora_client::AsyncClient as EsploraAsyncClient;

use bitcoin::{FeeRate, Network, Script, Txid};
use bitcoin::{FeeRate, Network, Script, Transaction, Txid};

use std::collections::HashMap;
use std::sync::{Arc, Mutex, RwLock};
Expand All@@ -44,7 +44,6 @@ pub(super) struct EsploraChainSource {
	tx_sync: Arc<EsploraSyncClient<Arc<Logger>>>,
	lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
	fee_estimator: Arc<OnchainFeeEstimator>,
	tx_broadcaster: Arc<Broadcaster>,
	kv_store: Arc<DynStore>,
	config: Arc<Config>,
	logger: Arc<Logger>,
Expand All@@ -55,8 +54,8 @@ impl EsploraChainSource {
	pub(crate) fn new(
 server_url: String, headers: HashMap<String, String>, sync_config: EsploraSyncConfig,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<Logger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<Logger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 // FIXME / TODO: We introduced this to make `bdk_esplora` work separately without updating
 // `lightning-transaction-sync`. We should revert this as part of of the upgrade to LDK 0.2.
Expand DownExpand Up@@ -90,7 +89,6 @@ impl EsploraChainSource {
 tx_sync,
 lightning_wallet_sync_status,
 fee_estimator,
 tx_broadcaster,
 kv_store,
 config,
 logger,
Expand DownExpand Up@@ -372,76 +370,73 @@ impl EsploraChainSource {
 Ok(())
	}

	pub(crate) async fn process_broadcast_queue(&self) {
 let mut receiver = self.tx_broadcaster.get_broadcast_queue().await;
 while let Some(next_package) = receiver.recv().await {
 for tx in &next_package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {}",
 message
 );
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 }
	pub(crate) async fn process_broadcast_package(&self, package: Vec<Transaction>) {
 for tx in &package {
 let txid = tx.compute_txid();
 let timeout_fut = tokio::time::timeout(
 Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS),
 self.esplora_client.broadcast(tx),
 );
 match timeout_fut.await {
 Ok(res) => match res {
 Ok(()) => {
 log_trace!(self.logger, "Successfully broadcast transaction {}", txid);
 },
 Err(e) => match e {
 esplora_client::Error::HttpResponse { status, message } => {
 if status == 400 {
 // Log 400 at lesser level, as this often just means bitcoind already knows the
 // transaction.
 // FIXME: We can further differentiate here based on the error
 // message which will be available with rust-esplora-client 0.7 and
 // later.
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {}",
message
 );
 },
 _ => {
 } else {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 "Failed to broadcast due to HTTP connection error: {} - {}",
 status,
 message
 );
 },
 }
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 _ => {
 log_error!(
 self.logger,
 "Failed to broadcast transaction {}: {}",
 txid,
 e
 );
 log_trace!(
 self.logger,
 "Failed broadcast transaction bytes: {}",
 log_bytes!(tx.encode())
 );
 },
 },
	Err(e) => {
 log_error!(
 self.logger,
	"Failed to broadcast transaction due to timeout {}: {}",
	txid,
	e
);
	log_trace!(
 self.logger,
	"Failed broadcast transaction bytes: {}",
	log_bytes!(tx.encode())
);
},
 }
},
Err(e) => {
log_error!(
self.logger,
"Failed to broadcast transaction due to timeout {}: {}",
txid,
e
);
log_trace!(
self.logger,
"Failed broadcast transaction bytes: {}",
log_bytes!(tx.encode())
);
 },
 }
 }
	}
Expand Down
Loading
Loading