File tree 3 files changed +6
-3
lines changed
3 files changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -339,7 +339,8 @@ struct InvoiceFields {
339
339
impl Invoice {
340
340
/// Paths to the recipient originating from publicly reachable nodes, including information
341
341
/// 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.
343
344
pub fn payment_paths ( & self ) -> & [ ( BlindedPath , BlindedPayInfo ) ] {
344
345
& self . contents . fields ( ) . payment_paths [ ..]
345
346
}
Original file line number Diff line number Diff line change @@ -333,7 +333,8 @@ impl InvoiceRequest {
333
333
/// for the invoice.
334
334
///
335
335
/// 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.
337
338
///
338
339
/// Errors if the request contains unknown required features.
339
340
///
Original file line number Diff line number Diff line change @@ -331,7 +331,8 @@ impl Refund {
331
331
/// offer, which does have a `signing_pubkey`.
332
332
///
333
333
/// 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.
335
336
///
336
337
/// Errors if the request contains unknown required features.
337
338
///
You can’t perform that action at this time.
0 commit comments