Add missing documentation for sigs-ready event to `splice_channel`
What the developer wrote
Authored by Matt Corallo
Add missing documentation for sigs-ready event to `splice_channel`
`ChannelManager::splice_channel` initiates a splice which
ultimately generates a series of events. The most important of
which, `FundingTransactionReadyForSigning` (which must always be
handled, unlike the others), was not documented.
Here we mention the event generation.
What changed, and why it matters
This commit only adds a missing documentation comment to the splice_channel function. It explains that a FundingTransactionReadyForSigning event will be generated after signatures are exchanged, and that funding_transaction_signed should then be called. There is no code change, bug fix, or security patch.
No action required. This is a documentation-only change with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds three lines of Rust doc comments to ChannelManager::splice_channel in lightning/src/ln/channelmanager.rs. It documents the existing Event::FundingTransactionReadyForSigning event flow and the follow-up call to ChannelManager::funding_transaction_signed. No logic, API, or behavior was modified.
Changed components
lightning/src/ln/channelmanager.rs documentationInspect captured patch +3 / −0
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 68c5e81..a77f086 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -4681,6 +4681,9 @@ where
/// emitted. At this point, any inputs contributed to the splice can only be re-spent if an
/// [`Event::DiscardFunding`] is seen.
///
+ /// After initial signatures have been exchanged, [`Event::FundingTransactionReadyForSigning`]
+ /// will be generated and [`ChannelManager::funding_transaction_signed`] should be called.
+ ///
/// If any failures occur while negotiating the funding transaction, an [`Event::SpliceFailed`]
/// will be emitted. Any contributed inputs no longer used will be included here and thus can
/// be re-spent.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.