@openzeppelin/hardhat-upgrades - npm Package Compare versions

Comparing version 1.11.0 to 1.12.0

CHANGELOG.md

 # Changelog
 
+## 1.12.0 (2021-10-28)
+
+- Add support for `upgradeToAndCall` to batch a function call into the upgrade transaction. ([#443](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/443))
+
 ## 1.11.0 (2021-10-22)
@@ -4,0 +8,0 @@

dist/upgrade-proxy.d.ts

 import { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { ContractFactory, Contract } from 'ethers';
-import { Options, ContractAddressOrInstance } from './utils';
-export declare type UpgradeFunction = (proxy: ContractAddressOrInstance, ImplFactory: ContractFactory, opts?: Options) => Promise<Contract>;
+import { UpgradeOptions, ContractAddressOrInstance } from './utils';
+export declare type UpgradeFunction = (proxy: ContractAddressOrInstance, ImplFactory: ContractFactory, opts?: UpgradeOptions) => Promise<Contract>;
 export declare function makeUpgradeProxy(hre: HardhatRuntimeEnvironment): UpgradeFunction;
 //# sourceMappingURL=upgrade-proxy.d.ts.map

dist/upgrade-proxy.js

@@ -11,3 +11,4 @@ "use strict";
         const { impl: nextImpl } = await (0, utils_1.deployImpl)(hre, ImplFactory, opts, proxyAddress);
-        const upgradeTx = await upgradeTo(nextImpl);
+        const call = encodeCall(ImplFactory, opts.call);
+        const upgradeTx = await upgradeTo(nextImpl, call);
         const inst = ImplFactory.attach(proxyAddress);
@@ -26,3 +27,3 @@ // @ts-ignore Won't be readonly because inst was created through attach.
             const proxy = TransparentUpgradeableProxyFactory.attach(proxyAddress);
-            return nextImpl => proxy.upgradeTo(nextImpl);
+            return (nextImpl, call) => (call ? proxy.upgradeToAndCall(nextImpl, call) : proxy.upgradeTo(nextImpl));
         }
@@ -38,3 +39,3 @@ else {
             }
-            return nextImpl => admin.upgrade(proxyAddress, nextImpl);
+            return (nextImpl, call) => call ? admin.upgradeAndCall(proxyAddress, nextImpl, call) : admin.upgrade(proxyAddress, nextImpl);
         }
@@ -44,2 +45,12 @@ }
 exports.makeUpgradeProxy = makeUpgradeProxy;
+function encodeCall(factory, call) {
+    var _a;
+    if (!call) {
+        return undefined;
+    }
+    if (typeof call === 'string') {
+        call = { fn: call };
+    }
+    return factory.interface.encodeFunctionData(call.fn, (_a = call.args) !== null && _a !== void 0 ? _a : []);
+}
 //# sourceMappingURL=upgrade-proxy.js.map

dist/utils/options.d.ts

@@ -9,2 +9,8 @@ import { ValidationOptions } from '@openzeppelin/upgrades-core';
 }
+export interface UpgradeOptions extends Options {
+    call?: {
+        fn: string;
+        args?: unknown[];
+    } | string;
+}
 //# sourceMappingURL=options.d.ts.map

package.json

 {
   "name": "@openzeppelin/hardhat-upgrades",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "",
@@ -5,0 +5,0 @@ "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/plugin-hardhat",

src/upgrade-proxy.ts

@@ -7,3 +7,3 @@ import { HardhatRuntimeEnvironment } from 'hardhat/types';
 import {
-  Options,
+  UpgradeOptions,
   deployImpl,
@@ -19,7 +19,7 @@ getTransparentUpgradeableProxyFactory,
   ImplFactory: ContractFactory,
-  opts?: Options,
+  opts?: UpgradeOptions,
 ) => Promise<Contract>;
 
 export function makeUpgradeProxy(hre: HardhatRuntimeEnvironment): UpgradeFunction {
-  return async function upgradeProxy(proxy, ImplFactory, opts: Options = {}) {
+  return async function upgradeProxy(proxy, ImplFactory, opts: UpgradeOptions = {}) {
     const proxyAddress = getContractAddress(proxy);
@@ -29,3 +29,4 @@
     const { impl: nextImpl } = await deployImpl(hre, ImplFactory, opts, proxyAddress);
-    const upgradeTx = await upgradeTo(nextImpl);
+    const call = encodeCall(ImplFactory, opts.call);
+    const upgradeTx = await upgradeTo(nextImpl, call);
 
@@ -38,3 +39,3 @@ const inst = ImplFactory.attach(proxyAddress);
 
-  type Upgrader = (nextImpl: string) => Promise<ethers.providers.TransactionResponse>;
+  type Upgrader = (nextImpl: string, call?: string) => Promise<ethers.providers.TransactionResponse>;
 
@@ -52,3 +53,3 @@ async function getUpgrader(proxyAddress: string, signer: Signer): Promise<Upgrader> {
 
-      return nextImpl => proxy.upgradeTo(nextImpl);
+      return (nextImpl, call) => (call ? proxy.upgradeToAndCall(nextImpl, call) : proxy.upgradeTo(nextImpl));
     } else {
@@ -65,5 +66,18 @@ // Admin contract: redirect upgrade call through it
 
-      return nextImpl => admin.upgrade(proxyAddress, nextImpl);
+      return (nextImpl, call) =>
+        call ? admin.upgradeAndCall(proxyAddress, nextImpl, call) : admin.upgrade(proxyAddress, nextImpl);
     }
   }
 }
+
+function encodeCall(factory: ContractFactory, call: UpgradeOptions['call']): string | undefined {
+  if (!call) {
+    return undefined;
+  }
+
+  if (typeof call === 'string') {
+    call = { fn: call };
+  }
+
+  return factory.interface.encodeFunctionData(call.fn, call.args ?? []);
+}

src/utils/options.ts

@@ -17,1 +17,5 @@ import { ValidationOptions, withValidationDefaults } from '@openzeppelin/upgrades-core';
 }
+
+export interface UpgradeOptions extends Options {
+  call?: { fn: string; args?: unknown[] } | string;
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

82266

increased by2.65%

Lines of code

1097

increased by2.91%

No dependency changes