Skip to content

Commit

Permalink
Update docs regarding payment path privacy
Browse files Browse the repository at this point in the history
  • Loading branch information
jkczyz committed Jan 30, 2023
1 parent 2d44dbe commit 22ea505
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
6 changes: 4 additions & 2 deletions lightning/src/offers/invoice.rs
Original file line number Diff line number Diff line change
Expand Up @@ -338,8 +338,10 @@ struct InvoiceFields {

impl Invoice {
/// Paths to the recipient originating from publicly reachable nodes, including information
/// needed for routing payments across them. Blinded paths provide recipient privacy by
/// obfuscating its node id.
/// needed for routing payments across them.
///
/// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this
/// privacy is lost if a public node id is used for [`Invoice::signing_pubkey`].
pub fn payment_paths(&self) -> &[(BlindedPath, BlindedPayInfo)] {
&self.contents.fields().payment_paths[..]
}
Expand Down
4 changes: 3 additions & 1 deletion lightning/src/offers/invoice_request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,9 @@ impl InvoiceRequest {
/// for the invoice.
///
/// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
/// must contain one or more elements.
/// must contain one or more elements ordered from most-preferred to least-preferred, if there's
/// a preference. Note, however, that any privacy is lost if a public node id was used for
/// [`Offer::signing_pubkey`].
///
/// Errors if the request contains unknown required features.
///
Expand Down
4 changes: 3 additions & 1 deletion lightning/src/offers/refund.rs
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,9 @@ impl Refund {
/// offer, which does have a `signing_pubkey`.
///
/// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
/// must contain one or more elements.
/// must contain one or more elements ordered from most-preferred to least-preferred, if there's
/// a preference. Note, however, that any privacy is lost if a public node id is used for
/// `signing_pubkey`.
///
/// Errors if the request contains unknown required features.
///
Expand Down

0 comments on commit 22ea505

Please sign in to comment.