wip

Author: zguesmi

script/RLCCrosschainToken.s.sol

@@ -4,7 +4,7 @@
 pragma solidity ^0.8.22;
 
 import {Script} from "forge-std/Script.sol";
-import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";
+import {Options} from "openzeppelin-foundry-upgrades/Upgrades.sol";
 import {RLCCrosschainToken} from "../src/RLCCrosschainToken.sol";
 import {UUPSProxyUtils} from "./lib/UUPSProxyUtils.sol";
 import {ConfigLib} from "./lib/ConfigLib.sol";
@@ -65,12 +65,24 @@ contract Deploy is Script {
 contract Upgrade is Script {
     function run() external {
         vm.startBroadcast();
-        UUPSProxyUtils.upgrade({
+        upgrade({
             proxyAddress: address(0), // Replace with the actual proxy address
             contractName: "", // e.g., "ContractV2.sol:ContractV2"
             constructorData: new bytes(0), // Replace with the actual constructor data
             initData: new bytes(0) // Replace with the actual initialization data
         });
         vm.stopBroadcast();
     }
+
+    // TODO add tests in `RLCCrosschainTokenUpgrade.t.sol`.
+    function upgrade(
+        address proxyAddress,
+        string memory contractName,
+        bytes memory constructorData,
+        bytes memory initData
+    ) public {
+        Options memory opts;
+        opts.constructorData = constructorData;
+        UUPSProxyUtils.executeUpgrade(proxyAddress, contractName, initData, opts);
+    }
 }

script/RLCLiquidityUnifier.s.sol

@@ -4,7 +4,7 @@
 pragma solidity ^0.8.22;
 
 import {Script} from "forge-std/Script.sol";
-import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";
+import {Options} from "openzeppelin-foundry-upgrades/Upgrades.sol";
 import {RLCLiquidityUnifier} from "../src/RLCLiquidityUnifier.sol";
 import {UUPSProxyUtils} from "./lib/UUPSProxyUtils.sol";
 import {ConfigLib} from "./lib/ConfigLib.sol";
@@ -65,12 +65,23 @@ contract Deploy is Script {
 contract Upgrade is Script {
     function run() external {
         vm.startBroadcast();
-        UUPSProxyUtils.upgrade({
+        upgrade({
             proxyAddress: address(0), // Replace with the actual proxy address
             contractName: "", // e.g., "ContractV2.sol:ContractV2"
             constructorData: new bytes(0), // Replace with the actual constructor data
             initData: new bytes(0) // Replace with the actual initialization data
         });
         vm.stopBroadcast();
     }
+
+    function upgrade(
+        address proxyAddress,
+        string memory contractName,
+        bytes memory constructorData,
+        bytes memory initData
+    ) public {
+        Options memory opts;
+        opts.constructorData = constructorData;
+        UUPSProxyUtils.executeUpgrade(proxyAddress, contractName, initData, opts);
+    }
 }

script/bridges/layerZero/IexecLayerZeroBridge.s.sol

@@ -3,7 +3,7 @@
 pragma solidity ^0.8.22;
 
 import {Script} from "forge-std/Script.sol";
-import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";
+import {Options} from "openzeppelin-foundry-upgrades/Upgrades.sol";
 import {EnforcedOptionParam} from "@layerzerolabs/oapp-evm/contracts/oapp/libs/OAppOptionsType3.sol";
 import {OptionsBuilder} from "@layerzerolabs/oapp-evm/contracts/oapp/libs/OptionsBuilder.sol";
 import {ConfigLib} from "./../../lib/ConfigLib.sol";
@@ -100,12 +100,29 @@ contract Configure is Script {
 contract Upgrade is Script {
     function run() external {
         vm.startBroadcast();
-        UUPSProxyUtils.upgrade({
+        upgrade({
             proxyAddress: address(0), // Replace with the actual proxy address
             contractName: "", // e.g., "ContractV2.sol:ContractV2"
             constructorData: new bytes(0), // Replace with the actual constructor data
             initData: new bytes(0) // Replace with the actual initialization data
         });
         vm.stopBroadcast();
     }
+
+    function upgrade(
+        address proxyAddress,
+        string memory contractName,
+        bytes memory constructorData,
+        bytes memory initData
+    ) public {
+        Options memory opts;
+        opts.constructorData = constructorData;
+        // Ignore checks related to LayerZero contracts:
+        // - OAppSenderUpgradeable
+        // - OAppReceiverUpgradeable
+        // - OFTCoreUpgradeable
+        // - OAppCoreUpgradeable
+        opts.unsafeAllow = "constructor,state-variable-immutable,missing-initializer-call";
+        UUPSProxyUtils.executeUpgrade(proxyAddress, contractName, initData, opts);
+    }
 }

script/lib/UUPSProxyDeployer.sol

@@ -69,25 +69,17 @@ library UUPSProxyUtils {
     /**
      * Upgrades a UUPS proxy contract to a new implementation.
      * @param proxyAddress address of the UUPS proxy contract to upgrade
-     * @param contractName name of the contract to upgrade (used to fetch creation code)
-     * @param constructorData constructor arguments for the new implementation contract
+     * @param contractName name of the contract to upgrade (e.g. "ContractV2.sol:ContractV2")
+     * @param opts options for the upgrade, such as unsafeAllow and others.
      * @param initData initialization data for the proxy contract after upgrade
      * @return newImplementation address of the new implementation contract
      */
-    function upgrade(
+    function executeUpgrade(
         address proxyAddress,
         string memory contractName,
-        bytes memory constructorData,
-        bytes memory initData
+        bytes memory initData,
+        Options memory opts
     ) internal returns (address newImplementation) {
-        Options memory opts;
-        opts.constructorData = constructorData;
-        // Ignore checks related to LayerZero contracts:
-        // - OAppSenderUpgradeable
-        // - OAppReceiverUpgradeable
-        // - OFTCoreUpgradeable
-        // - OAppCoreUpgradeable
-        opts.unsafeAllow = "constructor,state-variable-immutable,missing-initializer-call";
         Upgrades.upgradeProxy(proxyAddress, contractName, initData, opts);
         newImplementation = Upgrades.getImplementationAddress(proxyAddress);
         console.log("Upgraded", contractName, " proxy to new implementation", newImplementation);

script/lib/UUPSProxyUtils.sol

@@ -8,7 +8,9 @@ import {TestUtils} from "./utils/TestUtils.sol";
 import {UUPSProxyUtils} from "../../script/lib/UUPSProxyUtils.sol";
 import {RLCMock} from "./mocks/RLCMock.sol";
 import {RLCLiquidityUnifierV2} from "./mocks/RLCLiquidityUnifierV2Mock.sol";
+import {Upgrade as RLCLiquidityUnifierUpgradeScript} from "../../script/RLCLiquidityUnifier.s.sol";
 
+// TODO remove useless LZ setup (endpoint, ...).
 contract RLCLiquidityUnifierUpgradeTest is TestHelperOz5 {
     using TestUtils for *;
 
@@ -57,7 +59,7 @@ contract RLCLiquidityUnifierUpgradeTest is TestHelperOz5 {
 
         // 3. Perform upgrade
         vm.startPrank(upgrader);
-        UUPSProxyUtils.upgrade({
+        new RLCLiquidityUnifierUpgradeScript().upgrade({
             proxyAddress: proxyAddress,
             contractName:  "RLCLiquidityUnifierV2Mock.sol:RLCLiquidityUnifierV2",
             constructorData: abi.encode(rlcToken),

test/units/RLCLiquidityUnifierUpgrade.t.sol

@@ -8,6 +8,7 @@ import {TestUtils} from "./../../utils/TestUtils.sol";
 import {UUPSProxyUtils} from "../../../../script/lib/UUPSProxyUtils.sol";
 import {IexecLayerZeroBridge} from "../../../../src/bridges/layerZero/IexecLayerZeroBridge.sol";
 import {RLCCrosschainToken} from "../../../../src/RLCCrosschainToken.sol";
+import {Upgrade as IexecLayerZeroBridgeUpgradeScript} from "../../../../script/bridges/layerZero/IexecLayerZeroBridge.s.sol";
 
 contract IexecLayerZeroBridgeUpgradeTest is TestHelperOz5 {
     using TestUtils for *;
@@ -53,7 +54,7 @@ contract IexecLayerZeroBridgeUpgradeTest is TestHelperOz5 {
 
         // 3. Perform upgrade
         vm.startPrank(upgrader);
-        UUPSProxyUtils.upgrade({
+        new IexecLayerZeroBridgeUpgradeScript().upgrade({
             proxyAddress: proxyAddress,
             contractName:  "IexecLayerZeroBridgeV2Mock.sol:IexecLayerZeroBridgeV2",
             constructorData: abi.encode(false, rlcCrosschainToken, mockEndpoint),