fix(core): use EIP-1559 transactions if supported by the network

.changeset/selfish-badgers-buy.md

@@ -0,0 +1,7 @@
+---
+'@chugsplash/core': patch
+'@chugsplash/executor': patch
+'@chugsplash/plugins': patch
+---
+
+Override transaction gas prices to use EIP-1559 if supported by the network

packages/core/src/actions/execute.ts

@@ -13,12 +13,13 @@ import {
   ChugSplashBundleState,
   ChugSplashBundleStatus,
 } from './types'
+import { getGasPriceOverrides } from '../utils'
 
 export const executeTask = async (args: {
   chugSplashManager: ethers.Contract
   bundle: ChugSplashActionBundle
   bundleState: ChugSplashBundleState
-  executor: ethers.Signer
+  executor: ethers.Wallet
   projectName: string
   logger: Logger
 }) => {
@@ -52,9 +53,11 @@ export const executeTask = async (args: {
         `[ChugSplash]: claiming the bundle for project: ${projectName}`
       )
       await (
-        await chugSplashManager.claimBundle({
-          value: EXECUTOR_BOND_AMOUNT,
-        })
+        await chugSplashManager.claimBundle(
+          await getGasPriceOverrides(executor.provider, {
+            value: EXECUTOR_BOND_AMOUNT,
+          })
+        )
       ).wait()
       logger.info(`[ChugSplash]: claimed the bundle`)
     } else if (bundleState.selectedExecutor !== executorAddress) {
@@ -183,7 +186,8 @@ export const executeTask = async (args: {
           await chugSplashManager.executeMultipleActions(
             batch.map((action) => action.action),
             batch.map((action) => action.proof.actionIndex),
-            batch.map((action) => action.proof.siblings)
+            batch.map((action) => action.proof.siblings),
+            await getGasPriceOverrides(executor.provider)
           )
         ).wait()
 
@@ -221,7 +225,8 @@ export const executeTask = async (args: {
       await chugSplashManager.completeChugSplashBundle(
         setImplActions.map((action) => action.action),
         setImplActions.map((action) => action.proof.actionIndex),
-        setImplActions.map((action) => action.proof.siblings)
+        setImplActions.map((action) => action.proof.siblings),
+        await getGasPriceOverrides(executor.provider)
       )
     ).wait()
     logger.info(`[ChugSplash]: executed SetImplementation actions`)

packages/core/src/languages/solidity/predeploys.ts

@@ -34,6 +34,7 @@ import {
   getProxyAdmin,
   isContractDeployed,
   getProxyImplementationAddress,
+  getGasPriceOverrides,
 } from '../../utils'
 
 export const initializeChugSplash = async (
@@ -88,7 +89,8 @@ export const initializeChugSplash = async (
         EXECUTOR_PAYMENT_PERCENTAGE,
         ChugSplashManager.address,
         CHUGSPLASH_REGISTRY_PROXY_ADDRESS,
-        CHUGSPLASH_SALT
+        CHUGSPLASH_SALT,
+        await getGasPriceOverrides(provider)
       )
     ).wait()
     logger?.info('[ChugSplash]: ChugSplashBootLoader initialized')
@@ -153,7 +155,10 @@ export const initializeChugSplash = async (
     // Initialize the ChugSplashRegistry's proxy. This sets the ChugSplashRegistry proxy's
     // implementation and transfers ownership of the proxy to the multisig owner.
     await (
-      await ProxyInitializer.initialize(CHUGSPLASH_REGISTRY_ADDRESS)
+      await ProxyInitializer.initialize(
+        CHUGSPLASH_REGISTRY_ADDRESS,
+        await getGasPriceOverrides(provider)
+      )
     ).wait()
 
     // Make sure ownership of the ChugSplashRegistry's proxy has been transferred.
@@ -211,7 +216,8 @@ export const initializeChugSplash = async (
     await (
       await ChugSplashRegistry.addProxyType(
         ethers.constants.HashZero,
-        DefaultAdapter.address
+        DefaultAdapter.address,
+        await getGasPriceOverrides(provider)
       )
     ).wait()
     logger?.info(
@@ -298,13 +304,14 @@ export const doDeterministicDeploy = async (
     return new ethers.Contract(address, options.contract.abi, options.signer)
   }
 
+  // Create a transaction request with gas price overrides.
+  const txnRequest = await getGasPriceOverrides(provider, {
+    to: deployer,
+    data: options.salt + ethers.utils.hexlify(deploymentTx.data).slice(2),
+  })
+
   // Deploy the contract.
-  await (
-    await options.signer.sendTransaction({
-      to: deployer,
-      data: options.salt + ethers.utils.hexlify(deploymentTx.data).slice(2),
-    })
-  ).wait()
+  await (await options.signer.sendTransaction(txnRequest)).wait()
 
   if ((await isContractDeployed(address, provider)) === false) {
     throw new Error(`failed to deploy contract at ${address}`)

packages/core/src/utils.ts

@@ -1,7 +1,17 @@
 import * as path from 'path'
 import * as fs from 'fs'
 
-import { utils, constants, Signer, Contract, providers, ethers } from 'ethers'
+import {
+  utils,
+  constants,
+  Signer,
+  Wallet,
+  Contract,
+  providers,
+  ethers,
+  PayableOverrides,
+  BigNumber,
+} from 'ethers'
 import {
   ProxyArtifact,
   ChugSplashRegistryABI,
@@ -10,6 +20,7 @@ import {
   CHUGSPLASH_REGISTRY_PROXY_ADDRESS,
   ProxyABI,
 } from '@chugsplash/contracts'
+import { TransactionRequest } from '@ethersproject/abstract-provider'
 
 import { CanonicalChugSplashConfig, ParsedChugSplashConfig } from './config'
 import { ChugSplashActionBundle, ChugSplashActionType } from './actions'
@@ -211,7 +222,13 @@ export const registerChugSplashProject = async (
   if (
     (await ChugSplashRegistry.projects(projectName)) === constants.AddressZero
   ) {
-    await (await ChugSplashRegistry.register(projectName, projectOwner)).wait()
+    await (
+      await ChugSplashRegistry.register(
+        projectName,
+        projectOwner,
+        await getGasPriceOverrides(provider)
+      )
+    ).wait()
     return true
   } else {
     const existingProjectOwner = await getProjectOwnerAddress(
@@ -315,12 +332,16 @@ export const displayDeploymentTable = (
 }
 
 export const claimExecutorPayment = async (
-  executor: Signer,
+  executor: Wallet,
   ChugSplashManager: Contract
 ) => {
   const executorDebt = await ChugSplashManager.debt(await executor.getAddress())
   if (executorDebt.gt(0)) {
-    await (await ChugSplashManager.claimExecutorPayment()).wait()
+    await (
+      await ChugSplashManager.claimExecutorPayment(
+        await getGasPriceOverrides(executor.provider)
+      )
+    ).wait()
   }
 }
 
@@ -416,3 +437,30 @@ export const getProxyImplementationAddress = async (
   )
   return decoded
 }
+
+/**
+ * Overrides an object's gas price settings to support EIP-1559 transactions if EIP-1559 is
+ * supported by the network. This only overrides the default behavior on Goerli, where transactions
+ * sent via Alchemy or Infura do not yet support EIP-1559 gas pricing, despite the fact that
+ * `maxFeePerGas` and `maxPriorityFeePerGas` are defined.
+ *
+ * @param provider Provider object.
+ * @param overridden The object whose gas price settings will be overridden.
+ * @returns The object whose gas price settings will be overridden.
+ */
+export const getGasPriceOverrides = async (
+  provider: ethers.providers.Provider,
+  overridden: PayableOverrides | TransactionRequest = {}
+): Promise<PayableOverrides | TransactionRequest> => {
+  const { maxFeePerGas, maxPriorityFeePerGas } = await provider.getFeeData()
+
+  if (
+    BigNumber.isBigNumber(maxFeePerGas) &&
+    BigNumber.isBigNumber(maxPriorityFeePerGas)
+  ) {
+    overridden.maxFeePerGas = maxFeePerGas
+    overridden.maxPriorityFeePerGas = maxPriorityFeePerGas
+  }
+
+  return overridden
+}

packages/plugins/src/hardhat/deployments.ts

@@ -21,6 +21,7 @@ import {
   getAmountToDeposit,
   isContractDeployed,
   formatEther,
+  getGasPriceOverrides,
 } from '@chugsplash/core'
 import { getChainId } from '@eth-optimism/core-utils'
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
@@ -429,7 +430,8 @@ reference name to something other than ${upgradeReferenceName}.`
     await ChugSplashManager.proposeChugSplashBundle(
       bundle.root,
       bundle.actions.length,
-      configUri
+      configUri,
+      await getGasPriceOverrides(provider)
     )
   ).wait()
 

packages/plugins/src/hardhat/execution.ts

@@ -11,6 +11,7 @@ import {
   getAmountToDeposit,
   EXECUTION_BUFFER_MULTIPLIER,
   formatEther,
+  getGasPriceOverrides,
 } from '@chugsplash/core'
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
 import { ethers } from 'ethers'
@@ -159,7 +160,8 @@ export const postExecutionActions = async (
 ) => {
   spinner.start(`Sending leftover funds to the project owner...`)
 
-  const signer = hre.ethers.provider.getSigner()
+  const provider = hre.ethers.provider
+  const signer = provider.getSigner()
   const ChugSplashManager = getChugSplashManager(
     signer,
     parsedConfig.options.projectName
@@ -172,11 +174,15 @@ export const postExecutionActions = async (
   if ((await signer.getAddress()) === currProjectOwner) {
     // Withdraw any of the current project owner's funds in the ChugSplashManager.
     const ownerBalance = await getOwnerWithdrawableAmount(
-      hre.ethers.provider,
+      provider,
       parsedConfig.options.projectName
     )
     if (ownerBalance.gt(0)) {
-      await (await ChugSplashManager.withdrawOwnerETH()).wait()
+      await (
+        await ChugSplashManager.withdrawOwnerETH(
+          await getGasPriceOverrides(provider)
+        )
+      ).wait()
       spinner.succeed(
         `Sent leftover funds to the project owner. Amount: ${formatEther(
           ownerBalance,
@@ -194,10 +200,17 @@ export const postExecutionActions = async (
       spinner.start(`Transferring project ownership to: ${newProjectOwner}`)
       if (newProjectOwner === ethers.constants.AddressZero) {
         // We must call a separate function if ownership is being transferred to address(0).
-        await (await ChugSplashManager.renounceOwnership()).wait()
+        await (
+          await ChugSplashManager.renounceOwnership(
+            await getGasPriceOverrides(provider)
+          )
+        ).wait()
       } else {
         await (
-          await ChugSplashManager.transferOwnership(newProjectOwner)
+          await ChugSplashManager.transferOwnership(
+            newProjectOwner,
+            await getGasPriceOverrides(provider)
+          )
         ).wait()
       }
       spinner.succeed(`Transferred project ownership to: ${newProjectOwner}`)