projects
/
rust-lightning
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
681106d
)
Edit `Event::SpendableOutputs` docs to mention `OutputSweeper`
author
Elias Rohrer
<dev@tnull.de>
Tue, 16 Apr 2024 12:50:51 +0000
(14:50 +0200)
committer
Elias Rohrer
<dev@tnull.de>
Thu, 18 Apr 2024 14:20:03 +0000
(16:20 +0200)
lightning/src/events/mod.rs
patch
|
blob
|
history
diff --git
a/lightning/src/events/mod.rs
b/lightning/src/events/mod.rs
index f6e7f7164874f0de97fb56a8dc3c4294d2206c94..4d644fe43f8e48c318c754ff6ebb968cd31b326d 100644
(file)
--- 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.
},
/// 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.
/// 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>,
SpendableOutputs {
/// The outputs which you should store as spendable by you.
outputs: Vec<SpendableOutputDescriptor>,