@layerzerolabs/lz-evm-protocol-v2 2.0.13 → 2.0.15

package/contracts/MessagingChannel.sol

@@ -41,7 +41,7 @@ abstract contract MessagingChannel is IMessagingChannel {
         uint64 _nonce,
         bytes32 _payloadHash
     ) internal {
-        if (_payloadHash == EMPTY_PAYLOAD_HASH) revert Errors.InvalidPayloadHash();
+        if (_payloadHash == EMPTY_PAYLOAD_HASH) revert Errors.LZ_InvalidPayloadHash();
         inboundPayloadHash[_receiver][_srcEid][_sender][_nonce] = _payloadHash;
     }
 
@@ -82,7 +82,7 @@ abstract contract MessagingChannel is IMessagingChannel {
     function skip(address _oapp, uint32 _srcEid, bytes32 _sender, uint64 _nonce) external {
         _assertAuthorized(_oapp);
 
-        if (_nonce != inboundNonce(_oapp, _srcEid, _sender) + 1) revert Errors.InvalidNonce(_nonce);
+        if (_nonce != inboundNonce(_oapp, _srcEid, _sender) + 1) revert Errors.LZ_InvalidNonce(_nonce);
         lazyInboundNonce[_oapp][_srcEid][_sender] = _nonce;
         emit InboundNonceSkipped(_srcEid, _sender, _oapp, _nonce);
     }
@@ -96,9 +96,9 @@ abstract contract MessagingChannel is IMessagingChannel {
         _assertAuthorized(_oapp);
 
         bytes32 curPayloadHash = inboundPayloadHash[_oapp][_srcEid][_sender][_nonce];
-        if (curPayloadHash != _payloadHash) revert Errors.PayloadHashNotFound(curPayloadHash, _payloadHash);
+        if (curPayloadHash != _payloadHash) revert Errors.LZ_PayloadHashNotFound(curPayloadHash, _payloadHash);
         if (_nonce <= lazyInboundNonce[_oapp][_srcEid][_sender] && curPayloadHash == EMPTY_PAYLOAD_HASH)
-            revert Errors.InvalidNonce(_nonce);
+            revert Errors.LZ_InvalidNonce(_nonce);
         // set it to nil
         inboundPayloadHash[_oapp][_srcEid][_sender][_nonce] = NIL_PAYLOAD_HASH;
         emit PacketNilified(_srcEid, _sender, _oapp, _nonce, _payloadHash);
@@ -113,9 +113,9 @@ abstract contract MessagingChannel is IMessagingChannel {
         _assertAuthorized(_oapp);
 
         bytes32 curPayloadHash = inboundPayloadHash[_oapp][_srcEid][_sender][_nonce];
-        if (curPayloadHash != _payloadHash) revert Errors.PayloadHashNotFound(curPayloadHash, _payloadHash);
+        if (curPayloadHash != _payloadHash) revert Errors.LZ_PayloadHashNotFound(curPayloadHash, _payloadHash);
         if (curPayloadHash == EMPTY_PAYLOAD_HASH || _nonce > lazyInboundNonce[_oapp][_srcEid][_sender])
-            revert Errors.InvalidNonce(_nonce);
+            revert Errors.LZ_InvalidNonce(_nonce);
         delete inboundPayloadHash[_oapp][_srcEid][_sender][_nonce];
         emit PacketBurnt(_srcEid, _sender, _oapp, _nonce, _payloadHash);
     }
@@ -135,7 +135,7 @@ abstract contract MessagingChannel is IMessagingChannel {
             unchecked {
                 // try to lazily update the inboundNonce till the _nonce
                 for (uint64 i = currentNonce + 1; i <= _nonce; ++i) {
-                    if (!_hasPayloadHash(_receiver, _srcEid, _sender, i)) revert Errors.InvalidNonce(i);
+                    if (!_hasPayloadHash(_receiver, _srcEid, _sender, i)) revert Errors.LZ_InvalidNonce(i);
                 }
                 lazyInboundNonce[_receiver][_srcEid][_sender] = _nonce;
             }
@@ -144,7 +144,7 @@ abstract contract MessagingChannel is IMessagingChannel {
         // check the hash of the payload to verify the executor has given the proper payload that has been verified
         actualHash = keccak256(_payload);
         bytes32 expectedHash = inboundPayloadHash[_receiver][_srcEid][_sender][_nonce];
-        if (expectedHash != actualHash) revert Errors.PayloadHashNotFound(expectedHash, actualHash);
+        if (expectedHash != actualHash) revert Errors.LZ_PayloadHashNotFound(expectedHash, actualHash);
 
         // remove it from the storage
         delete inboundPayloadHash[_receiver][_srcEid][_sender][_nonce];

package/contracts/MessagingComposer.sol

@@ -22,7 +22,7 @@ abstract contract MessagingComposer is IMessagingComposer {
     /// @param _message the message
     function sendCompose(address _to, bytes32 _guid, uint16 _index, bytes calldata _message) external {
         // must have not been sent before
-        if (composeQueue[msg.sender][_to][_guid][_index] != NO_MESSAGE_HASH) revert Errors.ComposeExists();
+        if (composeQueue[msg.sender][_to][_guid][_index] != NO_MESSAGE_HASH) revert Errors.LZ_ComposeExists();
         composeQueue[msg.sender][_to][_guid][_index] = keccak256(_message);
         emit ComposeSent(msg.sender, _to, _guid, _index, _message);
     }
@@ -47,7 +47,7 @@ abstract contract MessagingComposer is IMessagingComposer {
         // assert the validity
         bytes32 expectedHash = composeQueue[_from][_to][_guid][_index];
         bytes32 actualHash = keccak256(_message);
-        if (expectedHash != actualHash) revert Errors.ComposeNotFound(expectedHash, actualHash);
+        if (expectedHash != actualHash) revert Errors.LZ_ComposeNotFound(expectedHash, actualHash);
 
         // marks the message as received to prevent reentrancy
         // cannot just delete the value, otherwise the message can be sent again and could result in some undefined behaviour

package/contracts/MessagingContext.sol

@@ -14,7 +14,7 @@ abstract contract MessagingContext is IMessagingContext {
 
     /// @dev the sendContext is set to 8 bytes 0s + 4 bytes eid + 20 bytes sender
     modifier sendContext(uint32 _dstEid, address _sender) {
-        if (_sendContext != NOT_ENTERED) revert Errors.SendReentrancy();
+        if (_sendContext != NOT_ENTERED) revert Errors.LZ_SendReentrancy();
         _sendContext = (uint256(_dstEid) << 160) | uint160(_sender);
         _;
         _sendContext = NOT_ENTERED;

package/contracts/interfaces/ILayerZeroEndpointV2.sol

@@ -32,12 +32,6 @@ struct Origin {
     uint64 nonce;
 }
 
-enum ExecutionState {
-    NotExecutable,
-    Executable,
-    Executed
-}
-
 interface ILayerZeroEndpointV2 is IMessageLibManager, IMessagingComposer, IMessagingChannel, IMessagingContext {
     event PacketSent(bytes encodedPayload, bytes options, address sendLibrary);
 
@@ -70,14 +64,9 @@ interface ILayerZeroEndpointV2 is IMessageLibManager, IMessagingComposer, IMessa
 
     function verify(Origin calldata _origin, address _receiver, bytes32 _payloadHash) external;
 
-    function verifiable(
-        Origin calldata _origin,
-        address _receiver,
-        address _receiveLib,
-        bytes32 _payloadHash
-    ) external view returns (bool);
+    function verifiable(Origin calldata _origin, address _receiver) external view returns (bool);
 
-    function executable(Origin calldata _origin, address _receiver) external view returns (ExecutionState);
+    function initializable(Origin calldata _origin, address _receiver) external view returns (bool);
 
     function lzReceive(
         Origin calldata _origin,

package/contracts/interfaces/ILayerZeroReceiver.sol

@@ -7,7 +7,6 @@ import { Origin } from "./ILayerZeroEndpointV2.sol";
 interface ILayerZeroReceiver {
     function allowInitializePath(Origin calldata _origin) external view returns (bool);
 
-    // todo: move to OAppReceiver? it is just convention for executor. we may can change it in a new Receiver version
     function nextNonce(uint32 _eid, bytes32 _sender) external view returns (uint64);
 
     function lzReceive(

package/contracts/interfaces/IMessageLibManager.sol

@@ -42,6 +42,8 @@ interface IMessageLibManager {
 
     function isSupportedEid(uint32 _eid) external view returns (bool);
 
+    function isValidReceiveLibrary(address _receiver, uint32 _eid, address _lib) external view returns (bool);
+
     /// ------------------- OApp interfaces -------------------
     function setSendLibrary(address _oapp, uint32 _eid, address _newLib) external;
 

package/contracts/interfaces/IMessagingChannel.sol

@@ -29,4 +29,6 @@ interface IMessagingChannel {
         bytes32 _sender,
         uint64 _nonce
     ) external view returns (bytes32);
+
+    function lazyInboundNonce(address _receiver, uint32 _srcEid, bytes32 _sender) external view returns (uint64);
 }

package/contracts/libs/AddressCast.sol

@@ -2,11 +2,12 @@
 
 pragma solidity ^0.8.20;
 
-import { Errors } from "./Errors.sol";
-
 library AddressCast {
+    error AddressCast_InvalidSizeForAddress();
+    error AddressCast_InvalidAddress();
+
     function toBytes32(bytes calldata _addressBytes) internal pure returns (bytes32 result) {
-        if (_addressBytes.length > 32) revert Errors.InvalidAddress();
+        if (_addressBytes.length > 32) revert AddressCast_InvalidAddress();
         result = bytes32(_addressBytes);
         unchecked {
             uint256 offset = 32 - _addressBytes.length;
@@ -19,7 +20,7 @@ library AddressCast {
     }
 
     function toBytes(bytes32 _addressBytes32, uint256 _size) internal pure returns (bytes memory result) {
-        if (_size == 0 || _size > 32) revert Errors.InvalidSizeForAddress();
+        if (_size == 0 || _size > 32) revert AddressCast_InvalidSizeForAddress();
         result = new bytes(_size);
         unchecked {
             uint256 offset = 256 - _size * 8;
@@ -34,7 +35,7 @@ library AddressCast {
     }
 
     function toAddress(bytes calldata _addressBytes) internal pure returns (address result) {
-        if (_addressBytes.length != 20) revert Errors.InvalidAddress();
+        if (_addressBytes.length != 20) revert AddressCast_InvalidAddress();
         result = address(bytes20(_addressBytes));
     }
 }

package/contracts/libs/Errors.sol

@@ -3,40 +3,37 @@
 pragma solidity ^0.8.20;
 
 library Errors {
-    error LzTokenUnavailable();
-    error OnlyAltToken();
-    error InvalidReceiveLibrary();
-    error InvalidNonce(uint64 nonce);
-    error InvalidArgument();
-    error InvalidExpiry();
-    error InvalidAmount(uint256 required, uint256 supplied);
-    error OnlyRegisteredOrDefaultLib();
-    error OnlyRegisteredLib();
-    error OnlyNonDefaultLib();
-    error Unauthorized();
-    error DefaultSendLibUnavailable();
-    error DefaultReceiveLibUnavailable();
-    error PathNotInitializable();
-    error PathNotVerifiable();
-    error OnlySendLib();
-    error OnlyReceiveLib();
-    error UnsupportedEid();
-    error UnsupportedInterface();
-    error AlreadyRegistered();
-    error SameValue();
-    error InvalidPayloadHash();
-    error PayloadHashNotFound(bytes32 expected, bytes32 actual);
-    error ComposeNotFound(bytes32 expected, bytes32 actual);
-    error ComposeExists();
-    error SendReentrancy();
-    error NotImplemented();
-    error InvalidAddress();
-    error InvalidSizeForAddress();
-    error InsufficientFee(
+    error LZ_LzTokenUnavailable();
+    error LZ_InvalidReceiveLibrary();
+    error LZ_InvalidNonce(uint64 nonce);
+    error LZ_InvalidArgument();
+    error LZ_InvalidExpiry();
+    error LZ_InvalidAmount(uint256 required, uint256 supplied);
+    error LZ_OnlyRegisteredOrDefaultLib();
+    error LZ_OnlyRegisteredLib();
+    error LZ_OnlyNonDefaultLib();
+    error LZ_Unauthorized();
+    error LZ_DefaultSendLibUnavailable();
+    error LZ_DefaultReceiveLibUnavailable();
+    error LZ_PathNotInitializable();
+    error LZ_PathNotVerifiable();
+    error LZ_OnlySendLib();
+    error LZ_OnlyReceiveLib();
+    error LZ_UnsupportedEid();
+    error LZ_UnsupportedInterface();
+    error LZ_AlreadyRegistered();
+    error LZ_SameValue();
+    error LZ_InvalidPayloadHash();
+    error LZ_PayloadHashNotFound(bytes32 expected, bytes32 actual);
+    error LZ_ComposeNotFound(bytes32 expected, bytes32 actual);
+    error LZ_ComposeExists();
+    error LZ_SendReentrancy();
+    error LZ_NotImplemented();
+    error LZ_InsufficientFee(
         uint256 requiredNative,
         uint256 suppliedNative,
         uint256 requiredLzToken,
         uint256 suppliedLzToken
     );
-    error ZeroLzTokenFee();
+    error LZ_ZeroLzTokenFee();
 }

package/contracts/libs/Transfer.sol

@@ -10,17 +10,17 @@ library Transfer {
 
     address internal constant ADDRESS_ZERO = address(0);
 
-    error TransferNativeFailed(address _to, uint256 _value);
-    error ToAddressIsZero();
+    error Transfer_NativeFailed(address _to, uint256 _value);
+    error Transfer_ToAddressIsZero();
 
     function native(address _to, uint256 _value) internal {
-        if (_to == ADDRESS_ZERO) revert ToAddressIsZero();
+        if (_to == ADDRESS_ZERO) revert Transfer_ToAddressIsZero();
         (bool success, ) = _to.call{ value: _value }("");
-        if (!success) revert TransferNativeFailed(_to, _value);
+        if (!success) revert Transfer_NativeFailed(_to, _value);
     }
 
     function token(address _token, address _to, uint256 _value) internal {
-        if (_to == ADDRESS_ZERO) revert ToAddressIsZero();
+        if (_to == ADDRESS_ZERO) revert Transfer_ToAddressIsZero();
         IERC20(_token).safeTransfer(_to, _value);
     }
 

package/contracts/messagelib/BlockedMessageLib.sol

@@ -25,6 +25,6 @@ contract BlockedMessageLib is ERC165 {
     }
 
     fallback() external {
-        revert Errors.NotImplemented();
+        revert Errors.LZ_NotImplemented();
     }
 }

package/contracts/messagelib/SimpleMessageLib.sol

@@ -142,7 +142,7 @@ contract SimpleMessageLib is Ownable, ERC165 {
     function _handleMessagingParamsHook(bytes memory _encodedPacket, bytes memory _options) internal virtual {}
 
     fallback() external payable {
-        revert Errors.NotImplemented();
+        revert Errors.LZ_NotImplemented();
     }
 
     receive() external payable {}

package/contracts/messagelib/libs/ExecutorOptions.sol

@@ -14,9 +14,9 @@ library ExecutorOptions {
     uint8 internal constant OPTION_TYPE_LZCOMPOSE = 3;
     uint8 internal constant OPTION_TYPE_ORDERED_EXECUTION = 4;
 
-    error InvalidLzReceiveOption();
-    error InvalidNativeDropOption();
-    error InvalidLzComposeOption();
+    error Executor_InvalidLzReceiveOption();
+    error Executor_InvalidNativeDropOption();
+    error Executor_InvalidLzComposeOption();
 
     /// @dev decode the next executor option from the options starting from the specified cursor
     /// @param _options [executor_id][executor_option][executor_id][executor_option]...
@@ -51,13 +51,13 @@ library ExecutorOptions {
     }
 
     function decodeLzReceiveOption(bytes calldata _option) internal pure returns (uint128 gas, uint128 value) {
-        if (_option.length != 16 && _option.length != 32) revert InvalidLzReceiveOption();
+        if (_option.length != 16 && _option.length != 32) revert Executor_InvalidLzReceiveOption();
         gas = _option.toU128(0);
         value = _option.length == 32 ? _option.toU128(16) : 0;
     }
 
     function decodeNativeDropOption(bytes calldata _option) internal pure returns (uint128 amount, bytes32 receiver) {
-        if (_option.length != 48) revert InvalidNativeDropOption();
+        if (_option.length != 48) revert Executor_InvalidNativeDropOption();
         amount = _option.toU128(0);
         receiver = _option.toB32(16);
     }
@@ -65,7 +65,7 @@ library ExecutorOptions {
     function decodeLzComposeOption(
         bytes calldata _option
     ) internal pure returns (uint16 index, uint128 gas, uint128 value) {
-        if (_option.length != 18 && _option.length != 34) revert InvalidLzComposeOption();
+        if (_option.length != 18 && _option.length != 34) revert Executor_InvalidLzComposeOption();
         index = _option.toU16(0);
         gas = _option.toU128(2);
         value = _option.length == 34 ? _option.toU128(18) : 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/lz-evm-protocol-v2",
-  "version": "2.0.13",
+  "version": "2.0.15",
   "license": "LZBL-1.2",
   "files": [
     "artifacts/contracts/**/!(*.dbg).json",
@@ -12,12 +12,14 @@
   "dependencies": {},
   "devDependencies": {
     "@openzeppelin/contracts": "^4.8.1",
+    "@openzeppelin/contracts-upgradeable": "^4.8.1",
     "hardhat-deploy": "^0.11.44",
     "hardhat-deploy-ethers": "^0.3.0-beta.13",
     "solidity-bytes-utils": "^0.8.0"
   },
   "peerDependencies": {
     "@openzeppelin/contracts": "^4.8.1",
+    "@openzeppelin/contracts-upgradeable": "^4.8.1",
     "hardhat-deploy": "^0.11.44",
     "solidity-bytes-utils": "^0.8.0"
   },