feat: introduce hardhat-deploy-config (#2755)

* feat: introduce hardhat-deploy-config

Creates a new package hardhat-deploy-config. We're using the same
configuration system for all of our contracts package, so might as well
turn it into a hardhat plugin to avoid duplicating code.

* feat(ct): use hardhat-deploy-config

* plugin: don't validate if spec not passed

* contracts: update deps

* contracts-bedrock: use deploy config plugin

* contracts-bedrock: deploy instructions

* contracts-bedrock: modularize deployment

* contracts-bedrock: add deploy-config

* contracts-bedrock: add in deploy config spec

* lint: fix
Co-authored-by: Mark Tyneway <mark.tyneway@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

.changeset/cyan-months-kneel.md

+---
+'@eth-optimism/contracts': patch
+---
+
+Use hardhat-deploy-config for deployments

.changeset/giant-cobras-heal.md

+---
+'@eth-optimism/hardhat-deploy-config': minor
+---
+
+Initial release of hardhat-deploy-config

ops/docker/Dockerfile.packages

@@ -24,6 +24,7 @@ COPY packages/contracts-bedrock/package.json ./packages/contracts-bedrock/packag
 COPY packages/contracts-periphery/package.json ./packages/contracts-periphery/package.json
 COPY packages/contracts-governance/package.json ./packages/contracts-governance/package.json
 COPY packages/data-transport-layer/package.json ./packages/data-transport-layer/package.json
+COPY packages/hardhat-deploy-config/package.json ./packages/hardhat-deploy-config/package.json
 COPY packages/message-relayer/package.json ./packages/message-relayer/package.json
 COPY packages/fault-detector/package.json ./packages/fault-detector/package.json
 COPY packages/replica-healthcheck/package.json ./packages/replica-healthcheck/package.json

packages/contracts-bedrock/README.md

@@ -43,3 +43,16 @@ To run only solidity tests:
 ```shell
 yarn test:forge
 ```
+
+## Deployment
+
+Create a file that corresponds to the network name in the `deploy-config`
+directory and then run the command:
+
+```shell
+npx hardhat deploy --network <network-name>
+```
+
+In the `hardhat.config.ts`, there is a `deployConfigSpec` field that validates that the types
+are correct, be sure to export an object in the `deploy-config/<network-name>.ts` file that
+has a key for each property in the `deployConfigSpec`.

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

+import { ethers } from 'ethers'
+
+const config = {
+  submissionInterval: 6,
+  l2BlockTime: 2,
+  genesisOutput: ethers.constants.HashZero,
+  historicalBlocks: 0,
+  startingBlockTimestamp:
+    parseInt(process.env.L2OO_STARTING_BLOCK_TIMESTAMP, 10) || Date.now(),
+  sequencerAddress: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
+}
+
+export default config

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

+import { ethers } from 'ethers'
+
+const config = {
+  submissionInterval: 6,
+  l2BlockTime: 2,
+  genesisOutput: ethers.constants.HashZero,
+  historicalBlocks: 0,
+  startingBlockTimestamp:
+    parseInt(process.env.L2OO_STARTING_BLOCK_TIMESTAMP, 10) || Date.now(),
+  sequencerAddress: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
+}
+
+export default config

packages/contracts-bedrock/deploy/000-L2OutputOracle.deploy.ts

@@ -7,23 +7,23 @@ const deployFn: DeployFunction = async (hre) => {
   const { deployer } = await hre.getNamedAccounts()
 
   if (
-    !process.env.L2OO_STARTING_BLOCK_TIMESTAMP ||
-    isNaN(Number(process.env.L2OO_STARTING_BLOCK_TIMESTAMP))
+    typeof hre.deployConfig.startingBlockTimestamp !== 'number' ||
+    isNaN(hre.deployConfig.startingBlockTimestamp)
   ) {
     throw new Error(
-      'Cannot deploy L2OutputOracle without specifying a valid L2OO_STARTING_BLOCK_TIMESTAMP.'
+      'Cannot deploy L2OutputOracle without specifying a valid startingBlockTimestamp.'
     )
   }
 
   await deploy('L2OutputOracle', {
     from: deployer,
     args: [
-      6, // submission interval
-      2, // l2 block time
-      `0x${'00'.repeat(32)}`, // genesis output
-      0, // historical blocks
-      process.env.L2OO_STARTING_BLOCK_TIMESTAMP,
-      '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // sequencer
+      hre.deployConfig.submissionInterval,
+      hre.deployConfig.l2BlockTime,
+      hre.deployConfig.genesisOutput,
+      hre.deployConfig.historicalBlocks,
+      hre.deployConfig.startingBlockTimestamp,
+      hre.deployConfig.sequencerAddress,
     ],
     log: true,
     waitConfirmations: 1,

packages/contracts-bedrock/hardhat.config.ts

+import { ethers } from 'ethers'
 import { HardhatUserConfig, task, subtask } from 'hardhat/config'
 import { TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS } from 'hardhat/builtin-tasks/task-names'
 import '@nomiclabs/hardhat-waffle'
@@ -5,6 +6,7 @@ import '@typechain/hardhat'
 import 'solidity-coverage'
 import 'hardhat-deploy'
 import '@foundry-rs/hardhat-forge'
+import '@eth-optimism/hardhat-deploy-config'
 
 import './tasks/deposits'
 
@@ -33,6 +35,11 @@ const config: HardhatUserConfig = {
       ],
     },
   },
+  paths: {
+    deploy: './deploy',
+    deployments: './deployments',
+    deployConfig: './deploy-config',
+  },
   typechain: {
     outDir: 'dist/types',
     target: 'ethers-v5',
@@ -42,6 +49,27 @@ const config: HardhatUserConfig = {
       default: 0,
     },
   },
+  deployConfigSpec: {
+    submissionInterval: {
+      type: 'number',
+    },
+    l2BlockTime: {
+      type: 'number',
+    },
+    genesisOutput: {
+      type: 'string',
+      default: ethers.constants.HashZero,
+    },
+    historicalBlocks: {
+      type: 'number',
+    },
+    startingBlockTimestamp: {
+      type: 'number',
+    },
+    sequencerAddress: {
+      type: 'address',
+    },
+  },
   solidity: {
     compilers: [
       {

packages/contracts-bedrock/package.json

@@ -42,6 +42,7 @@
   },
   "devDependencies": {
     "@foundry-rs/hardhat-forge": "^0.1.5",
+    "@eth-optimism/hardhat-deploy-config": "^0.1.0",
     "@nomiclabs/hardhat-ethers": "^2.0.0",
     "@nomiclabs/hardhat-etherscan": "^2.1.3",
     "@nomiclabs/hardhat-waffle": "^2.0.0",

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

-import { DeployConfig } from '../src/deploy-config'
-
-const config: DeployConfig = {
+const config = {
   l1BlockTimeSeconds: 15,
   l2BlockGasLimit: 15_000_000,
   l2ChainId: 421,

packages/contracts/deploy-config/goerli.ts

-import { DeployConfig } from '../src/deploy-config'
-
-const config: DeployConfig = {
+const config = {
   numDeployConfirmations: 1,
   l1BlockTimeSeconds: 15,
   l2BlockGasLimit: 15_000_000,

packages/contracts/deploy-config/hardhat.ts

+const config = {
+  l1BlockTimeSeconds: 15,
+  l2BlockGasLimit: 15_000_000,
+  l2ChainId: 17,
+  ctcL2GasDiscountDivisor: 32,
+  ctcEnqueueGasCost: 60_000,
+  sccFaultProofWindowSeconds: 0,
+  sccSequencerPublishWindowSeconds: 12592000,
+  ovmSequencerAddress: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+  ovmProposerAddress: '0x3c44cdddb6a900fa2b585dd299e03d12fa4293bc',
+  ovmBlockSignerAddress: '0x00000398232E2064F896018496b4b44b3D62751F',
+  ovmFeeWalletAddress: '0x391716d440c151c42cdf1c95c1d83a5427bca52c',
+  ovmAddressManagerOwner: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+  ovmGasPriceOracleOwner: '0x9965507d1a55bcc2695c58ba16fb37d819b0a4dc',
+}
+
+export default config

packages/contracts/deploy-config/kovan.ts

-import { DeployConfig } from '../src/deploy-config'
-
-const config: DeployConfig = {
+const config = {
   numDeployConfirmations: 1,
   gasPrice: 5_000_000_000,
   l1BlockTimeSeconds: 15,

packages/contracts/deploy-config/local.ts

-import { DeployConfig } from '../src/deploy-config'
-
-const config: DeployConfig = {
+const config = {
   l1BlockTimeSeconds: 15,
   l2BlockGasLimit: 15_000_000,
   l2ChainId: 17,

packages/contracts/deploy-config/mainnet.ts

-import { DeployConfig } from '../src/deploy-config'
-
-const config: DeployConfig = {
+const config = {
   numDeployConfirmations: 4,
   gasPrice: 150_000_000_000,
   l1BlockTimeSeconds: 15,

packages/contracts/deploy/000-hardhat-setup.ts

@@ -9,12 +9,10 @@ import {
   sendImpersonatedTx,
   BIG_BALANCE,
 } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
-  if (!deployConfig.isForkedNetwork) {
+  if (!hre.deployConfig.isForkedNetwork) {
     return
   }
 

packages/contracts/deploy/001-Lib_AddressManager.deploy.ts

@@ -2,20 +2,18 @@
 import { DeployFunction } from 'hardhat-deploy/dist/types'
 
 import { names } from '../src/address-names'
-import { getDeployConfig } from '../src/deploy-config'
 
 /* Imports: External */
 
 const deployFn: DeployFunction = async (hre) => {
   const { deploy } = hre.deployments
   const { deployer } = await hre.getNamedAccounts()
-  const deployConfig = getDeployConfig(hre.network.name)
 
   await deploy(names.unmanaged.Lib_AddressManager, {
     from: deployer,
     args: [],
     log: true,
-    waitConfirmations: deployConfig.numDeployConfirmations,
+    waitConfirmations: hre.deployConfig.numDeployConfirmations,
   })
 }
 

packages/contracts/deploy/004-OVM_CanonicalTransactionChain.deploy.ts

@@ -6,12 +6,9 @@ import {
   deployAndVerifyAndThen,
   getContractFromArtifact,
 } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
-
   const Lib_AddressManager = await getContractFromArtifact(
     hre,
     names.unmanaged.Lib_AddressManager
@@ -22,9 +19,9 @@ const deployFn: DeployFunction = async (hre) => {
     name: names.managed.contracts.CanonicalTransactionChain,
     args: [
       Lib_AddressManager.address,
-      deployConfig.l2BlockGasLimit,
-      deployConfig.ctcL2GasDiscountDivisor,
-      deployConfig.ctcEnqueueGasCost,
+      hre.deployConfig.l2BlockGasLimit,
+      hre.deployConfig.ctcL2GasDiscountDivisor,
+      hre.deployConfig.ctcEnqueueGasCost,
     ],
   })
 }

packages/contracts/deploy/005-OVM_StateCommitmentChain.deploy.ts

@@ -6,12 +6,9 @@ import {
   deployAndVerifyAndThen,
   getContractFromArtifact,
 } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
-
   const Lib_AddressManager = await getContractFromArtifact(
     hre,
     names.unmanaged.Lib_AddressManager
@@ -22,8 +19,8 @@ const deployFn: DeployFunction = async (hre) => {
     name: names.managed.contracts.StateCommitmentChain,
     args: [
       Lib_AddressManager.address,
-      deployConfig.sccFaultProofWindowSeconds,
-      deployConfig.sccSequencerPublishWindowSeconds,
+      hre.deployConfig.sccFaultProofWindowSeconds,
+      hre.deployConfig.sccSequencerPublishWindowSeconds,
     ],
   })
 }

packages/contracts/deploy/007-OVM_L1CrossDomainMessenger.deploy.ts

@@ -7,12 +7,9 @@ import {
   deployAndVerifyAndThen,
   getContractFromArtifact,
 } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
-
   const Lib_AddressManager = await getContractFromArtifact(
     hre,
     names.unmanaged.Lib_AddressManager
@@ -48,7 +45,7 @@ const deployFn: DeployFunction = async (hre) => {
       console.log(
         `Transferring ownership of L1CrossDomainMessenger (implementation)...`
       )
-      const owner = deployConfig.ovmAddressManagerOwner
+      const owner = hre.deployConfig.ovmAddressManagerOwner
       await contract.transferOwnership(owner)
 
       console.log(`Checking that contract owner was correctly set...`)

packages/contracts/deploy/010-AddressDictator.deploy.ts

@@ -7,13 +7,10 @@ import {
   deployAndVerifyAndThen,
   getContractFromArtifact,
 } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 import { predeploys } from '../src/predeploys'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
-
   const Lib_AddressManager = await getContractFromArtifact(
     hre,
     names.unmanaged.Lib_AddressManager
@@ -45,13 +42,13 @@ const deployFn: DeployFunction = async (hre) => {
     // CanonicalTransactionChain.
     {
       name: names.managed.accounts.OVM_Sequencer,
-      address: deployConfig.ovmSequencerAddress,
+      address: hre.deployConfig.ovmSequencerAddress,
     },
     // OVM_Proposer is the address allowed to submit state roots (transaction results) to the
     // StateCommitmentChain.
     {
       name: names.managed.accounts.OVM_Proposer,
-      address: deployConfig.ovmProposerAddress,
+      address: hre.deployConfig.ovmProposerAddress,
     },
   ]
 
@@ -72,7 +69,7 @@ const deployFn: DeployFunction = async (hre) => {
     name: names.unmanaged.AddressDictator,
     args: [
       Lib_AddressManager.address,
-      deployConfig.ovmAddressManagerOwner,
+      hre.deployConfig.ovmAddressManagerOwner,
       namesAndAddresses.map((pair) => {
         return pair.name
       }),

packages/contracts/deploy/012-initialize-Proxy__L1CrossDomainMessenger.ts

@@ -4,11 +4,9 @@ import { hexStringEquals, awaitCondition } from '@eth-optimism/core-utils'
 
 /* Imports: Internal */
 import { getContractFromArtifact } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
   const { deployer } = await hre.getNamedAccounts()
 
   // There's a risk that we could get front-run during a fresh deployment, which would brick this
@@ -45,7 +43,7 @@ const deployFn: DeployFunction = async (hre) => {
   )
 
   console.log(`Setting Proxy__OVM_L1CrossDomainMessenger owner...`)
-  const owner = deployConfig.ovmAddressManagerOwner
+  const owner = hre.deployConfig.ovmAddressManagerOwner
   await Proxy__OVM_L1CrossDomainMessenger.transferOwnership(owner)
 
   console.log(`Checking that the contract owner was correctly set...`)

packages/contracts/deploy/013-ChugSplashDictator.deploy.ts

@@ -9,12 +9,9 @@ import {
   getContractFromArtifact,
   deployAndVerifyAndThen,
 } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
-
   const Proxy__OVM_L1StandardBridge = await getContractFromArtifact(
     hre,
     'Proxy__OVM_L1StandardBridge'
@@ -34,7 +31,7 @@ const deployFn: DeployFunction = async (hre) => {
     name: names.unmanaged.ChugSplashDictator,
     args: [
       Proxy__OVM_L1StandardBridge.address,
-      deployConfig.ovmAddressManagerOwner,
+      hre.deployConfig.ovmAddressManagerOwner,
       ethers.utils.keccak256(bridgeCode),
       ethers.utils.hexZeroPad('0x00', 32),
       ethers.utils.hexZeroPad(Proxy__OVM_L1CrossDomainMessenger.address, 32),

packages/contracts/deploy/015-finalize.ts

@@ -4,10 +4,8 @@ import { hexStringEquals, awaitCondition } from '@eth-optimism/core-utils'
 
 /* Imports: Internal */
 import { getContractFromArtifact } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 
 const deployFn: DeployFunction = async (hre) => {
-  const deployConfig = getDeployConfig(hre.network.name)
   const { deployer } = await hre.getNamedAccounts()
 
   const Lib_AddressManager = await getContractFromArtifact(
@@ -18,7 +16,7 @@ const deployFn: DeployFunction = async (hre) => {
     }
   )
 
-  const owner = deployConfig.ovmAddressManagerOwner
+  const owner = hre.deployConfig.ovmAddressManagerOwner
   const remoteOwner = await Lib_AddressManager.owner()
   if (hexStringEquals(owner, remoteOwner)) {
     console.log(

packages/contracts/hardhat.config.ts

 import { HardhatUserConfig } from 'hardhat/types'
 import 'solidity-coverage'
 import * as dotenv from 'dotenv'
+import { ethers } from 'ethers'
 
 // Hardhat plugins
 import '@nomiclabs/hardhat-ethers'
@@ -11,6 +12,7 @@ import '@typechain/hardhat'
 import 'hardhat-deploy'
 import 'hardhat-gas-reporter'
 import 'hardhat-output-validator'
+import '@eth-optimism/hardhat-deploy-config'
 
 // Hardhat tasks
 import './tasks'
@@ -22,7 +24,7 @@ const enableGasReport = !!process.env.ENABLE_GAS_REPORT
 const privateKey = process.env.PRIVATE_KEY || '0x' + '11'.repeat(32) // this is to avoid hardhat error
 const deploy = process.env.DEPLOY_DIRECTORY || 'deploy'
 
-const config: HardhatUserConfig | any = {
+const config: HardhatUserConfig = {
   networks: {
     hardhat: {
       live: false,
@@ -99,6 +101,7 @@ const config: HardhatUserConfig | any = {
   paths: {
     deploy: './deploy',
     deployments: './deployments',
+    deployConfig: './deploy-config',
   },
   namedAccounts: {
     deployer: {
@@ -146,6 +149,87 @@ const config: HardhatUserConfig | any = {
     },
     exclude: ['contracts/test-helpers', 'contracts/test-libraries'],
   },
+  deployConfigSpec: {
+    isForkedNetwork: {
+      type: 'boolean',
+      default: false,
+    },
+    numDeployConfirmations: {
+      type: 'number',
+      default: 0,
+    },
+    gasPrice: {
+      type: 'number',
+      default: undefined,
+    },
+    l1BlockTimeSeconds: {
+      type: 'number',
+    },
+    l2BlockGasLimit: {
+      type: 'number',
+    },
+    l2ChainId: {
+      type: 'number',
+    },
+    ctcL2GasDiscountDivisor: {
+      type: 'number',
+    },
+    ctcEnqueueGasCost: {
+      type: 'number',
+    },
+    sccFaultProofWindowSeconds: {
+      type: 'number',
+    },
+    sccSequencerPublishWindowSeconds: {
+      type: 'number',
+    },
+    ovmSequencerAddress: {
+      type: 'address',
+    },
+    ovmProposerAddress: {
+      type: 'address',
+    },
+    ovmBlockSignerAddress: {
+      type: 'address',
+    },
+    ovmFeeWalletAddress: {
+      type: 'address',
+    },
+    ovmAddressManagerOwner: {
+      type: 'address',
+    },
+    ovmGasPriceOracleOwner: {
+      type: 'address',
+    },
+    ovmWhitelistOwner: {
+      type: 'address',
+      default: ethers.constants.AddressZero,
+    },
+    gasPriceOracleOverhead: {
+      type: 'number',
+      default: 2750,
+    },
+    gasPriceOracleScalar: {
+      type: 'number',
+      default: 1_500_000,
+    },
+    gasPriceOracleDecimals: {
+      type: 'number',
+      default: 6,
+    },
+    gasPriceOracleL1BaseFee: {
+      type: 'number',
+      default: 1,
+    },
+    gasPriceOracleL2GasPrice: {
+      type: 'number',
+      default: 1,
+    },
+    hfBerlinBlock: {
+      type: 'number',
+      default: 0,
+    },
+  },
 }
 
 if (

packages/contracts/package.json

@@ -64,6 +64,7 @@
   "devDependencies": {
     "@codechecks/client": "^0.1.11",
     "@defi-wonderland/smock": "^2.0.2",
+    "@eth-optimism/hardhat-deploy-config": "^0.1.0",
     "@ethersproject/abi": "^5.6.3",
     "@ethersproject/bytes": "^5.6.1",
     "@ethersproject/hardware-wallets": "^5.6.1",

packages/contracts/src/deploy-utils.ts

@@ -4,8 +4,6 @@ import { Signer } from '@ethersproject/abstract-signer'
 import { sleep, awaitCondition, getChainId } from '@eth-optimism/core-utils'
 import { HttpNetworkConfig } from 'hardhat/types'
 
-import { getDeployConfig } from './deploy-config'
-
 /**
  * @param  {Any} hre Hardhat runtime environment
  * @param  {String} name Contract name from the names object
@@ -32,14 +30,13 @@ export const deployAndVerifyAndThen = async ({
 }) => {
   const { deploy } = hre.deployments
   const { deployer } = await hre.getNamedAccounts()
-  const deployConfig = getDeployConfig(hre.network.name)
 
   const result = await deploy(name, {
     contract,
     from: deployer,
     args,
     log: true,
-    waitConfirmations: deployConfig.numDeployConfirmations,
+    waitConfirmations: hre.deployConfig.numDeployConfirmations,
   })
 
   await hre.ethers.provider.waitForTransaction(result.transactionHash)
@@ -94,8 +91,6 @@ export const getAdvancedContract = (opts: {
   hre: any
   contract: Contract
 }): Contract => {
-  const deployConfig = getDeployConfig(opts.hre.network.name)
-
   // Temporarily override Object.defineProperty to bypass ether's object protection.
   const def = Object.defineProperty
   Object.defineProperty = (obj, propName, prop) => {
@@ -119,7 +114,7 @@ export const getAdvancedContract = (opts: {
       // We want to use the gas price that has been configured at the beginning of the deployment.
       // However, if the function being triggered is a "constant" (static) function, then we don't
       // want to provide a gas price because we're prone to getting insufficient balance errors.
-      let gasPrice = deployConfig.gasPrice || undefined
+      let gasPrice = opts.hre.deployConfig.gasPrice || undefined
       if (contract.interface.getFunction(fnName).constant) {
         gasPrice = 0
       }
@@ -151,7 +146,7 @@ export const getAdvancedContract = (opts: {
             return contract[fnName](...args)
           }
         } else if (
-          receipt.confirmations >= deployConfig.numDeployConfirmations
+          receipt.confirmations >= opts.hre.deployConfig.numDeployConfirmations
         ) {
           return tx
         }
@@ -167,9 +162,7 @@ export const fundAccount = async (
   address: string,
   amount: ethers.BigNumber
 ) => {
-  const deployConfig = getDeployConfig(hre.network.name)
-
-  if (!deployConfig.isForkedNetwork) {
+  if (!hre.deployConfig.isForkedNetwork) {
     throw new Error('this method can only be used against a forked network')
   }
 
@@ -200,9 +193,7 @@ export const sendImpersonatedTx = async (opts: {
   gas: string
   args: any[]
 }) => {
-  const deployConfig = getDeployConfig(opts.hre.network.name)
-
-  if (!deployConfig.isForkedNetwork) {
+  if (!opts.hre.deployConfig.isForkedNetwork) {
     throw new Error('this method can only be used against a forked network')
   }
 

packages/contracts/tasks/take-dump.ts

@@ -10,7 +10,6 @@ import { remove0x } from '@eth-optimism/core-utils'
 
 import { predeploys } from '../src/predeploys'
 import { getContractFromArtifact } from '../src/deploy-utils'
-import { getDeployConfig } from '../src/deploy-config'
 import { names } from '../src/address-names'
 
 task('take-dump').setAction(async (args, hre) => {
@@ -30,13 +29,10 @@ task('take-dump').setAction(async (args, hre) => {
 
   /* eslint-enable @typescript-eslint/no-var-requires */
 
-  // Make sure we have a deploy config for this network
-  const deployConfig = getDeployConfig(hre.network.name)
-
   // Basic warning so users know that the whitelist will be disabled if the owner is the zero address.
   if (
-    deployConfig.ovmWhitelistOwner === undefined ||
-    deployConfig.ovmWhitelistOwner === ethers.constants.AddressZero
+    hre.deployConfig.ovmWhitelistOwner === undefined ||
+    hre.deployConfig.ovmWhitelistOwner === ethers.constants.AddressZero
   ) {
     console.log(
       'WARNING: whitelist owner is undefined or address(0), whitelist will be disabled'
@@ -45,15 +41,15 @@ task('take-dump').setAction(async (args, hre) => {
 
   const variables = {
     OVM_DeployerWhitelist: {
-      owner: deployConfig.ovmWhitelistOwner,
+      owner: hre.deployConfig.ovmWhitelistOwner,
     },
     OVM_GasPriceOracle: {
-      _owner: deployConfig.ovmGasPriceOracleOwner,
-      gasPrice: deployConfig.gasPriceOracleL2GasPrice,
-      l1BaseFee: deployConfig.gasPriceOracleL1BaseFee,
-      overhead: deployConfig.gasPriceOracleOverhead,
-      scalar: deployConfig.gasPriceOracleScalar,
-      decimals: deployConfig.gasPriceOracleDecimals,
+      _owner: hre.deployConfig.ovmGasPriceOracleOwner,
+      gasPrice: hre.deployConfig.gasPriceOracleL2GasPrice,
+      l1BaseFee: hre.deployConfig.gasPriceOracleL1BaseFee,
+      overhead: hre.deployConfig.gasPriceOracleOverhead,
+      scalar: hre.deployConfig.gasPriceOracleScalar,
+      decimals: hre.deployConfig.gasPriceOracleDecimals,
     },
     L2StandardBridge: {
       l1TokenBridge: (
@@ -65,7 +61,7 @@ task('take-dump').setAction(async (args, hre) => {
       messenger: predeploys.L2CrossDomainMessenger,
     },
     OVM_SequencerFeeVault: {
-      l1FeeWallet: deployConfig.ovmFeeWalletAddress,
+      l1FeeWallet: hre.deployConfig.ovmFeeWalletAddress,
     },
     OVM_ETH: {
       l2Bridge: predeploys.L2StandardBridge,
@@ -135,7 +131,7 @@ task('take-dump').setAction(async (args, hre) => {
   const genesis = {
     commit,
     config: {
-      chainId: deployConfig.l2ChainId,
+      chainId: hre.deployConfig.l2ChainId,
       homesteadBlock: 0,
       eip150Block: 0,
       eip155Block: 0,
@@ -145,18 +141,18 @@ task('take-dump').setAction(async (args, hre) => {
       petersburgBlock: 0,
       istanbulBlock: 0,
       muirGlacierBlock: 0,
-      berlinBlock: deployConfig.hfBerlinBlock,
+      berlinBlock: hre.deployConfig.hfBerlinBlock,
       clique: {
         period: 0,
         epoch: 30000,
       },
     },
     difficulty: '1',
-    gasLimit: deployConfig.l2BlockGasLimit.toString(10),
+    gasLimit: hre.deployConfig.l2BlockGasLimit.toString(10),
     extradata:
       '0x' +
       '00'.repeat(32) +
-      remove0x(deployConfig.ovmBlockSignerAddress) +
+      remove0x(hre.deployConfig.ovmBlockSignerAddress) +
       '00'.repeat(65),
     alloc: dump,
   }

packages/hardhat-deploy-config/.depcheckrc

+ignores: [
+  "@babel/eslint-parser",
+  "@typescript-eslint/parser",
+  "eslint-plugin-import",
+  "eslint-plugin-unicorn",
+  "eslint-plugin-jsdoc",
+  "eslint-plugin-prefer-arrow",
+  "eslint-plugin-react",
+  "@typescript-eslint/eslint-plugin",
+  "eslint-config-prettier",
+  "eslint-plugin-prettier",
+  "chai"
+]

packages/hardhat-deploy-config/.eslintrc.js

+module.exports = {
+  extends: '../../.eslintrc.js',
+}

packages/hardhat-deploy-config/.gitignore

+node_modules/
+build/

packages/hardhat-deploy-config/.lintstagedrc.yml

+"*.{ts,js}":
+  - eslint

packages/hardhat-deploy-config/.prettierrc.js

+module.exports = {
+  ...require('../../.prettierrc.js'),
+};

packages/hardhat-deploy-config/LICENSE

+(The MIT License)
+
+Copyright 2020-2021 Optimism
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/hardhat-deploy-config/README.md

+# @eth-optimism/hardhat-deploy-config
+
+`hardhat-deploy-config` is a simple plugin that adds support for global deploy configuration values.
+
+## Installation
+
+```
+yarn add @eth-optimism/hardhat-deploy-config
+```

packages/hardhat-deploy-config/package.json

+{
+  "name": "@eth-optimism/hardhat-deploy-config",
+  "version": "0.1.0",
+  "description": "[Optimism] Hardhat deploy configuration plugin",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist/*"
+  ],
+  "scripts": {
+    "test:coverage": "echo 'No tests defined.'",
+    "build": "tsc -p tsconfig.json",
+    "clean": "rimraf dist/ ./tsconfig.tsbuildinfo",
+    "lint": "yarn lint:fix && yarn lint:check",
+    "pre-commit": "lint-staged",
+    "lint:fix": "yarn lint:check --fix",
+    "lint:check": "eslint . --max-warnings=0"
+  },
+  "keywords": [
+    "optimism",
+    "ethereum",
+    "hardhat",
+    "deploy",
+    "config",
+    "plugin"
+  ],
+  "homepage": "https://github.com/ethereum-optimism/optimism/tree/develop/packages/hardhat-deploy-config#readme",
+  "license": "MIT",
+  "author": "Optimism PBC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethereum-optimism/optimism.git"
+  },
+  "devDependencies": {
+    "ethers": "^5.6.8",
+    "ts-node": "^10.7.0",
+    "hardhat": "^2.9.6"
+  }
+}

packages/hardhat-deploy-config/src/index.ts

+import './type-extensions'
+import './plugin'

packages/hardhat-deploy-config/src/plugin.ts

+import * as path from 'path'
+
+import { extendEnvironment, extendConfig } from 'hardhat/config'
+import {
+  HardhatConfig,
+  HardhatRuntimeEnvironment,
+  HardhatUserConfig,
+} from 'hardhat/types'
+import { ethers } from 'ethers'
+
+// From: https://github.com/wighawag/hardhat-deploy/blob/master/src/index.ts#L63-L76
+const normalizePath = (
+  config: HardhatConfig,
+  userPath: string | undefined,
+  defaultPath: string
+): string => {
+  if (userPath === undefined) {
+    userPath = path.join(config.paths.root, defaultPath)
+  } else {
+    if (!path.isAbsolute(userPath)) {
+      userPath = path.normalize(path.join(config.paths.root, userPath))
+    }
+  }
+  return userPath
+}
+
+export const loadDeployConfig = (hre: HardhatRuntimeEnvironment): any => {
+  let config: any
+  try {
+    config =
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      require(`${hre.config.paths.deployConfig}/${hre.network.name}.ts`).default
+  } catch (err) {
+    throw new Error(
+      `error while loading deploy config for network: ${hre.network.name}, ${err}`
+    )
+  }
+
+  return new Proxy(parseDeployConfig(hre, config), {
+    get: (target, prop) => {
+      if (target.hasOwnProperty(prop)) {
+        return target[prop]
+      }
+
+      // Explicitly throw if the property is not found since I can't yet figure out a good way to
+      // handle the necessary typings.
+      throw new Error(
+        `property does not exist in deploy config: ${String(prop)}`
+      )
+    },
+  })
+}
+
+export const parseDeployConfig = (
+  hre: HardhatRuntimeEnvironment,
+  config: any
+): any => {
+  // Create a clone of the config object. Shallow clone is fine because none of the input options
+  // are expected to be objects or functions etc.
+  const parsed = { ...config }
+
+  // If the deployConfigSpec is not provided, do no validation
+  if (!hre.config.deployConfigSpec) {
+    return parsed
+  }
+
+  for (const [key, spec] of Object.entries(hre.config.deployConfigSpec)) {
+    // Make sure the value is defined, or use a default.
+    if (parsed[key] === undefined) {
+      if ('default' in spec) {
+        parsed[key] = spec.default
+      } else {
+        throw new Error(
+          `deploy config is missing required field: ${key} (${spec.type})`
+        )
+      }
+    } else {
+      // Make sure the default has the correct type.
+      if (spec.type === 'address') {
+        if (!ethers.utils.isAddress(parsed[key])) {
+          throw new Error(
+            `deploy config field: ${key} is not of type ${spec.type}: ${parsed[key]}`
+          )
+        }
+      } else if (typeof parsed[key] !== spec.type) {
+        throw new Error(
+          `deploy config field: ${key} is not of type ${spec.type}: ${parsed[key]}`
+        )
+      }
+    }
+  }
+
+  return parsed
+}
+
+extendConfig(
+  (config: HardhatConfig, userConfig: Readonly<HardhatUserConfig>) => {
+    config.paths.deployConfig = normalizePath(
+      config,
+      userConfig.paths.deployConfig,
+      'deploy-config'
+    )
+  }
+)
+
+extendEnvironment((hre) => {
+  hre.deployConfig = loadDeployConfig(hre)
+})

packages/hardhat-deploy-config/src/type-extensions.ts

+import 'hardhat/types/runtime'
+import 'hardhat/types/config'
+
+interface DeployConfigSpec {
+  [key: string]: {
+    type: 'address' | 'number' | 'string' | 'boolean'
+    default?: any
+  }
+}
+
+declare module 'hardhat/types/config' {
+  interface HardhatUserConfig {
+    deployConfigSpec?: DeployConfigSpec
+  }
+
+  interface HardhatConfig {
+    deployConfigSpec?: DeployConfigSpec
+  }
+
+  interface ProjectPathsUserConfig {
+    deployConfig?: string
+  }
+
+  interface ProjectPathsConfig {
+    deployConfig?: string
+  }
+}
+
+declare module 'hardhat/types/runtime' {
+  interface HardhatRuntimeEnvironment {
+    deployConfig: {
+      // TODO: Is there any good way to type this?
+      [key: string]: any
+    }
+  }
+}

packages/hardhat-deploy-config/tsconfig.json

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