Provide a redundant Event::PaymentClaimed on restart if needed

If we crashed during a payment claim and then detected a partial
claim on restart, we should ensure the user is aware that the
payment has been claimed. We do so here by using the new
partial-claim detection logic to create a `PaymentClaimed` event.

Author: TheBlueMatt

lightning/src/ln/channelmanager.rs

@@ -6772,8 +6772,21 @@ impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
 		for (_, monitor) in args.channel_monitors.iter() {
 			for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
 				if let Some(claimable_htlcs) = claimable_htlcs.remove(&payment_hash) {
+
 					log_info!(args.logger, "Re-claimaing HTLCs with payment hash {} due to partial-claim.", log_bytes!(payment_hash.0));
+					let mut purpose = None;
+					let mut claimable_amt_msat = 0;
 					for claimable_htlc in claimable_htlcs {
+						if purpose.is_none() {
+							purpose = Some(match claimable_htlc.onion_payload {
+								OnionPayload::Spontaneous(preimage) => events::PaymentPurpose::SpontaneousPayment(preimage),
+								OnionPayload::Invoice(hop_data) => events::PaymentPurpose::InvoicePayment {
+									payment_secret: hop_data.payment_secret,
+									payment_preimage: Some(payment_preimage),
+								}
+							});
+						}
+						claimable_amt_msat += claimable_htlc.value;
 						let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
 						if let Some(channel) = by_id.get_mut(&previous_channel_id) {
 							channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
@@ -6782,6 +6795,11 @@ impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
 							previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &args.fee_estimator, &args.logger);
 						}
 					}
+					pending_events_read.push(events::Event::PaymentClaimed {
+						payment_hash,
+						purpose: purpose.unwrap(),
+						amt: claimable_amt_msat,
+					});
 				}
 			}
 		}

lightning/src/ln/functional_tests.rs

@@ -9600,6 +9600,9 @@ fn do_test_partial_claim_before_restart(persist_both_monitors: bool) {
 	// To get to the correct state, on startup we should propagate the preimage to the
 	// still-off-chain channel, claiming the HTLC as soon as the peer connects, with the monitor
 	// receiving the preimage without a state update.
+	//
+	// Further, we should generate a `PaymentClaimed` event to inform the user that the payment was
+	// definitely claimed.
 	let chanmon_cfgs = create_chanmon_cfgs(4);
 	let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 	let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
@@ -9717,13 +9720,19 @@ fn do_test_partial_claim_before_restart(persist_both_monitors: bool) {
 	// commitment transaction. We should also still have the original PaymentReceived event we
 	// never finished processing.
 	let events = nodes[3].node.get_and_clear_pending_events();
-	assert_eq!(events.len(), if persist_both_monitors { 3 } else { 2 });
+	assert_eq!(events.len(), if persist_both_monitors { 4 } else { 3 });
 	if let Event::PaymentReceived { amt: 15_000_000, .. } = events[0] { } else { panic!(); }
 	if let Event::ChannelClosed { reason: ClosureReason::OutdatedChannelManager, .. } = events[1] { } else { panic!(); }
 	if persist_both_monitors {
 		if let Event::ChannelClosed { reason: ClosureReason::OutdatedChannelManager, .. } = events[2] { } else { panic!(); }
 	}
 
+	// On restart, we should also get a duplicate PaymentClaimed event as we persisted the
+	// ChannelManager prior to handling the original one.
+	if let Event::PaymentClaimed { payment_hash: our_payment_hash, amt: 15_000_000, .. } = events[if persist_both_monitors { 3 } else { 2 }] {
+		assert_eq!(payment_hash, our_payment_hash);
+	} else { panic!(); }
+
 	assert_eq!(nodes[3].node.list_channels().len(), if persist_both_monitors { 0 } else { 1 });
 	if !persist_both_monitors {
 		// If one of the two channels is still live, reveal the payment preimage over it.