Skip to content

Commit 51036ec

Browse files
committed
Clarify docs regarding one-hop blinded paths
The docs assumed ChannelManager is parameterized by DefaultRouter, which may not be the case. Clarify the behavior is specific to using DefaultRouter.
1 parent 2149018 commit 51036ec

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8558,10 +8558,11 @@ macro_rules! create_offer_builder { ($self: ident, $builder: ty) => {
85588558
/// # Privacy
85598559
///
85608560
/// Uses [`MessageRouter`] to construct a [`BlindedPath`] for the offer based on the given
8561-
/// `absolute_expiry` according to [`MAX_SHORT_LIVED_RELATIVE_EXPIRY`]. However, if one is not
8562-
/// found, uses a one-hop [`BlindedPath`] with [`ChannelManager::get_our_node_id`] as the
8563-
/// introduction node instead. In the latter case, the node must be announced, otherwise, there
8564-
/// is no way to find a path to the introduction in order to send the [`InvoiceRequest`].
8561+
/// `absolute_expiry` according to [`MAX_SHORT_LIVED_RELATIVE_EXPIRY`]. When parameterized by
8562+
/// [`DefaultRouter`] (and thus using [`DefaultMessageRouter`), however, if a path is not found,
8563+
/// uses a one-hop [`BlindedPath`] with [`ChannelManager::get_our_node_id`] as the introduction
8564+
/// node instead. In the latter case, the node must be announced, otherwise, there is no way to
8565+
/// find a path to the introduction in order to send the [`InvoiceRequest`].
85658566
///
85668567
/// Also, uses a derived signing pubkey in the offer for recipient privacy.
85678568
///
@@ -8625,10 +8626,11 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => {
86258626
/// # Privacy
86268627
///
86278628
/// Uses [`MessageRouter`] to construct a [`BlindedPath`] for the refund based on the given
8628-
/// `absolute_expiry` according to [`MAX_SHORT_LIVED_RELATIVE_EXPIRY`]. However, if one is not
8629-
/// found, uses a one-hop [`BlindedPath`] with [`ChannelManager::get_our_node_id`] as the
8630-
/// introduction node instead. In the latter case, the node must be announced, otherwise, there
8631-
/// is no way to find a path to the introduction in order to send the [`Bolt12Invoice`].
8629+
/// `absolute_expiry` according to [`MAX_SHORT_LIVED_RELATIVE_EXPIRY`]. When parameterized by
8630+
/// [`DefaultRouter`] (and thus using [`DefaultMessageRouter`), however, if a path is not found,
8631+
/// uses a one-hop [`BlindedPath`] with [`ChannelManager::get_our_node_id`] as the introduction
8632+
/// node instead. In the latter case, the node must be announced, otherwise, there is no way to
8633+
/// find a path to the introduction in order to send the [`Bolt12Invoice`].
86328634
///
86338635
/// Also, uses a derived payer id in the refund for payer privacy.
86348636
///

0 commit comments

Comments
 (0)