From: Viktor Tigerström <11711198+ViktorTigerstrom@users.noreply.github.com>
Date: Fri, 13 May 2022 21:52:20 +0000 (+0200)
Subject: Update `OpenChannelRequest` documentation
X-Git-Tag: v0.0.107~27^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=c1798443b0de8999d4f8303faf8fcfb267c4ed78;p=rust-lightning

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.
---

diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
index bebc75baf..dd97d9645 100644
--- a/lightning/src/util/events.rs
+++ b/lightning/src/util/events.rs
@@ -432,13 +432,21 @@ pub enum Event {
 		/// The temporary channel ID of the channel requested to be opened.
 		///
 		/// When responding to the request, the `temporary_channel_id` should be passed
-		/// back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
-		/// or to [`ChannelManager::force_close_channel`] to reject.
+		/// back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
+		/// or through [`ChannelManager::force_close_channel`] to reject.
 		///
 		/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
 		/// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
 		temporary_channel_id: [u8; 32],
 		/// The node_id of the counterparty requesting to open the channel.
+		///
+		/// When responding to the request, the `counterparty_node_id` should be passed
+		/// back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
+		/// accept the request, or through [`ChannelManager::force_close_channel`] to reject the
+		/// request.
+		///
+		/// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
+		/// [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
 		counterparty_node_id: PublicKey,
 		/// The channel value of the requested channel.
 		funding_satoshis: u64,