]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Expand DefaultRouter's privacy docs
authorJeffrey Czyz <jkczyz@gmail.com>
Wed, 18 Sep 2024 17:06:26 +0000 (12:06 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Mon, 23 Sep 2024 03:22:00 +0000 (12:22 +0900)
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.

lightning/src/routing/router.rs

index 4215f66b2da9f0584f930ad0d8dba24f34697658..a74f9d834d474ce2706aaf68f6d28906fd59dab1 100644 (file)
@@ -45,6 +45,11 @@ pub use lightning_types::routing::{RouteHint, RouteHintHop};
 ///
 /// # Privacy
 ///
+/// Creating [`BlindedPaymentPath`]s may affect privacy since, if a suitable path cannot be found,
+/// it will create a one-hop path using the recipient as the introduction node if it is a announced
+/// node. Otherwise, there is no way to find a path to the introduction node in order to send a
+/// payment, and thus an `Err` is returned.
+///
 /// Implements [`MessageRouter`] by delegating to [`DefaultMessageRouter`]. See those docs for
 /// privacy implications.
 pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, ES: Deref, S: Deref, SP: Sized, Sc: ScoreLookUp<ScoreParams = SP>> where