Shapella upgrade (capella+shanghai)

.editorconfig

@@ -0,0 +1,12 @@
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.{js,yml}]
+indent_size = 2

.eslintrc

@@ -3,13 +3,8 @@
     "node": true,
     "es2020": true
   },
-    "extends": [
-    "standard",
-    "plugin:prettier/recommended",
-    "prettier",
-    "prettier/standard"
-  ],
-"parser": "babel-eslint",
+  "extends": ["standard", "plugin:prettier/recommended", "prettier", "prettier/standard"],
+  "parser": "babel-eslint",
   "parserOptions": {
     "ecmaVersion": 8,
     "sourceType": "module",
@@ -18,11 +13,7 @@
       "modules": true
     }
   },
-    "plugins": [
-    "node",
-    "prettier",
-    "standard"
-  ],
+  "plugins": ["node", "prettier", "standard"],
 
   "rules": {
     "prettier/prettier": "error",
@@ -37,16 +28,11 @@
     "quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": true }],
     "jsx-quotes": ["error", "prefer-single"],
     "no-useless-escape": "off",
-    "valid-jsdoc": "error",
     "linebreak-style": ["error", "unix"]
   },
   "overrides": [
     {
-      "files": [
-        "./scripts/{**/,}*.js",
-        "./test/{**/,}*.js",
-        "./e2e/test/{**/,}*.js"
-      ],
+      "files": ["./scripts/{**/,}*.js", "./test/{**/,}*.js", "./e2e/test/{**/,}*.js"],
       "env": {
         "mocha": true
       },

.github/deployed-bytecode-consts.js

@@ -1,14 +1,13 @@
 const APPS_TO_NAMES = new Map([
   ['lido', 'Lido'],
   ['node-operators-registry', 'NodeOperatorsRegistry'],
-  ['oracle', 'LidoOracle']
 ])
 
 const CONTRACTS_TO_NAMES = new Map([
   ['wstethContract', 'WstETH'],
   ['executionLayerRewardsVault', 'LidoExecutionLayerRewardsVault'],
   ['compositePostRebaseBeaconReceiver', 'CompositePostRebaseBeaconReceiver'],
-  ['selfOwnedStETHBurner', 'SelfOwnedStETHBurner'],
+  ['burner', 'Burner'],
   ['depositor', 'DepositSecurityModule']
 ])
 

.github/workflows/linters.yml

@@ -47,7 +47,7 @@ jobs:
         run: yarn test:unit
 
       - name: Run Solidity linters
-        run: yarn lint:sol:solhint
+        run: yarn lint:sol
 
       - name: Run JS linters
         run: yarn lint:js

.gitignore

@@ -3,6 +3,7 @@
 **/build/
 **/node_modules/
 **/artifacts/
+**/artifacts-userdoc/
 .cache
 **/cache/
 dist/
@@ -39,3 +40,6 @@ cli/vendor
 /accounts.json
 # e2e temp data
 /deployed-e2e.json
+
+# OS relative
+.DS_Store

.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn compile
+yarn lint:sol
+
+# TODO: uncomment. it's temporarily disabled on staking_router + withdrawals-poc merge
+# yarn lint:js:fix

.mocharc.json

@@ -0,0 +1,4 @@
+{
+  "require": "hardhat/register",
+  "timeout": 40000
+}

.prettierrc

@@ -4,5 +4,17 @@
   "trailingComma": "none",
   "bracketSpacing": true,
   "jsxBracketSameLine": false,
-  "printWidth": 140
+  "printWidth": 120,
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    }
+  ]
 }

.solcover.js

