Feat/upgrade on forking

.env.example

@@ -24,12 +24,9 @@ LOCAL_WITHDRAWAL_VAULT_ADDRESS=
 LOCAL_STAKING_VAULT_FACTORY_ADDRESS=
 LOCAL_STAKING_VAULT_BEACON_ADDRESS=
 
-# RPC URL for a separate, non Hardhat Network node (Anvil, Infura, Alchemy, etc.)
-MAINNET_RPC_URL=http://localhost:8545
-
-# RPC URL for Hardhat Network forking, required for running tests on mainnet fork with tracing (Infura, Alchemy, etc.)
+# RPC URL for Hardhat Network forking, required for running tests on fork with tracing (Infura, Alchemy, etc.)
 # https://hardhat.org/hardhat-network/docs/guides/forking-other-networks#forking-other-networks
-FORK_RPC_URL=https://eth.drpc.org
+RPC_URL=https://eth.drpc.org
 
 # https://docs.lido.fi/deployed-contracts
 MAINNET_LOCATOR_ADDRESS=0xC1d0b3DE6792Bf6b4b37EccdcC24e45978Cfd2Eb

.github/workflows/tests-integration-mainnet.yml

@@ -1,12 +1,7 @@
-name: Integration Tests
+name: Integration Tests On Upgrade
+# For local testing of this scenario use ./scripts/dao-upgrade-and-test-on-fork.sh
 
-on: workflow_dispatch
-
-# TODO: uncomment
-#on:
-#  push:
-#  schedule:
-#    - cron: "0 10 */2 * *"
+on: [push]
 
 jobs:
   test_hardhat_integration_fork:
@@ -16,22 +11,45 @@ jobs:
 
     services:
       hardhat-node:
-        image: ghcr.io/lidofinance/hardhat-node:2.22.19
+        image: ghcr.io/lidofinance/hardhat-node:2.22.19.3
         ports:
-          - 8545:8545
+          - 8555:8545
         env:
           ETH_RPC_URL: "${{ secrets.ETH_RPC_URL }}"
+          DONT_SET_CHAIN_ID: true
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Common setup
         uses: ./.github/workflows/setup
 
-      - name: Set env
-        run: cp .env.example .env
+      - name: Prepare network state file
+        run: cp deployed-mainnet.json deployed-mainnet-upgrade.json
+
+      - name: Run upgrade
+        run: yarn upgrade:deploy
+        env:
+          RPC_URL: http://localhost:8555
+          DEPLOYER: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" # first acc of default mnemonic "test test ..."
+          GAS_PRIORITY_FEE: 1
+          GAS_MAX_FEE: 100
+          NETWORK_STATE_FILE: deployed-mainnet-upgrade.json
+
+      - name: Mock Aragon voting
+        run: yarn upgrade:mock-voting
+        env:
+          RPC_URL: http://localhost:8555
+          NETWORK_STATE_FILE: deployed-mainnet-upgrade.json
+
+      - name: Finalize scratch deployment
+        run: yarn hardhat --network local run --no-compile scripts/utils/mine.ts
+        env:
+          RPC_URL: http://localhost:8555
 
       - name: Run integration tests
-        run: yarn test:integration:fork:mainnet
+        run: yarn test:integration
         env:
           LOG_LEVEL: debug
+          RPC_URL: http://localhost:8555
+          NETWORK_STATE_FILE: deployed-mainnet-upgrade.json

.gitignore

@@ -1,6 +1,9 @@
 .idea/
 .yarn/
