Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
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" + '
Prevent Electrum updates during shutdown by tnull · Pull Request #1054 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
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('^' + ".*" + ' Prevent Electrum updates during shutdown by tnull · Pull Request #1054 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
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('^' + ".*" + ' Prevent Electrum updates during shutdown by tnull · Pull Request #1054 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
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" + ' Prevent Electrum updates during shutdown by tnull · Pull Request #1054 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
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('^' + ".*" + ' Prevent Electrum updates during shutdown by tnull · Pull Request #1054 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
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('^' + ".*" + ' Prevent Electrum updates during shutdown by tnull · Pull Request #1054 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
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); } })(); })(); Prevent Electrum updates during shutdown by tnull · Pull Request #1054 · lightningdevkit/ldk-node · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
263 changes: 257 additions & 6 deletions src/chain/electrum.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@

use std::collections::{HashMap, HashSet};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::bdk_core::spk_client::{
Expand DownExpand Up@@ -95,7 +95,17 @@ impl ElectrumChainSource {
}

pub(super) fn stop(&self) {
self.electrum_runtime_status.write().expect("lock").stop();
let client = self.electrum_runtime_status.write().expect("lock").stop();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(super) fn begin_shutdown(&self) {
let client = self.electrum_runtime_status.read().expect("lock").client();
if let Some(client) = client {
client.begin_shutdown();
}
}

pub(crate) async fn sync_onchain_wallet(
Expand DownExpand Up@@ -243,7 +253,7 @@ impl ElectrumChainSource {
let sync_cman = Arc::clone(&channel_manager);
let sync_cmon = Arc::clone(&chain_monitor);
let sync_sweeper = Arc::clone(&output_sweeper);
let confirmables = vec![
let confirmables: Vec<Arc<dyn Confirm + Sync + Send>> = vec![
sync_cman as Arc<dyn Confirm + Sync + Send>,
sync_cmon as Arc<dyn Confirm + Sync + Send>,
sync_sweeper as Arc<dyn Confirm + Sync + Send>,
Expand All@@ -261,7 +271,8 @@ impl ElectrumChainSource {
return Err(Error::TxSyncFailed);
};

let res = electrum_client.sync_confirmables(confirmables).await;
let confirmable = electrum_client.wrap_confirmables(&confirmables);
let res = electrum_client.sync_confirmables(vec![confirmable]).await;

if let Ok(_) = res {
let unix_time_secs_opt =
Expand DownExpand Up@@ -436,10 +447,10 @@ impl ElectrumRuntimeStatus {
Ok(())
}

pub(super) fn stop(&mut self) {
pub(super) fn stop(&mut self) -> Option<Arc<ElectrumRuntimeClient>> {
// Drop the client, but retain the registration inventory so we can replay it if we're
// started again.
self.client = None;
self.client.take()
}

fn client(&self) -> Option<Arc<ElectrumRuntimeClient>> {
Expand DownExpand Up@@ -471,6 +482,7 @@ struct ElectrumRuntimeClient {
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
confirm_gate: Arc<ConfirmGate>,
}

impl ElectrumRuntimeClient {
Expand DownExpand Up@@ -507,9 +519,23 @@ impl ElectrumRuntimeClient {
runtime,
config,
logger,
confirm_gate: Arc::new(ConfirmGate::new()),
})
}

fn begin_shutdown(&self) {
self.confirm_gate.deactivate();
}

fn wrap_confirmables(
&self, confirmables: &[Arc<dyn Confirm + Sync + Send>],
) -> Arc<dyn Confirm + Sync + Send> {
Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&self.confirm_gate),
confirmables.iter().map(Arc::downgrade).collect(),
))
}

async fn sync_confirmables(
&self, confirmables: Vec<Arc<dyn Confirm + Sync + Send>>,
) -> Result<(), Error> {
Expand DownExpand Up@@ -539,6 +565,10 @@ impl ElectrumRuntimeClient {
Error::TxSyncFailed
})?;

if !self.confirm_gate.is_active() {
return Err(Error::TxSyncFailed);
}

log_debug!(
self.logger,
"Sync of Lightning wallet finished in {}ms.",
Expand DownExpand Up@@ -795,6 +825,89 @@ impl ElectrumRuntimeClient {
}
}

struct ConfirmGate {
active: Mutex<bool>,
}

impl ConfirmGate {
fn new() -> Self {
Self { active: Mutex::new(true) }
}

fn deactivate(&self) {
*self.active.lock().expect("lock") = false;
}

fn is_active(&self) -> bool {
*self.active.lock().expect("lock")
}
}

struct ShutdownAwareConfirm {
gate: Weak<ConfirmGate>,
confirmables: Vec<Weak<dyn Confirm + Sync + Send>>,
}

impl ShutdownAwareConfirm {
fn new(gate: Weak<ConfirmGate>, confirmables: Vec<Weak<dyn Confirm + Sync + Send>>) -> Self {
Self { gate, confirmables }
}

fn with_confirmables<T>(
&self, inactive_result: T, f: impl FnOnce(&[Arc<dyn Confirm + Sync + Send>]) -> T,
) -> T {
let Some(gate) = self.gate.upgrade() else {
return inactive_result;
};
let active = gate.active.lock().expect("lock");
if !*active {
return inactive_result;
}

let Some(confirmables): Option<Vec<Arc<dyn Confirm + Sync + Send>>> =
self.confirmables.iter().map(Weak::upgrade).collect()
else {
return inactive_result;
};
f(&confirmables)
}
}

impl Confirm for ShutdownAwareConfirm {
fn transactions_confirmed(
&self, header: &bitcoin::block::Header,
txdata: &lightning::chain::transaction::TransactionData<'_>, height: u32,
) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transactions_confirmed(header, txdata, height);
}
})
}

fn transaction_unconfirmed(&self, txid: &Txid) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.transaction_unconfirmed(txid);
}
})
}

