Skip to content

Commit

Permalink
Add note about SCID collisions in PaymentPathFailed
Browse files Browse the repository at this point in the history
This isn't specific to 0-conf but is useful for users to note as
the network moves towards more SCID aliases.
  • Loading branch information
TheBlueMatt committed May 27, 2022
1 parent 86ad252 commit ffaf9bc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lightning/src/util/events.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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>,
Expand Down

0 comments on commit ffaf9bc

Please sign in to comment.