Merge pull request #564 from lidofinance/lido-locator-updates

LidoLocator: safetyNetsRegistry -> oracleReportSanityChecks

Author: TheDZhon

contracts/0.4.24/Lido.sol

@@ -473,7 +473,7 @@ contract Lido is Versioned, StETHPermit, AragonApp {
     struct OracleReportContracts {
         address accountingOracle;
         address elRewardsVault;
-        address safetyNetsRegistry;
+        address oracleReportSanityChecker;
         address selfOwnedStEthBurner;
         address withdrawalQueue;
         address withdrawalVault;
@@ -1118,7 +1118,7 @@ contract Lido is Versioned, StETHPermit, AragonApp {
         handlingData.preTotalShares = _getTotalShares();
         handlingData.preCLBalance = _processClStateUpdate(_inputData.clValidators, _inputData.postCLBalance);
 
-        IOracleReportSanityChecker(_protocolContracts.safetyNetsRegistry).checkLidoOracleReport(
+        IOracleReportSanityChecker(_protocolContracts.oracleReportSanityChecker).checkLidoOracleReport(
             _inputData.timeElapsed,
             handlingData.preCLBalance,
             _inputData.postCLBalance,
@@ -1137,7 +1137,7 @@ contract Lido is Versioned, StETHPermit, AragonApp {
 
         (
             withdrawals, elRewards, handlingData.sharesToBurnLimit
-        ) = IOracleReportSanityChecker(_protocolContracts.safetyNetsRegistry).smoothenTokenRebase(
+        ) = IOracleReportSanityChecker(_protocolContracts.oracleReportSanityChecker).smoothenTokenRebase(
             handlingData.preTotalPooledEther,
             handlingData.preTotalShares,
             handlingData.preCLBalance,
@@ -1234,7 +1234,7 @@ contract Lido is Versioned, StETHPermit, AragonApp {
         (
             ret.accountingOracle,
             ret.elRewardsVault,
-            ret.safetyNetsRegistry,
+            ret.oracleReportSanityChecker,
             ret.selfOwnedStEthBurner,
             ret.withdrawalQueue,
             ret.withdrawalVault,

contracts/0.8.9/LidoLocator.sol

@@ -20,7 +20,7 @@ contract LidoLocator is ILidoLocator {
         address elRewardsVault;
         address legacyOracle;
         address lido;
-        address safetyNetsRegistry;
+        address oracleReportSanityChecker;
         address selfOwnedStEthBurner;
         address stakingRouter;
         address treasury;
@@ -37,7 +37,7 @@ contract LidoLocator is ILidoLocator {
     address public immutable elRewardsVault;
     address public immutable legacyOracle;
     address public immutable lido;
-    address public immutable safetyNetsRegistry;
+    address public immutable oracleReportSanityChecker;
     address public immutable selfOwnedStEthBurner;
     address public immutable stakingRouter;
     address public immutable treasury;
@@ -57,7 +57,7 @@ contract LidoLocator is ILidoLocator {
         elRewardsVault = _assertNonZero(_config.elRewardsVault);
         legacyOracle = _assertNonZero(_config.legacyOracle);
         lido = _assertNonZero(_config.lido);
-        safetyNetsRegistry = _assertNonZero(_config.safetyNetsRegistry);
+        oracleReportSanityChecker = _assertNonZero(_config.oracleReportSanityChecker);
         selfOwnedStEthBurner = _assertNonZero(_config.selfOwnedStEthBurner);
         stakingRouter = _assertNonZero(_config.stakingRouter);
         treasury = _assertNonZero(_config.treasury);
@@ -77,7 +77,7 @@ contract LidoLocator is ILidoLocator {
     ) {
         return (
             elRewardsVault,
-            safetyNetsRegistry,
+            oracleReportSanityChecker,
             stakingRouter,
             treasury,
             withdrawalQueue,
@@ -97,7 +97,7 @@ contract LidoLocator is ILidoLocator {
         return (
             accountingOracle,
             elRewardsVault,
-            safetyNetsRegistry,
+            oracleReportSanityChecker,
             selfOwnedStEthBurner,
             withdrawalQueue,
             withdrawalVault,

contracts/0.8.9/sanity_checks/OracleReportSanityChecker.sol

@@ -42,21 +42,26 @@ struct LimitsList {
     /// @notice The max possible number of validators that might appear or exit on the Consensus
     ///     Layer during one epoch
     uint256 churnValidatorsByEpochLimit;
+
     /// @notice The max decrease of the total validators' balances on the Consensus Layer since
     ///     the previous oracle report
-    /// @dev Represented in the Basis Points (100% == 100_00)
+    /// @dev Represented in the Basis Points (100% == 10_000)
     uint256 oneOffCLBalanceDecreaseBPLimit;
+
     /// @notice The max annual increase of the total validators' balances on the Consensus Layer
     ///     since the previous oracle report
-    /// @dev Represented in the Basis Points (100% == 100_00)
+    /// @dev Represented in the Basis Points (100% == 10_000)
     uint256 annualBalanceIncreaseBPLimit;
+
     /// @notice The max deviation of stETH.totalPooledEther() / stETH.totalShares() ratio since
     ///     the previous oracle report
-    /// @dev Represented in the Basis Points (100% == 100_00)
+    /// @dev Represented in the Basis Points (100% == 10_000)
     uint256 shareRateDeviationBPLimit;
+
     /// @notice The min time required to be passed from the creation of the request to be
     ///     finalized till the time of the oracle report
     uint256 requestTimestampMargin;
+
     /// @notice The positive token rebase allowed per single LidoOracle report
     /// @dev uses 1e9 precision, e.g.: 1e6 - 0.1%; 1e9 - 100%, see `setMaxPositiveTokenRebase()`
     uint256 maxPositiveTokenRebase;
@@ -151,7 +156,7 @@ contract OracleReportSanityChecker is AccessControlEnumerable {
 
     /// @notice Returns max positive token rebase value with 1e9 precision:
     ///     e.g.: 1e6 - 0.1%; 1e9 - 100%
-    ///     - zero value means unititialized
+    ///     - zero value means uninitialized
     ///     - type(uint64).max means unlimited
     ///
     /// @dev Get max positive rebase allowed per single oracle report token rebase happens on total

contracts/0.8.9/test_helpers/LidoLocatorMock.sol

@@ -14,7 +14,7 @@ contract LidoLocatorMock is ILidoLocator {
         address elRewardsVault;
         address accountingOracle;
         address legacyOracle;
-        address safetyNetsRegistry;
+        address oracleReportSanityChecker;
         address selfOwnedStEthBurner;
         address validatorExitBus;
         address stakingRouter;
@@ -29,7 +29,7 @@ contract LidoLocatorMock is ILidoLocator {
     address public immutable elRewardsVault;
     address public immutable accountingOracle;
     address public immutable legacyOracle;
-    address public immutable safetyNetsRegistry;
+    address public immutable oracleReportSanityChecker;
     address public immutable selfOwnedStEthBurner;
     address public immutable validatorExitBus;
     address public immutable stakingRouter;
@@ -39,27 +39,27 @@ contract LidoLocatorMock is ILidoLocator {
     address public immutable postTokenRebaseReceiver;
 
     constructor (
-        ContractAddresses memory addrs
+        ContractAddresses memory addresses
     ) {
-        lido = addrs.lido;
-        depositSecurityModule = addrs.depositSecurityModule;
-        elRewardsVault = addrs.elRewardsVault;
-        accountingOracle = addrs.accountingOracle;
-        legacyOracle = addrs.legacyOracle;
-        safetyNetsRegistry = addrs.safetyNetsRegistry;
-        selfOwnedStEthBurner = addrs.selfOwnedStEthBurner;
-        validatorExitBus = addrs.validatorExitBus;
-        stakingRouter = addrs.stakingRouter;
-        treasury = addrs.treasury;
-        withdrawalQueue = addrs.withdrawalQueue;
-        withdrawalVault = addrs.withdrawalVault;
-        postTokenRebaseReceiver = addrs.postTokenRebaseReceiver;
+        lido = addresses.lido;
+        depositSecurityModule = addresses.depositSecurityModule;
+        elRewardsVault = addresses.elRewardsVault;
+        accountingOracle = addresses.accountingOracle;
+        legacyOracle = addresses.legacyOracle;
+        oracleReportSanityChecker = addresses.oracleReportSanityChecker;
+        selfOwnedStEthBurner = addresses.selfOwnedStEthBurner;
+        validatorExitBus = addresses.validatorExitBus;
+        stakingRouter = addresses.stakingRouter;
+        treasury = addresses.treasury;
+        withdrawalQueue = addresses.withdrawalQueue;
+        withdrawalVault = addresses.withdrawalVault;
+        postTokenRebaseReceiver = addresses.postTokenRebaseReceiver;
     }
 
     function coreComponents() external view returns(address,address,address,address,address,address) {
         return (
             elRewardsVault,
-            safetyNetsRegistry,
+            oracleReportSanityChecker,
             stakingRouter,
             treasury,
             withdrawalQueue,
@@ -79,7 +79,7 @@ contract LidoLocatorMock is ILidoLocator {
         return (
             accountingOracle,
             elRewardsVault,
-            safetyNetsRegistry,
+            oracleReportSanityChecker,
             selfOwnedStEthBurner,
             withdrawalQueue,
             withdrawalVault,

contracts/0.8.9/test_helpers/oracle/MockLidoLocatorForOracles.sol

@@ -9,29 +9,29 @@ contract MockLidoLocatorForOracles is IComponentLocator {
     address public immutable lido;
     address public immutable stakingRouter;
     address public immutable withdrawalQueue;
-    address public immutable safetyNetsRegistry;
+    address public immutable oracleReportSanityChecker;
 
     constructor(
         address _lido,
         address _stakingRouter,
         address _withdrawalQueue,
-        address _safetyNetsRegistry
+        address _oracleReportSanityChecker
     ) {
         lido = _lido;
         stakingRouter = _stakingRouter;
         withdrawalQueue = _withdrawalQueue;
-        safetyNetsRegistry = _safetyNetsRegistry;
+        oracleReportSanityChecker = _oracleReportSanityChecker;
     }
 
     function coreComponents() external view returns (
         address elRewardsVault_,
-        address safetyNetsRegistry_,
+        address oracleReportSanityChecker_,
         address stakingRouter_,
         address treasury_,
         address withdrawalQueue_,
         address withdrawalVault_
     ) {
-        safetyNetsRegistry_ = safetyNetsRegistry;
+        oracleReportSanityChecker_ = oracleReportSanityChecker;
         stakingRouter_ = stakingRouter;
         withdrawalQueue_ = withdrawalQueue;
     }

contracts/common/interfaces/ILidoLocator.sol

@@ -12,7 +12,7 @@ interface ILidoLocator {
     function elRewardsVault() external view returns(address);
     function legacyOracle() external view returns(address);
     function lido() external view returns(address);
-    function safetyNetsRegistry() external view returns(address);
+    function oracleReportSanityChecker() external view returns(address);
     function selfOwnedStEthBurner() external view returns(address);
     function stakingRouter() external view returns(address);
     function treasury() external view returns(address);
@@ -22,7 +22,7 @@ interface ILidoLocator {
     function postTokenRebaseReceiver() external view returns(address);
     function coreComponents() external view returns(
         address elRewardsVault,
-        address safetyNetsRegistry,
+        address oracleReportSanityChecker,
         address stakingRouter,
         address treasury,
         address withdrawalQueue,
@@ -31,7 +31,7 @@ interface ILidoLocator {
     function oracleReportComponentsForLido() external view returns(
         address accountingOracle,
         address elRewardsVault,
-        address safetyNetsRegistry,
+        address oracleReportSanityChecker,
         address selfOwnedStEthBurner,
         address withdrawalQueue,
         address withdrawalVault,

lib/abi/LidoLocator.json

@@ -1 +1 @@
-[{"inputs":[{"components":[{"internalType":"address","name":"accountingOracle","type":"address"},{"internalType":"address","name":"depositSecurityModule","type":"address"},{"internalType":"address","name":"elRewardsVault","type":"address"},{"internalType":"address","name":"legacyOracle","type":"address"},{"internalType":"address","name":"lido","type":"address"},{"internalType":"address","name":"safetyNetsRegistry","type":"address"},{"internalType":"address","name":"selfOwnedStEthBurner","type":"address"},{"internalType":"address","name":"stakingRouter","type":"address"},{"internalType":"address","name":"treasury","type":"address"},{"internalType":"address","name":"validatorExitBus","type":"address"},{"internalType":"address","name":"withdrawalQueue","type":"address"},{"internalType":"address","name":"withdrawalVault","type":"address"},{"internalType":"address","name":"postTokenRebaseReceiver","type":"address"}],"internalType":"struct LidoLocator.Config","name":"_config","type":"tuple"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"ErrorZeroAddress","type":"error"},{"inputs":[],"name":"accountingOracle","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"coreComponents","outputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"depositSecurityModule","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"elRewardsVault","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"legacyOracle","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"lido","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"oracleReportComponentsForLido","outputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"postTokenRebaseReceiver","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"safetyNetsRegistry","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"selfOwnedStEthBurner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"stakingRouter","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"treasury","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"validatorExitBus","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"withdrawalQueue","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"withdrawalVault","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]
+[{"inputs":[{"components":[{"internalType":"address","name":"accountingOracle","type":"address"},{"internalType":"address","name":"depositSecurityModule","type":"address"},{"internalType":"address","name":"elRewardsVault","type":"address"},{"internalType":"address","name":"legacyOracle","type":"address"},{"internalType":"address","name":"lido","type":"address"},{"internalType":"address","name":"oracleReportSanityChecker","type":"address"},{"internalType":"address","name":"selfOwnedStEthBurner","type":"address"},{"internalType":"address","name":"stakingRouter","type":"address"},{"internalType":"address","name":"treasury","type":"address"},{"internalType":"address","name":"validatorExitBus","type":"address"},{"internalType":"address","name":"withdrawalQueue","type":"address"},{"internalType":"address","name":"withdrawalVault","type":"address"},{"internalType":"address","name":"postTokenRebaseReceiver","type":"address"}],"internalType":"struct LidoLocator.Config","name":"_config","type":"tuple"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"ErrorZeroAddress","type":"error"},{"inputs":[],"name":"accountingOracle","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"coreComponents","outputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"depositSecurityModule","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"elRewardsVault","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"legacyOracle","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"lido","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"oracleReportComponentsForLido","outputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"oracleReportSanityChecker","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"postTokenRebaseReceiver","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"selfOwnedStEthBurner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"stakingRouter","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"treasury","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"validatorExitBus","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"withdrawalQueue","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"withdrawalVault","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]