fn best_block_updated(&self, header: &bitcoin::block::Header, height: u32) {
self.with_confirmables((), |confirmables| {
for confirmable in confirmables {
confirmable.best_block_updated(header, height);
}
})
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
self.with_confirmables(Vec::new(), |confirmables| {
confirmables.iter().flat_map(|confirmable| confirmable.get_relevant_txids()).collect()
})
}
}

impl Filter for ElectrumRuntimeClient {
fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
self.tx_sync.register_tx(txid, script_pubkey)
Expand All@@ -803,3 +916,141 @@ impl Filter for ElectrumRuntimeClient {
self.tx_sync.register_output(output)
}
}

#[cfg(test)]
mod tests {
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::mpsc;
use std::thread;

use bitcoin::blockdata::constants::genesis_block;

use super::*;

struct RecordingConfirm {
calls: AtomicUsize,
relevant_txid: Txid,
}

impl RecordingConfirm {
fn new(relevant_txid: Txid) -> Self {
Self { calls: AtomicUsize::new(0), relevant_txid }
}
}

impl Confirm for RecordingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn transaction_unconfirmed(&self, _txid: &Txid) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
vec![(self.relevant_txid, 0, None)]
}
}

struct BlockingConfirm {
calls: AtomicUsize,
started: Mutex<Option<mpsc::SyncSender<()>>>,
release: Mutex<mpsc::Receiver<()>>,
}

impl Confirm for BlockingConfirm {
fn transactions_confirmed(
&self, _header: &bitcoin::block::Header,
_txdata: &lightning::chain::transaction::TransactionData<'_>, _height: u32,
) {
}

fn transaction_unconfirmed(&self, _txid: &Txid) {}

fn best_block_updated(&self, _header: &bitcoin::block::Header, _height: u32) {
self.calls.fetch_add(1, Ordering::AcqRel);
if let Some(started) = self.started.lock().expect("lock").take() {
started.send(()).expect("test should still be waiting");
}
self.release.lock().expect("lock").recv().expect("test should release callback");
}

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<bitcoin::BlockHash>)> {
Vec::new()
}
}

