Merge branch 'main' into mock-deps

getlipa · Jun 7, 2024 · 02a407f · 02a407f
2 parents 3fc5967 + 109c312
commit 02a407f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/src/lib.rs b/src/lib.rs
@@ -951,6 +951,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