Don't send PaymentReceived events for rebalances

Author: benthecarman

orange-sdk/src/event.rs

@@ -1,5 +1,5 @@
 use crate::logging::Logger;
-use crate::store::{self, PaymentId};
+use crate::store::{self, PaymentId, TxMetadataStore};
 
 use ldk_node::bitcoin::secp256k1::PublicKey;
 use ldk_node::bitcoin::{OutPoint, Txid};
@@ -308,6 +308,7 @@ impl Future for EventFuture {
 #[derive(Clone)]
 pub(crate) struct LdkEventHandler {
 	pub(crate) event_queue: Arc<EventQueue>,
+	pub(crate) tx_metadata: TxMetadataStore,
 	pub(crate) ldk_node: Arc<ldk_node::Node>,
 	pub(crate) payment_receipt_sender: watch::Sender<()>,
 	pub(crate) channel_pending_sender: watch::Sender<u128>,
@@ -357,15 +358,24 @@ impl LdkEventHandler {
 						None
 					}
 				});
-				if let Err(e) = self.event_queue.add_event(Event::PaymentReceived {
-					payment_id: PaymentId::Lightning(payment_id.0), // safe
-					payment_hash,
-					amount_msat,
-					custom_records,
-					lsp_fee_msats,
-				}) {
-					log_error!(self.logger, "Failed to add PaymentReceived event: {e:?}");
-					return;
+
+				let payment_id = PaymentId::Trusted(payment_id.0);
+				let is_rebalance = {
+					let map = self.tx_metadata.read();
+					map.get(&payment_id).is_some_and(|m| m.ty.is_rebalance())
+				};
+
+				// If this is a rebalance payment, we do not emit a PaymentReceived event.
+				if !is_rebalance {
+					if let Err(e) = self.event_queue.add_event(Event::PaymentReceived {
+						payment_id,
+						payment_hash,
+						amount_msat,
+						custom_records,
+						lsp_fee_msats,
+					}) {
+						log_error!(self.logger, "Failed to add PaymentReceived event: {e:?}");
+					}
 				}
 				let _ = self.payment_receipt_sender.send(());
 			},

orange-sdk/src/lib.rs

@@ -556,6 +556,7 @@ impl Wallet {
 				config,
 				Arc::clone(&store),
 				Arc::clone(&event_queue),
+				tx_metadata.clone(),
 				Arc::clone(&logger),
 			)
 			.await?,

orange-sdk/src/lightning_wallet.rs

@@ -1,7 +1,7 @@
 use crate::bitcoin::OutPoint;
 use crate::event::{EventQueue, LdkEventHandler};
 use crate::logging::Logger;
-use crate::store::TxStatus;
+use crate::store::{TxMetadataStore, TxStatus};
 use crate::{ChainSource, InitFailure, PaymentType, Seed, WalletConfig};
 
 use bitcoin_payment_instructions::PaymentMethod;
@@ -53,7 +53,7 @@ const DEFAULT_INVOICE_EXPIRY_SECS: u32 = 86_400; // 24 hours
 impl LightningWallet {
 	pub(super) async fn init(
 		runtime: Arc<Runtime>, config: WalletConfig, store: Arc<dyn KVStore + Sync + Send>,
-		event_queue: Arc<EventQueue>, logger: Arc<Logger>,
+		event_queue: Arc<EventQueue>, tx_metadata: TxMetadataStore, logger: Arc<Logger>,
 	) -> Result<Self, InitFailure> {
 		let anchor_channels_config = ldk_node::config::AnchorChannelsConfig {
 			trusted_peers_no_reserve: vec![config.lsp.1],
@@ -154,6 +154,7 @@ impl LightningWallet {
 			ldk_node: Arc::clone(&ldk_node),
 			payment_receipt_sender,
 			channel_pending_sender,
+			tx_metadata,
 			logger,
 		});
 		let inner = Arc::new(LightningWalletImpl {

orange-sdk/tests/integration_tests.rs

@@ -159,10 +159,6 @@ fn test_sweep_to_ln() {
 			_ => panic!("Expected ChannelOpened event"),
 		}
 
-		// LDK node receives the rebalance payment, todo we should probably not output this event
-		let event = wait_next_event(&wallet).await;
-		assert!(matches!(event, Event::PaymentReceived { .. }));
-
 		let event = wait_next_event(&wallet).await;
 		match event {
 			Event::RebalanceSuccessful { amount_msat, fee_msat, .. } => {