feat[contracts]: slightly better account funding for hardhat accounts (rebased) (#1065)

* feat[contracts]: better account funding for hardhat accounts

* add a sleep to avoid any potential problems

* chore: add changeset

* fix: bug with gas estimation in funding step

* fix: limit to 20 accounts max
Co-authored-by: Kelvin Fichter <kelvinfichter@gmail.com>

.changeset/poor-owls-wash.md

+---
+'@eth-optimism/contracts': patch
+---
+
+Adds a temporary way to fund hardhat accounts when testing locally

packages/contracts/deploy/014-OVM_L1MultiMessageRelayer.deploy.ts

@@ -30,7 +30,7 @@ const deployFn: DeployFunction = async (hre) => {
     await registerAddress({
       hre,
       name: 'OVM_L2MessageRelayer',
-      address: OVM_L1MultiMessageRelayer.address
+      address: OVM_L1MultiMessageRelayer.address,
     })
   }
 }

packages/contracts/deploy/018-fund-accounts.ts

+/* Imports: External */
+import { sleep } from '@eth-optimism/core-utils'
+import { DeployFunction } from 'hardhat-deploy/dist/types'
+import {
+  defaultHardhatNetworkHdAccountsConfigParams,
+  defaultHardhatNetworkParams,
+} from 'hardhat/internal/core/config/default-config'
+import { normalizeHardhatNetworkAccountsConfig } from 'hardhat/internal/core/providers/util'
+
+/* Imports: Internal */
+import { getDeployedContract } from '../src/hardhat-deploy-ethers'
+
+// This is a TEMPORARY way to fund the default hardhat accounts on L2. The better way to do this is
+// to make a modification to hardhat-ovm. However, I don't have the time right now to figure the
+// details of how to make that work cleanly. This is fine in the meantime.
+const deployFn: DeployFunction = async (hre) => {
+  // Only execute this step if we're on the hardhat chain ID.
+  const { chainId } = await hre.ethers.provider.getNetwork()
+  if (chainId === defaultHardhatNetworkParams.chainId) {
+    const Proxy__OVM_L1ETHGateway = await getDeployedContract(
+      hre,
+      'Proxy__OVM_L1ETHGateway',
+      {
+        iface: 'OVM_L1ETHGateway',
+      }
+    )
+
+    // Default has 20 accounts but we restrict to 20 accounts manually as well just to prevent
+    // future problems if the number of default accounts increases for whatever reason.
+    const accounts = normalizeHardhatNetworkAccountsConfig(
+      defaultHardhatNetworkHdAccountsConfigParams
+    ).slice(0, 20)
+
+    // Fund the accounts in parallel to speed things up.
+    await Promise.all(
+      accounts.map(async (account, index) => {
+        // Add a sleep here to avoid any potential issues with spamming hardhat. Not sure if this
+        // is strictly necessary but it can't hurt.
+        await sleep(200 * index)
+
+        const wallet = new hre.ethers.Wallet(
+          account.privateKey,
+          hre.ethers.provider
+        )
+        const balance = await wallet.getBalance()
+        const depositAmount = balance.div(2) // Deposit half of the wallet's balance into L2.
+        await Proxy__OVM_L1ETHGateway.connect(wallet).deposit(8_000_000, '0x', {
+          value: depositAmount,
+          gasLimit: 2_000_000, // Idk, gas estimation was broken and this fixes it.
+        })
+        console.log(
+          `✓ Funded ${wallet.address} on L2 with ${hre.ethers.utils.formatEther(
+            depositAmount
+          )} ETH`
+        )
+      })
+    )
+  }
+}
+
+deployFn.dependencies = ['Proxy__OVM_L1ETHGateway']
+deployFn.tags = ['fund-accounts']
+
+export default deployFn

packages/contracts/package.json

@@ -37,7 +37,7 @@
     "posttest:slither": "rm -f @openzeppelin && rm -f @ens && rm -f hardhat",
     "lint": "yarn lint:fix && yarn lint:check",
     "lint:fix": "yarn run lint:fix:typescript",
-    "lint:fix:typescript": "prettier --config .prettierrc.json --write \"hardhat.config.ts\" \"{src,test}/**/*.ts\"",
+    "lint:fix:typescript": "prettier --config .prettierrc.json --write \"hardhat.config.ts\" \"{src,test,deploy}/**/*.ts\"",
     "lint:check": "yarn run lint:typescript",
     "lint:typescript": "tslint --format stylish --project .",
     "clean": "rm -rf ./dist ./artifacts ./artifacts-ovm ./cache ./cache-ovm ./tsconfig.build.tsbuildinfo",