refactor: Clean some TODOs (#59)

Co-authored-by: gfournieriExec <[email protected]>
Co-authored-by: Robin Le Caignec <[email protected]>

Author: 3 people

script/lib/UUPSProxyDeployer.sol

@@ -8,62 +8,56 @@ import {StdConstants} from "forge-std/StdConstants.sol";
 import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 import {ICreateX} from "@createx/contracts/ICreateX.sol";
 
-/// @notice Utility library for deploying UUPS proxy contracts and their implementations using the CreateX Factory
+/**
+ * @notice Utility library for deploying UUPS proxy contracts and their implementations
+ * using the CreateX Factory.
+ */
 library UUPSProxyDeployer {
     /// @dev Reference to the VM cheat codes from forge-std
     Vm private constant vm = StdConstants.VM;
 
-    /// @notice Deploys a UUPS proxy contract and its implementation using the 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
-    /// @return The address of the deployed proxy
+    /**
+     * Deploys a UUPS proxy contract and its implementation using the 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
+     * @return The address of the deployed proxy
+     */
     function deployUUPSProxyWithCreateX(
         string memory contractName,
         bytes memory constructorData,
         bytes memory initializeData,
         address createXFactory,
         bytes32 salt
     ) internal returns (address) {
-        // CreateX Factory instance
-        // TODO read factory address here.
-        // address createxFactory = vm.envAddress("CREATE_X_FACTORY_ADDRESS");
         ICreateX createX = ICreateX(createXFactory);
-        address implementation = deployImplementationWithCreateX(contractName, constructorData, createX, salt);
-
-        // Deploy the proxy contract using CreateX Factory
+        address implementation = deployImplementation(contractName, constructorData, createX);
         address proxy = createX.deployCreate2AndInit(
-            salt, // salt
+            salt,
             abi.encodePacked(type(ERC1967Proxy).creationCode, abi.encode(implementation, "")), // initCode
-            initializeData, // data for initialize
+            initializeData,
             ICreateX.Values({constructorAmount: 0, initCallAmount: 0}) // values for CreateX
         );
         console.log("UUPS Proxy deployed at:", proxy);
-
         return proxy;
     }
 
-    // TODO remove and deploy implementation without create2.
-
-    /// @notice Deploys the implementation contract using the 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 salt The salt for deterministic deployment
-    /// @return The address of the deployed implementation contract
-    function deployImplementationWithCreateX(
-        string memory contractName,
-        bytes memory constructorData,
-        ICreateX createXFactory,
-        bytes32 salt
-    ) internal returns (address) {
-        // Deploy the implementation contract using CreateX Factory
+    /**
+     * Deploys the implementation contract using tradition `create`.
+     * @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
+     * @return The address of the deployed implementation contract
+     */
+    function deployImplementation(string memory contractName, bytes memory constructorData, ICreateX createxFactory)
+        internal
+        returns (address)
+    {
         bytes memory creationCode = vm.getCode(contractName);
-        address implementation = createXFactory.deployCreate2(salt, abi.encodePacked(creationCode, constructorData));
+        address implementation = createxFactory.deployCreate(abi.encodePacked(creationCode, constructorData));
         console.log("Implementation deployed at:", implementation);
-
         return implementation;
     }
 }

src/mocks/IexecLayerZeroBridgeV2Mock.sol

@@ -12,7 +12,7 @@ import {IexecLayerZeroBridge} from "../bridges/layerZero/IexecLayerZeroBridge.so
  * @custom:oz-upgrades-from src/bridges/layerZero/IexecLayerZeroBridge.sol:IexecLayerZeroBridge
  */
 contract IexecLayerZeroBridgeV2 is IexecLayerZeroBridge {
-    /// NEW STATE VARIABLES FOR V2
+    // New state variable for v2.
     uint256 public newStateVariable;
 
     /// @custom:oz-upgrades-unsafe-allow constructor

src/mocks/RLCLiquidityUnifierV2Mock.sol

@@ -12,7 +12,7 @@ import {RLCLiquidityUnifier} from "../RLCLiquidityUnifier.sol";
  * @custom:oz-upgrades-from src/RLCLiquidityUnifier.sol:RLCLiquidityUnifier
  */
 contract RLCLiquidityUnifierV2 is RLCLiquidityUnifier {
-    /// NEW STATE VARIABLES FOR V2
+    /// New state variable for v2.
     uint256 public newStateVariable;
 
     /// @custom:oz-upgrades-unsafe-allow constructor

test/e2e/IexecLayerZeroBridgeScript.t.sol

@@ -4,6 +4,7 @@
 pragma solidity ^0.8.22;
 
 import {Test} from "forge-std/Test.sol";
+import {CreateX} from "@createx/contracts/CreateX.sol";
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import {Deploy as IexecLayerZeroBridgeDeploy} from "../../script/bridges/layerZero/IexecLayerZeroBridge.s.sol";
 import {Deploy as RLCLiquidityUnifierDeployScript} from "../../script/RLCLiquidityUnifier.s.sol";
@@ -65,6 +66,10 @@ contract IexecLayerZeroBridgeScriptTest is Test {
     }
 
     function _test_Deployment(bool requireApproval, address bridgeableToken) internal {
+        // Check that CreateX salt is used to deploy the contract.
+        vm.expectEmit(false, true, false, false);
+        // CreateX uses a guarded salt (see CreateX._guard()), so we need to hash it to match the expected event.
+        emit CreateX.ContractCreation(address(0), keccak256(abi.encode(salt)));
         IexecLayerZeroBridge iexecLayerZeroBridge = IexecLayerZeroBridge(
             deployer.deploy(
                 requireApproval,
@@ -96,16 +101,6 @@ 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 {

test/units/RLCCrosschainTokenScript.t.sol

@@ -21,6 +21,10 @@ contract RLCCrosschainTokenTest is Test {
     function setUp() public {}
 
     function test_Deploy() public {
+        // Check that CreateX salt is used to deploy the contract.
+        vm.expectEmit(false, true, false, false);
+        // CreateX uses a guarded salt (see CreateX._guard()), so we need to hash it to match the expected event.
+        emit CreateX.ContractCreation(address(0), keccak256(abi.encode(salt)));
         address crosschainTokenAddress = deployer.deploy(name, symbol, admin, upgrader, createx, salt);
         RLCCrosschainToken rlcCrosschainToken = RLCCrosschainToken(crosschainTokenAddress);
         assertEq(rlcCrosschainToken.name(), name);
@@ -38,12 +42,4 @@ 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);
-    }
 }

test/units/RLCLiquidityUnifierScript.t.sol

@@ -20,6 +20,10 @@ contract LiquidityUnifierTest is Test {
     function setUp() public {}
 
     function test_Deploy() public {
+        // Check that CreateX salt is used to deploy the contract.
+        vm.expectEmit(false, true, false, false);
+        // CreateX uses a guarded salt (see CreateX._guard()), so we need to hash it to match the expected event.
+        emit CreateX.ContractCreation(address(0), keccak256(abi.encode(salt)));
         address rlcLiquidityUnifierAddress = deployer.deploy(rlcToken, admin, upgrader, createx, salt);
         RLCLiquidityUnifier rlcLiquidityUnifier = RLCLiquidityUnifier(rlcLiquidityUnifierAddress);
         assertEq(rlcLiquidityUnifier.owner(), admin);
@@ -31,12 +35,4 @@ 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);
-    }
 }