]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Expand request_refund_payment docs for limitations
authorJeffrey Czyz <jkczyz@gmail.com>
Thu, 19 Oct 2023 21:36:02 +0000 (16:36 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Fri, 20 Oct 2023 14:49:58 +0000 (09:49 -0500)
lightning/src/ln/channelmanager.rs

index e71d7124aaafcfb16492006d7ad19bfc8ee90f58..6ed42337987297ae50e484337578d02526806cbd 100644 (file)
@@ -7528,7 +7528,9 @@ where
        /// # Limitations
        ///
        /// Requires a direct connection to an introduction node in [`Refund::paths`] or to
-       /// [`Refund::payer_id`], if empty.
+       /// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
+       /// node meeting the aforementioned criteria, but there's no guarantee that they will be
+       /// received and no retries will be made.
        ///
        /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
        pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {