f document whats up

Author: TheBlueMatt

lightning/src/ln/functional_tests.rs

@@ -1284,26 +1284,26 @@ fn test_duplicate_htlc_different_direction_onchain() {
 	let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
 	assert_eq!(claim_txn.len(), 8);
 
-	check_spends!(claim_txn[0], remote_txn[0]);
+	check_spends!(claim_txn[0], remote_txn[0]); // Immediate HTLC claim with preimage
 
-	check_spends!(claim_txn[1], chan_1.3);
-	check_spends!(claim_txn[2], claim_txn[1]);
+	check_spends!(claim_txn[1], chan_1.3); // Alternative commitment tx
+	check_spends!(claim_txn[2], claim_txn[1]); // HTLC spend in alternative commitment tx
 
 	let bump_tx = if claim_txn[1] == claim_txn[4] {
 		assert_eq!(claim_txn[1], claim_txn[4]);
 		assert_eq!(claim_txn[2], claim_txn[5]);
 
-		check_spends!(claim_txn[7], claim_txn[1]);
+		check_spends!(claim_txn[7], claim_txn[1]); // HTLC timeout on alternative commitment tx
 
-		check_spends!(claim_txn[3], remote_txn[0]);
+		check_spends!(claim_txn[3], remote_txn[0]); // HTLC timeout on broadcasted commitment tx
 		&claim_txn[3]
 	} else {
 		assert_eq!(claim_txn[1], claim_txn[3]);
 		assert_eq!(claim_txn[2], claim_txn[4]);
 
-		check_spends!(claim_txn[5], claim_txn[1]);
+		check_spends!(claim_txn[5], claim_txn[1]); // HTLC timeout on alternative commitment tx
 
-		check_spends!(claim_txn[7], remote_txn[0]);
+		check_spends!(claim_txn[7], remote_txn[0]); // HTLC timeout on broadcasted commitment tx
 
 		&claim_txn[7]
 	};