@@ -1130,7 +1130,7 @@ macro_rules! commitment_signed_dance {
11301130 {
11311131 commitment_signed_dance!( $node_a, $node_b, $commitment_signed, $fail_backwards, true ) ;
11321132 if $fail_backwards {
1133- $crate :: expect_pending_htlcs_forwardable!( $node_a) ;
1133+ expect_pending_htlcs_forwardable!( $node_a, PaymentForwardedFailedConditions :: new ( ) . payment_forwarding_failed ( ) ) ;
11341134 check_added_monitors!( $node_a, 1 ) ;
11351135
11361136 let channel_state = $node_a. node. channel_state. lock( ) . unwrap( ) ;
@@ -1191,24 +1191,81 @@ macro_rules! get_route_and_payment_hash {
11911191 } }
11921192}
11931193
1194+ pub struct PaymentForwardedFailedConditions {
1195+ pub expected_pending_htlcs_forwardable : bool ,
1196+ pub expected_payment_forwarding_failed : Option < u32 > ,
1197+ }
1198+
1199+ impl PaymentForwardedFailedConditions {
1200+ pub fn new ( ) -> Self {
1201+ Self {
1202+ expected_pending_htlcs_forwardable : false ,
1203+ expected_payment_forwarding_failed : None ,
1204+ }
1205+ }
1206+
1207+ pub fn pending_htlcs_forwardable ( mut self ) -> Self {
1208+ self . expected_pending_htlcs_forwardable = true ;
1209+ self
1210+ }
1211+
1212+ pub fn payment_forwarding_failed ( mut self ) -> Self {
1213+ self . expected_payment_forwarding_failed = Some ( 1 ) ;
1214+ self
1215+ }
1216+
1217+ pub fn payment_forwarding_failed_with_count ( mut self , count : u32 ) -> Self {
1218+ self . expected_payment_forwarding_failed = Some ( count) ;
1219+ self
1220+ }
1221+ }
1222+
11941223#[ macro_export]
1195- /// Clears (and ignores) a PendingHTLCsForwardable event
1196- macro_rules! expect_pending_htlcs_forwardable_ignore {
1197- ( $node: expr) => { {
1224+ macro_rules! expect_pending_htlcs_forwardable_conditions {
1225+ ( $node: expr, $conditions: expr) => { {
11981226 let events = $node. node. get_and_clear_pending_events( ) ;
1199- assert_eq!( events. len( ) , 1 ) ;
12001227 match events[ 0 ] {
12011228 $crate:: util:: events:: Event :: PendingHTLCsForwardable { .. } => { } ,
12021229 _ => panic!( "Unexpected event" ) ,
12031230 } ;
1231+
1232+ if let Some ( count) = $conditions. expected_payment_forwarding_failed {
1233+ assert_eq!( events. len( ) as u32 , count + 1u32 ) ;
1234+ match events[ 1 ] {
1235+ $crate:: util:: events:: Event :: PaymentForwardedFailed { .. } => { } ,
1236+ _ => panic!( "Unexpected event" ) ,
1237+ }
1238+ } else {
1239+ assert_eq!( events. len( ) , 1 ) ;
1240+ }
1241+ } }
1242+ }
1243+
1244+ #[ macro_export]
1245+ /// Clears (and ignores) a PendingHTLCsForwardable event
1246+ macro_rules! expect_pending_htlcs_forwardable_ignore {
1247+ ( $node: expr) => { {
1248+ expect_pending_htlcs_forwardable_conditions!( $node, $crate:: ln:: functional_test_utils:: PaymentForwardedFailedConditions :: new( ) ) ;
1249+ } } ;
1250+
1251+ ( $node: expr, $conditions: expr) => { {
1252+ expect_pending_htlcs_forwardable_conditions!( $node, $conditions) ;
12041253 } }
12051254}
12061255
12071256#[ macro_export]
12081257/// Handles a PendingHTLCsForwardable event
12091258macro_rules! expect_pending_htlcs_forwardable {
12101259 ( $node: expr) => { {
1211- $crate:: expect_pending_htlcs_forwardable_ignore!( $node) ;
1260+ expect_pending_htlcs_forwardable_ignore!( $node) ;
1261+ $node. node. process_pending_htlc_forwards( ) ;
1262+
1263+ // Ensure process_pending_htlc_forwards is idempotent.
1264+ $node. node. process_pending_htlc_forwards( ) ;
1265+ } } ;
1266+
1267+ ( $node: expr, $conditions: expr) => { {
1268+ expect_pending_htlcs_forwardable_ignore!( $node, $conditions) ;
12121269 $node. node. process_pending_htlc_forwards( ) ;
12131270
12141271 // Ensure process_pending_htlc_forwards is idempotent.
@@ -1219,6 +1276,8 @@ macro_rules! expect_pending_htlcs_forwardable {
12191276#[ cfg( test) ]
12201277macro_rules! expect_pending_htlcs_forwardable_from_events {
12211278 ( $node: expr, $events: expr, $ignore: expr) => { {
1279+ // We need to clear pending events since there may possibly be `PaymentForwardingFailed` events here
1280+ $node. node. get_and_clear_pending_events( ) ;
12221281 assert_eq!( $events. len( ) , 1 ) ;
12231282 match $events[ 0 ] {
12241283 Event :: PendingHTLCsForwardable { .. } => { } ,
@@ -1692,7 +1751,8 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
16921751 assert_eq ! ( path. last( ) . unwrap( ) . node. get_our_node_id( ) , expected_paths[ 0 ] . last( ) . unwrap( ) . node. get_our_node_id( ) ) ;
16931752 }
16941753 assert ! ( expected_paths[ 0 ] . last( ) . unwrap( ) . node. fail_htlc_backwards( & our_payment_hash) ) ;
1695- expect_pending_htlcs_forwardable ! ( expected_paths[ 0 ] . last( ) . unwrap( ) ) ;
1754+
1755+ expect_pending_htlcs_forwardable ! ( expected_paths[ 0 ] . last( ) . unwrap( ) , PaymentForwardedFailedConditions :: new( ) . payment_forwarding_failed_with_count( expected_paths. len( ) as u32 ) ) ;
16961756 check_added_monitors ! ( expected_paths[ 0 ] . last( ) . unwrap( ) , expected_paths. len( ) ) ;
16971757
16981758 let mut per_path_msgs: Vec < ( ( msgs:: UpdateFailHTLC , msgs:: CommitmentSigned ) , PublicKey ) > = Vec :: with_capacity ( expected_paths. len ( ) ) ;
@@ -1727,7 +1787,7 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
17271787 node. node . handle_update_fail_htlc ( & prev_node. node . get_our_node_id ( ) , & next_msgs. as_ref ( ) . unwrap ( ) . 0 ) ;
17281788 commitment_signed_dance ! ( node, prev_node, next_msgs. as_ref( ) . unwrap( ) . 1 , update_next_node) ;
17291789 if !update_next_node {
1730- expect_pending_htlcs_forwardable ! ( node) ;
1790+ expect_pending_htlcs_forwardable ! ( node, PaymentForwardedFailedConditions :: new ( ) . payment_forwarding_failed ( ) ) ;
17311791 }
17321792 }
17331793 let events = node. node . get_and_clear_pending_msg_events ( ) ;
0 commit comments