Merge pull request #1099 from getlipa/doc/clarify-withdraw-lnurlw-docs

Clarify `withdraw_lnurlw` method documentation
getlipa · Jun 6, 2024 · c42ecec · c42ecec
2 parents 0584c8b + 006ce3a
commit c42ecec
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -941,6 +941,10 @@ impl LightningNode {
 
     /// Withdraw an LNURL-withdraw the provided amount.
     ///
+    /// A successful return means the LNURL-withdraw service has started a payment.
+    /// Only after the event [`EventsCallback::payment_received`] can the payment be considered
+    /// received.
+    ///
     /// Parameters:
     /// * `lnurl_withdraw_request_data` - LNURL-withdraw request data as obtained from [`LightningNode::decode_data`]
     /// * `amount_sat` - amount to be withdraw