Filter for the initiator for received payment events

[ci integration]

Author: LefterisJP

docs/changelog.rst

@@ -2,9 +2,11 @@
 Changelog
 =========
 
+
 * :feature:`2287` Internal events now have timestamps.
 * :feature:`2307` Matrix discovery rooms now are decentralized, aliased and shared by all servers in the federation
 * :bug:`2461` Always return payment received events irrespective of the target parameter.
+* :bug:`2461` For received payments events filter based on the initiator.
 * :feature:`2252` Adds payment history page to the webui.
 * :bug:`2367` Token network selection dropdown will not filter out not connected networks.
 * :bug:`2453` Connection manager will no longer be stuck if there are no available channel partners

raiden/api/python.py

@@ -42,14 +42,15 @@
 def event_filter_for_payments(
         event: architecture.Event,
         token_network_identifier: typing.TokenNetworkID = None,
-        target_address: typing.Address = None,
+        partner_address: typing.Address = None,
 ) -> bool:
     """Filters out non payment history related events
 
     - If no other args are given, all payment related events match
     - If a token network identifier is given then only payment events for that match
-    - If a target is also given then if the event is a payment sent event and the
-      target matches it's returned. If it's a payment received it's always returned.
+    - If a partner is also given then if the event is a payment sent event and the
+      target matches it's returned. If it's a payment received and the initiator matches
+      then it's returned.
     """
     is_matching_event = (
         isinstance(event, EVENTS_PAYMENT_HISTORY_RELATED) and
@@ -64,11 +65,18 @@ def event_filter_for_payments(
     sent_and_target_matches = (
         isinstance(event, (EventPaymentSentFailed, EventPaymentSentSuccess)) and
         (
-            target_address is None or
-            event.target == target_address
+            partner_address is None or
+            event.target == partner_address
         )
     )
-    return sent_and_target_matches or isinstance(event, (EventPaymentReceivedSuccess))
+    received_and_initiator_matches = (
+        isinstance(event, (EventPaymentSentFailed, EventPaymentReceivedSuccess)) and
+        (
+            partner_address is None or
+            event.initiator == partner_address
+        )
+    )
+    return sent_and_target_matches or received_and_initiator_matches
 
 
 class RaidenAPI:
@@ -698,7 +706,7 @@ def get_raiden_events_payment_history_with_timestamps(
             ) if event_filter_for_payments(
                 event=event.wrapped_event,
                 token_network_identifier=token_network_identifier,
-                target_address=target_address,
+                partner_address=target_address,
             )
         ]
 

raiden/tests/integration/api/test_restapi.py

@@ -1257,6 +1257,7 @@ def test_payment_events_endpoints(test_api_server, raiden_network, token_address
     identifier1 = 42
     token_address = token_addresses[0]
 
+    app0_address = app0.raiden.address
     target1_address = app1.raiden.address
     target2_address = app2.raiden.address
 
@@ -1512,13 +1513,17 @@ def test_payment_events_endpoints(test_api_server, raiden_network, token_address
     response = request.send().response
     assert_proper_response(response, HTTPStatus.OK)
     response = response.json()
-    assert must_have_events(
+    assert must_have_event(
         response,
         {
             'event': 'EventPaymentSentSuccess',
             'identifier': identifier3,
             'target': to_checksum_address(target2_address),
-        }, {
+        },
+    )
+    assert not must_have_event(
+        response,
+        {
             'event': 'EventPaymentReceivedSuccess',
             'identifier': identifier1,
         },
@@ -1534,20 +1539,46 @@ def test_payment_events_endpoints(test_api_server, raiden_network, token_address
     response = request.send().response
     assert_proper_response(response, HTTPStatus.OK)
     response = response.json()
-    assert must_have_event(
+    assert len(response) == 0
+    # test endpoint for token and partner for target2
+    request = grequests.get(
+        api_url_for(
+            app2_server,
+            'token_target_paymentresource',
+            token_address=token_address,
+            target_address=app0_address,
+        ),
+    )
+    response = request.send().response
+    assert_proper_response(response, HTTPStatus.OK)
+    response = response.json()
+    assert must_have_events(
+        response,
+        {
+            'event': 'EventPaymentReceivedSuccess',
+            'identifier': identifier2,
+        },
+    )
+    assert not must_have_event(
         response,
         {
             'event': 'EventPaymentReceivedSuccess',
             'identifier': identifier1,
         },
     )
-    # test endpoint for token and partner for target2
+    assert not must_have_event(
+        response,
+        {
+            'event': 'EventPaymentReceivedSuccess',
+            'identifier': identifier3,
+        },
+    )
     request = grequests.get(
         api_url_for(
             app2_server,
             'token_target_paymentresource',
             token_address=token_address,
-            target_address=target2_address,
+            target_address=target1_address,
         ),
     )
     response = request.send().response
@@ -1556,13 +1587,17 @@ def test_payment_events_endpoints(test_api_server, raiden_network, token_address
     assert must_have_events(
         response,
         {
-            'event': 'EventPaymentReceivedSuccess',
-            'identifier': identifier2,
-        }, {
             'event': 'EventPaymentReceivedSuccess',
             'identifier': identifier3,
         },
     )
+    assert not must_have_event(
+        response,
+        {
+            'event': 'EventPaymentReceivedSuccess',
+            'identifier': identifier2,
+        },
+    )
     assert not must_have_event(
         response,
         {