Update docs for Bolt12SemanticError::InvalidAmount

Added doc update to clarify that `InvalidAmount` now also covers cases where the amount in an invoice does not match the expected amount specified in the associated `InvoiceRequest` or `Refund`.
slanesuke · Oct 10, 2024 · 35e3daa · 35e3daa
1 parent f15db05
commit 35e3daa
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lightning/src/offers/parse.rs b/lightning/src/offers/parse.rs
@@ -147,6 +147,9 @@ pub enum Bolt12SemanticError {
 	/// An amount was expected but was missing.
 	MissingAmount,
 	/// The amount exceeded the total bitcoin supply.
+	///
+	/// This error can also occur if the amount in an invoice does not match the expected
+	/// amount specified in the associated `InvoiceRequest` or `Refund`.
 	InvalidAmount,
 	/// An amount was provided but was not sufficient in value.
 	InsufficientAmount,