#[test]
fn confirm_callbacks_are_ignored_after_shutdown() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let delegate = Arc::new(RecordingConfirm::new(txid));
let delegate_dyn: Arc<dyn Confirm + Sync + Send> = delegate.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm =
ShutdownAwareConfirm::new(Arc::downgrade(&gate), vec![Arc::downgrade(&delegate_dyn)]);

confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert_eq!(confirm.get_relevant_txids(), vec![(txid, 0, None)]);

gate.deactivate();
confirm.transactions_confirmed(&block.header, &[], 0);
confirm.transaction_unconfirmed(&txid);
confirm.best_block_updated(&block.header, 0);
assert_eq!(delegate.calls.load(Ordering::Acquire), 1);
assert!(confirm.get_relevant_txids().is_empty());
}

#[test]
fn shutdown_waits_for_the_whole_confirm_callback() {
let block = genesis_block(Network::Regtest);
let txid = block.txdata[0].compute_txid();
let (started_sender, started_receiver) = mpsc::sync_channel(1);
let (release_sender, release_receiver) = mpsc::sync_channel(1);
let blocking = Arc::new(BlockingConfirm {
calls: AtomicUsize::new(0),
started: Mutex::new(Some(started_sender)),
release: Mutex::new(release_receiver),
});
let trailing = Arc::new(RecordingConfirm::new(txid));
let blocking_dyn: Arc<dyn Confirm + Sync + Send> = blocking.clone();
let trailing_dyn: Arc<dyn Confirm + Sync + Send> = trailing.clone();
let gate = Arc::new(ConfirmGate::new());
let confirm = Arc::new(ShutdownAwareConfirm::new(
Arc::downgrade(&gate),
vec![Arc::downgrade(&blocking_dyn), Arc::downgrade(&trailing_dyn)],
));

let callback = {
let confirm = Arc::clone(&confirm);
thread::spawn(move || confirm.best_block_updated(&block.header, 0))
};
started_receiver.recv().expect("callback should start");

let (shutdown_done_sender, shutdown_done_receiver) = mpsc::sync_channel(1);
let shutdown = thread::spawn(move || {
gate.deactivate();
shutdown_done_sender.send(()).expect("test should still be waiting");
});
assert!(shutdown_done_receiver.recv_timeout(Duration::from_millis(50)).is_err());

release_sender.send(()).expect("callback should still be running");
callback.join().expect("callback should finish");
shutdown_done_receiver.recv().expect("shutdown should finish");
shutdown.join().expect("shutdown should not panic");

assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
confirm.best_block_updated(&block.header, 0);
assert_eq!(blocking.calls.load(Ordering::Acquire), 1);
assert_eq!(trailing.calls.load(Ordering::Acquire), 1);
}
}
12 changes: 12 additions & 0 deletions src/chain/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -255,6 +255,18 @@ impl ChainSource {
}
}

pub(crate) fn begin_shutdown(&self) {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.begin_shutdown()
},
_ => {
// Other chain sources don't leave synchronous callbacks running after their
// driving future is cancelled.
},
}
}

pub(crate) fn as_utxo_source(&self) -> Option<UtxoSourceClient> {
match &self.kind {
ChainSourceKind::Bitcoind(bitcoind_chain_source) => {
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -845,6 +845,10 @@ impl Node {

log_info!(self.logger, "Shutting down LDK Node with node ID {}...", self.node_id());

// Prevent blocking Electrum syncs from making any further callbacks before persistence
// tasks stop accepting work.
self.chain_source.begin_shutdown();

// Stop background tasks.
self.stop_sender
.send(())
Expand Down
Loading