Skip to content

Commit f78448c

Browse files
Expand ChannelManager::send_spontaneous_payment_with_retry docs
1 parent b28bfd3 commit f78448c

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lightning/src/ln/channelmanager.rs

+5
Original file line numberDiff line numberDiff line change
@@ -2637,6 +2637,11 @@ where
26372637

26382638
/// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
26392639
/// based on `route_params` and retry failed payment paths based on `retry_strategy`.
2640+
///
2641+
/// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
2642+
/// payments.
2643+
///
2644+
/// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
26402645
pub fn send_spontaneous_payment_with_retry(&self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<PaymentHash, PaymentSendFailure> {
26412646
let best_block_height = self.best_block.read().unwrap().height();
26422647
self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, payment_id,

0 commit comments

Comments
 (0)