Add txOverrides option for overriding transaction parameters

docs/modules/ROOT/pages/api-hardhat-upgrades.adoc

@@ -25,6 +25,7 @@ The following options are common to some functions.
 ** If set to `"always"`, the implementation contract is always redeployed even if it was previously deployed with the same bytecode. This can be used with the `salt` option when deploying a proxy through OpenZeppelin Platform to ensure that the implementation contract is deployed with the same salt as the proxy.
 ** If set to `"never"`, the implementation contract is never redeployed. If the implementation contract was not previously deployed or is not found in the network file, an error will be thrown.
 ** If set to `"onchange"`, the implementation contract is redeployed only if the bytecode has changed from previous deployments.
+* `txOverrides`: (`ethers.Overrides`) An ethers.js https://docs.ethers.org/v6/api/contract/#Overrides[Overrides] object to override transaction parameters, such as `gasLimit` and `gasPrice`. Applies to all transactions sent by a function with this option, even if the function sends multiple transactions.
 * `usePlatformDeploy`: (`boolean`) Deploy contracts using the OpenZeppelin Platform instead of ethers.js. See xref:platform-deploy.adoc[Using with OpenZeppelin Platform]. **Note**: OpenZeppelin Platform is in beta and functionality related to Platform is subject to change.
 * `verifySourceCode`: (`boolean`) When using Platform, whether to verify source code on block explorers. Defaults to `true`.
 * `relayerId`: (`string`) When using Platform, the ID of the relayer to use for the deployment. Defaults to the relayer configured for your deployment environment on Platform.
@@ -53,6 +54,7 @@ async function deployProxy(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: ethers.Overrides,
     kind?: 'uups' | 'transparent',
     usePlatformDeploy?: boolean,
   },
@@ -92,6 +94,7 @@ async function upgradeProxy(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: ethers.Overrides,
     kind?: 'uups' | 'transparent',
   },
 ): Promise<ethers.Contract>
@@ -124,6 +127,7 @@ async function deployBeacon(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: ethers.Overrides,
   },
 ): Promise<ethers.Contract>
 ----
@@ -160,6 +164,7 @@ async function upgradeBeacon(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: ethers.Overrides,
   },
 ): Promise<ethers.Contract>
 ----
@@ -192,6 +197,7 @@ async function deployBeaconProxy(
   args: unknown[] = [],
   opts?: {
     initializer?: string | false,
+    txOverrides?: ethers.Overrides,
     usePlatformDeploy?: boolean,
   },
 ): Promise<ethers.Contract>
@@ -290,6 +296,7 @@ async function deployImplementation(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: ethers.Overrides,
     getTxResponse?: boolean,
     kind?: 'uups' | 'transparent' | 'beacon',
     usePlatformDeploy?: boolean,
@@ -381,6 +388,7 @@ async function prepareUpgrade(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: ethers.Overrides,
     getTxResponse?: boolean,
     kind?: 'uups' | 'transparent' | 'beacon',
     usePlatformDeploy?: boolean,
@@ -566,6 +574,7 @@ async function deployProxyAdmin(
   opts?: {
     timeout?: number,
     pollingInterval?: number,
+    txOverrides?: ethers.Overrides,
   },
 ): Promise<string>
 ----
@@ -595,6 +604,9 @@ async function changeProxyAdmin(
   proxyAddress: string,
   newAdmin: string,
   signer?: ethers.Signer,
+  opts?: {
+    txOverrides?: ethers.Overrides,
+  }
 ): Promise<void>
 ----
 
@@ -605,6 +617,8 @@ Changes the admin for a specific proxy.
 * `proxyAddress` - the address of the proxy to change.
 * `newAdmin` - the new admin address.
 * `signer` - the signer to use for the transaction.
+* `opts` - an object with options:
+** additional options as described in <<common-options>>.
 
 [[admin-transfer-proxy-admin-ownership]]
 == admin.transferProxyAdminOwnership
@@ -614,6 +628,9 @@ Changes the admin for a specific proxy.
 async function transferProxyAdminOwnership(
   newAdmin: string,
   signer?: ethers.Signer,
+  opts?: {
+    txOverrides?: ethers.Overrides,
+  }
 ): Promise<void>
 ----
 
@@ -623,6 +640,8 @@ Changes the owner of the proxy admin contract, which is the default admin for up
 
 * `newAdmin` - the new admin address.
 * `signer` - the signer to use for the transaction.
+* `opts` - an object with options:
+** additional options as described in <<common-options>>.
 
 [[erc1967]]
 == erc1967

docs/modules/ROOT/pages/api-truffle-upgrades.adoc

@@ -24,6 +24,7 @@ The following options are common to some functions.
 ** If set to `"always"`, the implementation contract is always redeployed even if it was previously deployed with the same bytecode.
 ** If set to `"never"`, the implementation contract is never redeployed. If the implementation contract was not previously deployed or is not found in the network file, an error will be thrown.
 ** If set to `"onchange"`, the implementation contract is redeployed only if the bytecode has changed from previous deployments.
+* `txOverrides`: (`TruffleTxOptions`) A Truffle https://trufflesuite.com/docs/truffle/how-to/contracts/run-migrations/#deployerdeploycontract-args-options[options] object to override transaction parameters, such as `gas` and `gasPrice`. Applies to all transactions sent by a function with this option, even if the function sends multiple transactions.
 
 Note that the options `unsafeAllow` can also be specified in a more granular way directly in the source code if using Solidity >=0.8.2. See xref:faq.adoc#how-can-i-disable-checks[How can I disable some of the checks?]
 
@@ -49,6 +50,7 @@ async function deployProxy(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: TruffleTxOptions,
     kind?: 'uups' | 'transparent',
   },
 ): Promise<ContractInstance>
@@ -90,6 +92,7 @@ async function upgradeProxy(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: TruffleTxOptions,
     kind?: 'uups' | 'transparent',
   },
 ): Promise<ContractInstance>
