feat: fix code review comments

Author: sandstone-ag

.env.example

@@ -60,7 +60,9 @@ GAS_PRIORITY_FEE=1
 GAS_MAX_FEE=100
 
 # Dual Governance deployment
-DG_DEPLOYER_ACCOUNT_NAME=
+DG_DEPLOYMENT_ENABLED=true
+DG_DEPLOYER_ACCOUNT_NETWORK_NAME=
+DG_ETHERSCAN_VERIFY=false
 
 # Etherscan API key for verifying contracts
 ETHERSCAN_API_KEY=

.gitignore

@@ -18,6 +18,9 @@ artifacts/
 foundry/cache/
 foundry/out/
 
+# Dual Governance files
+dg/
+
 # Extracted ABI files
 lib/abi/*.json
 

lib/dg-installation.ts

@@ -2,79 +2,25 @@ import child_process from "node:child_process";
 import fs from "node:fs/promises";
 import util from "node:util";
 
-async function main() {
-  const dgDir = `${process.cwd()}/node_modules/@lido/dual-governance`;
-  const gitmodulesPath = `${dgDir}/.gitmodules`;
-
-  const gitmodulesExists = await checkFileExists(gitmodulesPath);
-  if (!gitmodulesExists) {
-    console.log(`.gitmodules file not found at ${gitmodulesPath}`);
-    return;
-  }
-
-  console.log(`.gitmodules file found at ${gitmodulesPath}`);
-
-  const gitmodulesFile = (await fs.readFile(gitmodulesPath)).toString().replaceAll(/\t/g, "");
+const DG_REPOSITORY_URL = "https://github.com/lidofinance/dual-governance.git";
+const DG_REPOSITORY_BRANCH = "feature/scratch-deploy-support"; // TODO: use release branch
+const DG_INSTALL_DIR = `${process.cwd()}/dg`;
 
-  const submodules = parseGitmodules(gitmodulesFile);
-  console.log(submodules);
-
-  await fs.rm(`${dgDir}/lib`, { force: true, recursive: true });
+async function main() {
+  console.log("Delete DG folder", DG_INSTALL_DIR);
+  await fs.rm(DG_INSTALL_DIR, { force: true, recursive: true });
 
-  await cloneSubmodules(submodules);
+  console.log("Clone DG repo to", DG_INSTALL_DIR);
+  await runCommand(
+    `git clone --branch ${DG_REPOSITORY_BRANCH} --single-branch ${DG_REPOSITORY_URL} ${DG_INSTALL_DIR}`,
+    process.cwd(),
+  );
 
   console.log("Building DualGovernance contracts");
-  await runForgeBuild(dgDir);
+  await runForgeBuild(DG_INSTALL_DIR);
 
   console.log("Running unit tests");
-  await runUnitTests(dgDir);
-}
-
-type GitSubmodule = {
-  path: string;
-  url: string;
-  branch?: string;
-};
-
-/**
- * @param {String} gitmodulesFile .gitmodules file content
- */
-function parseGitmodules(gitmodulesFile: string) {
-  const submoduleSectionRe = /\[submodule(\s+)('|")(.+)('|")\]([^\[]+)/gm;
-  const submodulePropertyRe = /(path)(.+)|(url)(.+)|(branch)(.+)/g;
-  const submodulesList = [...gitmodulesFile.matchAll(submoduleSectionRe)];
-  const result: Record<string, GitSubmodule> = {};
-
-  if (!submodulesList.length) {
-    return result;
-  }
-
-  submodulesList.forEach((submoduleText) => {
-    const item: GitSubmodule = {
-      path: "",
-      url: ""
-    };
-    const submodulePropertiesList = [...(submoduleText[5] || "").matchAll(submodulePropertyRe)];
-    submodulePropertiesList.forEach((conf) => {
-      const [key = "", value = ""] = (conf[0] ?? "").split("=");
-      const pureKey = key.trim() as "path" | "url" | "branch";
-      if (pureKey) {
-        item[pureKey] = value.trim();
-      }
-    });
-    result[item.path] = item;
-  })
-  return result;
-}
-
-async function cloneSubmodules(submodules: Record<string, GitSubmodule>) {
-  for (const key of Object.keys(submodules)) {
-    let branch = submodules[key].branch || "";
-    if (branch.length && branch.indexOf("tag") != -1) {
-      branch = branch.replace("tags/", "");
-    }
-    await runCommand(`git clone ${branch.length ? `--branch ${branch}` : ""} --single-branch ${submodules[key].url} ${process.cwd()}/node_modules/@lido/dual-governance/${submodules[key].path}`, process.cwd());
-  }
+  await runUnitTests(DG_INSTALL_DIR);
 }
 
 async function runForgeBuild(workingDirectory: string) {
@@ -97,12 +43,6 @@ async function runCommand(command: string, workingDirectory: string) {
   }
 }
 
-async function checkFileExists(path: string) {
-  return fs.access(path)
-    .then(() => true)
-    .catch(() => false);
-}
-
 main()
   .then(() => process.exit(0))
   .catch((error) => {

lib/state-file.ts

@@ -86,6 +86,15 @@ export enum Sk {
   chainSpec = "chainSpec",
   scratchDeployGasUsed = "scratchDeployGasUsed",
   minFirstAllocationStrategy = "minFirstAllocationStrategy",
+  dualGovernanceConfig = "dualGovernanceConfig",
+  dgAdminExecutor = "dg:admin_executor",
+  dualGovernance = "dg:dual_governance",
+  dgConfigProvider = "dg:dual_governance_config_provider",
+  dgEmergencyGovernance = "dg:emergency_governance",
+  dgEscrowMasterCopy = "dg:escrow_master_copy",
+  dgResealManager = "dg:reseal_manager",
+  dgTiebreakerCoreCommittee = "dg:tiebreaker_core_committee",
+  dgTimelock = "dg:timelock",
 }
 
 export function getAddress(contractKey: Sk, state: DeploymentState): string {
@@ -130,6 +139,14 @@ export function getAddress(contractKey: Sk, state: DeploymentState): string {
     case Sk.oracleReportSanityChecker:
     case Sk.wstETH:
     case Sk.depositContract:
+    case Sk.dgAdminExecutor:
+    case Sk.dualGovernance:
+    case Sk.dgConfigProvider:
+    case Sk.dgEmergencyGovernance:
+    case Sk.dgEscrowMasterCopy:
+    case Sk.dgResealManager:
+    case Sk.dgTiebreakerCoreCommittee:
+    case Sk.dgTimelock:
       return state[contractKey].address;
     default:
       throw new Error(`Unsupported contract entry key ${contractKey}`);

package.json

@@ -31,9 +31,9 @@
     "test:integration:fork:local": "MODE=scratch hardhat test test/integration/**/*.ts --network local",
     "test:integration:fork:mainnet": "MODE=forking hardhat test test/integration/**/*.ts --network mainnet-fork",
     "test:integration:fork:mainnet:custom": "MODE=forking hardhat test --network mainnet-fork",
+    "dg:install": "yarn ts-node lib/dg-installation.ts",
     "typecheck": "tsc --noEmit",
     "prepare": "husky",
-    "postinstall": "yarn ts-node lib/dg-installation.ts",
     "abis:extract": "hardhat abis:extract",
     "verify:deployed": "hardhat verify:deployed"
   },
@@ -107,7 +107,6 @@
     "@aragon/id": "2.1.1",
     "@aragon/minime": "1.0.0",
     "@aragon/os": "4.4.0",
-    "@lido/dual-governance": "https://github.com/lidofinance/dual-governance.git#feature/scratch-deploy-support",
     "@openzeppelin/contracts": "3.4.0",
     "@openzeppelin/contracts-v4.4": "npm:@openzeppelin/[email protected]",
     "openzeppelin-solidity": "2.0.0"

scripts/dao-deploy.sh

@@ -18,6 +18,8 @@ echo "NETWORK is $NETWORK"
 rm -f "${NETWORK_STATE_FILE}"
 cp "${NETWORK_STATE_DEFAULTS_FILE}" "${NETWORK_STATE_FILE}"
 
+yarn dg:install
+
 # Compile contracts
 yarn compile
 

scripts/dao-upgrade.sh

@@ -15,6 +15,8 @@ if [[ -z "${NETWORK}" ]]; then
 fi
 echo "NETWORK is $NETWORK"
 
+yarn dg:install
+
 # Compile contracts
 yarn compile
 

scripts/scratch/deployed-testnet-defaults.json

@@ -149,5 +149,49 @@
       "symbol": "unstETH",
       "baseUri": null
     }
+  },
+  "dualGovernanceConfig": {
+    "dual_governance": {
+      "tiebreaker_activation_timeout": 31536000,
+      "sanity_check_params": {
+        "max_min_assets_lock_duration": 4147200,
+        "max_sealable_withdrawal_blockers_count": 255,
+        "max_tiebreaker_activation_timeout": 63072000,
+        "min_tiebreaker_activation_timeout": 15768000,
+        "min_withdrawals_batch_size": 4
+      }
+    },
+    "dual_governance_config_provider": {
+      "first_seal_rage_quit_support": "10000000000000000",
+      "second_seal_rage_quit_support": "100000000000000000",
+      "min_assets_lock_duration": 18000,
+      "rage_quit_eth_withdrawals_delay_growth": 1296000,
+      "rage_quit_eth_withdrawals_min_delay": 5184000,
+      "rage_quit_eth_withdrawals_max_delay": 15552000,
+      "rage_quit_extension_period_duration": 604800,
+      "veto_cooldown_duration": 18000,
+      "veto_signalling_deactivation_max_duration": 259200,
+      "veto_signalling_min_active_duration": 18000,
+      "veto_signalling_min_duration": 432000,
+      "veto_signalling_max_duration": 3888000
+    },
+    "timelock": {
+      "after_submit_delay": 259200,
+      "after_schedule_delay": 86400,
+      "sanity_check_params": {
+        "min_execution_delay": 259200,
+        "max_after_submit_delay": 2592000,
+        "max_after_schedule_delay": 864000,
+        "max_emergency_mode_duration": 31536000,
+        "max_emergency_protection_duration": 94608000
+      },
+      "emergency_protection": {
+        "emergency_mode_duration": 2592000,
+        "emergency_protection_end_date": 1781913600
+      }
+    },
+    "tiebreaker": {
+      "execution_delay": 2592000
+    }
   }
 }