f Introduce ternary enum PaymentStoreUpdateResult

Author: tnull

src/event.rs

@@ -20,7 +20,7 @@ use crate::logger::Logger;
 
 use crate::payment::store::{
 	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
-	PaymentStore,
+	PaymentStore, PaymentStoreUpdateResult,
 };
 
 use crate::io::{
@@ -859,7 +859,7 @@ where
 				let payment_id = PaymentId(payment_hash.0);
 				log_info!(
 					self.logger,
-					"Claimed payment with ID {} from payment hash {} of {}msat.",
+					"Claiming payment with ID {} from payment hash {} of {}msat.",
 					payment_id,
 					hex_utils::to_string(&payment_hash.0),
 					amount_msat,
@@ -906,9 +906,16 @@ where
 				};
 
 				match self.payment_store.update(&update) {
-					Ok(_) => (
-						// No need to do anything if the update was applied.
-					),
+					Ok(PaymentStoreUpdateResult::EntryUpdated)
+					| Ok(PaymentStoreUpdateResult::EntryUnchanged) => (),
+					Ok(PaymentStoreUpdateResult::EntryNotFound) => {
+						log_error!(
+							self.logger,
+							"Failed to claim payment as ID {} couldn't be found in store",
+							payment_id,
+						);
+						return Ok(());
+					},
 					Err(e) => {
 						log_error!(
 							self.logger,

src/payment/bolt11.rs

@@ -16,7 +16,7 @@ use crate::liquidity::LiquiditySource;
 use crate::logger::{log_error, log_info, LdkLogger, Logger};
 use crate::payment::store::{
 	LSPFeeLimits, PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind,
-	PaymentStatus, PaymentStore,
+	PaymentStatus, PaymentStore, PaymentStoreUpdateResult,
 };
 use crate::payment::SendingParameters;
 use crate::peer_store::{PeerInfo, PeerStore};
@@ -394,8 +394,8 @@ impl Bolt11Payment {
 	/// failed back, e.g., if the correct preimage can't be retrieved in time before the claim
 	/// deadline has been reached.
 	///
-	/// Will check that the payment is known and pending before failing the payment, and will
-	/// return an error otherwise.
+	/// Will check that the payment is known before failing the payment, and will return an error
+	/// otherwise.
 	///
 	/// [`receive_for_hash`]: Self::receive_for_hash
 	/// [`receive_variable_amount_for_hash`]: Self::receive_variable_amount_for_hash
@@ -409,8 +409,9 @@ impl Bolt11Payment {
 		};
 
 		match self.payment_store.update(&update) {
-			Ok(true) => (),
-			Ok(false) => {
+			Ok(PaymentStoreUpdateResult::EntryUpdated)
+			| Ok(PaymentStoreUpdateResult::EntryUnchanged) => (),
+			Ok(PaymentStoreUpdateResult::EntryNotFound) => {
 				log_error!(
 					self.logger,
 					"Failed to manually fail unknown payment with hash {}",
@@ -421,7 +422,7 @@ impl Bolt11Payment {
 			Err(e) => {
 				log_error!(
 					self.logger,
-					"Failed to manually fail unknown payment with hash {}: {}",
+					"Failed to manually fail payment with hash {}: {}",
 					payment_hash,
 					e
 				);

src/payment/store.rs

@@ -590,6 +590,13 @@ impl From<&PaymentDetails> for PaymentDetailsUpdate {
 	}
 }
 
+#[derive(PartialEq, Eq, Debug, Clone, Copy)]
+pub(crate) enum PaymentStoreUpdateResult {
+	EntryUpdated,
+	EntryUnchanged,
+	EntryNotFound,
+}
+
 pub(crate) struct PaymentStore<L: Deref>
 where
 	L::Target: LdkLogger,
@@ -670,17 +677,22 @@ where
 		self.payments.lock().unwrap().get(id).cloned()
 	}
 
-	pub(crate) fn update(&self, update: &PaymentDetailsUpdate) -> Result<bool, Error> {
-		let mut updated = false;
+	pub(crate) fn update(
+		&self, update: &PaymentDetailsUpdate,
+	) -> Result<PaymentStoreUpdateResult, Error> {
 		let mut locked_payments = self.payments.lock().unwrap();
 
 		if let Some(payment) = locked_payments.get_mut(&update.id) {
-			updated = payment.update(update);
+			let updated = payment.update(update);
 			if updated {
 				self.persist_info(&update.id, payment)?;
+				Ok(PaymentStoreUpdateResult::EntryUpdated)
+			} else {
+				Ok(PaymentStoreUpdateResult::EntryUnchanged)
 			}
+		} else {
+			Ok(PaymentStoreUpdateResult::EntryNotFound)
 		}
-		Ok(updated)
 	}
 
 	pub(crate) fn list_filter<F: FnMut(&&PaymentDetails) -> bool>(
@@ -789,9 +801,22 @@ mod tests {
 		assert_eq!(Ok(true), payment_store.insert(payment));
 		assert!(payment_store.get(&id).is_some());
 
+		// Check update returns `EntryUpdated`
 		let mut update = PaymentDetailsUpdate::new(id);
 		update.status = Some(PaymentStatus::Succeeded);
-		assert_eq!(Ok(true), payment_store.update(&update));
+		assert_eq!(Ok(PaymentStoreUpdateResult::EntryUpdated), payment_store.update(&update));
+
+		// Check no-op update yields `EntryUnchanged`
+		let mut update = PaymentDetailsUpdate::new(id);
+		update.status = Some(PaymentStatus::Succeeded);
+		assert_eq!(Ok(PaymentStoreUpdateResult::EntryUnchanged), payment_store.update(&update));
+
+		// Check bogus update yields `EntryNotFound`
+		let bogus_id = PaymentId([84u8; 32]);
+		let mut update = PaymentDetailsUpdate::new(bogus_id);
+		update.status = Some(PaymentStatus::Succeeded);
+		assert_eq!(Ok(PaymentStoreUpdateResult::EntryNotFound), payment_store.update(&update));
+
 		assert!(payment_store.get(&id).is_some());
 
 		assert_eq!(PaymentStatus::Succeeded, payment_store.get(&id).unwrap().status);