revert: remove ScheduledUpgrade struct

Author: heueristik

src/XanV1.sol

@@ -63,17 +63,17 @@ contract XanV1 is
     error ImplementationNotDelayed(address expected, address actual);
 
     error UpgradeNotScheduled(address impl);
-    error UpgradeAlreadyScheduled(ScheduledUpgrade scheduledImpl);
-    error UpgradeCancellationInvalid(ScheduledUpgrade scheduledImpl);
+    error UpgradeAlreadyScheduled(address impl, uint48 endTime);
+    error UpgradeCancellationInvalid(address impl, uint48 endTime);
     error UpgradeIsNotAllowedToBeScheduledTwice(address impl);
 
     error MinLockedSupplyNotReached();
     error QuorumNowhereReached();
     error QuorumNotReached(address impl);
     error QuorumReached(address impl);
 
-    error DelayPeriodNotStarted(ScheduledUpgrade scheduledImpl);
-    error DelayPeriodNotEnded(ScheduledUpgrade scheduledImpl);
+    error DelayPeriodNotStarted(uint48 endTime);
+    error DelayPeriodNotEnded(uint48 endTime);
 
     error UnauthorizedCaller(address caller);
 
@@ -184,13 +184,14 @@ contract XanV1 is
     }
 
     /// @inheritdoc IXanV1
