mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 23:08:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Edit Event::SpendableOutputs docs to mention OutputSweeper

Browse source
This commit is contained in:
Elias Rohrer 2024-04-16 14:50:51 +02:00
parent 681106d23f
commit be8c0d099d
No known key found for this signature in database
GPG key ID: 36153082BDF676FD
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lightning/src/events/mod.rs
View file

@ -792,9 +792,15 @@ pub enum Event {
}, },
/// Used to indicate that an output which you should know how to spend was confirmed on chain /// Used to indicate that an output which you should know how to spend was confirmed on chain
/// and is now spendable. /// 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 /// 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. /// 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 { SpendableOutputs {
/// The outputs which you should store as spendable by you. /// The outputs which you should store as spendable by you.
outputs: Vec<SpendableOutputDescriptor>, outputs: Vec<SpendableOutputDescriptor>,