refactor: Rename lzChainId to lzEndpointId (#91)

Author: zguesmi

README.md

@@ -123,7 +123,7 @@ The bridge currently supports:
 #### **Testnets**
 - **Ethereum Sepolia** ↔ **Arbitrum Sepolia**
 
-#### **Mainnets**  
+#### **Mainnets**
 - **Ethereum Mainnet** ↔ **Arbitrum Mainnet**
 
 ### Bridge RLC on Testnets
@@ -333,14 +333,24 @@ The scripts automatically calculate these fees and include them in the transacti
 - [Forge Coverage](https://book.getfoundry.sh/reference/forge/forge-coverage)
 - [iExec Platform Documentation](https://docs.iex.ec/)
 
+## How to release:
+
+* First, deploy on Testnets and make sure all tests are ok.
+* Create a release branch `release/X.X.X` that starts from the `main` branch.
+   - Note that GitHub environments `arbitrum` and `ethereum` can only be used with `release/*` branches. The `main` branch cannot be used as the CI will not be able to commit deployment artifacts.
+* Commit required changes (salt, ...)
+* Go to "Actions" section on GitHub
+* Trigger `Deploy contracts` job and choose the correct release branch and the target Github environment.
+
 ## TODO
 
 - Use an enterprise RPC URL for `secrets.SEPOLIA_RPC_URL` in Github environment `ci`.
 - Add git pre-commit hook to format code locally.
 - Testing Documentation
-- Parametrize config.json to not overide btw mainnet and testnets
+- Parametrize the following addresses by chain in `config.json`:
 ```
   "initialAdmin": "0x111165a109feca14e4ad4d805f6460c7d206ead1",
   "initialUpgrader": "0x111121e2ec2557f484f65d5b1ad2b6b07b8acd23",
   "initialPauser": "0x11113fe3513787f5a4f5f19690700e2736b3056e",
-``` 
+```
+- Clean README.md

config/config.json

@@ -12,7 +12,7 @@
       "iexecLayerZeroBridgeAddress": "0xA18e571f91ab58889C348E1764fBaBF622ab89b5",
       "iexecLayerZeroBridgeCreatexSalt": "0x4f2784ad07b2be2a5c5e466c91d758133f4aa33bd4cf09ddba1a1e1035e57875",
       "lzEndpointAddress": "0x6EDCE65403992e310A62460808c4b910D972f10f",
-      "lzChainId": 40161
+      "lzEndpointId": 40161
     },
     "arbitrum_sepolia": {
       "approvalRequired": false,
@@ -21,7 +21,7 @@
       "iexecLayerZeroBridgeAddress": "0xB560ae1dD7FdF011Ead2189510ae08f2dbD168a5",
       "iexecLayerZeroBridgeCreatexSalt": "0x4f2784ad07b2be2a5c5e466c91d758133f4aa33bd4cf09ddba1a1e1035e57875",
       "lzEndpointAddress": "0x6EDCE65403992e310A62460808c4b910D972f10f",
-      "lzChainId": 40231
+      "lzEndpointId": 40231
     },
     "ethereum": {
       "approvalRequired": true,
@@ -31,7 +31,7 @@
       "iexecLayerZeroBridgeAddress": "0xA8Bc0B19b955c8AC38C8Cbc9383866b834Cd33d8",
       "iexecLayerZeroBridgeCreatexSalt": "0x0000000000000000000000000000000000000000000000000000000000000000",
       "lzEndpointAddress": "0x1a44076050125825900e736c501f859c50fE728c",
-      "lzChainId": 30101
+      "lzEndpointId": 30101
     },
     "arbitrum": {
       "approvalRequired": false,
@@ -40,7 +40,7 @@
       "iexecLayerZeroBridgeAddress": "0x7000e96D0Bfc74cf5259aEDaE6065B39B3888699",
       "iexecLayerZeroBridgeCreatexSalt": "0x0000000000000000000000000000000000000000000000000000000000000001",
       "lzEndpointAddress": "0x1a44076050125825900e736c501f859c50fE728c",
-      "lzChainId": 30110
+      "lzEndpointId": 30110
     }
   }
 }

script/SendFromArbitrumToEthereum.s.sol

@@ -49,7 +49,7 @@ contract SendFromArbitrumToEthereum is Script {
 
         // Prepare send parameters
         SendParam memory sendParam = SendParam(
-            uint16(targetParams.lzChainId), // Destination endpoint ID
+            uint16(targetParams.lzEndpointId), // Destination endpoint ID
             addressToBytes32(recipient), // Recipient address
             TRANSFER_AMOUNT, // Amount to send in local decimals
             TRANSFER_AMOUNT * 99 / 100, // Minimum amount to send (allowing 1% slippage)

script/SendFromEthereumToArbitrum.s.sol

@@ -45,7 +45,7 @@ contract SendFromEthereumToArbitrum is Script {
 
         // Prepare send parameters
         SendParam memory sendParam = SendParam(
-            uint16(targetParams.lzChainId), // Destination endpoint ID
+            uint16(targetParams.lzEndpointId), // Destination endpoint ID
             addressToBytes32(recipient), // Recipient address
             TRANSFER_AMOUNT, // Amount to send in local decimals
             TRANSFER_AMOUNT * 99 / 100, // Minimum amount to send (allowing 1% slippage)

script/bridges/layerZero/IexecLayerZeroBridge.s.sol

@@ -70,12 +70,12 @@ contract Configure is Script {
         IexecLayerZeroBridge sourceBridge = IexecLayerZeroBridge(sourceParams.iexecLayerZeroBridgeAddress);
         vm.startBroadcast();
         sourceBridge.setPeer(
-            targetParams.lzChainId, bytes32(uint256(uint160(targetParams.iexecLayerZeroBridgeAddress)))
+            targetParams.lzEndpointId, bytes32(uint256(uint160(targetParams.iexecLayerZeroBridgeAddress)))
         );
         EnforcedOptionParam[] memory enforcedOptions = new EnforcedOptionParam[](2);
         bytes memory _extraOptions = OptionsBuilder.newOptions().addExecutorLzReceiveOption(90_000, 0); // 90_000 gas limit for the receiving executor and 0 for the executor's value
-        enforcedOptions[0] = EnforcedOptionParam(targetParams.lzChainId, 1, _extraOptions); // lzReceive
-        enforcedOptions[1] = EnforcedOptionParam(targetParams.lzChainId, 2, _extraOptions); // lzCompose
+        enforcedOptions[0] = EnforcedOptionParam(targetParams.lzEndpointId, 1, _extraOptions); // lzReceive
+        enforcedOptions[1] = EnforcedOptionParam(targetParams.lzEndpointId, 2, _extraOptions); // lzCompose
         sourceBridge.setEnforcedOptions(enforcedOptions);
         // Authorize bridge in the relevant contract.
         if (sourceParams.approvalRequired) {

script/lib/ConfigLib.sol

@@ -25,7 +25,7 @@ library ConfigLib {
         address initialUpgrader;
         address createxFactory;
         address lzEndpoint;
-        uint32 lzChainId;
+        uint32 lzEndpointId;
         address rlcToken; // RLC token address (already deployed on L1)
         bytes32 rlcLiquidityUnifierCreatexSalt; // Salt for CreateX deployment of the RLC Liquidity Unifier
         address rlcLiquidityUnifierAddress; // RLC Liquidity Unifier address (only on L1)
@@ -118,7 +118,7 @@ library ConfigLib {
         params.approvalRequired = config.readBool(string.concat(prefix, ".approvalRequired"));
         params.iexecLayerZeroBridgeAddress = config.readAddress(string.concat(prefix, ".iexecLayerZeroBridgeAddress"));
         params.lzEndpoint = config.readAddress(string.concat(prefix, ".lzEndpointAddress"));
-        params.lzChainId = uint32(config.readUint(string.concat(prefix, ".lzChainId")));
+        params.lzEndpointId = uint32(config.readUint(string.concat(prefix, ".lzEndpointId")));
     }
 
     /**