fix: two step gov

yearn · Nov 14, 2023 · 288d6c8 · 288d6c8
1 parent ea51590
commit 288d6c8
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/src/utils/Clonable.sol b/src/utils/Clonable.sol
@@ -2,7 +2,7 @@
 pragma solidity 0.8.18;
 
 contract Clonable {
-    // Set to the address to auto clone from.
+    /// @notice Set to the address to auto clone from.
     address public original;
 
     /**

diff --git a/src/utils/Governance.sol b/src/utils/Governance.sol
@@ -2,6 +2,7 @@
 pragma solidity 0.8.18;
 
 contract Governance {
+    /// @notice Emitted when the governance address is updated.
     event GovernanceTransferred(
         address indexed previousGovernance,
         address indexed newGovernance
@@ -12,11 +13,12 @@ contract Governance {
         _;
     }
 
+    /// @notice Checks if the msg sender is the governance.
     function _checkGovernance() internal view virtual {
         require(governance == msg.sender, "!governance");
     }
 
-    // Address that can set the default base fee and provider
+    /// @notice Address that can set the default base fee and provider
     address public governance;
 
     constructor(address _governance) {

diff --git a/src/utils/Governance2Step.sol b/src/utils/Governance2Step.sol
@@ -4,16 +4,13 @@ pragma solidity 0.8.18;
 import {Governance} from "./Governance.sol";
 
 contract Governance2Step is Governance {
+    /// @notice Emitted when the pending governance address is set.
     event UpdatePendingGovernance(address indexed newPendingGovernance);
 
-    // Address that is set to take over governance.
+    /// @notice Address that is set to take over governance.
     address public pendingGovernance;
 
-    constructor(address _governance) {
-        governance = _governance;
-
-        emit GovernanceTransferred(address(0), _governance);
-    }
+    constructor(address _governance) Governance(_governance) {}
 
     /**
      * @notice Sets a new address as the `pendingGovernance` of the contract.