feat: Update LidoLocator with wstETH contract address

contracts/0.8.9/LidoLocator.sol

@@ -1,9 +1,10 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-/* See contracts/COMPILERS.md */
 pragma solidity 0.8.9;
 
+// solhint-disable immutable-vars-naming
+
 import {ILidoLocator} from "../common/interfaces/ILidoLocator.sol";
 
 /**
@@ -28,6 +29,7 @@ contract LidoLocator is ILidoLocator {
         address withdrawalQueue;
         address withdrawalVault;
         address oracleDaemonConfig;
+        address wstEth;
     }
 
     error ZeroAddress();
@@ -46,6 +48,7 @@ contract LidoLocator is ILidoLocator {
     address public immutable withdrawalQueue;
     address public immutable withdrawalVault;
     address public immutable oracleDaemonConfig;
+    address public immutable wstEth;
 
     /**
      * @notice declare service locations
@@ -67,9 +70,10 @@ contract LidoLocator is ILidoLocator {
         withdrawalQueue = _assertNonZero(_config.withdrawalQueue);
         withdrawalVault = _assertNonZero(_config.withdrawalVault);
         oracleDaemonConfig = _assertNonZero(_config.oracleDaemonConfig);
+        wstEth = _assertNonZero(_config.wstEth);
     }
 
-    function coreComponents() external view returns(
+    function coreComponents() external view returns (
         address,
         address,
         address,
@@ -87,7 +91,7 @@ contract LidoLocator is ILidoLocator {
         );
     }
 
-    function oracleReportComponentsForLido() external view returns(
+    function oracleReportComponentsForLido() external view returns (
         address,
         address,
         address,

contracts/common/interfaces/ILidoLocator.sol

@@ -1,34 +1,41 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-// See contracts/COMPILERS.md
 // solhint-disable-next-line
 pragma solidity >=0.4.24 <0.9.0;
 
 interface ILidoLocator {
-    function accountingOracle() external view returns(address);
-    function depositSecurityModule() external view returns(address);
-    function elRewardsVault() external view returns(address);
-    function legacyOracle() external view returns(address);
-    function lido() external view returns(address);
-    function oracleReportSanityChecker() external view returns(address);
-    function burner() external view returns(address);
-    function stakingRouter() external view returns(address);
-    function treasury() external view returns(address);
-    function validatorsExitBusOracle() external view returns(address);
-    function withdrawalQueue() external view returns(address);
-    function withdrawalVault() external view returns(address);
-    function postTokenRebaseReceiver() external view returns(address);
-    function oracleDaemonConfig() external view returns(address);
-    function coreComponents() external view returns(
+
+    function accountingOracle() external view returns (address);
+    function depositSecurityModule() external view returns (address);
+    function elRewardsVault() external view returns (address);
+    function legacyOracle() external view returns (address);
+    function lido() external view returns (address);
+    function oracleReportSanityChecker() external view returns (address);
+    function burner() external view returns (address);
+    function stakingRouter() external view returns (address);
+    function treasury() external view returns (address);
+    function validatorsExitBusOracle() external view returns (address);
+    function withdrawalQueue() external view returns (address);
+    function withdrawalVault() external view returns (address);
+    function postTokenRebaseReceiver() external view returns (address);
+    function oracleDaemonConfig() external view returns (address);
+    function wstEth() external view returns (address);
+
+    /// @dev Returns a batch of core components addresses at once.
+    ///      It's just a more gas-efficient way of calling several public getters at once.
+    function coreComponents() external view returns (
         address elRewardsVault,
         address oracleReportSanityChecker,
         address stakingRouter,
         address treasury,
         address withdrawalQueue,
         address withdrawalVault
     );
-    function oracleReportComponentsForLido() external view returns(
+
+    /// @dev Returns a batch of addresses that is used specifically during oracle report handling in the Lido contract.
+    ///      It's just a more gas-efficient way of calling several public getters at once.
+    function oracleReportComponentsForLido() external view returns (
         address accountingOracle,
         address elRewardsVault,
         address oracleReportSanityChecker,

lib/protocol/networks.ts

@@ -45,6 +45,7 @@ const defaultEnv = {
   withdrawalQueue: "WITHDRAWAL_QUEUE_ADDRESS",
   withdrawalVault: "WITHDRAWAL_VAULT_ADDRESS",
   oracleDaemonConfig: "ORACLE_DAEMON_CONFIG_ADDRESS",
+  wstEth: "WST_ETH_ADDRESS",
   // aragon contracts
   kernel: "ARAGON_KERNEL_ADDRESS",
   acl: "ARAGON_ACL_ADDRESS",

lib/protocol/types.ts

@@ -20,6 +20,7 @@ import {
   ValidatorsExitBusOracle,
   WithdrawalQueueERC721,
   WithdrawalVault,
+  WstETH,
 } from "typechain-types";
 
 export type ProtocolNetworkItems = {
@@ -41,6 +42,7 @@ export type ProtocolNetworkItems = {
   withdrawalQueue: string;
   withdrawalVault: string;
   oracleDaemonConfig: string;
+  wstEth: string;
   // aragon contracts
   kernel: string;
   acl: string;
@@ -65,6 +67,7 @@ export interface ContractTypes {
   WithdrawalQueueERC721: WithdrawalQueueERC721;
   WithdrawalVault: WithdrawalVault;
   OracleDaemonConfig: OracleDaemonConfig;
+  WstETH: WstETH;
   Kernel: Kernel;
   ACL: ACL;
   HashConsensus: HashConsensus;
@@ -93,6 +96,7 @@ export type CoreContracts = {
   withdrawalQueue: LoadedContract<WithdrawalQueueERC721>;
   withdrawalVault: LoadedContract<WithdrawalVault>;
   oracleDaemonConfig: LoadedContract<OracleDaemonConfig>;
+  wstEth: LoadedContract<WstETH>;
 };
 
 export type AragonContracts = {

scripts/scratch/steps/09-deploy-non-aragon-contracts.ts

@@ -301,6 +301,7 @@ async function main() {
     withdrawalQueueERC721.address,
     withdrawalVaultAddress,
     oracleDaemonConfig.address,
+    wstETH.address,
   ];
   await updateProxyImplementation(Sk.lidoLocator, "LidoLocator", locator.address, proxyContractsOwner, [locatorConfig]);
 

scripts/upgrade/deploy-locator.ts

@@ -19,6 +19,7 @@ const VIEW_NAMES_AND_CTOR_ARGS = [
   "withdrawalQueue",
   "withdrawalVault",
   "oracleDaemonConfig",
+  "wstEth",
 ];
 
 /////////////// GLOBAL VARIABLES ///////////////
@@ -52,12 +53,14 @@ async function main() {
   const newOrCurrent = async (name: string) => {
     return await getNewFromEnvOrCurrent(name, locator);
   };
+
   const ctorArgs = await Promise.all(VIEW_NAMES_AND_CTOR_ARGS.map(newOrCurrent));
 
   if (Object.keys(g_newAddresses).length === 0) {
     log(`No new addresses specified: exiting doing nothing`);
     process.exit(0);
   }
+
   log.splitter();
   for (const name in g_newAddresses) {
     log(`(!) "${name}" new address: ${g_newAddresses[name]}`);

test/0.8.9/contracts/LidoLocator__MockMutable.sol

@@ -19,6 +19,7 @@ contract LidoLocator__MockMutable {
         address withdrawalQueue;
         address withdrawalVault;
         address oracleDaemonConfig;
+        address wstEth;
     }
 
     error ZeroAddress();
@@ -37,6 +38,7 @@ contract LidoLocator__MockMutable {
     address public immutable withdrawalQueue;
     address public immutable withdrawalVault;
     address public immutable oracleDaemonConfig;
+    address public immutable wstEth;
 
     /**
      * @notice declare service locations
@@ -58,6 +60,7 @@ contract LidoLocator__MockMutable {
         withdrawalQueue = _assertNonZero(_config.withdrawalQueue);
         withdrawalVault = _assertNonZero(_config.withdrawalVault);
         oracleDaemonConfig = _assertNonZero(_config.oracleDaemonConfig);
+        wstEth = _assertNonZero(_config.wstEth);
     }
 
     function coreComponents() external view returns (address, address, address, address, address, address) {

test/0.8.9/lidoLocator.test.ts

@@ -21,6 +21,7 @@ const services = [
   "withdrawalQueue",
   "withdrawalVault",
   "oracleDaemonConfig",
+  "wstEth",
 ] as const;
 
 type Service = ArrayToUnion<typeof services>;

test/deploy/locator.ts

@@ -28,6 +28,7 @@ async function deployDummyLocator(config?: Partial<LidoLocator.ConfigStruct>, de
     validatorsExitBusOracle: certainAddress("dummy-locator:validatorsExitBusOracle"),
     withdrawalQueue: certainAddress("dummy-locator:withdrawalQueue"),
     withdrawalVault: certainAddress("dummy-locator:withdrawalVault"),
+    wstEth: certainAddress("dummy-locator:wstEth"),
     ...config,
   });
 
@@ -102,6 +103,7 @@ async function getLocatorConfig(locatorAddress: string) {
     "withdrawalQueue",
     "withdrawalVault",
     "oracleDaemonConfig",
+    "wstEth",
   ] as Partial<keyof LidoLocator.ConfigStruct>[];
 
   const configPromises = addresses.map((name) => locator[name]());