@@ -1582,24 +1582,30 @@ pub enum Event {
1582
1582
/// onion messages.
1583
1583
peer_node_id : PublicKey ,
1584
1584
} ,
1585
- /// Indicates that a funding transaction constructed via interactive transaction construction for a
1586
- /// channel is ready to be signed by the client. This event will only be triggered
1585
+ /// Indicates that a funding transaction constructed via interactive transaction construction for
1586
+ /// a new channel or splice is ready to be signed by the client. This event will only be triggered
1587
1587
/// if at least one input was contributed by the holder and needs to be signed.
1588
1588
///
1589
- /// The transaction contains all inputs provided by both parties along with the channel's funding
1589
+ /// The transaction contains all inputs provided by both parties along with the channel's funding
1590
1590
/// output and a change output if applicable.
1591
1591
///
1592
1592
/// No part of the transaction should be changed before signing as the content of the transaction
1593
1593
/// has already been negotiated with the counterparty.
1594
1594
///
1595
- /// Each signature MUST use the SIGHASH_ALL flag to avoid invalidation of the initial commitment and
1596
- /// hence possible loss of funds.
1595
+ /// Each signature MUST use the ` SIGHASH_ALL` flag to avoid invalidation of the initial commitment
1596
+ /// and hence possible loss of funds.
1597
1597
///
1598
1598
/// After signing, call [`ChannelManager::funding_transaction_signed`] with the (partially) signed
1599
1599
/// funding transaction.
1600
1600
///
1601
1601
/// Generated in [`ChannelManager`] message handling.
1602
1602
///
1603
+ /// # Failure Behavior and Persistence
1604
+ /// This event will eventually be replayed after failures-to-handle (i.e., the event handler
1605
+ /// returning `Err(ReplayEvent ())`), but won't be persisted across restarts as the new channel
1606
+ /// or spliced channel associated with the constructed funding transaction is not persisted at
1607
+ /// this point.
1608
+ ///
1603
1609
/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1604
1610
/// [`ChannelManager::funding_transaction_signed`]: crate::ln::channelmanager::ChannelManager::funding_transaction_signed
1605
1611
FundingTransactionReadyForSigning {
@@ -1613,17 +1619,7 @@ pub enum Event {
1613
1619
///
1614
1620
/// [`ChannelManager::funding_transaction_signed`]: crate::ln::channelmanager::ChannelManager::funding_transaction_signed
1615
1621
counterparty_node_id : PublicKey ,
1616
- // TODO(dual_funding): Enable links when methods are implemented
1617
- /// The `user_channel_id` value passed in to `ChannelManager::create_dual_funded_channel` for outbound
1618
- /// channels, or to [`ChannelManager::accept_inbound_channel`] or `ChannelManager::accept_inbound_channel_with_contribution`
1619
- /// for inbound channels if [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
1620
- /// Otherwise `user_channel_id` will be randomized for an inbound channel.
1621
- /// This may be zero for objects serialized with LDK versions prior to 0.0.113.
1622
- ///
1623
- /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1624
- /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1625
- // [`ChannelManager::create_dual_funded_channel`]: crate::ln::channelmanager::ChannelManager::create_dual_funded_channel
1626
- // [`ChannelManager::accept_inbound_channel_with_contribution`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel_with_contribution
1622
+ /// The `user_channel_id` value for the channel.
1627
1623
user_channel_id : u128 ,
1628
1624
/// The unsigned transaction to be signed and passed back to
1629
1625
/// [`ChannelManager::funding_transaction_signed`].
0 commit comments