Skip to content

Commit 929259e

Browse files
Update keysend docs
1 parent 8530078 commit 929259e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1912,9 +1912,13 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
19121912
/// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
19131913
/// never reach the recipient.
19141914
///
1915+
/// See [`send_payment`] documentation for more details on the return value of this function.
1916+
///
19151917
/// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
19161918
/// [`send_payment`] for more information about the risks of duplicate preimage usage.
19171919
///
1920+
/// Note that `route` must have exactly one path.
1921+
///
19181922
/// [`send_payment`]: Self::send_payment
19191923
pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<PaymentHash, PaymentSendFailure> {
19201924
let preimage = match payment_preimage {

0 commit comments

Comments
 (0)