Merge pull request #4300 from ethereum-optimism/sc/ctb-cfg-ts

feat(ctb): type safety for deploy config

integration-tests/package.json

@@ -43,8 +43,8 @@
     "@types/chai-as-promised": "^7.1.4",
     "@types/mocha": "^8.2.2",
     "@types/rimraf": "^3.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.26.0",
-    "@typescript-eslint/parser": "^4.26.0",
+    "@typescript-eslint/eslint-plugin": "^5.45.1",
+    "@typescript-eslint/parser": "^5.45.1",
     "@uniswap/v3-core": "1.0.0",
     "@uniswap/v3-periphery": "^1.0.1",
     "@uniswap/v3-sdk": "^3.6.2",

package.json

@@ -60,8 +60,8 @@
     "@types/chai-as-promised": "^7.1.4",
     "@types/mocha": "^8.2.2",
     "@types/node": "^12.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^4.26.0",
+    "@typescript-eslint/eslint-plugin": "^5.45.1",
+    "@typescript-eslint/parser": "^5.45.1",
     "chai": "^4.2.0",
     "copyfiles": "^2.3.0",
     "depcheck": "^1.4.3",
@@ -86,7 +86,7 @@
     "mocha": "^8.4.0",
     "nyc": "^15.1.0",
     "patch-package": "^6.4.7",
-    "prettier": "^2.3.1",
+    "prettier": "^2.8.0",
     "prettier-plugin-solidity": "^1.0.0-beta.13",
     "ts-mocha": "^10.0.0",
     "typescript": "^4.9.3"

packages/contracts-bedrock/deploy-config/devnetL1.ts

+import { DeployConfig } from '../src/deploy-config'
+import config from './devnetL1.json'
+
+export default config satisfies DeployConfig

packages/contracts-bedrock/deploy-config/goerli-forked.ts

+import { DeployConfig } from '../src/deploy-config'
+import config from './goerli-forked.json'
+
+export default config satisfies DeployConfig

packages/contracts-bedrock/deploy-config/goerli.ts

+import { DeployConfig } from '../src/deploy-config'
+import config from './goerli.json'
+
+export default config satisfies DeployConfig

packages/contracts-bedrock/deploy-config/hardhat.ts

+import { DeployConfig } from '../src/deploy-config'
+import config from './hardhat.json'
+
+export default config satisfies DeployConfig

packages/contracts-bedrock/deploy-config/hivenet.json

-{}

packages/contracts-bedrock/package.json

@@ -19,7 +19,7 @@
     "build:differential": "tsc scripts/differential-testing.ts --outDir dist --moduleResolution node --esModuleInterop",
     "prebuild": "yarn ts-node scripts/verify-foundry-install.ts",
     "build": "hardhat compile && yarn autogen:artifacts && yarn build:ts && yarn typechain",
-    "build:ts": "tsc -p tsconfig.json",
+    "build:ts": "tsc -p tsconfig.build.json",
     "autogen:artifacts": "ts-node scripts/generate-artifacts.ts",
     "deploy": "hardhat deploy",
     "test": "yarn build:differential && forge test",
@@ -66,8 +66,8 @@
     "@nomiclabs/hardhat-waffle": "^2.0.0",
     "@rari-capital/solmate": "https://github.com/rari-capital/solmate.git#8f9b23f8838670afda0fd8983f2c41e8037ae6bc",
     "@typechain/ethers-v5": "^10.1.0",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^4.29.1",
+    "@typescript-eslint/eslint-plugin": "^5.45.1",
+    "@typescript-eslint/parser": "^5.45.1",
     "bip39": "^3.0.4",
     "chai": "^4.2.0",
     "command-exists": "1.2.9",

packages/contracts-bedrock/src/deploy-config.ts

@@ -7,19 +7,19 @@ interface RequiredDeployConfig {
   /**
    * Number of confirmations to wait when deploying contracts.
    */
-  numDeployConfirmations: number
+  numDeployConfirmations?: number
 
   /**
    * Address that will own the entire system on L1 when the deploy is complete.
    */
-  finalSystemOwner: string
+  finalSystemOwner?: string
 
   /**
    * Address that will own the entire system on L1 during the deployment process. This address will
    * not own the system after the deployment is complete, ownership will be transferred to the
    * final system owner.
    */
-  controller: string
+  controller?: string
 
   /**
    * The L2 genesis script uses this to fill the storage of the L1Block info predeploy. The rollup
@@ -84,12 +84,12 @@ interface RequiredDeployConfig {
   /**
    * Starting block number for the output oracle.
    */
-  l2OutputOracleStartingBlockNumber: number
+  l2OutputOracleStartingBlockNumber?: number
 
   /**
    * Starting timestamp for the output oracle.
    */
-  l2OutputOracleStartingTimestamp: number
+  l2OutputOracleStartingTimestamp?: number
 
   /**
    * Address of the L2 output oracle proposer.

packages/contracts-bedrock/tsconfig.build.json

+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"]
+}

packages/contracts-bedrock/tsconfig.json

 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "rootDir": "./src",
     "outDir": "./dist"
   },
-  "include": ["src/**/*"]
+  "include": [
+    "src/**/*",
+    "deploy-config/**/*",
+    "deploy-config/**/*.json",
+    "tasks/**/*",
+    "scripts/**/*"
+  ]
 }

packages/contracts-governance/package.json

@@ -52,7 +52,7 @@
     "ethereum-waffle": "^3.4.0",
     "hardhat-gas-reporter": "^1.0.7",
     "hardhat-deploy": "^0.11.4",
-    "prettier": "^2.3.1",
+    "prettier": "^2.8.0",
     "prettier-plugin-solidity": "^1.0.0-beta.18",
     "solhint": "^3.3.6",
     "solidity-coverage": "^0.7.19",

packages/contracts-periphery/package.json

@@ -86,7 +86,7 @@
     "mocha": "^10.0.0",
     "mkdirp": "^1.0.4",
     "node-fetch": "^2.6.7",
-    "prettier": "^2.3.1",
+    "prettier": "^2.8.0",
     "prettier-plugin-solidity": "^1.0.0-beta.18",
     "solhint": "^3.3.6",
     "solhint-plugin-prettier": "^0.0.5",

packages/contracts/package.json

@@ -101,7 +101,7 @@
     "merkletreejs": "^0.2.18",
     "mkdirp": "^1.0.4",
     "mocha": "^8.4.0",
-    "prettier": "^2.3.1",
+    "prettier": "^2.8.0",
     "prettier-plugin-solidity": "^1.0.0-beta.18",
     "random-bytes-seed": "^1.0.3",
     "rlp": "^2.2.6",

packages/data-transport-layer/package.json

@@ -63,7 +63,7 @@
     "hardhat": "^2.9.6",
     "mocha": "^8.4.0",
     "pino-pretty": "^4.7.1",
-    "prettier": "^2.3.1",
+    "prettier": "^2.8.0",
     "prom-client": "^13.1.0",
     "rimraf": "^3.0.2",
     "ts-node": "^10.9.1"