Merge pull request #508 from lidofinance/fix/typos-base-precision

Staking Router: fix typos, add base precision to Lido views

contracts/0.4.24/Lido.sol

@@ -43,7 +43,6 @@ contract Lido is StETHPermit, AragonApp {
     bytes32 public constant STAKING_CONTROL_ROLE = keccak256("STAKING_CONTROL_ROLE");
     bytes32 public constant MANAGE_PROTOCOL_CONTRACTS_ROLE = keccak256("MANAGE_PROTOCOL_CONTRACTS_ROLE");
     bytes32 public constant BURN_ROLE = keccak256("BURN_ROLE");
-    bytes32 public constant SET_EL_REWARDS_VAULT_ROLE = keccak256("SET_EL_REWARDS_VAULT_ROLE");
     bytes32 public constant SET_EL_REWARDS_WITHDRAWAL_LIMIT_ROLE = keccak256("SET_EL_REWARDS_WITHDRAWAL_LIMIT_ROLE");
 
     uint256 private constant DEPOSIT_SIZE = 32 ether;
@@ -599,18 +598,22 @@ contract Lido is StETHPermit, AragonApp {
     /**
      * @notice Returns current staking rewards fee rate
      * @return totalFee total rewards fee in base precision
+     * @return basePrecision base precision number, which constitutes 100% fee
      */
-    function getFee() public view returns (uint96 totalFee) {
-        (, , totalFee, ) = getStakingRouter().getStakingRewardsDistribution();
+    function getFee() public view returns (uint96 totalFee, uint256 basePrecision) {
+        (, , totalFee, basePrecision) = getStakingRouter().getStakingRewardsDistribution();
     }
 
     /**
      * @notice Returns current fee distribution proportion
      * @return modulesFee modules summary fee in base precision
      * @return treasuryFee treasury fee in base precision
+     * @return basePrecision base precision number, which constitutes 100% fee
      */
-    function getFeeDistribution() public view returns (uint96 modulesFee, uint96 treasuryFee) {
-        (, uint96[] memory moduleFees, uint96 totalFee, ) = getStakingRouter().getStakingRewardsDistribution();
+    function getFeeDistribution() public view returns (uint96 modulesFee, uint96 treasuryFee, uint256 basePrecision) {
+        uint96[] memory moduleFees;
+        uint96 totalFee;
+        (, moduleFees, totalFee, basePrecision) = getStakingRouter().getStakingRewardsDistribution();
         for (uint256 i; i < moduleFees.length; ++i) {
             modulesFee += moduleFees[i];
         }
@@ -757,7 +760,7 @@ contract Lido is StETHPermit, AragonApp {
         _burnShares(withdrawalQueueAddress, sharesToBurn);
     }
 
-    /// @dev calculate the amout of rewards and distribute it
+    /// @dev calculate the amount of rewards and distribute it
     function _processRewards(
         uint256 _preBeaconBalance,
         uint256 _postBeaconBalance,
@@ -902,14 +905,12 @@ contract Lido is StETHPermit, AragonApp {
         require(recipients.length == modulesFees.length, "WRONG_RECIPIENTS_INPUT");
 
         if (totalFee > 0) {
-            uint256 shares2mint = _totalRewards
-                .mul(totalFee)
-                .mul(_getTotalShares())
+            uint256 shares2mint =
+                _totalRewards.mul(totalFee).mul(_getTotalShares())
                 .div(
-                    _getTotalPooledEther()
-                        .mul(precisionPoints)
-                        .sub(_totalRewards.mul(totalFee))
-            );
+                    (_getTotalPooledEther().mul(precisionPoints))
+                    .sub(_totalRewards.mul(totalFee))
+                );
             _mintShares(address(this), shares2mint);
 
             uint256 treasuryReward = shares2mint;

contracts/0.4.24/interfaces/IStETH.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 
 // SPDX-License-Identifier: GPL-3.0
 

contracts/0.4.24/interfaces/IStakingModule.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 pragma solidity 0.4.24;

contracts/0.4.24/interfaces/IStakingRouter.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 
 // SPDX-License-Identifier: GPL-3.0
 

contracts/0.4.24/lib/Math64.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 
 // SPDX-License-Identifier: MIT
 

contracts/0.4.24/lib/SigningKeysStats.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 // See contracts/COMPILERS.md

contracts/0.4.24/lib/StakeLimitUtils.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 
 // SPDX-License-Identifier: GPL-3.0
 

contracts/0.4.24/nos/NodeOperatorsRegistry.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 // See contracts/COMPILERS.md
@@ -210,7 +210,6 @@ contract NodeOperatorsRegistry is INodeOperatorsRegistry, AragonApp, IStakingMod
         operator.name = _name;
         operator.rewardAddress = _rewardAddress;
 
-        emit NodeOperatorAdded(id);
         emit NodeOperatorAdded(id, _name, _rewardAddress, 0);
     }
 

contracts/0.4.24/nos/test_helpers/ERC721Mock.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 pragma solidity 0.4.24;

contracts/0.4.24/test_helpers/MinFirstAllocationStrategyConsumerMockLegacyVersion.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */

contracts/0.4.24/test_helpers/StakeLimitUtilsMock.sol

@@ -1,6 +1,4 @@
-
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 pragma solidity 0.4.24;

contracts/0.8.9/BeaconChainDepositor.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 // See contracts/COMPILERS.md

contracts/0.8.9/CommitteeQuorum.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity 0.8.9;
 

contracts/0.8.9/DepositSecurityModule.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2021 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */
@@ -292,7 +291,7 @@ contract DepositSecurityModule {
     }
 
     /**
-     * Pauses deposits for module given that both conditions are satisfied (reverts otherwise):
+     * Pauses deposits for staking module given that both conditions are satisfied (reverts otherwise):
      *
      *   1. The function is called by the guardian with index guardianIndex OR sig
      *      is a valid signature by the guardian with index guardianIndex of the data
@@ -337,7 +336,7 @@ contract DepositSecurityModule {
     }
 
     /**
-     * Unpauses deposits for module
+     * Unpauses deposits for staking module
      *
      * Only callable by the owner.
      */

contracts/0.8.9/LidoOracleNew.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity 0.8.9;
 

contracts/0.8.9/ReportEpochChecker.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity 0.8.9;
 

contracts/0.8.9/StakingRouter.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 
 // SPDX-License-Identifier: GPL-3.0
 
@@ -97,7 +97,7 @@ contract StakingRouter is IStakingRouter, AccessControlEnumerable, BeaconChainDe
 
     constructor(address _depositContract) BeaconChainDepositor(_depositContract) {
         /// @dev lock version in implementation to avoid initialize() call
-        ///      DEFAULT_ADMIN_ROLE will remain unset, i.e. no ability to add new members ro roles
+        ///      DEFAULT_ADMIN_ROLE will remain unset, i.e. no ability to add new members or roles
         _setContractVersion(type(uint256).max);
     }
 
@@ -177,7 +177,7 @@ contract StakingRouter is IStakingRouter, AccessControlEnumerable, BeaconChainDe
     }
 
     /**
-     * @notice update staking module params
+     * @notice Update staking module params
      * @param _stakingModuleId staking module id
      * @param _targetShare target total stake share
      * @param _stakingModuleFee fee of the staking module taken from the consensus layer rewards
@@ -208,7 +208,7 @@ contract StakingRouter is IStakingRouter, AccessControlEnumerable, BeaconChainDe
 
 
     /**
-     * @notice Returns all registred staking modules
+     * @notice Returns all registered staking modules
      */
     function getStakingModules() external view returns (StakingModule[] memory res) {
         uint256 stakingModulesCount = getStakingModulesCount();
@@ -243,8 +243,8 @@ contract StakingRouter is IStakingRouter, AccessControlEnumerable, BeaconChainDe
     /**
      *  @dev Returns staking module by index
      */
-    function getStakingModuleByIndex(uint256 _stakingModuleIdndex) external view returns (StakingModule memory) {
-        return _getStakingModuleByIndex(_stakingModuleIdndex);
+    function getStakingModuleByIndex(uint256 _stakingModuleIndex) external view returns (StakingModule memory) {
+        return _getStakingModuleByIndex(_stakingModuleIndex);
     }
 
     /**
@@ -355,11 +355,12 @@ contract StakingRouter is IStakingRouter, AccessControlEnumerable, BeaconChainDe
     }
 
     /**
-     * @notice return shares table
+     * @notice Return shares table
      *
      * @return recipients recipients list
      * @return stakingModuleFees fee of each recipient
      * @return totalFee total fee to mint for each staking module and treasury
+     * @return precisionPoints base precision number, which constitutes 100% fee
      */
     function getStakingRewardsDistribution()
         external
@@ -390,7 +391,7 @@ contract StakingRouter is IStakingRouter, AccessControlEnumerable, BeaconChainDe
                 recipients[rewardedStakingModulesCount] = address(stakingModuleCache[i].stakingModuleAddress);
                 stakingModuleFee = uint96((stakingModuleKeysShare * stakingModuleCache[i].stakingModuleFee) / TOTAL_BASIS_POINTS);
                 /// @dev if the staking module has the `Stopped` status for some reason, then
-                ///      the staking module's rewards go to the treasure, so that the DAO has ability
+                ///      the staking module's rewards go to the treasury, so that the DAO has ability
                 ///      to manage them (e.g. to compensate the staking module in case of an error, etc.)
                 if (stakingModuleCache[i].status != StakingModuleStatus.Stopped) {
                     stakingModuleFees[rewardedStakingModulesCount] = stakingModuleFee;
@@ -471,7 +472,6 @@ contract StakingRouter is IStakingRouter, AccessControlEnumerable, BeaconChainDe
             }
         }
         _transferBalanceEthToLido();
-        // return keysCount;
     }
 
     /// @dev transfer all remaining balance to Lido contract

contracts/0.8.9/ValidatorExitBus.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity 0.8.9;
 

contracts/0.8.9/WithdrawalVault.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 
 // SPDX-License-Identifier: GPL-3.0
 

contracts/0.8.9/interfaces/ISelfOwnedStETHBurner.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 pragma solidity 0.8.9;

contracts/0.8.9/interfaces/IStakingModule.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 pragma solidity 0.8.9;

contracts/0.8.9/interfaces/IStakingRouter.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */

contracts/0.8.9/lib/Math.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: MIT
 
 // See contracts/COMPILERS.md

contracts/0.8.9/proxy/OssifiableProxy.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */

contracts/0.8.9/test_helpers/BeaconChainDepositorMock.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */

contracts/0.8.9/test_helpers/LidoOracleNewMock.sol

@@ -1,7 +1,7 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
+/* See contracts/COMPILERS.md */
 pragma solidity 0.8.9;
 
 import "../LidoOracleNew.sol";

contracts/0.8.9/test_helpers/MinFirstAllocationStrategyTest.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */

contracts/0.8.9/test_helpers/ModuleSolo.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 // See contracts/COMPILERS.md

contracts/0.8.9/test_helpers/StakingModuleMock.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 
 // SPDX-License-Identifier: GPL-3.0
 

contracts/0.8.9/test_helpers/StakingRouterMock.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */
@@ -17,4 +16,3 @@ contract StakingRouterMock is StakingRouter {
         return _getStakingModuleIndexById(uint24(_stakingModuleId));
     }
 }
-

contracts/0.8.9/test_helpers/StakingRouterMockForDepositSecurityModule.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */

contracts/0.8.9/test_helpers/ValidatorExitBusMock.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 pragma solidity 0.8.9;

contracts/common/lib/Math256.sol

@@ -1,5 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
-
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: MIT
 
 // See contracts/COMPILERS.md

contracts/common/lib/MinFirstAllocationStrategy.sol

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Lido <[email protected]>
+// SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
 /* See contracts/COMPILERS.md */