Add note about SCID collisions in `PaymentPathFailed`

This isn't specific to 0-conf but is useful for users to note as
the network moves towards more SCID aliases.

diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
index ef0c619b02e9f7a1b03cd6dd14b439e7799264dc..8d5fe00facfbac0e1ad275c9707666a45991056e 100644 (file)
--- a/lightning/src/util/events.rs
+++ b/lightning/src/util/events.rs
@@ -331,6 +331,10 @@ pub enum Event {
                path: Vec<RouteHop>,
                /// The channel responsible for the failed payment path.
                ///
+               /// Note that for route hints or for the first hop in a path this may be an SCID alias and
+               /// may not refer to a channel in the public network graph. These aliases may also collide
+               /// with channels in the public network graph.
+               ///
                /// If this is `Some`, then the corresponding channel should be avoided when the payment is
                /// retried. May be `None` for older [`Event`] serializations.
                short_channel_id: Option<u64>,