@@ -1,5 +1,6 @@
 module.exports = {
-  skipFiles: ['template', 'test_helpers', 'oracle/test_helpers', 'nos/test_helpers', 'mocks'],
+  // todo: add support for '**/test_helpers' globs
+  skipFiles: ['0.4.24/template', '0.4.24/test_helpers', '0.4.24/nos/test_helpers', '0.6.12/mocks', '0.8.9/test_helpers'],
   mocha: {
     enableTimeouts: false
   }

.solhint.json

@@ -1,15 +1,17 @@
 {
   "extends": "solhint:recommended",
-  "plugins": [
-    "lido"
-  ],
+  "plugins": ["lido"],
   "rules": {
+    "not-rely-on-time": "off",
     "no-inline-assembly": "off",
     "var-name-mixedcase": "off",
     "compiler-version": "off",
     "reason-string": "off",
     "no-empty-blocks": "off",
     "func-name-mixedcase": "off",
-    "lido/fixed-compiler-version": "error"
+    "lido/fixed-compiler-version": "error",
+    "visibility-modifier-order": "error",
+    "no-unused-vars": "error",
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
   }
 }

.storage-layout

@@ -51,7 +51,7 @@
 |------|------|------|--------|-------|----------|
 
 =======================
-➡ LidoOracle
+➡ LegacyOracle
 =======================
 
 | Name | Type | Slot | Offset | Bytes | Contract |
@@ -80,16 +80,16 @@
 |------|------|------|--------|-------|----------|
 
 =======================
-➡ SelfOwnedStETHBurner
+➡ Burner
 =======================
 
 | Name                           | Type    | Slot | Offset | Bytes | Contract                                                      |
 |--------------------------------|---------|------|--------|-------|---------------------------------------------------------------|
-| coverSharesBurnRequested       | uint256 | 0    | 0      | 32    | contracts/0.8.9/SelfOwnedStETHBurner.sol:SelfOwnedStETHBurner |
-| nonCoverSharesBurnRequested    | uint256 | 1    | 0      | 32    | contracts/0.8.9/SelfOwnedStETHBurner.sol:SelfOwnedStETHBurner |
-| totalCoverSharesBurnt          | uint256 | 2    | 0      | 32    | contracts/0.8.9/SelfOwnedStETHBurner.sol:SelfOwnedStETHBurner |
-| totalNonCoverSharesBurnt       | uint256 | 3    | 0      | 32    | contracts/0.8.9/SelfOwnedStETHBurner.sol:SelfOwnedStETHBurner |
-| maxBurnAmountPerRunBasisPoints | uint256 | 4    | 0      | 32    | contracts/0.8.9/SelfOwnedStETHBurner.sol:SelfOwnedStETHBurner |
+| coverSharesBurnRequested       | uint256 | 0    | 0      | 32    | contracts/0.8.9/Burner.sol:Burner |
+| nonCoverSharesBurnRequested    | uint256 | 1    | 0      | 32    | contracts/0.8.9/Burner.sol:Burner |
+| totalCoverSharesBurnt          | uint256 | 2    | 0      | 32    | contracts/0.8.9/Burner.sol:Burner |
+| totalNonCoverSharesBurnt       | uint256 | 3    | 0      | 32    | contracts/0.8.9/Burner.sol:Burner |
+| maxBurnAmountPerRunBasisPoints | uint256 | 4    | 0      | 32    | contracts/0.8.9/Burner.sol:Burner |
 
 =======================
 ➡ StETH

SCRATCH_DEPLOY.md

@@ -56,8 +56,7 @@ Steps for deploy:
 * [ ] deploy LidoExecutionLayerRewardsVault
 * [ ] finalize DAO setup (via Lido Template)
 * [ ] deploy CompositePostRebaseBeaconReceiver
-* [ ] deploy SelfOwnedStETHBurner
-* [ ] do Aragon voting to attach CompositePostRebaseBeaconReceiver and SelfOwnedStETHBurner to the protocol
+* [ ] deploy Burner
 * [ ] make final deployed DAO check via script
 * [ ] open and check Lido DAO web interface (via Aragon client)
 
@@ -81,6 +80,3 @@ const rootCid = await uploadDirToIpfs({ dirPath: distPath, ipfsApiUrl: ipfsAPI }
 It appeared that `@aragon/buidler-aragon@npm:^0.2.9` uses `ipfs-http-client`.
 
 `ipfs-http-client` has a brittle API. Neither `41.0.0` nor `50.0.0` versions of it will work with `@aragon/buidler-aragon@npm:^0.2.9`.
-
-## Default Aragon voting time
-To attach SelfOwnedStETHBurner to the protocol a DAO voting is needed. To do it reasonably fast on the protocol deployment the default Aragon voting duration time (see `deployed-local-defaults.json`) is set to seconds. Draft script for changing Aragon voting time is at `scripts/multisig/32-change-voting-time.js`.