@@ -123,6 +126,7 @@ async function deployBeacon(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: TruffleTxOptions,
   },
 ): Promise<ContractInstance>
 ----
@@ -160,6 +164,7 @@ async function upgradeBeacon(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: TruffleTxOptions,
   },
 ): Promise<ContractInstance>
 ----
@@ -193,6 +198,7 @@ async function deployBeaconProxy(
   opts?: {
     deployer?: Deployer,
     initializer?: string | false,
+    txOverrides?: TruffleTxOptions,
   },
 ): Promise<ContractInstance>
 ----
@@ -290,6 +296,7 @@ async function deployImplementation(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: TruffleTxOptions,
     kind?: 'uups' | 'transparent' | 'beacon',
   },
 ): Promise<string>
@@ -379,6 +386,7 @@ async function prepareUpgrade(
     timeout?: number,
     pollingInterval?: number,
     redeployImplementation?: 'always' | 'never' | 'onchange',
+    txOverrides?: TruffleTxOptions,
     kind?: 'uups' | 'transparent' | 'beacon',
   },
 ): Promise<string>
@@ -407,6 +415,7 @@ async function deployProxyAdmin(
     deployer?: Deployer,
     timeout?: number,
     pollingInterval?: number,
+    txOverrides?: TruffleTxOptions,
   },
 ): Promise<string>
 ----
@@ -434,6 +443,10 @@ Deploys a https://docs.openzeppelin.com/contracts/4.x/api/proxy#ProxyAdmin[proxy
 async function changeProxyAdmin(
   proxyAddress: string,
   newAdmin: string,
+  opts?: {
+    deployer?: Deployer,
+    txOverrides?: TruffleTxOptions,
+  },
 ): Promise<void>
 ----
 
@@ -443,6 +456,8 @@ Changes the admin for a specific proxy.
 
 * `proxyAddress` - the address of the proxy to change.
 * `newAdmin` - the new admin address.
+* `opts` - an object with options:
+** See <<common-options>>.
 
 [[admin-transfer-proxy-admin-ownership]]
 == admin.transferProxyAdminOwnership
@@ -451,6 +466,11 @@ Changes the admin for a specific proxy.
 ----
 async function transferProxyAdminOwnership(
   newAdmin: string,
+  opts?: {
+    deployer?: Deployer,
+    txOverrides?: TruffleTxOptions,
+  },
+
 ): Promise<void>
 ----
 
@@ -459,6 +479,8 @@ Changes the owner of the proxy admin contract, which is the default admin for up
 *Parameters:*
 
 * `newAdmin` - the new admin address.
+* `opts` - an object with options:
+** See <<common-options>>.
 
 [[erc1967]]
 == erc1967

