fix: Restore implementation deployment using CreateX (#72)

zguesmi · web-flow · commit 166593ccdf71 · 2025-07-08T09:25:10.000+02:00
diff --git a/docs/soldoc/src/README.md b/docs/soldoc/src/README.md
@@ -5,7 +5,7 @@ This project implements a cross-chain token bridge system for the RLC token usin
 ## Diagrams and source code docs (soldocs):
 
   - [Diagrams](../../diagrams/)
-  - [Source code docs](../../soldoc/)
+  - [Source code docs](../../soldoc/src/SUMMARY.md)
 
 ## Architecture
 
diff --git a/script/RLCCrosschainToken.s.sol b/script/RLCCrosschainToken.s.sol
@@ -58,8 +58,6 @@ contract Deploy is Script {
     ) public returns (address) {
         bytes memory initData =
             abi.encodeWithSelector(RLCCrosschainToken.initialize.selector, name, symbol, initialAdmin, initialUpgrader);
-        return UUPSProxyDeployer.deployUUPSProxyWithCreateX(
-            "RLCCrosschainToken", "", initData, createxFactory, createxSalt
-        );
+        return UUPSProxyDeployer.deployUsingCreateX("RLCCrosschainToken", "", initData, createxFactory, createxSalt);
     }
 }
diff --git a/script/RLCLiquidityUnifier.s.sol b/script/RLCLiquidityUnifier.s.sol
@@ -57,7 +57,7 @@ contract Deploy is Script {
         bytes memory constructorData = abi.encode(rlcToken);
         bytes memory initData =
             abi.encodeWithSelector(RLCLiquidityUnifier.initialize.selector, initialAdmin, initialUpgrader);
-        return UUPSProxyDeployer.deployUUPSProxyWithCreateX(
+        return UUPSProxyDeployer.deployUsingCreateX(
             "RLCLiquidityUnifier", constructorData, initData, createxFactory, createxSalt
         );
     }
diff --git a/script/bridges/layerZero/IexecLayerZeroBridge.s.sol b/script/bridges/layerZero/IexecLayerZeroBridge.s.sol
@@ -53,7 +53,7 @@ contract Deploy is Script {
         bytes memory initializeData = abi.encodeWithSelector(
             IexecLayerZeroBridge.initialize.selector, initialAdmin, initialUpgrader, initialPauser
         );
-        return UUPSProxyDeployer.deployUUPSProxyWithCreateX(
+        return UUPSProxyDeployer.deployUsingCreateX(
             "IexecLayerZeroBridge", constructorData, initializeData, createxFactory, createxSalt
         );
     }
diff --git a/script/lib/UUPSProxyDeployer.sol b/script/lib/UUPSProxyDeployer.sol
@@ -17,25 +17,25 @@ library UUPSProxyDeployer {
     Vm private constant vm = StdConstants.VM;
 
     /**
-     * Deploys a UUPS proxy contract and its implementation using the CreateX Factory
+     * Deploys a UUPS proxy contract and its implementation in create2 mode using CreateX Factory.
      * @param contractName The name of the contract to deploy (used to fetch creation code)
      * @param constructorData The constructor arguments for the implementation contract
      * @param initializeData The initialization data for the proxy contract
-     * @param createXFactory The address of the CreateX factory
-     * @param salt The salt for deterministic deployment
+     * @param createxFactory The address of the CreateX factory
+     * @param createxSalt The salt for deterministic deployment
      * @return The address of the deployed proxy
      */
-    function deployUUPSProxyWithCreateX(
+    function deployUsingCreateX(
         string memory contractName,
         bytes memory constructorData,
         bytes memory initializeData,
-        address createXFactory,
-        bytes32 salt
+        address createxFactory,
+        bytes32 createxSalt
     ) internal returns (address) {
-        ICreateX createX = ICreateX(createXFactory);
-        address implementation = deployImplementation(contractName, constructorData, createX);
-        address proxy = createX.deployCreate2AndInit(
-            salt,
+        address implementation =
+            deployImplementationUsingCreateX(contractName, constructorData, createxFactory, createxSalt);
+        address proxy = ICreateX(createxFactory).deployCreate2AndInit(
+            createxSalt,
             abi.encodePacked(type(ERC1967Proxy).creationCode, abi.encode(implementation, "")), // initCode
             initializeData,
             ICreateX.Values({constructorAmount: 0, initCallAmount: 0}) // values for CreateX
@@ -45,18 +45,22 @@ library UUPSProxyDeployer {
     }
 
     /**
-     * Deploys the implementation contract using tradition `create`.
+     * Deploys the implementation contract in create2 mode using CreateX factory.
      * @param contractName The name of the contract to deploy (used to fetch creation code)
      * @param constructorData The constructor arguments for the implementation contract
      * @param createxFactory The address of the CreateX factory
+     * @param createxSalt The salt for deterministic deployment
      * @return The address of the deployed implementation contract
      */
-    function deployImplementation(string memory contractName, bytes memory constructorData, ICreateX createxFactory)
-        internal
-        returns (address)
-    {
+    function deployImplementationUsingCreateX(
+        string memory contractName,
+        bytes memory constructorData,
+        address createxFactory,
+        bytes32 createxSalt
+    ) internal returns (address) {
         bytes memory creationCode = vm.getCode(contractName);
-        address implementation = createxFactory.deployCreate(abi.encodePacked(creationCode, constructorData));
+        address implementation =
+            ICreateX(createxFactory).deployCreate2(createxSalt, abi.encodePacked(creationCode, constructorData));
         console.log("Implementation deployed at:", implementation);
         return implementation;
     }
diff --git a/test/e2e/IexecLayerZeroBridgeScript.t.sol b/test/e2e/IexecLayerZeroBridgeScript.t.sol
@@ -101,6 +101,16 @@ contract IexecLayerZeroBridgeScriptTest is Test {
         // TODO check that the proxy address is saved.
     }
 
+    function testFork_RevertWhen_TwoDeploymentsWithTheSameSalt() public {
+        deployer.deploy(
+            false, address(rlcCrosschainToken), params.lzEndpoint, admin, upgrader, pauser, params.createxFactory, salt
+        );
+        vm.expectRevert(abi.encodeWithSignature("FailedContractCreation(address)", params.createxFactory));
+        deployer.deploy(
+            false, address(rlcCrosschainToken), params.lzEndpoint, admin, upgrader, pauser, params.createxFactory, salt
+        );
+    }
+
     // TODO: add tests for the configuration script.
 
     function testFork_ConfigureContractCorrectly() public {
diff --git a/test/units/RLCCrosschainTokenScript.t.sol b/test/units/RLCCrosschainTokenScript.t.sol
@@ -42,4 +42,12 @@ contract RLCCrosschainTokenTest is Test {
 
         // TODO check that the proxy address is saved.
     }
+
+    // Makes sure create2 deployment is well implemented.
+    function test_RevertWhen_TwoDeploymentsWithTheSameSalt() public {
+        address random = makeAddr("random");
+        deployer.deploy(name, symbol, admin, upgrader, createx, salt);
+        vm.expectRevert(abi.encodeWithSignature("FailedContractCreation(address)", createx));
+        deployer.deploy("Foo", "BAR", random, random, createx, salt);
+    }
 }
diff --git a/test/units/RLCLiquidityUnifierScript.t.sol b/test/units/RLCLiquidityUnifierScript.t.sol
@@ -35,4 +35,12 @@ contract LiquidityUnifierTest is Test {
         rlcLiquidityUnifier.initialize(admin, upgrader);
         // TODO check that the proxy address is saved.
     }
+
+    // Makes sure create2 deployment is well implemented.
+    function test_RevertWhen_TwoDeploymentsWithTheSameSalt() public {
+        address random = makeAddr("random");
+        deployer.deploy(rlcToken, admin, upgrader, createx, salt);
+        vm.expectRevert(abi.encodeWithSignature("FailedContractCreation(address)", createx));
+        deployer.deploy(rlcToken, random, random, createx, salt);
+    }
 }
diff --git a/test/units/utils/TestUtils.sol b/test/units/utils/TestUtils.sol
@@ -45,7 +45,7 @@ library TestUtils {
 
         // Deploy Liquidity Unifier
         rlcLiquidityUnifier = RLCLiquidityUnifier(
-            UUPSProxyDeployer.deployUUPSProxyWithCreateX(
+            UUPSProxyDeployer.deployUsingCreateX(
                 "RLCLiquidityUnifier",
                 abi.encode(rlcToken),
                 abi.encodeWithSelector(RLCLiquidityUnifier.initialize.selector, initialAdmin, initialUpgrader),
@@ -56,7 +56,7 @@ library TestUtils {
 
         // Deploy IexecLayerZeroBridgeAdapter
         iexecLayerZeroBridgeChainA = IexecLayerZeroBridge(
-            UUPSProxyDeployer.deployUUPSProxyWithCreateX(
+            UUPSProxyDeployer.deployUsingCreateX(
                 "IexecLayerZeroBridge",
                 abi.encode(true, rlcLiquidityUnifier, lzEndpointSource),
                 abi.encodeWithSelector(
@@ -75,7 +75,7 @@ library TestUtils {
         );
         // Deploy IexecLayerZeroBridge
         iexecLayerZeroBridgeChainB = IexecLayerZeroBridge(
-            UUPSProxyDeployer.deployUUPSProxyWithCreateX(
+            UUPSProxyDeployer.deployUsingCreateX(
                 "IexecLayerZeroBridge",
                 abi.encode(false, rlcCrosschainToken, lzEndpointDestination),
                 abi.encodeWithSelector(

Original file line number	Diff line number	Diff line change
`@@ -58,8 +58,6 @@ contract Deploy is Script {`
`58`	`58`	`) public returns (address) {`
`59`	`59`	`bytes memory initData =`
`60`	`60`	`abi.encodeWithSelector(RLCCrosschainToken.initialize.selector, name, symbol, initialAdmin, initialUpgrader);`
`61`		`- return UUPSProxyDeployer.deployUUPSProxyWithCreateX(`
`62`		`- "RLCCrosschainToken", "", initData, createxFactory, createxSalt`
`63`		`- );`
	`61`	`+ return UUPSProxyDeployer.deployUsingCreateX("RLCCrosschainToken", "", initData, createxFactory, createxSalt);`
`64`	`62`	`}`
`65`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ contract Deploy is Script {`
`57`	`57`	`bytes memory constructorData = abi.encode(rlcToken);`
`58`	`58`	`bytes memory initData =`
`59`	`59`	`abi.encodeWithSelector(RLCLiquidityUnifier.initialize.selector, initialAdmin, initialUpgrader);`
`60`		`- return UUPSProxyDeployer.deployUUPSProxyWithCreateX(`
	`60`	`+ return UUPSProxyDeployer.deployUsingCreateX(`
`61`	`61`	`"RLCLiquidityUnifier", constructorData, initData, createxFactory, createxSalt`
`62`	`62`	`);`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ contract Deploy is Script {`
`53`	`53`	`bytes memory initializeData = abi.encodeWithSelector(`
`54`	`54`	`IexecLayerZeroBridge.initialize.selector, initialAdmin, initialUpgrader, initialPauser`
`55`	`55`	`);`
`56`		`- return UUPSProxyDeployer.deployUUPSProxyWithCreateX(`
	`56`	`+ return UUPSProxyDeployer.deployUsingCreateX(`
`57`	`57`	`"IexecLayerZeroBridge", constructorData, initializeData, createxFactory, createxSalt`
`58`	`58`	`);`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,4 +42,12 @@ contract RLCCrosschainTokenTest is Test {`
`42`	`42`
`43`	`43`	`// TODO check that the proxy address is saved.`
`44`	`44`	`}`
	`45`	`+`
	`46`	`+ // Makes sure create2 deployment is well implemented.`
	`47`	`+ function test_RevertWhen_TwoDeploymentsWithTheSameSalt() public {`
	`48`	`+ address random = makeAddr("random");`
	`49`	`+ deployer.deploy(name, symbol, admin, upgrader, createx, salt);`
	`50`	`+ vm.expectRevert(abi.encodeWithSignature("FailedContractCreation(address)", createx));`
	`51`	`+ deployer.deploy("Foo", "BAR", random, random, createx, salt);`
	`52`	`+ }`
`45`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,12 @@ contract LiquidityUnifierTest is Test {`
`35`	`35`	`rlcLiquidityUnifier.initialize(admin, upgrader);`
`36`	`36`	`// TODO check that the proxy address is saved.`
`37`	`37`	`}`
	`38`	`+`
	`39`	`+ // Makes sure create2 deployment is well implemented.`
	`40`	`+ function test_RevertWhen_TwoDeploymentsWithTheSameSalt() public {`
	`41`	`+ address random = makeAddr("random");`
	`42`	`+ deployer.deploy(rlcToken, admin, upgrader, createx, salt);`
	`43`	`+ vm.expectRevert(abi.encodeWithSignature("FailedContractCreation(address)", createx));`
	`44`	`+ deployer.deploy(rlcToken, random, random, createx, salt);`
	`45`	`+ }`
`38`	`46`	`}`