From 006ce3ac1d2c8a6c111e6e80ed244b34b0836c6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Granh=C3=A3o?= Date: Thu, 6 Jun 2024 09:37:16 +0100 Subject: [PATCH] Clarify `withdraw_lnurlw` method documentation --- src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 55479acb..d66f7c60 100644 --- 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