Return path events from expect_payment_sent

Prepare for inspecting hold times in PaymentPathSuccessful.

Author: joostjager

lightning/src/ln/async_payments_tests.rs

@@ -605,7 +605,7 @@ fn async_receive_flow_success() {
 	let args = PassAlongPathArgs::new(&nodes[0], route[0], amt_msat, payment_hash, ev);
 	let claimable_ev = do_pass_along_path(args).unwrap();
 	let keysend_preimage = extract_payment_preimage(&claimable_ev);
-	let res =
+	let (res, _) =
 		claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], route, keysend_preimage));
 	assert_eq!(res, Some(PaidBolt12Invoice::StaticInvoice(static_invoice)));
 }

lightning/src/ln/functional_test_utils.rs

@@ -2840,11 +2840,13 @@ macro_rules! expect_payment_claimed {
 	};
 }
 
+/// Inspect events to assert that a payment was sent. If this was a BOLT 12 payment, the BOLT 12 invoice is returned. If
+/// per-path claims are expected, the events for each path are returned as well.
 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM = CM>>(
 	node: &H, expected_payment_preimage: PaymentPreimage,
 	expected_fee_msat_opt: Option<Option<u64>>, expect_per_path_claims: bool,
 	expect_post_ev_mon_update: bool,
-) -> Option<PaidBolt12Invoice> {
+) -> (Option<PaidBolt12Invoice>, Vec<Event>) {
 	let events = node.node().get_and_clear_pending_events();
 	let expected_payment_hash = PaymentHash(
 		bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).to_byte_array(),
@@ -2859,6 +2861,7 @@ pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM = CM>>(
 	}
 	// We return the invoice because some test may want to check the invoice details.
 	let invoice;
+	let mut path_events = Vec::new();
 	let expected_payment_id = match events[0] {
 		Event::PaymentSent {
 			ref payment_id,
@@ -2887,12 +2890,14 @@ pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM = CM>>(
 				Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
 					assert_eq!(payment_id, expected_payment_id);
 					assert_eq!(payment_hash, Some(expected_payment_hash));
+
+					path_events.push(events[i].clone());
 				},
 				_ => panic!("Unexpected event"),
 			}
 		}
 	}
-	invoice
+	(invoice, path_events)
 }
 
 #[macro_export]
@@ -3904,15 +3909,17 @@ pub fn pass_claimed_payment_along_route(args: ClaimAlongRouteArgs) -> u64 {
 
 	expected_total_fee_msat
 }
-pub fn claim_payment_along_route(args: ClaimAlongRouteArgs) -> Option<PaidBolt12Invoice> {
+pub fn claim_payment_along_route(
+	args: ClaimAlongRouteArgs,
+) -> (Option<PaidBolt12Invoice>, Vec<Event>) {
 	let origin_node = args.origin_node;
 	let payment_preimage = args.payment_preimage;
 	let skip_last = args.skip_last;
 	let expected_total_fee_msat = do_claim_payment_along_route(args);
 	if !skip_last {
 		expect_payment_sent!(origin_node, payment_preimage, Some(expected_total_fee_msat))
 	} else {
-		None
+		(None, Vec::new())
 	}
 }
 
@@ -3925,6 +3932,7 @@ pub fn claim_payment<'a, 'b, 'c>(
 		&[expected_route],
 		our_payment_preimage,
 	))
+	.0
 }
 
 pub const TEST_FINAL_CLTV: u32 = 70;