Backport master to develop: integration tests

.editorconfig

@@ -6,7 +6,7 @@ end_of_line = lf
 insert_final_newline = true
 charset = utf-8
 indent_style = space
-indent_size = 4
-
-[*.{js,yml,json,cjs,ts}]
 indent_size = 2
+
+[*.sol]
+indent_size = 4

.env.example

@@ -0,0 +1,46 @@
+LOCAL_RPC_URL=http://localhost:8555
+LOCAL_LOCATOR_ADDRESS=
+LOCAL_AGENT_ADDRESS=
+LOCAL_VOTING_ADDRESS=
+LOCAL_EASY_TRACK_EXECUTOR_ADDRESS=
+LOCAL_ACCOUNTING_ORACLE_ADDRESS=
+LOCAL_ACL_ADDRESS=
+LOCAL_BURNER_ADDRESS=
+LOCAL_DEPOSIT_SECURITY_MODULE_ADDRESS=
+LOCAL_EL_REWARDS_VAULT_ADDRESS=
+LOCAL_HASH_CONSENSUS_ADDRESS=
+LOCAL_KERNEL_ADDRESS=
+LOCAL_LEGACY_ORACLE_ADDRESS=
+LOCAL_LIDO_ADDRESS=
+LOCAL_NOR_ADDRESS=
+LOCAL_ORACLE_DAEMON_CONFIG_ADDRESS=
+LOCAL_ORACLE_REPORT_SANITY_CHECKER_ADDRESS=
+LOCAL_SDVT_ADDRESS=
+LOCAL_STAKING_ROUTER_ADDRESS=
+LOCAL_VALIDATORS_EXIT_BUS_ORACLE_ADDRESS=
+LOCAL_WITHDRAWAL_QUEUE_ADDRESS=
+LOCAL_WITHDRAWAL_VAULT_ADDRESS=
+
+# https://docs.lido.fi/deployed-contracts
+MAINNET_RPC_URL=http://localhost:8545
+MAINNET_LOCATOR_ADDRESS=0xC1d0b3DE6792Bf6b4b37EccdcC24e45978Cfd2Eb
+MAINNET_AGENT_ADDRESS=0x3e40D73EB977Dc6a537aF587D48316feE66E9C8c
+MAINNET_VOTING_ADDRESS=0x2e59A20f205bB85a89C53f1936454680651E618e
+MAINNET_EASY_TRACK_EXECUTOR_ADDRESS=0xFE5986E06210aC1eCC1aDCafc0cc7f8D63B3F977
+MAINNET_ACCOUNTING_ORACLE_ADDRESS=
+MAINNET_ACL_ADDRESS=
+MAINNET_BURNER_ADDRESS=
+MAINNET_DEPOSIT_SECURITY_MODULE_ADDRESS=
+MAINNET_EL_REWARDS_VAULT_ADDRESS=
+MAINNET_HASH_CONSENSUS_ADDRESS=
+MAINNET_KERNEL_ADDRESS=
+MAINNET_LEGACY_ORACLE_ADDRESS=
+MAINNET_LIDO_ADDRESS=
+MAINNET_NOR_ADDRESS=
+MAINNET_ORACLE_DAEMON_CONFIG_ADDRESS=
+MAINNET_ORACLE_REPORT_SANITY_CHECKER_ADDRESS=
+MAINNET_SDVT_ADDRESS=
+MAINNET_STAKING_ROUTER_ADDRESS=
+MAINNET_VALIDATORS_EXIT_BUS_ORACLE_ADDRESS=
+MAINNET_WITHDRAWAL_QUEUE_ADDRESS=
+MAINNET_WITHDRAWAL_VAULT_ADDRESS=

.eslintrc

@@ -1,17 +1,20 @@
 {
   "parser": "@typescript-eslint/parser",
   "extends": ["plugin:@typescript-eslint/recommended", "prettier"],
-  "parserOptions": { "ecmaVersion": 2022, "sourceType": "module", "project": ["./tsconfig.json"] },
+  "parserOptions": {
+    "ecmaVersion": 2022, "sourceType": "module", "project": ["./tsconfig.json"]
+  },
   "plugins": ["no-only-tests", "simple-import-sort"],
   "rules": {
     "@typescript-eslint/no-explicit-any": ["warn"],
     "@typescript-eslint/no-unused-vars": ["warn"],
     "@typescript-eslint/no-floating-promises": ["warn"],
+    "@typescript-eslint/no-shadow": ["error"],
     // prevents committing `describe.only` and `it.only` tests
     "no-only-tests/no-only-tests": "warn",
+    "no-shadow": "off",
     "simple-import-sort/imports": [
-      "error",
-      {
+      "error", {
         "groups": [
           ["^node:"],
           ["^\\u0000"],
@@ -22,17 +25,14 @@
           ["^test"],
           ["^../"],
           ["^./"],
-          ["^"],
-        ],
-      },
-    ],
+          ["^"]
+        ]
+      }
+    ]
   },
   "overrides": [
     {
-      "files": ["./scripts/{**/,}*.js", "./test/{**/,}*.js"],
-      "env": {
-        "mocha": true,
-      },
-    },
-  ],
+      "files": ["./scripts/{**/,}*.js", "./test/{**/,}*.js"], "env": {"mocha": true}
+    }
+  ]
 }

