Update docs for amount_msats to handle currency cases

Improves documentation for the amount_msats method in InvoiceRequestBuilder. The update describes the behavior when an Offer specifies a currency.
slanesuke · Aug 8, 2024 · 05fc9fd · 05fc9fd
1 parent 560835c
commit 05fc9fd
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lightning/src/offers/invoice_request.rs b/lightning/src/offers/invoice_request.rs
@@ -270,6 +270,11 @@ macro_rules! invoice_request_builder_methods { (
 	/// Sets the [`InvoiceRequest::amount_msats`] for paying an invoice. Errors if `amount_msats` is
 	/// not at least the expected invoice amount (i.e., [`Offer::amount`] times [`quantity`]).
 	///
+	/// When the [`Offer`] specifies a currency, this method allows setting the `amount_msats` in the
+	/// `InvoiceRequest`. The issuer of the offer will validate this amount and must set a matching
+	/// amount in the final invoice. If the issuer disagrees with the specfified amount, the invoice
+	/// request will be rejected.
+	///
 	/// Successive calls to this method will override the previous setting.
 	///
 	/// [`quantity`]: Self::quantity