Use SemanticError in OfferBuilder::build

Author: jkczyz

lightning/src/offers/offer.rs

@@ -47,8 +47,7 @@
 //!     .issuer("Foo Bar".to_string())
 //!     .path(create_blinded_path())
 //!     .path(create_another_blinded_path())
-//!     .build()
-//!     .unwrap();
+//!     .build()?;
 //!
 //! // Encode as a bech32 string for use in a QR code.
 //! let encoded_offer = offer.to_string();
@@ -213,17 +212,17 @@ impl OfferBuilder {
 	}
 
 	/// Builds an [`Offer`] from the builder's settings.
-	pub fn build(self) -> Result<Offer, ()> {
+	pub fn build(self) -> Result<Offer, SemanticError> {
 		if let Some(Amount::Currency { .. }) = self.offer.amount {
-			return Err(());
+			return Err(SemanticError::UnsupportedCurrency);
 		}
 
 		if self.offer.amount_msats() > MAX_VALUE_MSAT {
-			return Err(());
+			return Err(SemanticError::InvalidAmount);
 		}
 
 		if self.offer.quantity_min() > self.offer.quantity_max() {
-			return Err(());
+			return Err(SemanticError::InvalidQuantity);
 		}
 
 		let mut bytes = Vec::new();
@@ -559,6 +558,7 @@ mod tests {
 	use core::time::Duration;
 	use ln::features::OfferFeatures;
 	use ln::msgs::MAX_VALUE_MSAT;
+	use offers::parse::SemanticError;
 	use onion_message::{BlindedHop, BlindedPath};
 	use util::ser::Writeable;
 
@@ -679,7 +679,7 @@ mod tests {
 		assert_eq!(tlv_stream.currency, Some(b"USD"));
 		match builder.build() {
 			Ok(_) => panic!("expected error"),
-			Err(e) => assert_eq!(e, ()),
+			Err(e) => assert_eq!(e, SemanticError::UnsupportedCurrency),
 		}
 
 		let offer = OfferBuilder::new("foo".into(), pubkey(42))
@@ -694,7 +694,7 @@ mod tests {
 		let invalid_amount = Amount::Bitcoin { amount_msats: MAX_VALUE_MSAT + 1 };
 		match OfferBuilder::new("foo".into(), pubkey(42)).amount(invalid_amount).build() {
 			Ok(_) => panic!("expected error"),
-			Err(e) => assert_eq!(e, ()),
+			Err(e) => assert_eq!(e, SemanticError::InvalidAmount),
 		}
 	}
 
@@ -920,11 +920,10 @@ mod tests {
 		assert_eq!(tlv_stream.quantity_min, None);
 		assert_eq!(tlv_stream.quantity_max, Some(9));
 
-		assert!(OfferBuilder::new("foo".into(), pubkey(42))
-			.quantity_range(ten..five)
-			.build()
-			.is_err()
-		);
+		match OfferBuilder::new("foo".into(), pubkey(42)).quantity_range(ten..five).build() {
+			Ok(_) => panic!("expected error"),
+			Err(e) => assert_eq!(e, SemanticError::InvalidQuantity),
+		}
 	}
 }
 

lightning/src/offers/parse.rs

@@ -79,6 +79,8 @@ pub enum SemanticError {
 	UnsupportedChain,
 	/// An amount was expected but was missing.
 	MissingAmount,
+	/// An amount exceeded the maximum number of bitcoin.
+	InvalidAmount,
 	/// A currency was provided that is not supported.
 	UnsupportedCurrency,
 	/// A required description was not provided.