Skip to content

Commit 0dc5da0

Browse files
committed
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.
1 parent 0944141 commit 0dc5da0

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4681,6 +4681,10 @@ where
46814681
/// emitted. At this point, any inputs contributed to the splice can only be re-spent if an
46824682
/// [`Event::DiscardFunding`] is seen.
46834683
///
4684+
/// After initial signatures have been exchanged, if we contributed any inputs,
4685+
/// [`Event::FundingTransactionReadyForSigning`] will be generated and
4686+
/// [`ChannelManager::funding_transaction_signed`] should be called.
4687+
///
46844688
/// If any failures occur while negotiating the funding transaction, an [`Event::SpliceFailed`]
46854689
/// will be emitted. Any contributed inputs no longer used will be included here and thus can
46864690
/// be re-spent.

0 commit comments

Comments
 (0)