fix: add extra parameters to contract events (OZ CR-XX)

Signed-off-by: Tomás Migone <[email protected]>

Author: juanmardefago

packages/horizon/contracts/interfaces/internal/IHorizonStakingMain.sol

@@ -189,12 +189,14 @@ interface IHorizonStakingMain {
      * @param verifier The address of the verifier
      * @param delegator The address of the delegator
      * @param tokens The amount of tokens undelegated
+     * @param tokens The amount of shares undelegated
      */
     event TokensUndelegated(
         address indexed serviceProvider,
         address indexed verifier,
         address indexed delegator,
-        uint256 tokens
+        uint256 tokens,
+        uint256 shares
     );
 
     /**

packages/horizon/contracts/staking/HorizonStaking.sol

@@ -947,7 +947,7 @@ contract HorizonStaking is HorizonStakingBase, IHorizonStakingMain {
             pool.thawingNonce
         );
 
-        emit TokensUndelegated(_serviceProvider, _verifier, msg.sender, tokens);
+        emit TokensUndelegated(_serviceProvider, _verifier, msg.sender, tokens, _shares);
         return thawRequestId;
     }
 

packages/horizon/test/shared/horizon-staking/HorizonStakingShared.t.sol

@@ -1010,7 +1010,7 @@ abstract contract HorizonStakingSharedTest is GraphBaseTest {
             calcValues.thawRequestId
         );
         vm.expectEmit();
-        emit IHorizonStakingMain.TokensUndelegated(serviceProvider, verifier, delegator, calcValues.tokens);
+        emit IHorizonStakingMain.TokensUndelegated(serviceProvider, verifier, delegator, calcValues.tokens, shares);
         if (legacy) {
             staking.undelegate(serviceProvider, shares);
         } else if (thawRequestType == IHorizonStakingTypes.ThawRequestType.Delegation) {

packages/subgraph-service/contracts/SubgraphService.sol

@@ -227,7 +227,7 @@ contract SubgraphService is
             _allocations.get(allocationId).indexer == indexer,
             SubgraphServiceAllocationNotAuthorized(indexer, allocationId)
         );
-        _closeAllocation(allocationId);
+        _closeAllocation(allocationId, false);
         emit ServiceStopped(indexer, data);
     }
 
@@ -306,7 +306,7 @@ contract SubgraphService is
         Allocation.State memory allocation = _allocations.get(allocationId);
         require(allocation.isStale(maxPOIStaleness), SubgraphServiceCannotForceCloseAllocation(allocationId));
         require(!allocation.isAltruistic(), SubgraphServiceAllocationIsAltruistic(allocationId));
-        _closeAllocation(allocationId);
+        _closeAllocation(allocationId, true);
     }
 
     /// @inheritdoc ISubgraphService
@@ -522,7 +522,14 @@ contract SubgraphService is
             }
         }
 
-        emit QueryFeesCollected(indexer, _signedRav.rav.payer, tokensCollected, tokensCurators);
+        emit QueryFeesCollected(
+            indexer,
+            _signedRav.rav.payer,
+            allocationId,
+            subgraphDeploymentId,
+            tokensCollected,
+            tokensCurators
+        );
         return tokensCollected;
     }
 

packages/subgraph-service/contracts/interfaces/ISubgraphService.sol

@@ -34,12 +34,16 @@ interface ISubgraphService is IDataServiceFees {
      * @notice Emitted when a subgraph service collects query fees from Graph Payments
      * @param serviceProvider The address of the service provider
      * @param payer The address paying for the query fees
+     * @param allocationId The id of the allocation
+     * @param subgraphDeploymentId The id of the subgraph deployment
      * @param tokensCollected The amount of tokens collected
      * @param tokensCurators The amount of tokens curators receive
      */
     event QueryFeesCollected(
         address indexed serviceProvider,
         address indexed payer,
+        address indexed allocationId,
+        bytes32 subgraphDeploymentId,
         uint256 tokensCollected,
         uint256 tokensCurators
     );

packages/subgraph-service/contracts/utilities/AllocationManager.sol

@@ -96,12 +96,14 @@ abstract contract AllocationManager is EIP712Upgradeable, GraphDirectory, Alloca
      * @param allocationId The id of the allocation
      * @param subgraphDeploymentId The id of the subgraph deployment
      * @param tokens The amount of tokens allocated
+     * @param forceClosed Whether the allocation was force closed
      */
     event AllocationClosed(
         address indexed indexer,
         address indexed allocationId,
         bytes32 indexed subgraphDeploymentId,
-        uint256 tokens
+        uint256 tokens,
+        bool forceClosed
     );
 
     /**
@@ -335,9 +337,9 @@ abstract contract AllocationManager is EIP712Upgradeable, GraphDirectory, Alloca
             currentEpoch
         );
 
-        // Check if the indexer is over-allocated and close the allocation if necessary
+        // Check if the indexer is over-allocated and force close the allocation if necessary
         if (_isOverAllocated(allocation.indexer, _delegationRatio)) {
-            _closeAllocation(_allocationId);
+            _closeAllocation(_allocationId, true);
         }
 
         return tokensRewards;
@@ -415,8 +417,9 @@ abstract contract AllocationManager is EIP712Upgradeable, GraphDirectory, Alloca
      * Emits a {AllocationClosed} event
      *
      * @param _allocationId The id of the allocation to be closed
+     * @param _forceClosed Whether the allocation was force closed
      */
-    function _closeAllocation(address _allocationId) internal {
+    function _closeAllocation(address _allocationId, bool _forceClosed) internal {
         Allocation.State memory allocation = _allocations.get(_allocationId);
 
         // Take rewards snapshot to prevent other allos from counting tokens from this allo
@@ -433,7 +436,13 @@ abstract contract AllocationManager is EIP712Upgradeable, GraphDirectory, Alloca
             _subgraphAllocatedTokens[allocation.subgraphDeploymentId] -
             allocation.tokens;
 
-        emit AllocationClosed(allocation.indexer, _allocationId, allocation.subgraphDeploymentId, allocation.tokens);
+        emit AllocationClosed(
+            allocation.indexer,
+            _allocationId,
+            allocation.subgraphDeploymentId,
+            allocation.tokens,
+            _forceClosed
+        );
     }
 
     /**

packages/subgraph-service/test/shared/SubgraphServiceShared.t.sol

@@ -145,7 +145,8 @@ abstract contract SubgraphServiceSharedTest is HorizonStakingSharedTest {
             _indexer,
             allocationId,
             allocation.subgraphDeploymentId,
-            allocation.tokens
+            allocation.tokens,
+            false
         );
         emit IDataService.ServiceStopped(_indexer, _data);
 

packages/subgraph-service/test/subgraphService/SubgraphService.t.sol

@@ -160,7 +160,8 @@ contract SubgraphServiceTest is SubgraphServiceSharedTest {
             allocation.indexer,
             _allocationId,
             allocation.subgraphDeploymentId,
-            allocation.tokens
+            allocation.tokens,
+            true
         );
 
         // close stale allocation
@@ -278,9 +279,10 @@ contract SubgraphServiceTest is SubgraphServiceSharedTest {
         bytes memory _data
     ) private returns (uint256 paymentCollected) {
         IGraphTallyCollector.SignedRAV memory signedRav = abi.decode(_data, (IGraphTallyCollector.SignedRAV));
-        Allocation.State memory allocation = subgraphService.getAllocation(
-            address(uint160(uint256(signedRav.rav.collectionId)))
-        );
+        address allocationId = address(uint160(uint256(signedRav.rav.collectionId)));
+        Allocation.State memory allocation = subgraphService.getAllocation(allocationId);
+        bytes32 subgraphDeploymentId = allocation.subgraphDeploymentId;
+
         address payer = graphTallyCollector.isAuthorized(signedRav.rav.payer, _recoverRAVSigner(signedRav))
             ? signedRav.rav.payer
             : address(0);
@@ -298,7 +300,14 @@ contract SubgraphServiceTest is SubgraphServiceSharedTest {
         uint256 tokensCurators = (paymentCollected - tokensProtocol).mulPPMRoundUp(queryFeeData.curationCut);
 
         vm.expectEmit(address(subgraphService));
-        emit ISubgraphService.QueryFeesCollected(_indexer, payer, paymentCollected, tokensCurators);
+        emit ISubgraphService.QueryFeesCollected(
+            _indexer,
+            payer,
+            allocationId,
+            subgraphDeploymentId,
+            paymentCollected,
+            tokensCurators
+        );
 
         return paymentCollected;
     }

packages/subgraph-service/test/subgraphService/collect/indexing/indexing.t.sol

@@ -7,7 +7,7 @@ import { IGraphPayments } from "@graphprotocol/horizon/contracts/interfaces/IGra
 
 import { ISubgraphService } from "../../../../contracts/interfaces/ISubgraphService.sol";
 import { SubgraphServiceTest } from "../../SubgraphService.t.sol";
-
+import { Allocation } from "../../../../contracts/libraries/Allocation.sol";
 contract SubgraphServiceCollectIndexingTest is SubgraphServiceTest {
     /*
      * TESTS