f - add events

Author: matiasedgeandnode

IndexingPaymentsTodo.md

@@ -4,7 +4,7 @@
 * Economics
   * If service wants to collect more than collector allows. Collector limits but doesn't tell the service?
   * Since an allocation is required for collecting, do we want to expect that the allocation is not stale? Do we want to add code to collect rewards as part of the collection of fees? Make sure allocation is more than one epoch old if we attempt this.
-  * What happens if the escrow doesn't have enough funds? Since you can't collect that means you lose out forever?
+  * What should happen if the escrow doesn't have enough funds?
   * Don't pay for entities on initial collection? Where did we land in terms of payment terms?
   * Should we set a different param for initial collection time max? Some subgraphs take a lot to catch up.
   * How do we solve for the case where an indexer has reached their max expected payout for the initial sync but haven't reached the current epoch (thus their POI is incorrect)?
@@ -14,7 +14,6 @@
 * If an indexer closes an allocation, what should happen to the accepeted agreement?
 * test_SubgraphService_CollectIndexingFee_Integration fails with PaymentsEscrowInconsistentCollection
 * Reduce the number of errors declared and returned
-* Missing events for accept, cancel, upgrade RCAs.
 * Switch `duration` for `endsAt`?
 
 # Done
@@ -28,3 +27,4 @@
 * DONE: ~~Maybe IRecurringCollector.cancel(address payer, address serviceProvider, bytes16 agreementId) should only take in agreementId?~~
 * DONE: ~~Unify to one error in Decoder.sol~~
 * DONE: ~~Built-in upgrade path to indexing agreements v2~~
+* DONE: ~~Missing events for accept, cancel, upgrade RCAs.~~

packages/horizon/contracts/interfaces/IRecurringCollector.sol

@@ -115,6 +115,58 @@ interface IRecurringCollector is IAuthorizable, IPaymentsCollector {
         uint256 dataServiceCut;
     }
 
