[EPIC] stVaults

.env.example

@@ -1,6 +1,5 @@
 # RPC URL for a locally running node (Ganache, Anvil, Hardhat Network, etc.), used for scratch deployment and tests
 LOCAL_RPC_URL=http://localhost:8555
-
 LOCAL_LOCATOR_ADDRESS=
 LOCAL_AGENT_ADDRESS=
 LOCAL_VOTING_ADDRESS=
@@ -23,13 +22,13 @@ LOCAL_VALIDATOR_EXIT_DELAY_VERIFIER_ADDRESS=
 LOCAL_VALIDATORS_EXIT_BUS_ORACLE_ADDRESS=
 LOCAL_WITHDRAWAL_QUEUE_ADDRESS=
 LOCAL_WITHDRAWAL_VAULT_ADDRESS=
+LOCAL_STAKING_VAULT_FACTORY_ADDRESS=
+LOCAL_STAKING_VAULT_BEACON_ADDRESS=
+LOCAL_VALIDATOR_CONSOLIDATION_REQUESTS_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
@@ -53,12 +52,22 @@ MAINNET_STAKING_ROUTER_ADDRESS=
 MAINNET_VALIDATORS_EXIT_BUS_ORACLE_ADDRESS=
 MAINNET_WITHDRAWAL_QUEUE_ADDRESS=
 MAINNET_WITHDRAWAL_VAULT_ADDRESS=
+MAINNET_STAKING_VAULT_FACTORY_ADDRESS=
+MAINNET_STAKING_VAULT_BEACON_ADDRESS=
+MAINNET_VALIDATOR_CONSOLIDATION_REQUESTS_ADDRESS=
+
+SEPOLIA_RPC_URL=
+HOODI_RPC_URL=
 
 # Scratch deployment via hardhat variables
 DEPLOYER=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
 GENESIS_TIME=1639659600
+SLOTS_PER_EPOCH=32
 GAS_PRIORITY_FEE=1
 GAS_MAX_FEE=100
 
 # Etherscan API key for verifying contracts
 ETHERSCAN_API_KEY=
+
+# Local devnet private key
+LOCAL_DEVNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000

.github/workflows/coverage.yml

@@ -23,10 +23,6 @@ jobs:
       - name: Common setup
         uses: ./.github/workflows/setup
 
-      # Remove the integration tests from the test suite, as they require a mainnet fork to run properly
-      - name: Remove integration tests
-        run: rm -rf test/integration
-
       - name: Collect coverage
         run: yarn test:coverage
 
@@ -35,7 +31,8 @@ jobs:
         with:
           path: ./coverage/cobertura-coverage.xml
           publish: true
-          threshold: 95
+          # TODO: restore to 95% before release
+          threshold: 80
           diff: true
           diff-branch: master
           diff-storage: _core_coverage_reports

.github/workflows/linters.yml

@@ -44,3 +44,29 @@ jobs:
 
       - name: Run typescript types check
         run: yarn typecheck
+
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Common setup
+        uses: ./.github/workflows/setup
+
+      - name: Run format check
+        run: yarn format
+
+  validate-configs:
+    name: Validate Configs
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Common setup
+        uses: ./.github/workflows/setup
+
+      - name: Validate configurations
+        run: yarn validate:configs

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

@@ -1,34 +1,62 @@
-name: Integration Tests
+name: Integration Tests On Upgrade
+# For local testing of this scenario use ./scripts/dao-upgrade-and-test-on-fork.sh
 
-on:
-  push:
-  schedule:
-    - cron: "0 10 */2 * *"
+on: [push]
 
 jobs:
   test_hardhat_integration_fork:
     name: Hardhat / Mainnet
     runs-on: ubuntu-latest
     timeout-minutes: 120
+    env:
+      NODE_OPTIONS: --max_old_space_size=7200
+      SKIP_GAS_REPORT: true
+      SKIP_CONTRACT_SIZE: true
+      SKIP_INTERFACES_CHECK: true
 
     services:
       hardhat-node:
