Layer Zero integration

.env.example

@@ -5,4 +5,5 @@ mumbai=
 sepolia=
 basesepolia=
 arbitrumsepolia=
-optimismsepolia=
+optimismsepolia=
+basttestnet=

.gitmodules

@@ -7,3 +7,9 @@
 [submodule "lib/vibc-core-smart-contracts"]
 	path = lib/vibc-core-smart-contracts
 	url = https://github.com/open-ibc/vibc-core-smart-contracts
+[submodule "lib/LayerZero-v2"]
+	path = lib/LayerZero-v2
+	url = https://github.com/LayerZero-Labs/LayerZero-v2
+[submodule "lib/solidity-bytes-utils"]
+	path = lib/solidity-bytes-utils
+	url = https://github.com/GNSPS/solidity-bytes-utils

remappings.txt

@@ -1,3 +1,7 @@
 forge-std/=lib/forge-std/src/
 openzeppelin/=lib/openzeppelin-contracts/contracts/
-vibc-core-smart-contracts/=lib/vibc-core-smart-contracts/contracts/
+vibc-core-smart-contracts/=lib/vibc-core-smart-contracts/contracts/
+@openzeppelin/=lib/openzeppelin-contracts/
+@layerzerolabs/lz-evm-protocol-v2/=lib/LayerZero-v2/protocol/
+
+solidity-bytes-utils/=lib/solidity-bytes-utils/

script/Deploy.sol

@@ -10,6 +10,7 @@ import { BaseMultiChainDeployer} from "./BaseMultiChainDeployer.s.sol";
 import { IncentivizedMockEscrow } from "../src/apps/mock/IncentivizedMockEscrow.sol";
 import { IncentivizedWormholeEscrow } from "../src/apps/wormhole/IncentivizedWormholeEscrow.sol";
 import { IncentivizedPolymerEscrow } from "../src/apps/polymer/vIBCEscrow.sol";
+import { IncentivizedLayerZeroEscrow } from "../src/apps/layerzero/IncentivizedLayerZeroEscrow.sol";
 
 contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
     using stdJson for string;
@@ -29,6 +30,7 @@ contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
     // define a list of AMB mappings so we can get their addresses.
     mapping(string => mapping(string => address)) bridgeContract;
 
+
     constructor() {
         // Here we can define input salts. These are always assumed to be dependent on the secondary argument
         // to an AMB. (as the first should be send lost gas to which is fixed.)
@@ -93,6 +95,24 @@ contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
             IncentivizedPolymerEscrow polymerEscrow = new IncentivizedPolymerEscrow{salt: salt}(vm.envAddress("SEND_LOST_GAS_TO"), polymerBridgeContract);
 
             incentive = address(polymerEscrow);
+
+        } else if (versionHash == keccak256(abi.encodePacked("LayerZero"))) {
+            address layerZeroBridgeContract = bridgeContract[version][currentChainKey];
+            bytes32 salt = deploySalts[layerZeroBridgeContract];
+            require(layerZeroBridgeContract != address(0), "bridge cannot be address(0)");
+
+            address expectedAddress = _getAddress(
+                abi.encodePacked(
+                    type(IncentivizedLayerZeroEscrow).creationCode,
+                    abi.encode(vm.envAddress("SEND_LOST_GAS_TO"), layerZeroBridgeContract)
+                ),
+                salt
+            );
+
+            if (expectedAddress.codehash != bytes32(0)) return expectedAddress;
+
+            IncentivizedLayerZeroEscrow layerZeroEscrow = new IncentivizedLayerZeroEscrow{salt: salt}(vm.envAddress("SEND_LOST_GAS_TO"), layerZeroBridgeContract);
+            incentive = address(layerZeroEscrow);
         } else {
             revert IncentivesVersionNotFound();
         }
@@ -106,8 +126,7 @@ contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
         return incentive;
     }
 
-    modifier load_config() {
-
+modifier load_config() {
         string memory pathRoot = vm.projectRoot();
         pathToAmbConfig = string.concat(pathRoot, "/script/bridge_contracts.json");
 
@@ -119,11 +138,11 @@ contract DeployGeneralisedIncentives is BaseMultiChainDeployer {
         // For each bridge, decode their contracts for each chain.
         for (uint256 i = 0; i < availableBridges.length; ++i) {
             string memory bridge = availableBridges[i];
-            // Get the chains this bridge support.
+            // Get the chains this bridge supports.
             string[] memory availableBridgesChains = vm.parseJsonKeys(bridge_config, string.concat(".", bridge));
             for (uint256 j = 0; j < availableBridgesChains.length; ++j) {
                 string memory chain = availableBridgesChains[j];
-                // decode the address
+                // Decode the address
                 address _bridgeContract = vm.parseJsonAddress(bridge_config, string.concat(".", bridge, ".", chain, ".bridge"));
                 bridgeContract[bridge][chain] = _bridgeContract;
             }

script/bridge_contracts.json

@@ -46,5 +46,19 @@
       "bridge": "0xE2029629f51ab994210d671Dc08b7Ec94899b278",
       "escrow": "0x87AE7bC6B565E545bDD51788C43BF9E5cbB72EBD"
     }
+  },
+  "LayerZero": {
+    "basesepolia": {
+      "bridge": "0x6EDCE65403992e310A62460808c4b910D972f10f",
+      "escrow": "0x495691fafcf2E0c8554bfD6eA67698BCD9795eec"
+    },
+    "optimismsepolia": {
+      "bridge": "0x6EDCE65403992e310A62460808c4b910D972f10f",
+      "escrow": "0x495691fafcf2E0c8554bfD6eA67698BCD9795eec"
+    },
+    "blasttestnet": {
+      "bridge": "0x6EDCE65403992e310A62460808c4b910D972f10f",
+      "escrow": "0x495691fafcf2E0c8554bfD6eA67698BCD9795eec"
+    }
   }
 }

src/IncentivizedMessageEscrow.sol

@@ -255,7 +255,7 @@ abstract contract IncentivizedMessageEscrow is IIncentivizedMessageEscrow, Bytes
         return _messageDelivered[sourceIdentifier][sourceImplementationIdentifier][messageIdentifier];
    }
 
-     /**
+    /**
      * @notice Sets the escrow implementation for a specific chain
      * @dev This can only be set once. When set, it cannot be changed.
      * This is to protect relayers as this could be used to fail acks.
@@ -419,6 +419,7 @@ abstract contract IncentivizedMessageEscrow is IIncentivizedMessageEscrow, Bytes
             if (msg.value > sum) {
                 // We know: msg.value > sum, thus msg.value - sum > 0.
                 gasRefund = msg.value - sum;
+                // Send the refund to the refund address.
                 Address.sendValue(payable(incentive.refundGasTo), uint256(gasRefund));
                 return (gasRefund, messageIdentifier);
             }