packages/plugin-hardhat/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Add `txOverrides` option for overriding transaction parameters. ([#852](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/852))
+
 ## 2.0.2 (2023-07-26)
 
 - Enable storage layout for overrides from Hardhat config. ([#851](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/851))

packages/plugin-hardhat/src/admin.ts

@@ -2,19 +2,33 @@ import chalk from 'chalk';
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import { Manifest, getAdminAddress } from '@openzeppelin/upgrades-core';
 import { Contract, Signer } from 'ethers';
-import { getProxyAdminFactory } from './utils';
+import { EthersDeployOptions, getProxyAdminFactory } from './utils';
 import { disablePlatform } from './platform/utils';
 import { attach } from './utils/ethers';
 
 const SUCCESS_CHECK = chalk.green('✔') + ' ';
 const FAILURE_CROSS = chalk.red('✘') + ' ';
 
-export type ChangeAdminFunction = (proxyAddress: string, newAdmin: string, signer?: Signer) => Promise<void>;
-export type TransferProxyAdminOwnershipFunction = (newOwner: string, signer?: Signer) => Promise<void>;
+export type ChangeAdminFunction = (
+  proxyAddress: string,
+  newAdmin: string,
+  signer?: Signer,
+  opts?: EthersDeployOptions,
+) => Promise<void>;
+export type TransferProxyAdminOwnershipFunction = (
+  newOwner: string,
+  signer?: Signer,
+  opts?: EthersDeployOptions,
+) => Promise<void>;
 export type GetInstanceFunction = (signer?: Signer) => Promise<Contract>;
 
 export function makeChangeProxyAdmin(hre: HardhatRuntimeEnvironment, platformModule: boolean): ChangeAdminFunction {
-  return async function changeProxyAdmin(proxyAddress, newAdmin, signer?: Signer) {
+  return async function changeProxyAdmin(
+    proxyAddress: string,
+    newAdmin: string,
+    signer?: Signer,
+    opts: EthersDeployOptions = {},
+  ) {
     disablePlatform(hre, platformModule, {}, changeProxyAdmin.name);
 
     const admin = await getManifestAdmin(hre, signer);
@@ -24,7 +38,8 @@ export function makeChangeProxyAdmin(hre: HardhatRuntimeEnvironment, platformMod
     if (manifestAdminAddress !== proxyAdminAddress) {
       throw new Error('Proxy admin is not the one registered in the network manifest');
     } else if (manifestAdminAddress !== newAdmin) {
-      await admin.changeProxyAdmin(proxyAddress, newAdmin);
+      const overrides = opts.txOverrides ? [opts.txOverrides] : [];
+      await admin.changeProxyAdmin(proxyAddress, newAdmin, ...overrides);
     }
   };
 }
@@ -33,11 +48,13 @@ export function makeTransferProxyAdminOwnership(
   hre: HardhatRuntimeEnvironment,
   platformModule: boolean,
 ): TransferProxyAdminOwnershipFunction {
-  return async function transferProxyAdminOwnership(newOwner, signer?: Signer) {
+  return async function transferProxyAdminOwnership(newOwner: string, signer?: Signer, opts: EthersDeployOptions = {}) {
     disablePlatform(hre, platformModule, {}, transferProxyAdminOwnership.name);
 
     const admin = await getManifestAdmin(hre, signer);
-    await admin.transferOwnership(newOwner);
+
+    const overrides = opts.txOverrides ? [opts.txOverrides] : [];
+    await admin.transferOwnership(newOwner, ...overrides);
 
     const { provider } = hre.network;
     const manifest = await Manifest.forNetwork(provider);

packages/plugin-hardhat/src/upgrade-beacon.ts

@@ -27,7 +27,9 @@ export function makeUpgradeBeacon(hre: HardhatRuntimeEnvironment, platformModule
 
     const UpgradeableBeaconFactory = await getUpgradeableBeaconFactory(hre, getSigner(ImplFactory.runner));
     const beaconContract = attach(UpgradeableBeaconFactory, beaconAddress);
-    const upgradeTx = await beaconContract.upgradeTo(nextImpl);
+
+    const overrides = opts.txOverrides ? [opts.txOverrides] : [];
+    const upgradeTx = await beaconContract.upgradeTo(nextImpl, ...overrides);
 
     // @ts-ignore Won't be readonly because beaconContract was created through attach.
     beaconContract.deployTransaction = upgradeTx;

packages/plugin-hardhat/src/upgrade-proxy.ts

@@ -29,7 +29,7 @@ export function makeUpgradeProxy(hre: HardhatRuntimeEnvironment, platformModule:
 
     const { impl: nextImpl } = await deployProxyImpl(hre, ImplFactory, opts, proxyAddress);
     // upgrade kind is inferred above
-    const upgradeTo = await getUpgrader(proxyAddress, getSigner(ImplFactory.runner));
+    const upgradeTo = await getUpgrader(proxyAddress, opts, getSigner(ImplFactory.runner));
     const call = encodeCall(ImplFactory, opts.call);
     const upgradeTx = await upgradeTo(nextImpl, call);
 
@@ -41,18 +41,21 @@ export function makeUpgradeProxy(hre: HardhatRuntimeEnvironment, platformModule:
 
   type Upgrader = (nextImpl: string, call?: string) => Promise<ethers.TransactionResponse>;
 
-  async function getUpgrader(proxyAddress: string, signer?: Signer): Promise<Upgrader> {
+  async function getUpgrader(proxyAddress: string, opts: UpgradeProxyOptions, signer?: Signer): Promise<Upgrader> {
     const { provider } = hre.network;
 
     const adminAddress = await getAdminAddress(provider, proxyAddress);
     const adminBytecode = await getCode(provider, adminAddress);
 
+    const overrides = opts.txOverrides ? [opts.txOverrides] : [];
+
     if (isEmptySlot(adminAddress) || adminBytecode === '0x') {
       // No admin contract: use ITransparentUpgradeableProxyFactory to get proxiable interface
       const ITransparentUpgradeableProxyFactory = await getITransparentUpgradeableProxyFactory(hre, signer);
       const proxy = attach(ITransparentUpgradeableProxyFactory, proxyAddress);
 
-      return (nextImpl, call) => (call ? proxy.upgradeToAndCall(nextImpl, call) : proxy.upgradeTo(nextImpl));
+      return (nextImpl, call) =>
+        call ? proxy.upgradeToAndCall(nextImpl, call, ...overrides) : proxy.upgradeTo(nextImpl, ...overrides);
     } else {
       // Admin contract: redirect upgrade call through it
       const manifest = await Manifest.forNetwork(provider);
@@ -65,7 +68,9 @@ export function makeUpgradeProxy(hre: HardhatRuntimeEnvironment, platformModule:
       }
 
       return (nextImpl, call) =>
-        call ? admin.upgradeAndCall(proxyAddress, nextImpl, call) : admin.upgrade(proxyAddress, nextImpl);
+        call
+          ? admin.upgradeAndCall(proxyAddress, nextImpl, call, ...overrides)
+          : admin.upgrade(proxyAddress, nextImpl, ...overrides);
     }
   }
 }

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

@@ -1,30 +1,33 @@
 import type { Deployment, RemoteDeploymentId } from '@openzeppelin/upgrades-core';
-import type { ethers, ContractFactory } from 'ethers';
+import type { ethers, ContractFactory, ContractMethodArgs } from 'ethers';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
 import { platformDeploy } from '../platform/deploy';
-import { PlatformDeployOptions, UpgradeOptions } from './options';
+import { EthersDeployOptions, PlatformDeployOptions, UpgradeOptions } from './options';
 
 export interface DeployTransaction {
   deployTransaction?: ethers.TransactionResponse;
 }
 
 export async function deploy(
   hre: HardhatRuntimeEnvironment,
-  opts: UpgradeOptions & PlatformDeployOptions,
+  opts: UpgradeOptions & EthersDeployOptions & PlatformDeployOptions,
   factory: ContractFactory,
   ...args: unknown[]
 ): Promise<Required<Deployment> & DeployTransaction & RemoteDeploymentId> {
   // platform always includes RemoteDeploymentId, while ethers always includes DeployTransaction
   if (opts?.usePlatformDeploy) {
     return await platformDeploy(hre, factory, opts, ...args);
   } else {
+    if (opts.txOverrides !== undefined) {
+      args.push(opts.txOverrides);
+    }
     return await ethersDeploy(factory, ...args);
   }
 }
 
 async function ethersDeploy(
   factory: ContractFactory,
-  ...args: unknown[]
+  ...args: ContractMethodArgs<unknown[]>
 ): Promise<Required<Deployment & DeployTransaction> & RemoteDeploymentId> {
   const contractInstance = await factory.deploy(...args);