-        image: ghcr.io/lidofinance/hardhat-node:2.24.0
+        image: ghcr.io/lidofinance/hardhat-node:2.26.0
         ports:
-          - 8545:8545
+          - 8555:8545
         env:
           ETH_RPC_URL: "${{ secrets.ETH_RPC_URL }}"
+          DONT_SET_CHAIN_ID: true
+          HARDFORK: "prague"
 
     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: Deploy 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
+          GENESIS_TIME: 1606824023 # needed only for TW upgrade
+
+      - name: Mock Aragon voting
+        run: yarn upgrade:mock-voting
+        env:
+          RPC_URL: http://localhost:8555
+          NETWORK_STATE_FILE: deployed-mainnet-upgrade.json
+
+      - name: Workaround for not updated state error when forking a fork
+        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:
+          RPC_URL: http://localhost:8555
           LOG_LEVEL: debug
+          NETWORK_STATE_FILE: deployed-mainnet-upgrade.json

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

@@ -7,10 +7,14 @@ jobs:
     name: Hardhat / Scratch
     runs-on: ubuntu-latest
     timeout-minutes: 120
+    env:
+      SKIP_GAS_REPORT: true
+      SKIP_CONTRACT_SIZE: true
+      SKIP_INTERFACES_CHECK: true
 
     services:
       hardhat-node:
-        image: ghcr.io/lidofinance/hardhat-node:2.24.0-scratch
+        image: ghcr.io/lidofinance/hardhat-node:2.26.0-scratch
         ports:
           - 8555:8545
 
@@ -33,13 +37,12 @@ jobs:
           GAS_PRIORITY_FEE: 1
           GAS_MAX_FEE: 100
           NETWORK_STATE_FILE: "deployed-local.json"
-          NETWORK_STATE_DEFAULTS_FILE: "scripts/scratch/deployed-testnet-defaults.json"
+          NETWORK_STATE_DEFAULTS_FILE: "scripts/defaults/testnet-defaults.json"
 
       - name: Finalize scratch deployment
         run: yarn hardhat --network local run --no-compile scripts/utils/mine.ts
 
       - name: Run integration tests
         run: yarn test:integration:fork:local
         env:
-          LOG_LEVEL: "debug"
           INTEGRATION_WITH_CSM: "off"

.github/workflows/tests-integration-upgrade-template.yml

@@ -0,0 +1,29 @@
+name: Integration Test For Upgrade Template
+
+on: [push]
+
+jobs:
+  test_hardhat_integration_fork_template:
+    name: Hardhat / Upgrade Template
+    runs-on: ubuntu-latest
+    timeout-minutes: 120
+    env:
+      SKIP_GAS_REPORT: true
+      SKIP_CONTRACT_SIZE: true
+      SKIP_INTERFACES_CHECK: true
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Common setup
+        uses: ./.github/workflows/setup
+
+      - name: Prepare network state file
+        run: cp deployed-mainnet.json deployed-mainnet-upgrade.json
+
+      - name: Run Upgrade Template Integration Tests
+        run: yarn test:integration:upgrade-template
+        env:
+          RPC_URL: "${{ secrets.ETH_RPC_URL }}"
+          UPGRADE_PARAMETERS_FILE: upgrade-parameters-mainnet.json
+          GENESIS_TIME: 1606824023 # needed only for TW upgrade

.gitignore

@@ -2,9 +2,11 @@
 .yarn/
 .vscode/
 .cursor/
+.claude/
 
 node_modules/
 coverage/
+state-mate/
 
 coverage.json
 