+    // TODO! remove input arg
     function scheduleVoterBodyUpgrade(address proposedImpl) external override {
         Voting.Data storage votingData = _getVotingData();
 
         // Check that no other upgrade has been scheduled yet.
         {
-            if (votingData.scheduledUpgrade.endTime != 0 && votingData.scheduledUpgrade.impl != address(0)) {
-                revert UpgradeAlreadyScheduled(votingData.scheduledUpgrade);
+            if (votingData.scheduledEndTime != 0 && votingData.scheduledImpl != address(0)) {
+                revert UpgradeAlreadyScheduled(votingData.scheduledImpl, votingData.scheduledEndTime);
             }
         }
 
@@ -205,37 +206,36 @@ contract XanV1 is
         // Check if the council has proposed an upgrade and, if so, cancel.
         {
             Council.Data storage councilData = _getCouncilData();
-            if (councilData.scheduledUpgrade.endTime != 0 && councilData.scheduledUpgrade.impl != address(0)) {
+            if (councilData.scheduledEndTime != 0 && councilData.scheduledImpl != address(0)) {
                 _cancelCouncilUpgrade();
 
                 emit CouncilUpgradeVetoed(); // TODO! Revisit event args
             }
         }
 
         // Schedule the upgrade and emit the associated event.
-        votingData.scheduledUpgrade =
-            ScheduledUpgrade({impl: proposedImpl, endTime: Time.timestamp() + Parameters.DELAY_DURATION});
+        votingData.scheduledImpl = proposedImpl;
+        votingData.scheduledEndTime = Time.timestamp() + Parameters.DELAY_DURATION;
 
-        emit VoterBodyUpgradeScheduled(votingData.scheduledUpgrade);
+        emit VoterBodyUpgradeScheduled(votingData.scheduledImpl, votingData.scheduledEndTime);
     }
 
     /// @inheritdoc IXanV1
     function cancelVoterBodyUpgrade() external override {
         Voting.Data storage data = _getVotingData();
 
-        ScheduledUpgrade memory scheduledUpgrade = data.scheduledUpgrade;
-
-        _checkDelayCriterion(scheduledUpgrade);
+        _checkDelayCriterion(data.scheduledEndTime);
 
         // Check that the quorum for the new implementation is reached.
-        if (_isQuorumReached(scheduledUpgrade.impl) && scheduledUpgrade.impl == data.ranking[0]) {
-            revert UpgradeCancellationInvalid(scheduledUpgrade);
+        if (_isQuorumReached(data.scheduledImpl) && data.scheduledImpl == data.ranking[0]) {
+            revert UpgradeCancellationInvalid(data.scheduledImpl, data.scheduledEndTime);
         }
 
-        emit VoterBodyUpgradeCancelled(data.scheduledUpgrade);
+        emit VoterBodyUpgradeCancelled(data.scheduledImpl, data.scheduledEndTime);
 
         // Reset the scheduled upgrade
-        data.scheduledUpgrade = ScheduledUpgrade({impl: address(0), endTime: 0});
+        data.scheduledImpl = address(0);
+        data.scheduledEndTime = 0;
     }
 
     /// @notice @inheritdoc IXanV1
@@ -252,14 +252,14 @@ contract XanV1 is
 
         Council.Data storage data = _getCouncilData();
 
-        if (data.scheduledUpgrade.impl == proposedImpl) {
+        if (data.scheduledImpl == proposedImpl) {
             revert ImplementationAlreadyProposed(proposedImpl);
         }
 
-        data.scheduledUpgrade =
-            ScheduledUpgrade({impl: proposedImpl, endTime: Time.timestamp() + Parameters.DELAY_DURATION});
+        data.scheduledImpl = proposedImpl;
+        data.scheduledEndTime = Time.timestamp() + Parameters.DELAY_DURATION;
 
-        emit CouncilUpgradeScheduled(data.scheduledUpgrade);
+        emit CouncilUpgradeScheduled(data.scheduledImpl, data.scheduledEndTime);
     }
 
     /// @notice @inheritdoc IXanV1
@@ -324,13 +324,17 @@ contract XanV1 is
     }
 
     /// @inheritdoc IXanV1
-    function scheduledVoterBodyUpgrade() public view override returns (ScheduledUpgrade memory scheduledUpgrade) {
-        scheduledUpgrade = _getVotingData().scheduledUpgrade;
+    function scheduledVoterBodyUpgrade() public view override returns (address impl, uint48 endTime) {
+        Voting.Data storage data = _getVotingData();
+        impl = data.scheduledImpl;
+        endTime = data.scheduledEndTime;
     }
 
     /// @inheritdoc IXanV1
-    function scheduledCouncilUpgrade() public view override returns (ScheduledUpgrade memory scheduledUpgrade) {
-        scheduledUpgrade = _getCouncilData().scheduledUpgrade;
+    function scheduledCouncilUpgrade() public view override returns (address impl, uint48 endTime) {
+        Council.Data storage data = _getCouncilData();
+        impl = data.scheduledImpl;
+        endTime = data.scheduledEndTime;
     }
 
     /// @inheritdoc IXanV1
@@ -385,7 +389,10 @@ contract XanV1 is
 
     /// @notice Cancels the scheduled upgrade by the council by resetting it to 0.
     function _cancelCouncilUpgrade() internal {
-        _getCouncilData().scheduledUpgrade = ScheduledUpgrade({impl: address(0), endTime: 0});
+        Council.Data storage data = _getCouncilData();
+
+        data.scheduledImpl = address(0);
+        data.scheduledEndTime = 0;
     }
 
     /// @notice Authorizes an upgrade.
@@ -396,13 +403,12 @@ contract XanV1 is
         }
 
         Voting.Data storage votingData = _getVotingData();
-        address bestRankedVoterBodyImpl = votingData.ranking[0];
+        Council.Data storage councilData = _getCouncilData();
 
-        ScheduledUpgrade memory voterBodyUpgrade = votingData.scheduledUpgrade;
-        ScheduledUpgrade memory councilUpgrade = scheduledCouncilUpgrade();
+        address bestRankedVoterBodyImpl = votingData.ranking[0];
 
-        bool isScheduledByVoterBody = (newImpl == voterBodyUpgrade.impl);
-        bool isScheduledByCouncil = (newImpl == councilUpgrade.impl);
+        bool isScheduledByVoterBody = (newImpl == votingData.scheduledImpl);
+        bool isScheduledByCouncil = (newImpl == councilData.scheduledImpl);
 
         // NOTE: councilUpgrade.impl and voterBodyUpgrade.impl can still be address(0);
 
@@ -412,17 +418,17 @@ contract XanV1 is
         }
 
         if (isScheduledByVoterBody) {
-            _checkDelayCriterion(voterBodyUpgrade);
+            _checkDelayCriterion(votingData.scheduledEndTime);
             _checkVoterBodyUpgradeCriteria({
-                impl: voterBodyUpgrade.impl,
+                impl: votingData.scheduledImpl,
                 bestRankedVoterBodyImpl: bestRankedVoterBodyImpl
             });
 
             return;
         }
 
         if (isScheduledByCouncil) {
-            _checkDelayCriterion(councilUpgrade);
+            _checkDelayCriterion(councilData.scheduledEndTime);
             _checkCouncilUpgradeCriteria({bestRankedVoterBodyImpl: bestRankedVoterBodyImpl});
 
             return;
@@ -486,14 +492,14 @@ contract XanV1 is
     }
 
     /// @notice Checks if the delay period for a scheduled upgrade has ended and reverts with errors if not.
-    /// @param scheduledUpgrade The end time to check.
-    function _checkDelayCriterion(ScheduledUpgrade memory scheduledUpgrade) internal view {
-        if (scheduledUpgrade.endTime == 0) {
-            revert DelayPeriodNotStarted(scheduledUpgrade);
+    /// @param endTime The end time of the delay period to check.
+    function _checkDelayCriterion(uint48 endTime) internal view {
+        if (endTime == 0) {
+            revert DelayPeriodNotStarted(endTime);
         }
 
-        if (Time.timestamp() < scheduledUpgrade.endTime) {
-            revert DelayPeriodNotEnded(scheduledUpgrade);
+        if (Time.timestamp() < endTime) {
+            revert DelayPeriodNotEnded(endTime);
         }
     }
 

src/interfaces/IXanV1.sol

@@ -2,14 +2,6 @@
 pragma solidity ^0.8.30;
 
 interface IXanV1 {
-    /// @notice A struct representing a scheduled implementation.
-    /// @param impl The scheduled implementation for which the delay period has been started.
-    /// @param endTime The end time of the delay period.
-    struct ScheduledUpgrade {
-        address impl;
-        uint48 endTime;
-    }
-
     /// @notice Emitted when tokens are locked.
     /// @param account The owning account.
     /// @param value The number of tokens being locked.
@@ -28,16 +20,19 @@ interface IXanV1 {
     event VoteRevoked(address indexed voter, address indexed implementation, uint256 value);
 
     /// @notice Emitted when the upgrade to a new implementation proposed by the voter body is scheduled.
-    /// @param scheduledUpgrade The scheduled upgrade.
-    event VoterBodyUpgradeScheduled(ScheduledUpgrade scheduledUpgrade);
+    /// @param impl The implementation that has been scheduled.
+    /// @param endTime The end time of the delay period.
+    event VoterBodyUpgradeScheduled(address indexed impl, uint48 endTime);
 
     /// @notice Emitted  when the upgrade to a new implementation proposed by the voter body is cancelled.
-    /// @param cancelledUpgrade The scheduled upgrade that was cancelled.
-    event VoterBodyUpgradeCancelled(ScheduledUpgrade cancelledUpgrade);
+    /// @param impl The implementation that has been cancelled.
+    /// @param endTime The end time of the delay period.
+    event VoterBodyUpgradeCancelled(address indexed impl, uint48 endTime);
 
     /// @notice Emitted when the upgrade to a new implementation proposed by the governance council is scheduled.
-    /// @param scheduledUpgrade The scheduled upgrade.
-    event CouncilUpgradeScheduled(ScheduledUpgrade indexed scheduledUpgrade);
+    /// @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
@@ -71,7 +66,6 @@ interface IXanV1 {
     /// @param winningImpl The winning implementation to activate the delay period for.
     function scheduleVoterBodyUpgrade(address winningImpl) external;
 
-    // TODO! Remove input args.
     /// @notice Cancels the upgrade for a losing implementation.
     function cancelVoterBodyUpgrade() external;
 
@@ -117,13 +111,15 @@ interface IXanV1 {
 
     /// @notice Returns the upgrade scheduled by the voter body or `ScheduledUpgrade(0)`
     /// if no implementation has reached quorum yet.
-    /// @return scheduledUpgrade The upgrade scheduled by the voter body.
-    function scheduledVoterBodyUpgrade() external view returns (ScheduledUpgrade memory scheduledUpgrade);
+    /// @return impl The implementation to upgrade to.
+    /// @return endTime The end time of the scheduled delay.
+    function scheduledVoterBodyUpgrade() external view returns (address impl, uint48 endTime);
 
     /// @notice Returns the upgrade scheduled by the council or `ScheduledUpgrade(0)`
     /// if no implementation has reached quorum yet.
-    /// @return scheduledUpgrade The upgrade scheduled by the council.
-    function scheduledCouncilUpgrade() external view returns (ScheduledUpgrade memory scheduledUpgrade);
+    /// @return impl The implementation to upgrade to.
+    /// @return endTime The end time of the scheduled delay.
+    function scheduledCouncilUpgrade() external view returns (address impl, uint48 endTime);
 
     /// @notice Returns the current implementation
     /// @return current The current implementation.

src/libs/Council.sol

@@ -6,9 +6,11 @@ import {IXanV1} from "../interfaces/IXanV1.sol";
 library Council {
     /// @notice A struct containing data associated with a current implementation and proposed upgrades from it.
     /// @param council The address of the governance council.
-    /// @param scheduledUpgrade An upgrade scheduled by the council.
+    /// @param scheduledImpl The scheduled implementation.
+    /// @param scheduledEndTime The scheduled end time of the delay period.
     struct Data {
         address council;
-        IXanV1.ScheduledUpgrade scheduledUpgrade;
+        address scheduledImpl;
+        uint48 scheduledEndTime;
     }
 }

src/libs/Voting.sol

@@ -10,12 +10,14 @@ library Voting {
     /// @param ballots The ballots of proposed implementations to upgrade to.
     /// @param ranking The proposed implementations ranking.
     /// @param implCount The count of proposed implementations.
-    /// @param scheduledUpgrade An upgrade scheduled by the voting body.
+    /// @param scheduledImpl The scheduled implementation.
+    /// @param scheduledEndTime The scheduled end time of the delay period.
     struct Data {
         mapping(address proposedImpl => Ballot) ballots;
         mapping(uint48 rank => address proposedImpl) ranking;
         uint48 implCount;
-        IXanV1.ScheduledUpgrade scheduledUpgrade;
+        address scheduledImpl;
+        uint48 scheduledEndTime;
     }
 
     /// @notice The vote data of a proposed implementation.

test/XanV1.council.t.sol

@@ -90,9 +90,7 @@ contract XanV1CouncilTest is Test {
     function test_scheduleCouncilUpgrade_emits_the_CouncilUpgradeScheduled_event() public {
         vm.prank(_COUNCIL);
         vm.expectEmit(address(_xanProxy));
-        emit IXanV1.CouncilUpgradeScheduled(
-            IXanV1.ScheduledUpgrade({impl: _NEW_IMPL, endTime: Time.timestamp() + Parameters.DELAY_DURATION})
-        );
+        emit IXanV1.CouncilUpgradeScheduled({impl: _NEW_IMPL, endTime: Time.timestamp() + Parameters.DELAY_DURATION});
         _xanProxy.scheduleCouncilUpgrade(_NEW_IMPL);
     }
 
@@ -119,8 +117,9 @@ contract XanV1CouncilTest is Test {
         emit IXanV1.CouncilUpgradeCancelled();
         _xanProxy.cancelCouncilUpgrade();
 
-        assertEq(_xanProxy.scheduledVoterBodyUpgrade().impl, address(0));
-        assertEq(_xanProxy.scheduledVoterBodyUpgrade().endTime, 0);
+        (address impl, uint48 endTime) = _xanProxy.scheduledVoterBodyUpgrade();
+        assertEq(impl, address(0));
+        assertEq(endTime, 0);
     }
 
     function test_vetoCouncilUpgrade_reverts_if_no_implementation_proposed_by_the_voter_body_has_reached_quorum()
@@ -146,8 +145,9 @@ contract XanV1CouncilTest is Test {
 
         _xanProxy.vetoCouncilUpgrade();
 
-        assertEq(_xanProxy.scheduledVoterBodyUpgrade().impl, address(0));
-        assertEq(_xanProxy.scheduledVoterBodyUpgrade().endTime, 0);
+        (address impl, uint48 endTime) = _xanProxy.scheduledVoterBodyUpgrade();
+        assertEq(impl, address(0));
+        assertEq(endTime, 0);
     }
 
     function test_vetoCouncilUpgrade_emits_the_CouncilUpgradeVetoed_event() public {
@@ -172,12 +172,14 @@ contract XanV1CouncilTest is Test {
         vm.prank(_COUNCIL);
         _xanProxy.scheduleCouncilUpgrade(_NEW_IMPL);
 
-        assertEq(_xanProxy.scheduledCouncilUpgrade().impl, _NEW_IMPL);
-        assertEq(_xanProxy.scheduledCouncilUpgrade().endTime, expectedEndTime);
+        (address impl, uint48 endTime) = _xanProxy.scheduledCouncilUpgrade();
+        assertEq(impl, _NEW_IMPL);
+        assertEq(endTime, expectedEndTime);
     }
 
     function test_scheduledCouncilImplementation_returns_0_if_no_upgrade_delay_has_been_started() public view {
-        assertEq(_xanProxy.scheduledCouncilUpgrade().impl, address(0));
-        assertEq(_xanProxy.scheduledCouncilUpgrade().endTime, 0);
+        (address impl, uint48 endTime) = _xanProxy.scheduledCouncilUpgrade();
+        assertEq(impl, address(0));
+        assertEq(endTime, 0);
     }
 }