f Revert Bolt12CreationError to Bolt12SemanticError

Revert the return type of `create_refund_builder` and
`pay_for_offer` from `Bolt12CreationError` back to
`Bolt12SemanticError`. This change is temporary, as a
future commit will introduce `Bolt12RequestError` for
these functions.

Author: slanesuke

lightning/src/ln/channelmanager.rs

@@ -1946,12 +1946,13 @@ where
 /// ```
 /// # use core::time::Duration;
 /// # use lightning::events::{Event, EventsProvider};
-/// # use lightning::ln::channelmanager::{AChannelManager, Bolt12CreationError, PaymentId, RecentPaymentDetails, Retry};
+/// # use lightning::ln::channelmanager::{AChannelManager, PaymentId, RecentPaymentDetails, Retry};
+/// # use lightning::offers::parse::Bolt12SemanticError;
 /// #
 /// # fn example<T: AChannelManager>(
 /// #     channel_manager: T, amount_msats: u64, absolute_expiry: Duration, retry: Retry,
 /// #     max_total_routing_fee_msat: Option<u64>
-/// # ) -> Result<(), Bolt12CreationError> {
+/// # ) -> Result<(), Bolt12SemanticError> {
 /// # let channel_manager = channel_manager.get_cm();
 /// let payment_id = PaymentId([42; 32]);
 /// let refund = channel_manager
@@ -2688,10 +2689,6 @@ pub enum RecentPaymentDetails {
 pub enum Bolt12CreationError {
     /// Error from  BOLT 12 semantic checks.
     InvalidSemantics(Bolt12SemanticError),
-    /// The payment id for a refund or request is already in use.
-    DuplicatePaymentId,
-    /// There is insufficient liquidity to complete the payment.
-    InsufficientLiquidity,
     /// Failed to create a blinded path.
     BlindedPathCreationFailed,
 }
@@ -9205,7 +9202,7 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => {
 	pub fn create_refund_builder(
 		&$self, amount_msats: u64, absolute_expiry: Duration, payment_id: PaymentId,
 		retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
-	) -> Result<$builder, Bolt12CreationError> {
+	) -> Result<$builder, Bolt12SemanticError> {
 		let node_id = $self.get_our_node_id();
 		let expanded_key = &$self.inbound_payment_key;
 		let entropy = &*$self.entropy_source;
@@ -9215,7 +9212,7 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => {
 		let context = OffersContext::OutboundPayment { payment_id, nonce, hmac: None };
 		let path = $self.create_blinded_paths_using_absolute_expiry(context, Some(absolute_expiry))
 			.and_then(|paths| paths.into_iter().next().ok_or(()))
-			.map_err(|()| Bolt12CreationError::BlindedPathCreationFailed)?;
+			.map_err(|_| Bolt12SemanticError::MissingPaths)?;
 
 		let builder = RefundBuilder::deriving_signing_pubkey(
 			node_id, expanded_key, nonce, secp_ctx, amount_msats, payment_id
@@ -9231,7 +9228,7 @@ macro_rules! create_refund_builder { ($self: ident, $builder: ty) => {
 			.add_new_awaiting_invoice(
 				payment_id, expiration, retry_strategy, max_total_routing_fee_msat, None,
 			)
-			.map_err(|()| Bolt12CreationError::DuplicatePaymentId)?;
+			.map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
 
 		Ok(builder.into())
 	}
@@ -9323,7 +9320,7 @@ where
 		&self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>,
 		payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry,
 		max_total_routing_fee_msat: Option<u64>
-	) -> Result<(), Bolt12CreationError> {
+	) -> Result<(), Bolt12SemanticError> {
 		let expanded_key = &self.inbound_payment_key;
 		let entropy = &*self.entropy_source;
 		let secp_ctx = &self.secp_ctx;
@@ -9353,7 +9350,7 @@ where
 			OffersContext::OutboundPayment { payment_id, nonce, hmac: Some(hmac) }
 		);
 		let reply_paths = self.create_blinded_paths(context)
-			.map_err(|()| Bolt12CreationError::BlindedPathCreationFailed)?;
+			.map_err(|_| Bolt12SemanticError::MissingPaths)?;
 
 		let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
 
@@ -9367,7 +9364,7 @@ where
 				payment_id, expiration, retry_strategy, max_total_routing_fee_msat,
 				Some(retryable_invoice_request)
 			)
-			.map_err(|()| Bolt12CreationError::DuplicatePaymentId)?;
+			.map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
 
 		self.enqueue_invoice_request(invoice_request, reply_paths)?;
 		Ok(())

lightning/src/ln/offers_tests.rs

@@ -1697,7 +1697,7 @@ fn fails_creating_or_paying_for_offer_without_connected_peers() {
 
 	match david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
 		Ok(_) => panic!("Expected error"),
-		Err(e) => assert_eq!(e, Bolt12CreationError::BlindedPathCreationFailed),
+		Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
 	}
 
 	assert!(nodes[0].node.list_recent_payments().is_empty());
@@ -1755,7 +1755,7 @@ fn fails_creating_refund_or_sending_invoice_without_connected_peers() {
 		10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
 	) {
 		Ok(_) => panic!("Expected error"),
-		Err(e) => assert_eq!(e, Bolt12CreationError::BlindedPathCreationFailed),
+		Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
 	}
 
 	let mut args = ReconnectArgs::new(charlie, david);
@@ -1801,7 +1801,7 @@ fn fails_creating_invoice_request_for_unsupported_chain() {
 	let payment_id = PaymentId([1; 32]);
 	match bob.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
 		Ok(_) => panic!("Expected error"),
-		Err(e) => assert_eq!(e, Bolt12CreationError::InvalidSemantics(Bolt12SemanticError::UnsupportedChain)),
+		Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
 	}
 }
 
@@ -1860,7 +1860,7 @@ fn fails_creating_invoice_request_without_blinded_reply_path() {
 
 	match david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
 		Ok(_) => panic!("Expected error"),
-		Err(e) => assert_eq!(e, Bolt12CreationError::BlindedPathCreationFailed),
+		Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
 	}
 
 	assert!(nodes[0].node.list_recent_payments().is_empty());
@@ -1900,7 +1900,7 @@ fn fails_creating_invoice_request_with_duplicate_payment_id() {
 
 	match david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
 		Ok(_) => panic!("Expected error"),
-		Err(e) => assert_eq!(e, Bolt12CreationError::DuplicatePaymentId),
+		Err(e) => assert_eq!(e, Bolt12SemanticError::DuplicatePaymentId),
 	}
 
 	expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
@@ -1928,7 +1928,7 @@ fn fails_creating_refund_with_duplicate_payment_id() {
 		10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
 	) {
 		Ok(_) => panic!("Expected error"),
-		Err(e) => assert_eq!(e, Bolt12CreationError::DuplicatePaymentId),
+		Err(e) => assert_eq!(e, Bolt12SemanticError::DuplicatePaymentId),
 	}
 
 	expect_recent_payment!(nodes[0], RecentPaymentDetails::AwaitingInvoice, payment_id);

lightning/src/offers/parse.rs

@@ -180,6 +180,8 @@ pub enum Bolt12SemanticError {
 	MissingPayerSigningPubkey,
 	/// A payer id was expected but was missing.
 	MissingPayerId,
+	/// The payment id for a refund or request is already in use.
+	DuplicatePaymentId,
 	/// Blinded paths were expected but were missing.
 	MissingPaths,
 	/// Blinded paths were provided but were not expected.