add checkVersion flag to Upgradeable

bancorprotocol · Aug 23, 2024 · 658260b · 658260b
1 parent 88915fa
commit 658260b
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 15 deletions.
diff --git a/contracts/utility/Upgradeable.sol b/contracts/utility/Upgradeable.sol
@@ -81,18 +81,17 @@ abstract contract Upgradeable is IUpgradeable, AccessControlEnumerableUpgradeabl
      *
      * - this must and can be called only once per-upgrade
      */
-    function postUpgrade(bytes calldata data) external {
+    function postUpgrade(bool checkVersion, bytes calldata data) external {
         uint16 initializations = _initializations + 1;
         uint16 _version = version();
-        if (initializations < _version) {
-            initializations = _version;
-        }
-        if (initializations != _version) {
+        if (checkVersion && initializations != _version) {
             revert AlreadyInitialized();
+        } else if (!checkVersion) {
+            initializations = _version;
+        } else {
+            initializations = initializations;
         }
 
-        _initializations = initializations;
-
         _postUpgrade(data);
     }
 

diff --git a/deploy/scripts/network/0002-Voucher.ts b/deploy/scripts/network/0002-Voucher.ts
@@ -20,7 +20,7 @@ const func: DeployFunction = async ({ getNamedAccounts }: HardhatRuntimeEnvironm
     await execute({
         name: InstanceName.Voucher,
         methodName: 'postUpgrade',
-        args: ["0x"],
+        args: ['0x'],
         from: deployer
     });
 

diff --git a/deploy/tests/mainnet/carbon.ts b/deploy/tests/mainnet/carbon.ts
@@ -77,7 +77,10 @@ import { ethers, getNamedAccounts } from 'hardhat';
             await expectRoleMembers(carbonVortex, Roles.Upgradeable.ROLE_ADMIN, [daoMultisig.address]);
 
             // expect carbon vortex to have fee manager role in Carbon
-            await expectRoleMembers(carbonController, Roles.CarbonController.ROLE_FEES_MANAGER, [oldVortex, carbonVortex.address]);
+            await expectRoleMembers(carbonController, Roles.CarbonController.ROLE_FEES_MANAGER, [
+                oldVortex,
+                carbonVortex.address
+            ]);
 
             // expect carbonController to have minter role in voucher
             await expectRoleMembers(voucher, Roles.Voucher.ROLE_MINTER, [carbonController.address]);

diff --git a/deploy/tests/network/0002-voucher.ts b/deploy/tests/network/0002-voucher.ts
@@ -27,7 +27,7 @@ describeDeployment(__filename, () => {
 
     it('cannot call postUpgrade on voucher', async () => {
         // hardcoding gas limit to avoid gas estimation attempts (which get rejected instead of reverted)
-        const tx = await voucher.postUpgrade("0x", { gasLimit: 6000000 });
+        const tx = await voucher.postUpgrade('0x', { gasLimit: 6000000 });
         await expect(tx.wait()).to.be.reverted;
     });
 });
diff --git a/deploy/tests/network/0003-carbon-controller.ts b/deploy/tests/network/0003-carbon-controller.ts
@@ -30,7 +30,7 @@ describeDeployment(__filename, () => {
 
     it('cannot call postUpgrade on carbon controller', async () => {
         // hardcoding gas limit to avoid gas estimation attempts (which get rejected instead of reverted)
-        const tx = await carbonController.postUpgrade("0x", { gasLimit: 6000000 });
+        const tx = await carbonController.postUpgrade('0x', { gasLimit: 6000000 });
         await expect(tx.wait()).to.be.reverted;
     });
 });
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/utils/Deploy.ts b/utils/Deploy.ts
@@ -329,6 +329,7 @@ export const deployProxy = async (options: DeployOptions, proxy: ProxyOptions =
 // ]
 interface UpgradeProxyOptions extends DeployOptions {
     postUpgradeArgs?: TypedParam[];
+    checkVersion?: boolean;
 }
 
 export const upgradeProxy = async (options: UpgradeProxyOptions) => {
@@ -351,16 +352,17 @@ export const upgradeProxy = async (options: UpgradeProxyOptions) => {
         const values = postUpgradeArgs.map(({ value }) => value);
         const abiCoder = new AbiCoder();
 
-        upgradeCallData = [abiCoder.encode(types, values)];
+        upgradeCallData = abiCoder.encode(types, values);
     } else {
-        upgradeCallData = [ZERO_BYTES];
+        upgradeCallData = ZERO_BYTES;
     }
+    const checkVersion = options.checkVersion ?? true;
 
     const proxyOptions = {
         proxyContract: PROXY_CONTRACT,
         owner: await proxyAdmin.owner(),
         viaAdminContract: InstanceName.ProxyAdmin,
-        execute: { onUpgrade: { methodName: POST_UPGRADE, args: upgradeCallData } }
+        execute: { onUpgrade: { methodName: POST_UPGRADE, args: [checkVersion, upgradeCallData] } }
     };
 
     Logger.log(`  upgrading proxy ${contractName} V${prevVersion}`);
+6 −12		.github/workflows/ci.yml
+3 −1		.github/workflows/sync.yml
+2 −2		foundry.toml
+1 −1		package.json
+1 −1		src/StdAssertions.sol
+17 −8		src/StdChains.sol
+18 −3		src/StdInvariant.sol
+1 −1		src/StdStorage.sol
+1 −1		src/StdUtils.sol
+125 −6		src/Vm.sol
+401 −382		src/console.sol
+1 −1,555		src/console2.sol
+1 −5		src/mocks/MockERC721.sol
+12 −7		test/StdChains.t.sol
+1 −1		test/StdCheats.t.sol
+8 −0		test/StdStorage.t.sol
+2 −2		test/Vm.t.sol