Skip to content

Commit 006ce3a

Browse files
committed
Clarify withdraw_lnurlw method documentation
1 parent 0584c8b commit 006ce3a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -941,6 +941,10 @@ impl LightningNode {
941941

942942
/// Withdraw an LNURL-withdraw the provided amount.
943943
///
944+
/// A successful return means the LNURL-withdraw service has started a payment.
945+
/// Only after the event [`EventsCallback::payment_received`] can the payment be considered
946+
/// received.
947+
///
944948
/// Parameters:
945949
/// * `lnurl_withdraw_request_data` - LNURL-withdraw request data as obtained from [`LightningNode::decode_data`]
946950
/// * `amount_sat` - amount to be withdraw

0 commit comments

Comments
 (0)