From f78448c604e3859d6c387d253549474e667e9527 Mon Sep 17 00:00:00 2001 From: Valentine Wallace Date: Mon, 6 Feb 2023 16:30:51 -0500 Subject: [PATCH] Expand ChannelManager::send_spontaneous_payment_with_retry docs --- lightning/src/ln/channelmanager.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs index 771e7c4a8..59d8e3875 100644 --- a/lightning/src/ln/channelmanager.rs +++ b/lightning/src/ln/channelmanager.rs @@ -2637,6 +2637,11 @@ where /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route /// based on `route_params` and retry failed payment paths based on `retry_strategy`. + /// + /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous + /// payments. + /// + /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend pub fn send_spontaneous_payment_with_retry(&self, payment_preimage: Option, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result { let best_block_height = self.best_block.read().unwrap().height(); self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, payment_id, -- 2.39.5