]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Correct docs
authorJeffrey Czyz <jkczyz@gmail.com>
Fri, 19 Jul 2024 16:50:07 +0000 (11:50 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Mon, 22 Jul 2024 16:38:39 +0000 (11:38 -0500)
lightning/src/offers/refund.rs

index fbd4758d6a01c4d9aed4299d559fe89e27d2d5ae..6c9226779a13bb7cdf3ed3db69d3a2323f54908a 100644 (file)
@@ -189,13 +189,14 @@ macro_rules! refund_builder_methods { (
        /// different payer id for each refund, assuming a different nonce is used.  Otherwise, the
        /// provided `node_id` is used for the payer id.
        ///
-       /// Also, sets the metadata when [`RefundBuilder::build`] is called such that it can be used to
-       /// verify that an [`InvoiceRequest`] was produced for the refund given an [`ExpandedKey`].
+       /// Also, sets the metadata when [`RefundBuilder::build`] is called such that it can be used by
+       /// [`Bolt12Invoice::verify`] to determine if the invoice was produced for the refund given an
+       /// [`ExpandedKey`].
        ///
        /// The `payment_id` is encrypted in the metadata and should be unique. This ensures that only
        /// one invoice will be paid for the refund and that payments can be uniquely identified.
        ///
-       /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
+       /// [`Bolt12Invoice::verify`]: crate::offers::invoice::Bolt12Invoice::verify
        /// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
        pub fn deriving_payer_id(
                node_id: PublicKey, expanded_key: &ExpandedKey, nonce: Nonce,