@hyperlane-xyz/core 5.12.0 → 6.0.0

package/contracts/PackageVersioned.sol

@@ -7,5 +7,5 @@ pragma solidity >=0.6.11;
  **/
 abstract contract PackageVersioned {
     // GENERATED CODE - DO NOT EDIT
-    string public constant PACKAGE_VERSION = "5.12.0";
+    string public constant PACKAGE_VERSION = "6.0.0";
 }

package/contracts/hooks/aggregation/StaticAggregationHook.sol

@@ -13,11 +13,23 @@ pragma solidity >=0.8.0;
  @@@@@@@@@       @@@@@@@@@
 @@@@@@@@@       @@@@@@@@*/
 
+// ============ Internal Imports ============
+import {StandardHookMetadata} from "../libs/StandardHookMetadata.sol";
+import {Message} from "../../libs/Message.sol";
+import {TypeCasts} from "../../libs/TypeCasts.sol";
 import {AbstractPostDispatchHook} from "../libs/AbstractPostDispatchHook.sol";
 import {IPostDispatchHook} from "../../interfaces/hooks/IPostDispatchHook.sol";
 import {MetaProxy} from "../../libs/MetaProxy.sol";
 
+// ============ External Imports ============
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+
 contract StaticAggregationHook is AbstractPostDispatchHook {
+    using Message for bytes;
+    using TypeCasts for bytes32;
+    using StandardHookMetadata for bytes;
+    using Address for address payable;
+
     // ============ External functions ============
 
     /// @inheritdoc IPostDispatchHook
@@ -32,16 +44,29 @@ contract StaticAggregationHook is AbstractPostDispatchHook {
     ) internal override {
         address[] memory _hooks = hooks(message);
         uint256 count = _hooks.length;
+        uint256 valueRemaining = msg.value;
         for (uint256 i = 0; i < count; i++) {
             uint256 quote = IPostDispatchHook(_hooks[i]).quoteDispatch(
                 metadata,
                 message
             );
+            require(
+                valueRemaining >= quote,
+                "StaticAggregationHook: insufficient value"
+            );
 
             IPostDispatchHook(_hooks[i]).postDispatch{value: quote}(
                 metadata,
                 message
             );
+
+            valueRemaining -= quote;
+        }
+
+        if (valueRemaining > 0) {
+            payable(metadata.refundAddress(message.senderAddress())).sendValue(
+                valueRemaining
+            );
         }
     }
 

package/contracts/hooks/warp-route/RateLimitedHook.sol

@@ -1,18 +1,47 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
 import {MailboxClient} from "contracts/client/MailboxClient.sol";
 import {IPostDispatchHook} from "contracts/interfaces/hooks/IPostDispatchHook.sol";
 import {Message} from "contracts/libs/Message.sol";
 import {TokenMessage} from "contracts/token/libs/TokenMessage.sol";
 import {RateLimited} from "contracts/libs/RateLimited.sol";
+import {AbstractPostDispatchHook} from "../libs/AbstractPostDispatchHook.sol";
 
-contract RateLimitedHook is IPostDispatchHook, MailboxClient, RateLimited {
+/*
+ * @title RateLimitedHook
+ * @author Abacus Works
+ * @notice A hook that rate limits the volume of token transfers to a destination using a bucket fill algorithm
+ */
+contract RateLimitedHook is
+    AbstractPostDispatchHook,
+    MailboxClient,
+    RateLimited
+{
     using Message for bytes;
     using TokenMessage for bytes;
 
+    /// @notice The address that is authorized to call this hook
+    address public immutable sender;
+    /// @notice A mapping of message IDs to whether they have been validated
     mapping(bytes32 messageId => bool validated) public messageValidated;
 
+    // ============ Modifiers ============
+
+    /// @notice Ensures that the message has not been validated yet
     modifier validateMessageOnce(bytes calldata _message) {
         bytes32 messageId = _message.id();
         require(!messageValidated[messageId], "MessageAlreadyValidated");
@@ -20,40 +49,48 @@ contract RateLimitedHook is IPostDispatchHook, MailboxClient, RateLimited {
         messageValidated[messageId] = true;
     }
 
+    /// @notice Ensures that the message was sent by the authorized sender
+    modifier onlySender(bytes calldata _message) {
+        require(_message.senderAddress() == sender, "InvalidSender");
+        _;
+    }
+
+    // ============ Constructor ============
+
     constructor(
         address _mailbox,
-        uint256 _maxCapacity
-    ) MailboxClient(_mailbox) RateLimited(_maxCapacity) {}
+        uint256 _maxCapacity,
+        address _sender
+    ) MailboxClient(_mailbox) RateLimited(_maxCapacity) {
+        require(_sender != address(0), "InvalidSender");
+        sender = _sender;
+    }
+
+    // ============ External Functions ============
 
     /// @inheritdoc IPostDispatchHook
     function hookType() external pure returns (uint8) {
         return uint8(IPostDispatchHook.Types.RATE_LIMITED);
     }
 
-    /// @inheritdoc IPostDispatchHook
-    function supportsMetadata(bytes calldata) external pure returns (bool) {
-        return false;
-    }
+    // ============ Internal Functions ============
 
-    /**
-     * Verify a message, rate limit, and increment the sender's limit.
-     * @dev ensures that this gets called by the Mailbox
-     */
-    function postDispatch(
+    /// @inheritdoc AbstractPostDispatchHook
+    function _postDispatch(
         bytes calldata,
         bytes calldata _message
-    ) external payable validateMessageOnce(_message) {
+    ) internal override onlySender(_message) validateMessageOnce(_message) {
         require(_isLatestDispatched(_message.id()), "InvalidDispatchedMessage");
 
         uint256 newAmount = _message.body().amount();
         validateAndConsumeFilledLevel(newAmount);
     }
 
-    /// @inheritdoc IPostDispatchHook
-    function quoteDispatch(
+    /// @inheritdoc AbstractPostDispatchHook
+    function _quoteDispatch(
         bytes calldata,
         bytes calldata
-    ) external pure returns (uint256) {
+    ) internal pure override returns (uint256) {
         return 0;
     }
 }

package/contracts/token/HypERC20.sol

@@ -2,6 +2,7 @@
 pragma solidity >=0.8.0;
 
 import {TokenRouter} from "./libs/TokenRouter.sol";
+import {FungibleTokenRouter} from "./libs/FungibleTokenRouter.sol";
 
 import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 
@@ -10,10 +11,14 @@ import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/
  * @author Abacus Works
  * @dev Supply on each chain is not constant but the aggregate supply across all chains is.
  */
-contract HypERC20 is ERC20Upgradeable, TokenRouter {
+contract HypERC20 is ERC20Upgradeable, FungibleTokenRouter {
     uint8 private immutable _decimals;
 
-    constructor(uint8 __decimals, address _mailbox) TokenRouter(_mailbox) {
+    constructor(
+        uint8 __decimals,
+        uint256 _scale,
+        address _mailbox
+    ) FungibleTokenRouter(_scale, _mailbox) {
         _decimals = __decimals;
     }
 

package/contracts/token/HypERC20Collateral.sol

@@ -15,6 +15,7 @@ pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
 import {TokenRouter} from "./libs/TokenRouter.sol";
+import {FungibleTokenRouter} from "./libs/FungibleTokenRouter.sol";
 import {TokenMessage} from "./libs/TokenMessage.sol";
 import {MailboxClient} from "../client/MailboxClient.sol";
 
@@ -27,7 +28,7 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
  * @title Hyperlane ERC20 Token Collateral that wraps an existing ERC20 with remote transfer functionality.
  * @author Abacus Works
  */
-contract HypERC20Collateral is TokenRouter {
+contract HypERC20Collateral is FungibleTokenRouter {
     using SafeERC20 for IERC20;
 
     IERC20 public immutable wrappedToken;
@@ -36,7 +37,11 @@ contract HypERC20Collateral is TokenRouter {
      * @notice Constructor
      * @param erc20 Address of the token to keep as collateral
      */
-    constructor(address erc20, address _mailbox) TokenRouter(_mailbox) {
+    constructor(
+        address erc20,
+        uint256 _scale,
+        address _mailbox
+    ) FungibleTokenRouter(_scale, _mailbox) {
         require(Address.isContract(erc20), "HypERC20Collateral: invalid token");
         wrappedToken = IERC20(erc20);
     }

package/contracts/token/HypNative.sol

@@ -2,6 +2,7 @@
 pragma solidity >=0.8.0;
 
 import {TokenRouter} from "./libs/TokenRouter.sol";
+import {FungibleTokenRouter} from "./libs/FungibleTokenRouter.sol";
 import {TokenMessage} from "./libs/TokenMessage.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 
@@ -10,7 +11,7 @@ import {Address} from "@openzeppelin/contracts/utils/Address.sol";
  * @author Abacus Works
  * @dev Supply on each chain is not constant but the aggregate supply across all chains is.
  */
-contract HypNative is TokenRouter {
+contract HypNative is FungibleTokenRouter {
     /**
      * @dev Emitted when native tokens are donated to the contract.
      * @param sender The address of the sender.
@@ -18,7 +19,10 @@ contract HypNative is TokenRouter {
      */
     event Donation(address indexed sender, uint256 amount);
 
-    constructor(address _mailbox) TokenRouter(_mailbox) {}
+    constructor(
+        uint256 _scale,
+        address _mailbox
+    ) FungibleTokenRouter(_scale, _mailbox) {}
 
     /**
      * @notice Initializes the Hyperlane router

package/contracts/token/extensions/FastHypERC20.sol

@@ -15,8 +15,9 @@ import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/
 contract FastHypERC20 is FastTokenRouter, HypERC20 {
     constructor(
         uint8 __decimals,
+        uint256 _scale,
         address _mailbox
-    ) HypERC20(__decimals, _mailbox) {}
+    ) HypERC20(__decimals, _scale, _mailbox) {}
 
     /**
      * @dev delegates transfer logic to `_transferTo`.

package/contracts/token/extensions/FastHypERC20Collateral.sol

@@ -21,8 +21,9 @@ contract FastHypERC20Collateral is FastTokenRouter, HypERC20Collateral {
      */
     constructor(
         address erc20,
+        uint256 _scale,
         address _mailbox
-    ) HypERC20Collateral(erc20, _mailbox) {}
+    ) HypERC20Collateral(erc20, _scale, _mailbox) {}
 
     /**
      * @dev delegates transfer logic to `_transferTo`.

package/contracts/token/extensions/HypERC4626.sol

@@ -44,9 +44,10 @@ contract HypERC4626 is HypERC20 {
 
     constructor(
         uint8 _decimals,
+        uint256 _scale,
         address _mailbox,
         uint32 _collateralDomain
-    ) HypERC20(_decimals, _mailbox) {
+    ) HypERC20(_decimals, _scale, _mailbox) {
         collateralDomain = _collateralDomain;
         exchangeRate = 1e10;
         _disableInitializers();

package/contracts/token/extensions/HypERC4626Collateral.sol

@@ -42,8 +42,9 @@ contract HypERC4626Collateral is HypERC20Collateral {
 
     constructor(
         ERC4626 _vault,
+        uint256 _scale,
         address _mailbox
-    ) HypERC20Collateral(_vault.asset(), _mailbox) {
+    ) HypERC20Collateral(_vault.asset(), _scale, _mailbox) {
         vault = _vault;
     }
 

package/contracts/token/extensions/HypERC4626OwnerCollateral.sol

@@ -37,8 +37,9 @@ contract HypERC4626OwnerCollateral is HypERC20Collateral {
 
     constructor(
         ERC4626 _vault,
+        uint256 _scale,
         address _mailbox
-    ) HypERC20Collateral(_vault.asset(), _mailbox) {
+    ) HypERC20Collateral(_vault.asset(), _scale, _mailbox) {
         vault = _vault;
     }
 

package/contracts/token/extensions/HypFiatToken.sol

@@ -8,8 +8,9 @@ import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 contract HypFiatToken is HypERC20Collateral {
     constructor(
         address _fiatToken,
+        uint256 _scale,
         address _mailbox
-    ) HypERC20Collateral(_fiatToken, _mailbox) {}
+    ) HypERC20Collateral(_fiatToken, _scale, _mailbox) {}
 
     function _transferFromSender(
         uint256 _amount

package/contracts/token/extensions/HypXERC20.sol

@@ -7,8 +7,9 @@ import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 contract HypXERC20 is HypERC20Collateral {
     constructor(
         address _xerc20,
+        uint256 _scale,
         address _mailbox
-    ) HypERC20Collateral(_xerc20, _mailbox) {
+    ) HypERC20Collateral(_xerc20, _scale, _mailbox) {
         _disableInitializers();
     }
 

package/contracts/token/extensions/HypXERC20Lockbox.sol

@@ -13,8 +13,15 @@ contract HypXERC20Lockbox is HypERC20Collateral {
 
     constructor(
         address _lockbox,
+        uint256 _scale,
         address _mailbox
-    ) HypERC20Collateral(address(IXERC20Lockbox(_lockbox).ERC20()), _mailbox) {
+    )
+        HypERC20Collateral(
+            address(IXERC20Lockbox(_lockbox).ERC20()),
+            _scale,
+            _mailbox
+        )
+    {
         lockbox = IXERC20Lockbox(_lockbox);
         xERC20 = lockbox.XERC20();
         approveLockbox();

package/contracts/token/libs/FastTokenRouter.sol

@@ -5,12 +5,13 @@ import {TypeCasts} from "../../libs/TypeCasts.sol";
 
 import {TokenMessage} from "./TokenMessage.sol";
 import {TokenRouter} from "./TokenRouter.sol";
+import {FungibleTokenRouter} from "./FungibleTokenRouter.sol";
 
 /**
  * @title Common FastTokenRouter functionality for ERC20 Tokens with remote transfer support.
  * @author Abacus Works
  */
-abstract contract FastTokenRouter is TokenRouter {
+abstract contract FastTokenRouter is FungibleTokenRouter {
     using TypeCasts for bytes32;
     using TokenMessage for bytes;
 

package/contracts/token/libs/FungibleTokenRouter.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0;
+
+import {TokenRouter} from "./TokenRouter.sol";
+
+abstract contract FungibleTokenRouter is TokenRouter {
+    uint256 public immutable scale;
+
+    constructor(uint256 _scale, address _mailbox) TokenRouter(_mailbox) {
+        scale = _scale;
+    }
+
+    /**
+     * @dev Scales local amount to message amount (up by scale factor).
+     * @inheritdoc TokenRouter
+     */
+    function _outboundAmount(
+        uint256 _localAmount
+    ) internal view virtual override returns (uint256 _messageAmount) {
+        _messageAmount = _localAmount * scale;
+    }
+
+    /**
+     * @dev Scales message amount to local amount (down by scale factor).
+     * @inheritdoc TokenRouter
+     */
+    function _inboundAmount(
+        uint256 _messageAmount
+    ) internal view virtual override returns (uint256 _localAmount) {
+        _localAmount = _messageAmount / scale;
+    }
+}

package/contracts/token/libs/TokenRouter.sol

@@ -116,9 +116,11 @@ abstract contract TokenRouter is GasRouter {
         address _hook
     ) internal virtual returns (bytes32 messageId) {
         bytes memory _tokenMetadata = _transferFromSender(_amountOrId);
+
+        uint256 outboundAmount = _outboundAmount(_amountOrId);
         bytes memory _tokenMessage = TokenMessage.format(
             _recipient,
-            _amountOrId,
+            outboundAmount,
             _tokenMetadata
         );
 
@@ -130,7 +132,29 @@ abstract contract TokenRouter is GasRouter {
             _hook
         );
 
-        emit SentTransferRemote(_destination, _recipient, _amountOrId);
+        emit SentTransferRemote(_destination, _recipient, outboundAmount);
+    }
+
+    /**
+     * @dev Should return the amount of tokens to be encoded in the message amount (eg for scaling `_localAmount`).
+     * @param _localAmount The amount of tokens transferred on this chain in local denomination.
+     * @return _messageAmount The amount of tokens to be encoded in the message body.
+     */
+    function _outboundAmount(
+        uint256 _localAmount
+    ) internal view virtual returns (uint256 _messageAmount) {
+        _messageAmount = _localAmount;
+    }
+
+    /**
+     * @dev Should return the amount of tokens to be decoded from the message amount.
+     * @param _messageAmount The amount of tokens received in the message body.
+     * @return _localAmount The amount of tokens to be transferred on this chain in local denomination.
+     */
+    function _inboundAmount(
+        uint256 _messageAmount
+    ) internal view virtual returns (uint256 _localAmount) {
+        _localAmount = _messageAmount;
     }
 
     /**
@@ -179,7 +203,11 @@ abstract contract TokenRouter is GasRouter {
         bytes32 recipient = _message.recipient();
         uint256 amount = _message.amount();
         bytes calldata metadata = _message.metadata();
-        _transferTo(recipient.bytes32ToAddress(), amount, metadata);
+        _transferTo(
+            recipient.bytes32ToAddress(),
+            _inboundAmount(amount),
+            metadata
+        );
         emit ReceivedTransferRemote(_origin, recipient, amount);
     }