From be8c0d099d9fe132727606cdf019fb21d1e5a6a5 Mon Sep 17 00:00:00 2001 From: Elias Rohrer Date: Tue, 16 Apr 2024 14:50:51 +0200 Subject: [PATCH] Edit `Event::SpendableOutputs` docs to mention `OutputSweeper` --- lightning/src/events/mod.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs index f6e7f7164..4d644fe43 100644 --- a/lightning/src/events/mod.rs +++ b/lightning/src/events/mod.rs @@ -792,9 +792,15 @@ pub enum Event { }, /// Used to indicate that an output which you should know how to spend was confirmed on chain /// and is now spendable. - /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your + /// + /// Such an output will *never* be spent directly by LDK, and are not at risk of your /// counterparty spending them due to some kind of timeout. Thus, you need to store them /// somewhere and spend them when you create on-chain transactions. + /// + /// You may hand them to the [`OutputSweeper`] utility which will store and (re-)generate spending + /// transactions for you. + /// + /// [`OutputSweeper`]: crate::util::sweep::OutputSweeper SpendableOutputs { /// The outputs which you should store as spendable by you. outputs: Vec, -- 2.39.5