Code tidy

rocket-pool · Feb 11, 2025 · 85442a1 · 85442a1
1 parent db3a15e
commit 85442a1
Show file tree

Hide file tree

Showing 17 changed files with 67 additions and 72 deletions.
diff --git a/contracts/contract/dao/protocol/settings/RocketDAOProtocolSettingsNode.sol b/contracts/contract/dao/protocol/settings/RocketDAOProtocolSettingsNode.sol
@@ -1,13 +1,12 @@
-pragma solidity 0.7.6;
-
 // SPDX-License-Identifier: GPL-3.0-only
+pragma solidity 0.8.18;
 
-import "./RocketDAOProtocolSettings.sol";
-import "../../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNodeInterface.sol";
-import "../../../../interface/network/RocketNetworkSnapshotsInterface.sol";
-
-// Network auction settings
+import {RocketStorageInterface} from "../../../../interface/RocketStorageInterface.sol";
+import {RocketDAOProtocolSettings} from "./RocketDAOProtocolSettings.sol";
+import {RocketDAOProtocolSettingsNodeInterface} from "../../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNodeInterface.sol";
+import {RocketNetworkSnapshotsInterface} from "../../../../interface/network/RocketNetworkSnapshotsInterface.sol";
 
+/// @notice Network auction settings
 contract RocketDAOProtocolSettingsNode is RocketDAOProtocolSettings, RocketDAOProtocolSettingsNodeInterface {
 
     // Construct

diff --git a/contracts/contract/dao/protocol/settings/RocketDAOProtocolSettingsSecurity.sol b/contracts/contract/dao/protocol/settings/RocketDAOProtocolSettingsSecurity.sol
@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "./RocketDAOProtocolSettings.sol";
-import "../../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsSecurityInterface.sol";
+import {RocketStorageInterface} from "../../../../interface/RocketStorageInterface.sol";
+import {RocketDAOProtocolSettings} from "./RocketDAOProtocolSettings.sol";
+import {RocketDAOProtocolSettingsSecurityInterface} from "../../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsSecurityInterface.sol";
 
 /// @notice Protocol parameters relating to the security council
 contract RocketDAOProtocolSettingsSecurity is RocketDAOProtocolSettings, RocketDAOProtocolSettingsSecurityInterface {

diff --git a/contracts/contract/dao/security/RocketDAOSecurityProposals.sol b/contracts/contract/dao/security/RocketDAOSecurityProposals.sol
@@ -1,17 +1,18 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "../../../interface/RocketVaultInterface.sol";
-import "../../../interface/dao/RocketDAOProposalInterface.sol";
-import "../../../interface/dao/protocol/RocketDAOProtocolInterface.sol";
-import "../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsSecurityInterface.sol";
-import "../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNetworkInterface.sol";
-import "../../../interface/dao/security/RocketDAOSecurityActionsInterface.sol";
-import "../../../interface/dao/security/RocketDAOSecurityInterface.sol";
-import "../../../interface/dao/security/RocketDAOSecurityProposalsInterface.sol";
-import "../../../interface/network/RocketNetworkRevenuesInterface.sol";
-import "../../../interface/util/IERC20Burnable.sol";
-import "../../RocketBase.sol";
+import {RocketBase} from "../../RocketBase.sol";
+import {RocketStorageInterface} from "../../../interface/RocketStorageInterface.sol";
+import {RocketVaultInterface} from "../../../interface/RocketVaultInterface.sol";
+import {RocketDAOProposalInterface} from "../../../interface/dao/RocketDAOProposalInterface.sol";
+import {RocketDAOProtocolInterface} from "../../../interface/dao/protocol/RocketDAOProtocolInterface.sol";
+import {RocketDAOProtocolSettingsSecurityInterface} from "../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsSecurityInterface.sol";
+import {RocketDAOProtocolSettingsNetworkInterface} from "../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNetworkInterface.sol";
+import {RocketDAOSecurityActionsInterface} from "../../../interface/dao/security/RocketDAOSecurityActionsInterface.sol";
+import {RocketDAOSecurityInterface} from "../../../interface/dao/security/RocketDAOSecurityInterface.sol";
+import {RocketDAOSecurityProposalsInterface} from "../../../interface/dao/security/RocketDAOSecurityProposalsInterface.sol";
+import {RocketNetworkRevenuesInterface} from "../../../interface/network/RocketNetworkRevenuesInterface.sol";
+import {IERC20Burnable} from "../../../interface/util/IERC20Burnable.sol";
 
 /// @notice Proposal contract for the security council
 contract RocketDAOSecurityProposals is RocketBase, RocketDAOSecurityProposalsInterface {

diff --git a/contracts/contract/deposit/RocketDepositPool.sol b/contracts/contract/deposit/RocketDepositPool.sol
@@ -1,9 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "../../interface/util/LinkedListStorageInterface.sol";
 import {AddressQueueStorageInterface} from "../../interface/util/AddressQueueStorageInterface.sol";
-import {LinkedListStorageInterface} from "../../interface/util/LinkedListStorageInterface.sol";
+import {LinkedListStorageInterface, DepositQueueKey, DepositQueueValue} from "../../interface/util/LinkedListStorageInterface.sol";
 import {RocketBase} from "../RocketBase.sol";
 import {RocketDAOProtocolSettingsDepositInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsDepositInterface.sol";
 import {RocketDAOProtocolSettingsMinipoolInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsMinipoolInterface.sol";

diff --git a/contracts/contract/megapool/RocketMegapoolManager.sol b/contracts/contract/megapool/RocketMegapoolManager.sol
@@ -1,8 +1,7 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "./RocketMegapoolStorageLayout.sol";
-import "./RocketMegapoolStorageLayout.sol";
+import {RocketMegapoolStorageLayout} from "./RocketMegapoolStorageLayout.sol";
 import {RocketBase} from "../RocketBase.sol";
 import {RocketMegapoolInterface} from "../../interface/megapool/RocketMegapoolInterface.sol";
 import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";

diff --git a/contracts/contract/megapool/RocketMegapoolStorageLayout.sol b/contracts/contract/megapool/RocketMegapoolStorageLayout.sol
@@ -59,8 +59,9 @@ abstract contract RocketMegapoolStorageLayout {
     // Megapool state
     //
 
-    address internal nodeAddress;     // Megapool owner
-    uint32 internal numValidators;    // Number of individual validators handled by this megapool
+    address internal nodeAddress;             // Megapool owner
+    uint32 internal numValidators;            // Number of individual validators handled by this megapool
+    uint32 internal numInactiveValidators;    // Number of validators that are no longer contributing to bond requirement
 
     uint256 internal assignedValue;   // ETH assigned from DP pending prestake/stake
     uint256 internal refundValue;     // ETH refunded to the owner after a dissolution
@@ -76,6 +77,4 @@ abstract contract RocketMegapoolStorageLayout {
 
     mapping(uint32 => ValidatorInfo) internal validators;
     mapping(uint32 => PrestakeData) internal prestakeData;
-
-    uint32 internal numInactiveValidators;    // Number of validators that are no longer contributing to bond requirement
 }
diff --git a/contracts/contract/network/RocketNetworkRevenues.sol b/contracts/contract/network/RocketNetworkRevenues.sol
@@ -1,7 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "../RocketBase.sol";
+import {RocketBase} from "../RocketBase.sol";
+import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
 import {RocketNetworkSnapshotsInterface} from "../../interface/network/RocketNetworkSnapshotsInterface.sol";
 import {RocketNetworkRevenuesInterface} from "../../interface/network/RocketNetworkRevenuesInterface.sol";
 

diff --git a/contracts/contract/network/RocketNetworkSnapshots.sol b/contracts/contract/network/RocketNetworkSnapshots.sol
@@ -3,10 +3,11 @@
 // Adapted from OpenZeppelin `Checkpoints` contract
 pragma solidity 0.8.18;
 
-import "@openzeppelin4/contracts/utils/math/Math.sol";
+import {Math} from "@openzeppelin4/contracts/utils/math/Math.sol";
 
-import "../RocketBase.sol";
-import "../../interface/network/RocketNetworkSnapshotsInterface.sol";
+import {RocketBase} from "../RocketBase.sol";
+import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
+import {RocketNetworkSnapshotsInterface, Checkpoint224} from "../../interface/network/RocketNetworkSnapshotsInterface.sol";
 
 /// @notice Accounting for snapshotting of values based on block numbers
 contract RocketNetworkSnapshots is RocketBase, RocketNetworkSnapshotsInterface {

diff --git a/contracts/contract/node/RocketNodeDeposit.sol b/contracts/contract/node/RocketNodeDeposit.sol
@@ -1,20 +1,20 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "../../interface/RocketStorageInterface.sol";
-import "../../interface/RocketVaultInterface.sol";
-import "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsMinipoolInterface.sol";
-import "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNodeInterface.sol";
-import "../../interface/deposit/RocketDepositPoolInterface.sol";
-import "../../interface/megapool/RocketMegapoolFactoryInterface.sol";
-import "../../interface/megapool/RocketMegapoolInterface.sol";
-import "../../interface/network/RocketNetworkFeesInterface.sol";
-import "../../interface/network/RocketNetworkVotingInterface.sol";
-import "../../interface/network/RocketNetworkSnapshotsInterface.sol";
-import "../../interface/node/RocketNodeDepositInterface.sol";
-import "../../interface/node/RocketNodeManagerInterface.sol";
-import "../../interface/node/RocketNodeStakingInterface.sol";
-import "../RocketBase.sol";
+import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
+import {RocketVaultInterface} from "../../interface/RocketVaultInterface.sol";
+import {RocketDAOProtocolSettingsMinipoolInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsMinipoolInterface.sol";
+import {RocketDAOProtocolSettingsNodeInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNodeInterface.sol";
+import {RocketDepositPoolInterface} from "../../interface/deposit/RocketDepositPoolInterface.sol";
+import {RocketMegapoolFactoryInterface} from "../../interface/megapool/RocketMegapoolFactoryInterface.sol";
+import {RocketMegapoolInterface} from "../../interface/megapool/RocketMegapoolInterface.sol";
+import {RocketNetworkFeesInterface} from "../../interface/network/RocketNetworkFeesInterface.sol";
+import {RocketNetworkVotingInterface} from "../../interface/network/RocketNetworkVotingInterface.sol";
+import {RocketNetworkSnapshotsInterface} from "../../interface/network/RocketNetworkSnapshotsInterface.sol";
+import {RocketNodeDepositInterface} from "../../interface/node/RocketNodeDepositInterface.sol";
+import {RocketNodeManagerInterface} from "../../interface/node/RocketNodeManagerInterface.sol";
+import {RocketNodeStakingInterface} from "../../interface/node/RocketNodeStakingInterface.sol";
+import {RocketBase} from "../RocketBase.sol";
 import {RocketMegapoolManagerInterface} from "../../interface/megapool/RocketMegapoolManagerInterface.sol";
 import {RocketVaultWithdrawerInterface} from "../../interface/RocketVaultWithdrawerInterface.sol";
 

diff --git a/contracts/contract/node/RocketNodeManager.sol b/contracts/contract/node/RocketNodeManager.sol
@@ -2,8 +2,8 @@
 pragma solidity 0.8.18;
 pragma abicoder v2;
 
-import "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsDepositInterface.sol";
-import "../../types/MinipoolStatus.sol";
+import {RocketDAOProtocolSettingsDepositInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsDepositInterface.sol";
+import {MinipoolStatus} from "../../types/MinipoolStatus.sol";
 import {AddressSetStorageInterface} from "../../interface/util/AddressSetStorageInterface.sol";
 import {IERC20} from "../../interface/util/IERC20.sol";
 import {NodeDetails} from "../../types/NodeDetails.sol";

diff --git a/contracts/contract/rewards/RocketVoterRewards.sol b/contracts/contract/rewards/RocketVoterRewards.sol
@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "../../interface/RocketVaultInterface.sol";
-import "../RocketBase.sol";
+import {RocketBase} from "../RocketBase.sol";
+import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
+import {RocketVaultInterface} from "../../interface/RocketVaultInterface.sol";
 import {RocketVoterRewardsInterface} from "../../interface/rewards/RocketVoterRewardsInterface.sol";
 
 /// @notice Holding contract for voter's share of ETH rewards until implementation details are resolved

diff --git a/contracts/contract/upgrade/RocketUpgradeOneDotFour.sol b/contracts/contract/upgrade/RocketUpgradeOneDotFour.sol
@@ -1,15 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 
-import "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNodeInterface.sol";
-import "../../interface/megapool/RocketMegapoolFactoryInterface.sol";
-import "../../interface/minipool/RocketMinipoolManagerInterface.sol";
-import "../../interface/network/RocketNetworkPricesInterface.sol";
-import "../../interface/network/RocketNetworkRevenuesInterface.sol";
-import "../../interface/network/RocketNetworkSnapshotsInterface.sol";
-import "../../interface/util/AddressSetStorageInterface.sol";
-import "../RocketBase.sol";
-import {RocketDAOProtocolSettingsNetworkInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNetworkInterface.sol";
+import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
+import {RocketNetworkRevenuesInterface} from "../../interface/network/RocketNetworkRevenuesInterface.sol";
+import {RocketBase} from "../RocketBase.sol";
 
 interface InitialiseInterface {
     function initialise() external;
@@ -184,10 +178,10 @@ contract RocketUpgradeOneDotFour is RocketBase {
 
         // Initialise UARS setting defaults per RPIP-46
         settingNameSpace = keccak256(abi.encodePacked("dao.protocol.setting.", "network"));
-        setUint(keccak256(abi.encodePacked(settingNameSpace,"network.node.commission.share")), 0.05 ether);                        // 5% (RPIP-46)
-        setUint(keccak256(abi.encodePacked(settingNameSpace,"network.node.commission.share.security.council.adder")), 0 ether);    // 0% (RPIP-46)
-        setUint(keccak256(abi.encodePacked(settingNameSpace,"network.voter.share")), 0.09 ether);                                  // 9% (RPIP-46)
-        setUint(keccak256(abi.encodePacked(settingNameSpace,"network.max.node.commission.share.council.adder")), 0.01 ether);      // 1% (RPIP-46)
+        setUint(keccak256(abi.encodePacked(settingNameSpace, "network.node.commission.share")), 0.05 ether);                        // 5% (RPIP-46)
+        setUint(keccak256(abi.encodePacked(settingNameSpace, "network.node.commission.share.security.council.adder")), 0 ether);    // 0% (RPIP-46)
+        setUint(keccak256(abi.encodePacked(settingNameSpace, "network.voter.share")), 0.09 ether);                                  // 9% (RPIP-46)
+        setUint(keccak256(abi.encodePacked(settingNameSpace, "network.max.node.commission.share.council.adder")), 0.01 ether);      // 1% (RPIP-46)
 
         // Initialise UARS system
         RocketNetworkRevenuesInterface rocketNetworkRevenuesInstance = RocketNetworkRevenuesInterface(rocketNetworkRevenues);

diff --git a/contracts/contract/util/BeaconStateVerifier.sol b/contracts/contract/util/BeaconStateVerifier.sol
@@ -5,7 +5,7 @@ import {RocketBase} from "../RocketBase.sol";
 import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
 import {SSZ} from "./SSZ.sol";
 import {BlockRootsInterface} from "../../interface/util/BlockRootsInterface.sol";
-import "../../interface/util/BeaconStateVerifierInterface.sol";
+import {BeaconStateVerifierInterface, ValidatorProof, Withdrawal} from "../../interface/util/BeaconStateVerifierInterface.sol";
 
 contract BeaconStateVerifier is RocketBase, BeaconStateVerifierInterface {
     // TODO: Decide how to supply these required beacon chain constants

diff --git a/contracts/contract/util/LinkedListStorage.sol b/contracts/contract/util/LinkedListStorage.sol
@@ -233,6 +233,9 @@ contract LinkedListStorage is RocketBase, LinkedListStorageInterface {
     }
 
     /// @notice Returns the supplied number of entries starting at the supplied index
+    /// @param _namespace The namespace of the linked list to scan
+    /// @param _start The index to start from, or 0 to start from the start of the first item in the list
+    /// @param _count The maximum number of items to return
     function scan(bytes32 _namespace, uint256 _start, uint256 _count) override external view returns (DepositQueueValue[] memory entries, uint256 nextIndex) {
         entries = new DepositQueueValue[](_count);
         nextIndex = _start;
@@ -258,5 +261,4 @@ contract LinkedListStorage is RocketBase, LinkedListStorageInterface {
 
         return (entries, nextIndex);
     }
-
 }
diff --git a/contracts/contract/util/LinkedListStorageHelper.sol b/contracts/contract/util/LinkedListStorageHelper.sol
@@ -1,9 +1,9 @@
+// SPDX-License-Identifier: GPL-3.0-only
 pragma solidity 0.8.18;
 pragma abicoder v2;
 
-// SPDX-License-Identifier: GPL-3.0-only
-
-import "./LinkedListStorage.sol";
+import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
+import {LinkedListStorage, DepositQueueValue, DepositQueueKey} from "./LinkedListStorage.sol";
 
 /// @notice A linked list storage helper to test internal functions
 contract LinkedListStorageHelper is LinkedListStorage {

diff --git a/contracts/interface/RocketStorageInterface.sol b/contracts/interface/RocketStorageInterface.sol
@@ -1,6 +1,5 @@
-pragma solidity >0.5.0 <0.9.0;
-
 // SPDX-License-Identifier: GPL-3.0-only
+pragma solidity >0.5.0 <0.9.0;
 
 interface RocketStorageInterface {
 

diff --git a/contracts/interface/util/LinkedListStorageInterface.sol b/contracts/interface/util/LinkedListStorageInterface.sol
@@ -1,8 +1,7 @@
+// SPDX-License-Identifier: GPL-3.0-only
 pragma solidity >0.5.0 <0.9.0;
 pragma abicoder v2;
 
-// SPDX-License-Identifier: GPL-3.0-only
-
 struct DepositQueueValue {
     address receiver;      // the address that will receive the requested value
     uint32 validatorId;    // internal validator id