From: Matt Corallo <git@bluematt.me>
Date: Mon, 28 Mar 2022 14:24:16 +0000 (+0000)
Subject: Add notes about SCID alias rotation to `ChannelDetails` docs
X-Git-Tag: v0.0.106~4^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=952cee4a168d266d7bdd43d21ac71a3e3de46a53;p=rust-lightning

Add notes about SCID alias rotation to `ChannelDetails` docs
---

diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 6cf07ab4..81789313 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -1218,6 +1218,9 @@ pub struct ChannelDetails {
 	/// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
 	/// when they see a payment to be routed to us.
 	///
+	/// Our counterparty may choose to rotate this value at any time, though will always recognize
+	/// previous values for inbound payment forwarding.
+	///
 	/// [`short_channel_id`]: Self::short_channel_id
 	pub inbound_scid_alias: Option<u64>,
 	/// The value, in satoshis, of this channel as appears in the funding output
@@ -1306,9 +1309,12 @@ pub struct ChannelDetails {
 }
 
 impl ChannelDetails {
-	/// Gets the SCID which should be used to identify this channel for inbound payments. This
-	/// should be used for providing invoice hints or in any other context where our counterparty
-	/// will forward a payment to us.
+	/// Gets the current SCID which should be used to identify this channel for inbound payments.
+	/// This should be used for providing invoice hints or in any other context where our
+	/// counterparty will forward a payment to us.
+	///
+	/// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
+	/// [`ChannelDetails::short_channel_id`]. See those for more information.
 	pub fn get_inbound_payment_scid(&self) -> Option<u64> {
 		self.inbound_scid_alias.or(self.short_channel_id)
 	}