fix(pg): support upgrades using the hardhat test command

hujw77 · Nov 23, 2022 · 9e48bbf · 9e48bbf
1 parent a1ae30f
commit 9e48bbf
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 30 deletions.
diff --git a/.changeset/orange-pumas-check.md b/.changeset/orange-pumas-check.md
@@ -0,0 +1,5 @@
+---
+'@chugsplash/plugins': patch
+---
+
+Support upgrades with the hardhat test command
diff --git a/packages/plugins/src/hardhat/deployments.ts b/packages/plugins/src/hardhat/deployments.ts
@@ -192,7 +192,6 @@ export const deployChugSplashConfig = async (
       {
         configPath,
         silent: true,
-        remoteExecution,
         amount: executionAmountPlusBuffer,
         skipMonitorStatus: true,
       },

diff --git a/packages/plugins/src/hardhat/execution.ts b/packages/plugins/src/hardhat/execution.ts
@@ -9,9 +9,10 @@ import {
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
 import { ethers } from 'ethers'
 import { ChugSplashManagerABI } from '@chugsplash/contracts'
-import { sleep } from '@eth-optimism/core-utils'
+import { getChainId, sleep } from '@eth-optimism/core-utils'
 
 import { getFinalDeploymentTxnHash } from './deployments'
+import { writeHardhatSnapshotId } from './utils'
 
 export const monitorRemoteExecution = async (
   hre: HardhatRuntimeEnvironment,
@@ -106,10 +107,10 @@ npx hardhat chugsplash-fund --network ${hre.network.name} --amount ${estCost} <c
  * @param parsedConfig Parsed ChugSplashConfig.
  */
 export const postExecutionActions = async (
-  provider: ethers.providers.JsonRpcProvider,
+  hre: HardhatRuntimeEnvironment,
   parsedConfig: ChugSplashConfig
 ) => {
-  const signer = provider.getSigner()
+  const signer = hre.ethers.provider.getSigner()
   const ChugSplashManager = getChugSplashManager(
     signer,
     parsedConfig.options.projectName
@@ -123,7 +124,7 @@ export const postExecutionActions = async (
 
   // Withdraw any of the current project owner's funds in the ChugSplashManager.
   const ownerFunds = await getOwnerBalanceInChugSplashManager(
-    provider,
+    hre.ethers.provider,
     parsedConfig.options.projectName
   )
   if (ownerFunds.gt(0)) {
@@ -144,4 +145,9 @@ export const postExecutionActions = async (
       ).wait()
     }
   }
+
+  // Save the snapshot ID if we're on the hardhat network.
+  if ((await getChainId(hre.ethers.provider)) === 31337) {
+    await writeHardhatSnapshotId(hre)
+  }
 }
diff --git a/packages/plugins/src/hardhat/tasks.ts b/packages/plugins/src/hardhat/tasks.ts
@@ -390,14 +390,12 @@ export const chugsplashApproveTask = async (
   args: {
     configPath: string
     silent: boolean
-    remoteExecution: boolean
     amount: ethers.BigNumber
     skipMonitorStatus: boolean
   },
   hre: HardhatRuntimeEnvironment
 ) => {
-  const { configPath, silent, remoteExecution, amount, skipMonitorStatus } =
-    args
+  const { configPath, silent, amount, skipMonitorStatus } = args
 
   const provider = hre.ethers.provider
   const signer = provider.getSigner()
@@ -469,14 +467,14 @@ Please wait a couple minutes then try again.`
     await (await ChugSplashManager.approveChugSplashBundle(bundleId)).wait()
     spinner.succeed(`Project approved on ${hre.network.name}.`)
 
-    if (remoteExecution && !skipMonitorStatus) {
+    if (!skipMonitorStatus) {
       spinner.start('The deployment is being executed. This may take a moment.')
       const finalDeploymentTxnHash = await monitorRemoteExecution(
         hre,
         parsedConfig,
         bundleId
       )
-      await postExecutionActions(provider, parsedConfig)
+      await postExecutionActions(hre, parsedConfig)
       await createDeploymentArtifacts(hre, parsedConfig, finalDeploymentTxnHash)
       displayDeploymentTable(parsedConfig, silent)
       spinner.succeed(
@@ -883,25 +881,27 @@ project with a name other than ${parsedConfig.options.projectName}`
     spinner.start(
       'The deployment is currently being executed. This may take a moment.'
     )
+  }
 
-    const finalDeploymentTxnHash = await monitorRemoteExecution(
-      hre,
-      parsedConfig,
-      bundleId
-    )
-    await postExecutionActions(provider, parsedConfig)
-    await createDeploymentArtifacts(hre, parsedConfig, finalDeploymentTxnHash)
+  // If we make it to this point, the bundle status is either completed or approved.
 
-    bundleState.status === ChugSplashBundleStatus.APPROVED
-      ? spinner.succeed(
-          `${parsedConfig.options.projectName} successfully deployed on ${hre.network.name}.`
-        )
-      : spinner.succeed(
-          `${parsedConfig.options.projectName} was already deployed on ${hre.network.name}.`
-        )
+  const finalDeploymentTxnHash = await monitorRemoteExecution(
+    hre,
+    parsedConfig,
+    bundleId
+  )
+  await postExecutionActions(hre, parsedConfig)
+  await createDeploymentArtifacts(hre, parsedConfig, finalDeploymentTxnHash)
 
-    displayDeploymentTable(parsedConfig, silent)
-  }
+  bundleState.status === ChugSplashBundleStatus.APPROVED
+    ? spinner.succeed(
+        `${parsedConfig.options.projectName} successfully deployed on ${hre.network.name}.`
+      )
+    : spinner.succeed(
+        `${parsedConfig.options.projectName} was already deployed on ${hre.network.name}.`
+      )
+
+  displayDeploymentTable(parsedConfig, silent)
 }
 
 task(TASK_CHUGSPLASH_MONITOR)
@@ -1012,7 +1012,7 @@ task(TASK_NODE)
           }
           await deployAllChugSplashConfigs(hre, hide, '', true, spinner)
         }
-        await writeHardhatSnapshotId(hre)
+        await writeHardhatSnapshotId(hre, 'localhost')
       }
       await runSuper(args)
     }

diff --git a/packages/plugins/src/hardhat/utils.ts b/packages/plugins/src/hardhat/utils.ts
@@ -10,10 +10,14 @@ import {
 import { TASK_COMPILE, TASK_CLEAN } from 'hardhat/builtin-tasks/task-names'
 import { Signer } from 'ethers'
 
-export const writeHardhatSnapshotId = async (hre: any) => {
-  const networkName = hre.network.name === 'localhost' ? 'localhost' : 'hardhat'
+export const writeHardhatSnapshotId = async (
+  hre: any,
+  networkName?: string
+) => {
+  const inferredNetworkName =
+    hre.network.name === 'localhost' ? 'localhost' : 'hardhat'
   await writeSnapshotId(
-    networkName,
+    networkName === undefined ? inferredNetworkName : networkName,
     hre.config.paths.deployed,
     await hre.network.provider.send('evm_snapshot', [])
   )