-.vscode/
+.vscode/*
+!./vscode/settings.json
+!./vscode/extensions.json
+!./vscode/snippets.code-snippets
 
 node_modules/
 coverage/
@@ -26,6 +29,7 @@ accounts.json
 deployed-local.json
 deployed-hardhat.json
 deployed-local-devnet.json
+deployed-mainnet-upgrade.json
 
 # MacOS
 .DS_Store

.solcover.js

@@ -12,5 +12,6 @@ module.exports = {
     "common/lib", // 100% covered by test/common/*.t.sol
     "0.8.9/lib/UnstructuredStorage.sol", // 100% covered by test/0.8.9/unstructuredStorage.t.sol
     "openzeppelin",
+    "0.8.25/utils/UpgradeTemplateV3.sol",
   ],
 };

.vscode/settings.json

@@ -4,5 +4,26 @@
     "source.fixAll.eslint": "always"
   },
   "solidity.defaultCompiler": "remote",
-  "cSpell.words": ["IETHRegistrarController", "sealables", "streccak", "TmplAppInstalled", "TmplDAOAndTokenDeployed"]
+  "cSpell.words": [
+    "automine",
+    "Codehash",
+    "disconnecters",
+    "funders",
+    "IETHRegistrarController",
+    "mintable",
+    "permissionless",
+    "postdeposits",
+    "predeposit",
+    "predeposits",
+    "rebalancers",
+    "sdvt",
+    "sealables",
+    "streccak",
+    "TmplAppInstalled",
+    "TmplDAOAndTokenDeployed",
+    "Triggerers",
+    "unvet",
+    "Unvetting",
+    "withdrawers"
+  ]
 }

CONTRIBUTING.md

@@ -273,19 +273,19 @@ maintain optimal test performance.
 
 To enable tracing:
 
-- Wrap the code you want to trace with `Tracer.enable()` and `Tracer.disable()` functions.
+- Wrap the code you want to trace with `Tracing.enable()` and `Tracing.disable()` functions.
 - Run the tests with the appropriate command that enables tracing (e.g., `yarn test:trace`).
 
 Here's an example:
 
 ```typescript
-import { Tracer } from "test/suite";
+import { Tracing } from "test/suite";
 
 describe("MyContract", () => {
   it("should do something", async () => {
-    Tracer.enable();
+    Tracing.enable();
     // code to trace
-    Tracer.disable();
+    Tracing.disable();
   });
 });
 ```

contracts/0.4.24/Lido.sol

@@ -8,6 +8,7 @@ import {AragonApp, UnstructuredStorage} from "@aragon/os/contracts/apps/AragonAp
 import {SafeMath} from "@aragon/os/contracts/lib/math/SafeMath.sol";
 
 import {ILidoLocator} from "../common/interfaces/ILidoLocator.sol";
+import {IBurner} from "../common/interfaces/IBurner.sol";
 import {StakeLimitUtils, StakeLimitUnstructuredStorage, StakeLimitState} from "./lib/StakeLimitUtils.sol";
 import {Math256} from "../common/lib/Math256.sol";
 
@@ -210,10 +211,6 @@ contract Lido is Versioned, StETHPermit, AragonApp {
         emit LidoLocatorSet(_lidoLocator);
         _initializeEIP712StETH(_eip712StETH);
 
-        // set infinite allowance for burner from withdrawal queue
-        // to burn finalized requests' shares
-        _approve(ILidoLocator(_lidoLocator).withdrawalQueue(), ILidoLocator(_lidoLocator).burner(), INFINITE_ALLOWANCE);
-
         _initialize_v3();
         initialized();
     }
@@ -222,19 +219,53 @@ contract Lido is Versioned, StETHPermit, AragonApp {
      * @notice A function to finalize upgrade to v3 (from v2). Can be called only once
      *
      * For more details see https://github.com/lidofinance/lido-improvement-proposals/blob/develop/LIPS/lip-10.md
+     * @param _oldBurner The address of the old Burner contract to migrate from
      */
-    function finalizeUpgrade_v3() external {
+    function finalizeUpgrade_v3(address _oldBurner, address _simpleDvt, address _nodeOperatorsRegistry, address _csmAccounting) external {
         require(hasInitialized(), "NOT_INITIALIZED");
         _checkContractVersion(2);
+        require(_oldBurner != address(0), "OLD_BURNER_ADDRESS_ZERO");
+        require(_oldBurner != getLidoLocator().burner(), "OLD_BURNER_SAME_AS_NEW");
 
         _initialize_v3();
+
+        // migrate burner stETH balance
+        address burner = getLidoLocator().burner();
+        uint256 oldBurnerShares = _sharesOf(_oldBurner);
+        if (oldBurnerShares > 0) {
+            _transferShares(_oldBurner, burner, oldBurnerShares);
+            _emitTransferEvents(_oldBurner, burner, oldBurnerShares, oldBurnerShares);
+        }
+
+        // initialize new burner with state from the old burner
+        IBurner(burner).migrate(_oldBurner);
+
+        // revoke allowances for the old burner
+        _approve(getLidoLocator().withdrawalQueue(), _oldBurner, 0);
+        _approve(_simpleDvt, _oldBurner, 0);
+        _approve(_nodeOperatorsRegistry, _oldBurner, 0);
+        _approve(_csmAccounting, _oldBurner, 0);
+
+        // set allowances to new burner
+        _approve(_simpleDvt, burner, INFINITE_ALLOWANCE);
+        _approve(_nodeOperatorsRegistry, burner, INFINITE_ALLOWANCE);
+        _approve(_csmAccounting, burner, INFINITE_ALLOWANCE);
+        // NB: allowances for withdrawalQueue and accounting are set in _initialize_v3()
+        //     because they are required upon scratch deployment as well
     }
 
     /**
      * initializer for the Lido version "3"
      */
     function _initialize_v3() internal {
         _setContractVersion(3);
+
+        // Set approvals for the burner
+        address burner = getLidoLocator().burner();
+        _approve(getLidoLocator().withdrawalQueue(), burner, INFINITE_ALLOWANCE);
+        _approve(getLidoLocator().accounting(), burner, INFINITE_ALLOWANCE);
+        // NB: allowances for simpleDvt and nodeOperatorsRegistry are not set here
+        //     because NodeOperatorsRegistry sets it itself upon scratch deployment
     }
 
     /**

contracts/0.4.24/template/LidoTemplate.sol

@@ -123,7 +123,7 @@ contract LidoTemplate is IsContract {
     APMRegistryFactory private apmRegistryFactory;
 
     DeployState private deployState;
-    APMRepos private apmRepos;
+    APMRepos public apmRepos;
 
     event TmplAPMDeployed(address apm);
     event TmplReposCreated();