refactor: event args

.

Author: heueristik

src/XanV1.sol

@@ -209,9 +209,13 @@ contract XanV1 is
         {
             Council.Data storage councilData = _getCouncilData();
             if (councilData.scheduledEndTime != 0 && councilData.scheduledImpl != address(0)) {
-                _cancelCouncilUpgrade();
+                // TODO! Ask Chris: Should we check `_checkDelayCriterion(councilData.scheduledEndTime);`
 
-                emit CouncilUpgradeVetoed(); // TODO! Revisit event args
+                emit CouncilUpgradeVetoed(councilData.scheduledImpl);
+
+                // Reset the scheduled
+                councilData.scheduledImpl = address(0);
+                councilData.scheduledEndTime = 0;
             }
         }
     }
@@ -220,10 +224,9 @@ contract XanV1 is
     function cancelVoterBodyUpgrade() external override {
         Voting.Data storage data = _getVotingData();
 
+        // TODO! Confirm with Chris
         _checkDelayCriterion(data.scheduledEndTime);
 
-        // TODO! check min quorum
-
         // Revert the cancellation if the currently scheduled implementation still
         // * meets the quorum and minimum locked supply for the
         // * is the best ranked implementation
@@ -235,7 +238,7 @@ contract XanV1 is
             revert UpgradeCancellationInvalid(data.scheduledImpl, data.scheduledEndTime);
         }
 
-        emit VoterBodyUpgradeCancelled(data.scheduledImpl, data.scheduledEndTime);
+        emit VoterBodyUpgradeCancelled(data.scheduledImpl);
 
         // Reset the scheduled upgrade
         data.scheduledImpl = address(0);
@@ -271,8 +274,15 @@ contract XanV1 is
 
     /// @notice @inheritdoc IXanV1
     function cancelCouncilUpgrade() external override onlyCouncil {
-        emit CouncilUpgradeCancelled();
-        _cancelCouncilUpgrade();
+        Council.Data storage data = _getCouncilData();
+
+        // TODO! Ask Chris: Should we check `_checkDelayCriterion(data.scheduledEndTime);`
+
+        emit CouncilUpgradeCancelled(data.scheduledImpl);
+
+        // Reset the scheduled
+        data.scheduledImpl = address(0);
+        data.scheduledEndTime = 0;
     }
 
     /// @notice @inheritdoc IXanV1
@@ -290,10 +300,15 @@ contract XanV1 is
             revert QuorumOrMinLockedSupplyNotReached(bestRankedImplementation);
         }
 
-        emit CouncilUpgradeVetoed();
+        Council.Data storage data = _getCouncilData();
+
+        // TODO! Ask Chris: Should we check `_checkDelayCriterion(data.scheduledEndTime);`
 
-        // Cancel the council upgrade
-        _cancelCouncilUpgrade();
+        emit CouncilUpgradeVetoed(data.scheduledImpl);
+
+        // Reset the scheduled upgrade
+        data.scheduledImpl = address(0);
+        data.scheduledEndTime = 0;
     }
 
     /// @inheritdoc IXanV1
@@ -400,14 +415,6 @@ contract XanV1 is
         emit Locked({account: account, value: value});
     }
 
-    /// @notice Cancels the scheduled upgrade by the council by resetting it to 0.
-    function _cancelCouncilUpgrade() internal {
-        Council.Data storage data = _getCouncilData();
-
-        data.scheduledImpl = address(0);
-        data.scheduledEndTime = 0;
-    }
-
     /// @notice Authorizes an upgrade.
     /// @param newImpl The new implementation to authorize the upgrade to.
     function _authorizeUpgrade(address newImpl) internal view override {

src/interfaces/IXanV1.sol

@@ -26,21 +26,21 @@ interface IXanV1 {
 
     /// @notice Emitted  when the upgrade to a new implementation proposed by the voter body is cancelled.
     /// @param impl The implementation that has been cancelled.
-    /// @param endTime The end time of the delay period.
-    event VoterBodyUpgradeCancelled(address indexed impl, uint48 endTime);
+    event VoterBodyUpgradeCancelled(address indexed impl);
 
     /// @notice Emitted when the upgrade to a new implementation proposed by the governance council is scheduled.
     /// @param impl The implementation that has been scheduled.
     /// @param endTime The end time of the delay period.
     event CouncilUpgradeScheduled(address indexed impl, uint48 endTime);
 
     /// @notice Emitted when the upgrade scheduled by the governance council is cancelled.
-    // TODO! do we need to emit data
-    event CouncilUpgradeCancelled();
+    /// @param impl The implementation to which the upgrade has been cancelled by the governance council.
+    event CouncilUpgradeCancelled(address indexed impl);
 
     /// @notice Emitted when the upgrade to a new implementation proposed by the governance council is vetoed
     /// by the voter body.
-    event CouncilUpgradeVetoed();
+    /// @param impl The implementation to which the upgrade has been vetoed by the voter body.
+    event CouncilUpgradeVetoed(address indexed impl);
 
     /// @notice Permanently locks tokens for the current implementation until it gets upgraded.
     /// @param value The value to be locked.

test/XanV1.council.t.sol

@@ -121,7 +121,7 @@ contract XanV1CouncilTest is Test {
         _xanProxy.scheduleCouncilUpgrade(_NEW_IMPL);
 
         vm.expectEmit(address(_xanProxy));
-        emit IXanV1.CouncilUpgradeCancelled();
+        emit IXanV1.CouncilUpgradeCancelled(_NEW_IMPL);
         _xanProxy.cancelCouncilUpgrade();
 
         (address impl, uint48 endTime) = _xanProxy.scheduledVoterBodyUpgrade();
@@ -180,7 +180,7 @@ contract XanV1CouncilTest is Test {
         vm.stopPrank();
 
         vm.expectEmit(address(_xanProxy));
-        emit IXanV1.CouncilUpgradeVetoed();
+        emit IXanV1.CouncilUpgradeVetoed(_NEW_IMPL);
         _xanProxy.vetoCouncilUpgrade();
     }
 

test/XanV1.voting.t.sol

@@ -306,7 +306,7 @@ contract XanV1VotingTest is Test {
         emit IXanV1.VoterBodyUpgradeScheduled(_NEW_IMPL, Time.timestamp() + Parameters.DELAY_DURATION);
 
         vm.expectEmit(address(_xanProxy));
-        emit IXanV1.CouncilUpgradeVetoed();
+        emit IXanV1.CouncilUpgradeVetoed(_OTHER_NEW_IMPL);
         _xanProxy.scheduleVoterBodyUpgrade();
     }
 
@@ -346,7 +346,6 @@ contract XanV1VotingTest is Test {
         _xanProxy.lock(Parameters.MIN_LOCKED_SUPPLY);
         _xanProxy.castVote(_NEW_IMPL);
 
-        uint48 endTime = Time.timestamp() + Parameters.DELAY_DURATION;
         _xanProxy.scheduleVoterBodyUpgrade();
 
         // Vote with more weight for another implementation
@@ -362,7 +361,7 @@ contract XanV1VotingTest is Test {
 
         // Cancel the upgrade
         vm.expectEmit(address(_xanProxy));
-        emit IXanV1.VoterBodyUpgradeCancelled(_NEW_IMPL, endTime);
+        emit IXanV1.VoterBodyUpgradeCancelled(_NEW_IMPL);
         _xanProxy.cancelVoterBodyUpgrade();
     }