Skip to content

Commit c179844

Browse files
Update OpenChannelRequest documentation
As the `counterparty_node_id` is now required to be passed back to the `ChannelManager` to accept or reject an inbound channel request, the documentation is updated to reflect that.
1 parent 70fa465 commit c179844

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

lightning/src/util/events.rs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -432,13 +432,21 @@ pub enum Event {
432432
/// The temporary channel ID of the channel requested to be opened.
433433
///
434434
/// When responding to the request, the `temporary_channel_id` should be passed
435-
/// back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
436-
/// or to [`ChannelManager::force_close_channel`] to reject.
435+
/// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
436+
/// or through [`ChannelManager::force_close_channel`] to reject.
437437
///
438438
/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
439439
/// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
440440
temporary_channel_id: [u8; 32],
441441
/// The node_id of the counterparty requesting to open the channel.
442+
///
443+
/// When responding to the request, the `counterparty_node_id` should be passed
444+
/// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
445+
/// accept the request, or through [`ChannelManager::force_close_channel`] to reject the
446+
/// request.
447+
///
448+
/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
449+
/// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
442450
counterparty_node_id: PublicKey,
443451
/// The channel value of the requested channel.
444452
funding_satoshis: u64,

0 commit comments

Comments
 (0)