more

solidity/contracts/hooks/OPL2ToL1Hook.sol

@@ -67,12 +67,8 @@ contract OPL2ToL1Hook is AbstractMessageIdAuthHook {
         bytes calldata metadata,
         bytes calldata message
     ) internal view override returns (uint256) {
-        bytes memory metadataWithGasLimit = metadata.overrideGasLimit(
-            MIN_GAS_LIMIT
-        );
         return
-            metadata.msgValue(0) +
-            childHook.quoteDispatch(metadataWithGasLimit, message);
+            metadata.msgValue(0) + childHook.quoteDispatch(metadata, message);
     }
 
     // ============ Internal functions ============
@@ -87,12 +83,9 @@ contract OPL2ToL1Hook is AbstractMessageIdAuthHook {
             (message.id(), metadata.msgValue(0))
         );
 
-        bytes memory metadataWithGasLimit = metadata.overrideGasLimit(
-            MIN_GAS_LIMIT
-        );
         childHook.postDispatch{
-            value: childHook.quoteDispatch(metadataWithGasLimit, message)
-        }(metadataWithGasLimit, message);
+            value: childHook.quoteDispatch(metadata, message)
+        }(metadata, message);
         l2Messenger.sendMessage{value: metadata.msgValue(0)}(
             TypeCasts.bytes32ToAddress(ism),
             payload,

solidity/contracts/token/HypNative.sol

@@ -1,84 +1,106 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity >=0.8.0;
 
-/*@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-     @@@@@  HYPERLANE  @@@@@@@
-    @@@@@@@@@@@@@@@@@@@@@@@@@
-   @@@@@@@@@       @@@@@@@@@
-  @@@@@@@@@       @@@@@@@@@
- @@@@@@@@@       @@@@@@@@@
-@@@@@@@@@       @@@@@@@@*/
-
-// ============ Internal Imports ============
 import {TokenRouter} from "./libs/TokenRouter.sol";
-import {HypNativeCollateral} from "./HypNativeCollateral.sol";
-import {StandardHookMetadata} from "../hooks/libs/StandardHookMetadata.sol";
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 
 /**
- * @title HypNative
+ * @title Hyperlane Native Token Router that extends ERC20 with remote transfer functionality.
  * @author Abacus Works
- * @notice This contract facilitates the transfer of value between chains using value transfer hooks
+ * @dev Supply on each chain is not constant but the aggregate supply across all chains is.
  */
-contract HypNative is HypNativeCollateral {
-    constructor(address _mailbox) HypNativeCollateral(_mailbox) {}
+contract HypNative is TokenRouter {
+    /**
+     * @dev Emitted when native tokens are donated to the contract.
+     * @param sender The address of the sender.
+     * @param amount The amount of native tokens donated.
+     */
+    event Donation(address indexed sender, uint256 amount);
 
-    // ============ External Functions ============
+    constructor(address _mailbox) TokenRouter(_mailbox) {}
 
-    /// @inheritdoc TokenRouter
+    /**
+     * @notice Initializes the Hyperlane router
+     * @param _hook The post-dispatch hook contract.
+     *    @param _interchainSecurityModule The interchain security module contract.
+     *    @param _owner The this contract.
+     */
+    function initialize(
+        address _hook,
+        address _interchainSecurityModule,
+        address _owner
+    ) public initializer {
+        _MailboxClient_initialize(_hook, _interchainSecurityModule, _owner);
+    }
+
+    /**
+     * @inheritdoc TokenRouter
+     * @dev uses (`msg.value` - `_amount`) as hook payment and `msg.sender` as refund address.
+     */
     function transferRemote(
         uint32 _destination,
         bytes32 _recipient,
         uint256 _amount
     ) external payable virtual override returns (bytes32 messageId) {
-        bytes calldata emptyBytes;
-        assembly {
-            emptyBytes.length := 0
-            emptyBytes.offset := 0
-        }
-        return
-            transferRemote(
-                _destination,
-                _recipient,
-                _amount,
-                emptyBytes,
-                address(hook)
-            );
+        require(msg.value >= _amount, "Native: amount exceeds msg.value");
+        uint256 _hookPayment = msg.value - _amount;
+        return _transferRemote(_destination, _recipient, _amount, _hookPayment);
     }
 
     /**
      * @inheritdoc TokenRouter
-     * @dev use _hook with caution, make sure that this hook can handle msg.value transfer using the metadata.msgValue()
+     * @dev uses (`msg.value` - `_amount`) as hook payment.
      */
     function transferRemote(
         uint32 _destination,
         bytes32 _recipient,
         uint256 _amount,
         bytes calldata _hookMetadata,
         address _hook
-    ) public payable virtual override returns (bytes32 messageId) {
-        uint256 quote = _GasRouter_quoteDispatch(
-            _destination,
-            _hookMetadata,
-            _hook
-        );
-
-        bytes memory hookMetadata = StandardHookMetadata.overrideMsgValue(
-            _hookMetadata,
-            _amount
-        );
-
+    ) external payable virtual override returns (bytes32 messageId) {
+        require(msg.value >= _amount, "Native: amount exceeds msg.value");
+        uint256 _hookPayment = msg.value - _amount;
         return
             _transferRemote(
                 _destination,
                 _recipient,
                 _amount,
-                _amount + quote,
-                hookMetadata,
+                _hookPayment,
+                _hookMetadata,
                 _hook
             );
     }
+
+    function balanceOf(
+        address _account
+    ) external view override returns (uint256) {
+        return _account.balance;
+    }
+
+    /**
+     * @inheritdoc TokenRouter
+     * @dev No-op because native amount is transferred in `msg.value`
+     * @dev Compiler will not include this in the bytecode.
+     */
+    function _transferFromSender(
+        uint256
+    ) internal pure override returns (bytes memory) {
+        return bytes(""); // no metadata
+    }
+
+    /**
+     * @dev Sends `_amount` of native token to `_recipient` balance.
+     * @inheritdoc TokenRouter
+     */
+    function _transferTo(
+        address _recipient,
+        uint256 _amount,
+        bytes calldata // no metadata
+    ) internal virtual override {
+        Address.sendValue(payable(_recipient), _amount);
+    }
+
+    receive() external payable {
+        emit Donation(msg.sender, msg.value);
+    }
 }

solidity/contracts/token/HypNativeCollateral.sol

@@ -1,107 +1,84 @@
-// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
 import {TokenRouter} from "./libs/TokenRouter.sol";
-import {TokenMessage} from "./libs/TokenMessage.sol";
-import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+import {HypNative} from "./HypNative.sol";
+import {StandardHookMetadata} from "../hooks/libs/StandardHookMetadata.sol";
 
 /**
- * @title Hyperlane Native Token Router that extends ERC20 with remote transfer functionality.
+ * @title HypNativeCollateral
  * @author Abacus Works
- * @dev Supply on each chain is not constant but the aggregate supply across all chains is.
+ * @notice This contract facilitates the transfer of value between chains using value transfer hooks
  */
-contract HypNativeCollateral is TokenRouter {
-    /**
-     * @dev Emitted when native tokens are donated to the contract.
-     * @param sender The address of the sender.
-     * @param amount The amount of native tokens donated.
-     */
-    event Donation(address indexed sender, uint256 amount);
+contract HypNativeCollateral is HypNative {
+    constructor(address _mailbox) HypNative(_mailbox) {}
 
-    constructor(address _mailbox) TokenRouter(_mailbox) {}
+    // ============ External Functions ============
 
-    /**
-     * @notice Initializes the Hyperlane router
-     * @param _hook The post-dispatch hook contract.
-     *    @param _interchainSecurityModule The interchain security module contract.
-     *    @param _owner The this contract.
-     */
-    function initialize(
-        address _hook,
-        address _interchainSecurityModule,
-        address _owner
-    ) public initializer {
-        _MailboxClient_initialize(_hook, _interchainSecurityModule, _owner);
-    }
-
-    /**
-     * @inheritdoc TokenRouter
-     * @dev uses (`msg.value` - `_amount`) as hook payment and `msg.sender` as refund address.
-     */
+    /// @inheritdoc TokenRouter
     function transferRemote(
         uint32 _destination,
         bytes32 _recipient,
         uint256 _amount
     ) external payable virtual override returns (bytes32 messageId) {
-        require(msg.value >= _amount, "Native: amount exceeds msg.value");
-        uint256 _hookPayment = msg.value - _amount;
-        return _transferRemote(_destination, _recipient, _amount, _hookPayment);
+        bytes calldata emptyBytes;
+        assembly {
+            emptyBytes.length := 0
+            emptyBytes.offset := 0
+        }
+        return
+            transferRemote(
+                _destination,
+                _recipient,
+                _amount,
+                emptyBytes,
+                address(hook)
+            );
     }
 
     /**
      * @inheritdoc TokenRouter
-     * @dev uses (`msg.value` - `_amount`) as hook payment.
+     * @dev use _hook with caution, make sure that this hook can handle msg.value transfer using the metadata.msgValue()
      */
     function transferRemote(
         uint32 _destination,
         bytes32 _recipient,
         uint256 _amount,
         bytes calldata _hookMetadata,
         address _hook
-    ) external payable virtual override returns (bytes32 messageId) {
-        require(msg.value >= _amount, "Native: amount exceeds msg.value");
-        uint256 _hookPayment = msg.value - _amount;
+    ) public payable virtual override returns (bytes32 messageId) {
+        uint256 quote = _GasRouter_quoteDispatch(
+            _destination,
+            _hookMetadata,
+            _hook
+        );
+
+        bytes memory hookMetadata = StandardHookMetadata.overrideMsgValue(
+            _hookMetadata,
+            _amount
+        );
+
         return
             _transferRemote(
                 _destination,
                 _recipient,
                 _amount,
-                _hookPayment,
-                _hookMetadata,
+                _amount + quote,
+                hookMetadata,
                 _hook
             );
     }
-
-    function balanceOf(
-        address _account
-    ) external view override returns (uint256) {
-        return _account.balance;
-    }
-
-    /**
-     * @inheritdoc TokenRouter
-     * @dev No-op because native amount is transferred in `msg.value`
-     * @dev Compiler will not include this in the bytecode.
-     */
-    function _transferFromSender(
-        uint256
-    ) internal pure override returns (bytes memory) {
-        return bytes(""); // no metadata
-    }
-
-    /**
-     * @dev Sends `_amount` of native token to `_recipient` balance.
-     * @inheritdoc TokenRouter
-     */
-    function _transferTo(
-        address _recipient,
-        uint256 _amount,
-        bytes calldata // no metadata
-    ) internal virtual override {
-        Address.sendValue(payable(_recipient), _amount);
-    }
-
-    receive() external payable {
-        emit Donation(msg.sender, msg.value);
-    }
 }