@@ -966,15 +966,24 @@ pub struct ChannelDetails {
966
966
/// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
967
967
/// payments instead of this. See [`get_inbound_payment_scid`].
968
968
///
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
+ ///
969
972
/// [`inbound_scid_alias`]: Self::inbound_scid_alias
973
+ /// [`outbound_scid_alias`]: Self::outbound_scid_alias
970
974
/// [`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
971
977
pub short_channel_id : Option < u64 > ,
972
978
/// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
973
979
/// usable in place of [`short_channel_id`] to reference the channel in outbound routes even if
974
980
/// the channel has not yet been confirmed (as long as [`confirmations_required`] is
975
981
/// `Some(0)`).
976
982
///
977
983
/// 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
978
987
pub outbound_scid_alias : Option < u64 > ,
979
988
/// An optional [`short_channel_id`] alias for this channel, randomly generated by our
980
989
/// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
0 commit comments