Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
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
164 changes: 159 additions & 5 deletions lightning/src/util/sweep.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -488,12 +488,18 @@ where
return Ok(());
}

let result = self.regenerate_and_broadcast_spend_if_necessary_internal().await;

// Release the pending sweep flag again, regardless of result.
self.pending_sweep.store(false, Ordering::Release);
// Use an RAII guard so the flag is released even if this future is dropped mid-await
// (e.g. cancelled by `tokio::time::timeout` or `select!`). A bare `store(false)` after
// the await would never run on cancellation, leaving the sweeper permanently disabled.
struct PendingSweepGuard<'a>(&'a AtomicBool);
impl<'a> Drop for PendingSweepGuard<'a> {
fn drop(&mut self) {
self.0.store(false, Ordering::Release);
}
}
let _guard = PendingSweepGuard(&self.pending_sweep);

result
self.regenerate_and_broadcast_spend_if_necessary_internal().await
}

/// Regenerates and broadcasts the spending transaction for any outputs that are pending
Expand DownExpand Up@@ -1176,3 +1182,151 @@ where
Ok((best_block, OutputSweeperSync { sweeper }))
}
}

#[cfg(all(test, feature = "std"))]
mod tests {
use super::*;
use crate::chain::transaction::OutPoint;
use crate::sign::{ChangeDestinationSource, OutputSpender};
use crate::util::async_poll::dummy_waker;
use crate::util::logger::Record;
use crate::util::native_async::MaybeSend;

use bitcoin::hashes::Hash as _;
use bitcoin::secp256k1::All;
use bitcoin::transaction::Version;
use bitcoin::{Amount, BlockHash, ScriptBuf, Transaction, TxOut, Txid};

use core::future as core_future;
use core::pin::pin;
use core::sync::atomic::Ordering;
use core::task::Poll;

struct DummyBroadcaster;
impl BroadcasterInterface for DummyBroadcaster {
fn broadcast_transactions(&self, _: &[(&Transaction, TransactionType)]) {}
}

struct DummyFeeEstimator;
impl FeeEstimator for DummyFeeEstimator {
fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
1000
}
}

struct DummyFilter;
impl Filter for DummyFilter {
fn register_tx(&self, _: &Txid, _: &bitcoin::Script) {}
fn register_output(&self, _: WatchedOutput) {}
}

struct DummyLogger;
impl Logger for DummyLogger {
fn log(&self, _: Record) {}
}

struct DummyOutputSpender;
impl OutputSpender for DummyOutputSpender {
fn spend_spendable_outputs(
&self, _: &[&SpendableOutputDescriptor], _: Vec<TxOut>, _: ScriptBuf, _: u32,
_: Option<LockTime>, _: &Secp256k1<All>,
) -> Result<Transaction, ()> {
Ok(Transaction {
version: Version::TWO,
lock_time: LockTime::ZERO,
input: Vec::new(),
output: Vec::new(),
})
}
}

struct DummyChangeDestSource;
impl ChangeDestinationSource for DummyChangeDestSource {
fn get_change_destination_script<'a>(
&'a self,
) -> impl Future<Output = Result<ScriptBuf, ()>> + MaybeSend + 'a {
core_future::ready(Ok(ScriptBuf::new()))
}
}

struct PendingKVStore;
impl KVStore for PendingKVStore {
fn read(
&self, _: &str, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + 'static + MaybeSend {
core_future::ready(Err(io::Error::new(io::ErrorKind::NotFound, "")))
}
fn write(
&self, _: &str, _: &str, _: &str, _: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::pending()
}
fn remove(
&self, _: &str, _: &str, _: &str, _: bool,
) -> impl Future<Output = Result<(), io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(()))
}
fn list(
&self, _: &str, _: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + 'static + MaybeSend {
core_future::ready(Ok(Vec::new()))
}
}

#[test]
fn pending_sweep_flag_resets_after_future_drop() {
let best_block = BlockLocator::new(BlockHash::all_zeros(), 1_000);

let sweeper: OutputSweeper<
DummyBroadcaster,
Box<DummyChangeDestSource>,
DummyFeeEstimator,
DummyFilter,
PendingKVStore,
DummyLogger,
DummyOutputSpender,
> = OutputSweeper::new(
best_block,
DummyBroadcaster,
DummyFeeEstimator,
None,
DummyOutputSpender,
Box::new(DummyChangeDestSource),
PendingKVStore,
DummyLogger,
);

// Inject a tracked output directly so the sweep loop has work to do.
let descriptor = SpendableOutputDescriptor::StaticOutput {
outpoint: OutPoint { txid: Txid::all_zeros(), index: 0 },
output: TxOut { value: Amount::from_sat(100_000), script_pubkey: ScriptBuf::new() },
channel_keys_id: None,
};
sweeper.sweeper_state.lock().unwrap().outputs.push(TrackedSpendableOutput {
descriptor,
channel_id: None,
counterparty_node_id: None,
status: OutputSpendStatus::PendingInitialBroadcast { delayed_until_height: None },
});

// Start a sweep, poll once (the persist step stays Pending because our KVStore's
// `write` future is `future::pending()`), then drop the future to mimic
// cancellation - the sort of thing a `tokio::time::timeout` wrapper produces.
{
let mut fut = pin!(sweeper.regenerate_and_broadcast_spend_if_necessary());
let waker = dummy_waker();
let mut ctx = task::Context::from_waker(&waker);
assert!(matches!(fut.as_mut().poll(&mut ctx), Poll::Pending));
}

// Once the future has been dropped, `pending_sweep` must be cleared. The bug
// is that the flag is only ever cleared after the inner future returns, so a
// dropped future leaves it stuck `true` and every subsequent call to
// `regenerate_and_broadcast_spend_if_necessary` short-circuits with `Ok(())`,
// permanently disabling the sweeper.
assert!(
!sweeper.pending_sweep.load(Ordering::Acquire),
"pending_sweep flag was not reset when the future was dropped",
);
}
}
Loading