chore: add paymentId to TAPCollector tokens tracking

Author: Maikol

packages/horizon/contracts/interfaces/IPaymentsCollector.sol

@@ -23,7 +23,8 @@ interface IPaymentsCollector {
      * @param tokens The amount of tokens being collected
      */
     event PaymentCollected(
-        IGraphPayments.PaymentTypes indexed paymentType,
+        IGraphPayments.PaymentTypes paymentType,
+        address indexed paymentId,
         address indexed payer,
         address receiver,
         address indexed dataService,

packages/horizon/contracts/interfaces/ITAPCollector.sol

@@ -25,6 +25,8 @@ interface ITAPCollector is IPaymentsCollector {
 
     /// @notice The Receipt Aggregate Voucher (RAV) struct
     struct ReceiptAggregateVoucher {
+        // The ID of the payment
+        address paymentId;
         // The address of the payer the RAV was issued by
         address payer;
         // The address of the data service the RAV was issued to

packages/horizon/contracts/payments/collectors/TAPCollector.sol

@@ -36,7 +36,7 @@ contract TAPCollector is EIP712, GraphDirectory, ITAPCollector {
     mapping(address signer => PayerAuthorization authorizedSigner) public authorizedSigners;
 
     /// @notice Tracks the amount of tokens already collected by a data service from a payer to a receiver
-    mapping(address dataService => mapping(address receiver => mapping(address payer => uint256 tokens)))
+    mapping(address dataService => mapping(address paymentId => mapping(address receiver => mapping(address payer => uint256 tokens))))
         public tokensCollected;
 
     /// @notice The duration (in seconds) in which a signer is thawing before they can be revoked
@@ -182,6 +182,7 @@ contract TAPCollector is EIP712, GraphDirectory, ITAPCollector {
         address payer = authorizedSigners[signer].payer;
         require(signedRAV.rav.payer == payer, TAPCollectorInvalidRAVPayer(payer, signedRAV.rav.payer));
 
+        address paymentId = signedRAV.rav.paymentId;
         address dataService = signedRAV.rav.dataService;
         address receiver = signedRAV.rav.serviceProvider;
 
@@ -199,7 +200,7 @@ contract TAPCollector is EIP712, GraphDirectory, ITAPCollector {
         uint256 tokensToCollect = 0;
         {
             uint256 tokensRAV = signedRAV.rav.valueAggregate;
-            uint256 tokensAlreadyCollected = tokensCollected[dataService][receiver][payer];
+            uint256 tokensAlreadyCollected = tokensCollected[dataService][paymentId][receiver][payer];
             require(
                 tokensRAV > tokensAlreadyCollected,
                 TAPCollectorInconsistentRAVTokens(tokensRAV, tokensAlreadyCollected)
@@ -217,11 +218,11 @@ contract TAPCollector is EIP712, GraphDirectory, ITAPCollector {
         }
 
         if (tokensToCollect > 0) {
-            tokensCollected[dataService][receiver][payer] += tokensToCollect;
+            tokensCollected[dataService][paymentId][receiver][payer] += tokensToCollect;
             _graphPaymentsEscrow().collect(_paymentType, payer, receiver, tokensToCollect, dataService, dataServiceCut);
         }
 
-        emit PaymentCollected(_paymentType, payer, receiver, dataService, tokensToCollect);
+        emit PaymentCollected(_paymentType, paymentId, payer, receiver, dataService, tokensToCollect);
         emit RAVCollected(
             payer,
             dataService,

packages/horizon/test/payments/tap-collector/TAPCollector.t.sol

@@ -142,6 +142,7 @@ contract TAPCollectorTest is HorizonStakingSharedTest, PaymentsEscrowSharedTest
         (address _payer, , ) = tapCollector.authorizedSigners(_signer);
         uint256 tokensAlreadyCollected = tapCollector.tokensCollected(
             signedRAV.rav.dataService,
+            signedRAV.rav.paymentId,
             signedRAV.rav.serviceProvider,
             _payer
         );
@@ -152,6 +153,7 @@ contract TAPCollectorTest is HorizonStakingSharedTest, PaymentsEscrowSharedTest
         vm.expectEmit(address(tapCollector));
         emit IPaymentsCollector.PaymentCollected(
             _paymentType,
+            signedRAV.rav.paymentId,
             _payer,
             signedRAV.rav.serviceProvider,
             signedRAV.rav.dataService,
@@ -173,6 +175,7 @@ contract TAPCollectorTest is HorizonStakingSharedTest, PaymentsEscrowSharedTest
 
         uint256 tokensCollectedAfter = tapCollector.tokensCollected(
             signedRAV.rav.dataService,
+            signedRAV.rav.paymentId,
             signedRAV.rav.serviceProvider,
             _payer
         );