Add ChannelId pending change note; formatting
authoroptout <13562139+optout21@users.noreply.github.com>
Mon, 28 Aug 2023 05:20:23 +0000 (07:20 +0200)
committeroptout <13562139+optout21@users.noreply.github.com>
Mon, 28 Aug 2023 05:20:23 +0000 (07:20 +0200)
lightning/src/ln/channel_id.rs
lightning/src/ln/payment_tests.rs
pending_changelog/new_channel_id_type_pr_2485.txt [new file with mode: 0644]

index 621ebf0c460333446e22d2a28bd7bdc4b724dae8..cdbcd302929c70b1a2a5c59dd51da2d22df39e2e 100644 (file)
@@ -21,7 +21,9 @@ use core::fmt;
 use core::ops::Deref;
 
 /// A unique 32-byte identifier for a channel.
-/// Depending on how the ID is generated, several varieties are distinguished (but all are stored as 32 bytes): _v1_ and _temporary_.
+/// Depending on how the ID is generated, several varieties are distinguished
+/// (but all are stored as 32 bytes):
+///   _v1_ and _temporary_.
 /// A _v1_ channel ID is generated based on funding tx outpoint (txid & index).
 /// A _temporary_ ID is generated randomly.
 /// (Later revocation-point-based _v2_ is a possibility.)
index f87fb867fc952bcd15856a601c3626aa1908acf9..f0c3fa92d37c4b07f3c40d641e011e70d8b87c2e 100644 (file)
@@ -16,7 +16,7 @@ use crate::chain::channelmonitor::{ANTI_REORG_DELAY, HTLC_FAIL_BACK_BUFFER, LATE
 use crate::sign::EntropySource;
 use crate::chain::transaction::OutPoint;
 use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason, PaymentPurpose};
-use crate::ln::channel::{EXPIRE_PREV_CONFIG_TICKS};
+use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
 use crate::ln::channelmanager::{BREAKDOWN_TIMEOUT, MPP_TIMEOUT_TICKS, MIN_CLTV_EXPIRY_DELTA, PaymentId, PaymentSendFailure, IDEMPOTENCY_TIMEOUT_TICKS, RecentPaymentDetails, RecipientOnionFields, HTLCForwardInfo, PendingHTLCRouting, PendingAddHTLCInfo};
 use crate::ln::features::Bolt11InvoiceFeatures;
 use crate::ln::{msgs, ChannelId, PaymentSecret, PaymentPreimage};
diff --git a/pending_changelog/new_channel_id_type_pr_2485.txt b/pending_changelog/new_channel_id_type_pr_2485.txt
new file mode 100644 (file)
index 0000000..4ae3c2c
--- /dev/null
@@ -0,0 +1 @@
+* In several APIs, `channel_id` parameters have been changed from type `[u8; 32]` to newly introduced `ChannelId` type, from `ln` namespace (`lightning::ln::ChannelId`) (PR #2485)