@@ -25,8 +27,10 @@ lib/abi/*.json
 .env
 accounts.json
 deployed-local.json
+deployed-local-devnet.json
 deployed-hardhat.json
 deployed-local-devnet.json
+deployed-mainnet-upgrade.json
 
 # MacOS
 .DS_Store

.husky/pre-commit

@@ -1 +1,3 @@
+yarn compile
 yarn lint-staged
+yarn typecheck

.nvmrc

@@ -1 +1 @@
-20.12
+22.15

.solcover.js

@@ -11,5 +11,8 @@ module.exports = {
     // Skip contracts that are tested by Foundry tests
     "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",
+    "testnet",
+    "upgrade",
   ],
 };

.solhintignore

@@ -1,2 +1,9 @@
-contracts/Migrations.sol
-contracts/0.6.11/deposit_contract.sol
+contracts/openzeppelin/
+contracts/0.8.9/utils/access/AccessControl.sol
+contracts/0.8.9/utils/access/AccessControlEnumerable.sol
+
+contracts/0.4.24/template/
+contracts/0.6.11/deposit_contract.sol
+contracts/0.6.12/
+contracts/0.8.9/WithdrawalsManagerProxy.sol
+contracts/0.8.9/LidoExecutionLayerRewardsVault.sol

CONTRIBUTING.md

@@ -45,7 +45,7 @@ the [Lido Research Forum](https://research.lido.fi/).
 
 ### Requirements
 
-- [Node.js](https://nodejs.org/en) version 20 (LTS) with `corepack` enabled
+- [Node.js](https://nodejs.org/en) version 22 (LTS) with `corepack` enabled
 - [Yarn](https://yarnpkg.com/) installed via corepack (see below)
 - [Foundry](https://book.getfoundry.sh/) latest available version
 
@@ -117,16 +117,30 @@ the [Mocking and Harnessing Contracts](#mocking-and-harnessing-contracts) sectio
 
 #### Unit Tests
 
-Unit tests are crucial for ensuring the functionality of individual contracts and their components. These tests should
-be written using Hardhat and placed in the `/tests` directory. Each subdirectory should correspond to the version of the
-contract being tested, mirroring the structure of the `/contracts` directory.
+Every contract must be accompanied by high-quality unit tests.
+The [Moloch Testing Guide](https://github.com/MolochVentures/moloch/tree/master/test#readme) provides excellent recommendations,
+though some guidelines may not apply directly to this project.
 
-Follow the naming convention `*.test.ts` for unit test files, such as `myContract.test.ts`. This convention aids in the
-easy identification and organization of tests.
+> [!NOTE]
+> Tests should not only verify correct functionality but also be clear and well-structured for thorough peer
+> review—particularly for mission-critical Solidity code where tests are often as important as the implementation itself.
+
+- All new features or code changes must include comprehensive, relevant tests.
+- Refactoring should be performed separately from test modifications to maintain test integrity.
+- Tests must be reliable and deterministic; flaky tests will not be accepted.
+- The test suite runs automatically with every repository change, and all tests must pass before pull requests can be merged.
+- Maintain test coverage as close to 100% as possible, which will be verified during pull request reviews.
+
+Unit tests should be written using Hardhat and placed in the `/tests` directory.
+The subdirectory structure should mirror the `/contracts` directory, with each subdirectory corresponding to the
+Solidity version of the contracts being tested.
+
+Use the naming convention `*.test.ts` for unit test files (e.g., `myContract.test.ts`) to ensure consistent
+organization and easy identification of test files.
 
 > [!NOTE]
-> The project utilizes the `hardhat-coverage` plugin to generate coverage reports. Foundry-based tests are not included
-> in the coverage.
+> The project uses the `hardhat-coverage` plugin to generate coverage reports. Note that Foundry-based tests are not
+> included in these coverage calculations.
 
 #### Integration Tests
 
@@ -416,7 +430,7 @@ jobs:
 
     services:
       mainnet-fork:
-        image: hardhat/hardhat:2.22.8 # note: this is an example image, choose the appropriate one for your needs
+        image: hardhat/hardhat:2.23.0 # note: this is an example image, choose the appropriate one for your needs
         ports:
           - 8545:8545
         env: