Skip to content

Commit bde331f

Browse files
committed
Expand DefaultRouter's privacy docs
DefaultRouter::create_blinded_payment_paths may creat a one-hop blinded path with the recipient as the introduction node. Update the privacy section of DefaultRouter's docs to indicate this as is done in the docs for DefaultMessageRouter.
1 parent 04c51b3 commit bde331f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lightning/src/routing/router.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ pub use lightning_types::routing::{RouteHint, RouteHintHop};
4545
///
4646
/// # Privacy
4747
///
48+
/// Creating [`BlindedPaymentPath`]s may affect privacy since, if a suitable path cannot be found,
49+
/// it will create a one-hop path using the recipient as the introduction node if it is a announced
50+
/// node. Otherwise, there is no way to find a path to the introduction node in order to send a
51+
/// payment, and thus an `Err` is returned.
52+
///
4853
/// Implements [`MessageRouter`] by delegating to [`DefaultMessageRouter`]. See those docs for
4954
/// privacy implications.
5055
pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, ES: Deref, S: Deref, SP: Sized, Sc: ScoreLookUp<ScoreParams = SP>> where

0 commit comments

Comments
 (0)