From: Jeffrey Czyz Date: Wed, 18 Sep 2024 17:06:26 +0000 (-0500) Subject: Expand DefaultRouter's privacy docs X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=bde331fe94eb2855e020677a856cca6809100388;p=rust-lightning 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. --- diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs index 4215f66b2..a74f9d834 100644 --- a/lightning/src/routing/router.rs +++ b/lightning/src/routing/router.rs @@ -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>, L: Deref, ES: Deref, S: Deref, SP: Sized, Sc: ScoreLookUp> where