@@ -538,6 +538,18 @@ impl_writeable_tlv_based_enum!(PaymentFailureReason,
538
538
( 10 , UnexpectedError ) => { } , ;
539
539
) ;
540
540
541
+ /// Used to indicate the kind of funding for this channel by the channel acceptor (us).
542
+ ///
543
+ /// Allows the differentiation between a request for a dual-funded and non-dual-funded channel.
544
+ #[ derive( Clone , Debug , PartialEq , Eq ) ]
545
+ pub enum InboundChannelFunds {
546
+ /// For a non-dual-funded channel, the `push_msat` value from the channel initiator to us.
547
+ PushMsat ( u64 ) ,
548
+ /// Indicates the open request is for a dual funded channel and we may choose to contribute
549
+ /// funds to the channel.
550
+ DualFunded ,
551
+ }
552
+
541
553
/// An Event which you should probably take some action in response to.
542
554
///
543
555
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
@@ -1143,14 +1155,28 @@ pub enum Event {
1143
1155
} ,
1144
1156
/// Indicates a request to open a new channel by a peer.
1145
1157
///
1146
- /// To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the request,
1147
- /// call [`ChannelManager::force_close_without_broadcasting_txn`]. Note that a ['ChannelClosed`]
1148
- /// event will _not_ be triggered if the channel is rejected.
1158
+ /// If `acceptor_funds` is `InboundChannelFunds::DualFunded`, this indicates that the peer wishes to
1159
+ /// open a dual-funded channel. In this case you can choose whether to contribute funds or not.
1160
+ /// Otherwise, `acceptor_funds` will be `InboundChannelFunds::PushMsats`, indicating the `push_msats`
1161
+ /// value for a non-dual-funded channel.
1162
+ ///
1163
+ /// To accept the request (and in the case of a dual-funded channel, not contribute funds),
1164
+ /// call [`ChannelManager::accept_inbound_channel`].
1165
+ // TODO(dual_funding): Make this a doc comment when dual-funding fully released.
1166
+ // To accept the request and contribute funds for a dual-funded channel,
1167
+ // call [`ChannelManager::accept_inbound_channel_with_contribution`].
1168
+ /// To reject the request, call [`ChannelManager::force_close_without_broadcasting_txn`].
1169
+ /// Note that a ['ChannelClosed`] event will _not_ be triggered if the channel is rejected.
1149
1170
///
1150
1171
/// The event is only triggered when a new open channel request is received and the
1151
1172
/// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
1173
+ /// Note that if you wish to be able to contribute funds to dual-funded open channel requests,
1174
+ /// [`UserConfig::manually_accept_inbound_channels`] MUST be set to true so that you may
1175
+ /// provide funding inputs when choosing to contribute to the channel capacity.
1152
1176
///
1153
1177
/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1178
+ // TODO(dual_funding): Make this a doc comment when dual-funding fully released.
1179
+ // [`ChannelManager::accept_inbound_channel_with_contribution`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel_with_contribution
1154
1180
/// [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
1155
1181
/// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1156
1182
OpenChannelRequest {
@@ -1176,7 +1202,7 @@ pub enum Event {
1176
1202
/// The channel value of the requested channel.
1177
1203
funding_satoshis : u64 ,
1178
1204
/// Our starting balance in the channel if the request is accepted, in milli-satoshi.
1179
- push_msat : u64 ,
1205
+ acceptor_funds : InboundChannelFunds ,
1180
1206
/// The features that this channel will operate with. If you reject the channel, a
1181
1207
/// well-behaved counterparty may automatically re-attempt the channel with a new set of
1182
1208
/// feature flags.
0 commit comments