Skip to content

Commit 0758ed2

Browse files
committed
f links in outbound_scid_alias
1 parent 9c2e22c commit 0758ed2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -966,15 +966,24 @@ pub struct ChannelDetails {
966966
/// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
967967
/// payments instead of this. See [`get_inbound_payment_scid`].
968968
///
969+
/// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
970+
/// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
971+
///
969972
/// [`inbound_scid_alias`]: Self::inbound_scid_alias
973+
/// [`outbound_scid_alias`]: Self::outbound_scid_alias
970974
/// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
975+
/// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
976+
/// [`confirmations_required`]: Self::confirmations_required
971977
pub short_channel_id: Option<u64>,
972978
/// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
973979
/// usable in place of [`short_channel_id`] to reference the channel in outbound routes even if
974980
/// the channel has not yet been confirmed (as long as [`confirmations_required`] is
975981
/// `Some(0)`).
976982
///
977983
/// This will be `None` as long as the channel is not available for routing outbound payments.
984+
///
985+
/// [`short_channel_id`]: Self::short_channel_id
986+
/// [`confirmations_required`]: Self::confirmations_required
978987
pub outbound_scid_alias: Option<u64>,
979988
/// An optional [`short_channel_id`] alias for this channel, randomly generated by our
980989
/// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our

0 commit comments

Comments
 (0)