Skip to content

Commit 6459cb8

Browse files
committed
Update docs regarding payment paths
1 parent f88da8f commit 6459cb8

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

lightning/src/offers/invoice.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,8 @@ struct InvoiceFields {
339339
impl Invoice {
340340
/// Paths to the recipient originating from publicly reachable nodes, including information
341341
/// needed for routing payments across them. Blinded paths provide recipient privacy by
342-
/// obfuscating its node id.
342+
/// obfuscating its node id and may serve as hints to find a successful payment path to the
343+
/// recipient.
343344
pub fn payment_paths(&self) -> &[(BlindedPath, BlindedPayInfo)] {
344345
&self.contents.fields().payment_paths[..]
345346
}

lightning/src/offers/invoice_request.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,8 @@ impl InvoiceRequest {
333333
/// for the invoice.
334334
///
335335
/// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
336-
/// must contain one or more elements.
336+
/// must contain one or more elements ordered from most-preferred to least-preferred, if there's
337+
/// a preference.
337338
///
338339
/// Errors if the request contains unknown required features.
339340
///

lightning/src/offers/refund.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,8 @@ impl Refund {
331331
/// offer, which does have a `signing_pubkey`.
332332
///
333333
/// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
334-
/// must contain one or more elements.
334+
/// must contain one or more elements ordered from most-preferred to least-preferred, if there's
335+
/// a preference.
335336
///
336337
/// Errors if the request contains unknown required features.
337338
///

0 commit comments

Comments
 (0)