+    /**
+     * @notice Emitted when an agreement is accepted
+     * @param dataService The address of the data service
+     * @param payer The address of the payer
+     * @param serviceProvider The address of the service provider
+     */
+    event AgreementAccepted(
+        address indexed dataService,
+        address indexed payer,
+        address indexed serviceProvider,
+        bytes16 agreementId,
+        uint256 acceptedAt,
+        uint256 duration,
+        uint256 maxInitialTokens,
+        uint256 maxOngoingTokensPerSecond,
+        uint32 minSecondsPerCollection,
+        uint32 maxSecondsPerCollection
+    );
+
+    /**
+     * @notice Emitted when an agreement is canceled
+     * @param dataService The address of the data service
+     * @param payer The address of the payer
+     * @param serviceProvider The address of the service provider
+     */
+    event AgreementCanceled(
+        address indexed dataService,
+        address indexed payer,
+        address indexed serviceProvider,
+        bytes16 agreementId,
+        uint256 canceledAt
+    );
+
+    /**
+     * @notice Emitted when an agreement is upgraded
+     * @param dataService The address of the data service
+     * @param payer The address of the payer
+     * @param serviceProvider The address of the service provider
+     */
+    event AgreementUpgraded(
+        address indexed dataService,
+        address indexed payer,
+        address indexed serviceProvider,
+        bytes16 agreementId,
+        uint256 upgradedAt,
+        uint256 duration,
+        uint256 maxInitialTokens,
+        uint256 maxOngoingTokensPerSecond,
+        uint32 minSecondsPerCollection,
+        uint32 maxSecondsPerCollection
+    );
+
     /**
      * @notice Emitted when an RCA is collected
      * @param dataService The address of the data service

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

@@ -102,6 +102,19 @@ contract RecurringCollector is EIP712, GraphDirectory, Authorizable, IRecurringC
         agreement.minSecondsPerCollection = signedRCA.rca.minSecondsPerCollection;
         agreement.maxSecondsPerCollection = signedRCA.rca.maxSecondsPerCollection;
         _requireValidAgreement(agreement, signedRCA.rca.agreementId);
+
+        emit AgreementAccepted(
+            agreement.dataService,
+            agreement.payer,
+            agreement.serviceProvider,
+            signedRCA.rca.agreementId,
+            agreement.acceptedAt,
+            agreement.duration,
+            agreement.maxInitialTokens,
+            agreement.maxOngoingTokensPerSecond,
+            agreement.minSecondsPerCollection,
+            agreement.maxSecondsPerCollection
+        );
     }
 
     /**
@@ -117,6 +130,14 @@ contract RecurringCollector is EIP712, GraphDirectory, Authorizable, IRecurringC
             RecurringCollectorDataServiceNotAuthorized(agreementId, msg.sender)
         );
         agreement.acceptedAt = CANCELED;
+
+        emit AgreementCanceled(
+            agreement.dataService,
+            agreement.payer,
+            agreement.serviceProvider,
+            agreementId,
+            block.timestamp
+        );
     }
 
     /**
@@ -147,6 +168,19 @@ contract RecurringCollector is EIP712, GraphDirectory, Authorizable, IRecurringC
         agreement.minSecondsPerCollection = signedRCAU.rcau.minSecondsPerCollection;
         agreement.maxSecondsPerCollection = signedRCAU.rcau.maxSecondsPerCollection;
         _requireValidAgreement(agreement, signedRCAU.rcau.agreementId);
+
+        emit AgreementUpgraded(
+            agreement.dataService,
+            agreement.payer,
+            agreement.serviceProvider,
+            signedRCAU.rcau.agreementId,
+            block.timestamp,
+            agreement.duration,
+            agreement.maxInitialTokens,
+            agreement.maxOngoingTokensPerSecond,
+            agreement.minSecondsPerCollection,
+            agreement.maxSecondsPerCollection
+        );
     }
 
     /**

packages/horizon/test/payments/recurring-collector/shared.t.sol

@@ -63,13 +63,34 @@ contract RecurringCollectorSharedTest is Test, Bounder {
         _recurringCollectorHelper.authorizeSignerWithChecks(_rca.payer, _signerKey);
         IRecurringCollector.SignedRCA memory signedRCA = _recurringCollectorHelper.generateSignedRCA(_rca, _signerKey);
 
+        vm.expectEmit(address(_recurringCollector));
+        emit IRecurringCollector.AgreementAccepted(
+            _rca.dataService,
+            _rca.payer,
+            _rca.serviceProvider,
+            _rca.agreementId,
+            block.timestamp,
+            _rca.duration,
+            _rca.maxInitialTokens,
+            _rca.maxOngoingTokensPerSecond,
+            _rca.minSecondsPerCollection,
+            _rca.maxSecondsPerCollection
+        );
         vm.prank(_rca.dataService);
         _recurringCollector.accept(signedRCA);
 
         return signedRCA;
     }
 
     function _cancel(IRecurringCollector.RecurringCollectionAgreement memory _rca) internal {
+        vm.expectEmit(address(_recurringCollector));
+        emit IRecurringCollector.AgreementCanceled(
+            _rca.dataService,
+            _rca.payer,
+            _rca.serviceProvider,
+            _rca.agreementId,
+            block.timestamp
+        );
         vm.prank(_rca.dataService);
         _recurringCollector.cancel(_rca.agreementId);
     }

packages/horizon/test/payments/recurring-collector/upgrade.t.sol

@@ -127,6 +127,19 @@ contract RecurringCollectorUpgradeTest is RecurringCollectorSharedTest {
             signerKey
         );
 
+        vm.expectEmit(address(_recurringCollector));
+        emit IRecurringCollector.AgreementUpgraded(
+            rca.dataService,
+            rca.payer,
+            rca.serviceProvider,
+            rcau.agreementId,
+            block.timestamp,
+            rcau.duration,
+            rcau.maxInitialTokens,
+            rcau.maxOngoingTokensPerSecond,
+            rcau.minSecondsPerCollection,
+            rcau.maxSecondsPerCollection
+        );
         vm.prank(rca.dataService);
         _recurringCollector.upgrade(signedRCAU);