Skip to content

Commit be8c0d0

Browse files
committed
Edit Event::SpendableOutputs docs to mention OutputSweeper
1 parent 681106d commit be8c0d0

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

lightning/src/events/mod.rs

+7-1
Original file line numberDiff line numberDiff line change
@@ -792,9 +792,15 @@ pub enum Event {
792792
},
793793
/// Used to indicate that an output which you should know how to spend was confirmed on chain
794794
/// and is now spendable.
795-
/// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
795+
///
796+
/// Such an output will *never* be spent directly by LDK, and are not at risk of your
796797
/// counterparty spending them due to some kind of timeout. Thus, you need to store them
797798
/// somewhere and spend them when you create on-chain transactions.
799+
///
800+
/// You may hand them to the [`OutputSweeper`] utility which will store and (re-)generate spending
801+
/// transactions for you.
802+
///
803+
/// [`OutputSweeper`]: crate::util::sweep::OutputSweeper
798804
SpendableOutputs {
799805
/// The outputs which you should store as spendable by you.
800806
outputs: Vec<SpendableOutputDescriptor>,

0 commit comments

Comments
 (0)