.github/workflows/analyse.yml

@@ -1,14 +1,14 @@
-name: Code Analysis
+name: Analysis
 
 on:
   push:
-    branches: [ master, develop, repovation ]
+    branches: [master, develop, repovation]
   pull_request:
-    branches: [ master, develop, repovation ]
+    branches: [master, develop, repovation]
 
 jobs:
   slither:
-    name: Solidity code analysis
+    name: Slither
     runs-on: ubuntu-latest
 
     permissions:
@@ -17,18 +17,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-
-      - run: corepack enable
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: .nvmrc
-          cache: "yarn"
-
-      - name: Install dependencies
-        run: yarn install
+      - name: Common setup
+        uses: ./.github/workflows/setup
 
       # REVIEW: here and below steps taken from official guide
       # https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#caching-packages

.github/workflows/coverage.yml

@@ -2,31 +2,26 @@ name: Coverage
 
 on:
   push:
-    branches: [ master, develop, repovation ]
+    branches: [master, develop, repovation]
   pull_request:
-    branches: [ master, develop, repovation ]
+    branches: [master, develop, repovation]
 
 jobs:
   coverage:
-    name: Solidity coverage
+    name: Hardhat
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-
-      - run: corepack enable
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: .nvmrc
-          cache: "yarn"
+      - name: Common setup
+        uses: ./.github/workflows/setup
 
-      - name: Install dependencies
-        run: yarn install
+      # 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: Run Solidity coverage
+      - name: Collect coverage
         run: yarn test:coverage
 
       - name: Produce the coverage report
@@ -37,5 +32,5 @@ jobs:
           diff: true
           diff-branch: master
           diff-storage: _core_coverage_reports
-          coverage-summary-title: "Code Coverage Summary"
+          coverage-summary-title: "Hardhat Unit Tests Coverage Summary"
           togglable-report: true

.github/workflows/linters.yml

@@ -1,54 +1,46 @@
 name: Linters
 
-on: [ push ]
+on: [push]
 
 jobs:
-  lint:
-    name: Solidity and TypeScript linters
+  solhint:
+    name: Solhint
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
-        with:
-          persist-credentials: false
 
-      - run: corepack enable
+      - name: Common setup
+        uses: ./.github/workflows/setup
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: .nvmrc
-          cache: "yarn"
+      - name: Run solhint
+        run: yarn lint:sol
 
-      - name: Install dependencies
-        run: yarn install
+  eslint:
+    name: ESLint
+    runs-on: ubuntu-latest
 
-      - name: Run Solidity linters
-        run: yarn lint:sol
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Common setup
+        uses: ./.github/workflows/setup
 
-      - name: Run TS linters
+      - name: Run eslint
         run: yarn lint:ts
 
-  types:
-    name: TypeScript types check
+  typescript:
+    name: TypeScript
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-
-      - run: corepack enable
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: .nvmrc
-          cache: "yarn"
 
-      - name: Install dependencies
-        run: yarn install
+      - name: Common setup
+        uses: ./.github/workflows/setup
 
       - name: Generate typechain types
         run: yarn hardhat compile
 
-      - name: Run TypeScript types check
+      - name: Run typescript types check
         run: yarn typecheck

.github/workflows/setup/action.yml

@@ -0,0 +1,19 @@
+name: Common setup
+
+on: workflow_call
+
+runs:
+  using: "composite"
+  steps:
+    - name: Enable corepack
+      shell: bash
+      run: corepack enable
+
+    - uses: actions/setup-node@v4
+      with:
+        node-version-file: .nvmrc
+        cache: yarn
+
+    - name: Install dependencies
+      shell: bash
+      run: yarn install

.github/workflows/tests-integration.yml

@@ -0,0 +1,31 @@
+name: Integration Tests
+
+on: [push]
+
+jobs:
+  test_hardhat_integration:
+    name: Hardhat
+    runs-on: ubuntu-latest
+    timeout-minutes: 120
+
+    services:
+      hardhat-node:
+        image: feofanov/hardhat-node:2.22.4
+        ports:
+          - 8545:8545
+        env:
+          ETH_RPC_URL: "${{ secrets.ETH_RPC_URL }}"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Common setup
+        uses: ./.github/workflows/setup
+
+      - name: Set env
+        run: cp .env.example .env
+
+      - name: Run integration tests
+        run: yarn test:integration:fork
+        env:
+          LOG_LEVEL: debug

.github/workflows/tests-unit.yml

@@ -0,0 +1,37 @@
+name: Unit Tests
+
+on: [push]
+
+jobs:
+  test_hardhat_unit:
+    name: Hardhat
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Common setup
+        uses: ./.github/workflows/setup
+
+      - name: Run unit tests
+        run: yarn test
+
+  test_foundry_fuzzing:
+    name: Foundry (fuzzing & invariant)
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Common setup
+        uses: ./.github/workflows/setup
+
+      - name: Install foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        # Use a specific version of Foundry in case nightly is broken
+        # https://github.com/foundry-rs/foundry/releases
+        # with:
+        #   version: nightly-54d8510c0f2b0f791f4c5ef99866c6af99b7606a
+
+      - name: Run fuzzing and invariant tests
+        run: forge test -vvv