Skip to content

Commit

Permalink
Edit Event::SpendableOutputs docs to mention OutputSweeper
Browse files Browse the repository at this point in the history
  • Loading branch information
tnull committed Apr 16, 2024
1 parent bffd030 commit 4dfcfc0
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion lightning/src/events/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 *not* ever 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<SpendableOutputDescriptor>,
Expand Down

0 comments on commit 4dfcfc0

Please sign in to comment.