@hyperlane-xyz/core 5.5.0 → 5.6.1

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.5.0";
+    string public constant PACKAGE_VERSION = "5.6.1";
 }

package/contracts/client/GasRouter.sol

@@ -1,10 +1,25 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.6.11;
 
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
 import {Router} from "./Router.sol";
 import {StandardHookMetadata} from "../hooks/libs/StandardHookMetadata.sol";
 
 abstract contract GasRouter is Router {
+    event GasSet(uint32 domain, uint256 gas);
+
     // ============ Mutable Storage ============
     mapping(uint32 => uint256) public destinationGas;
 
@@ -56,6 +71,7 @@ abstract contract GasRouter is Router {
 
     function _setDestinationGas(uint32 domain, uint256 gas) internal {
         destinationGas[domain] = gas;
+        emit GasSet(domain, gas);
     }
 
     function _GasRouter_dispatch(

package/contracts/libs/TypeCasts.sol

@@ -9,6 +9,10 @@ library TypeCasts {
 
     // alignment preserving cast
     function bytes32ToAddress(bytes32 _buf) internal pure returns (address) {
+        require(
+            uint256(_buf) <= uint256(type(uint160).max),
+            "TypeCasts: bytes32ToAddress overflow"
+        );
         return address(uint160(uint256(_buf)));
     }
 }

package/contracts/token/HypERC20Collateral.sol

@@ -1,10 +1,25 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity >=0.8.0;
 
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
 import {TokenRouter} from "./libs/TokenRouter.sol";
 import {TokenMessage} from "./libs/TokenMessage.sol";
 import {MailboxClient} from "../client/MailboxClient.sol";
 
+// ============ External Imports ============
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
@@ -22,6 +37,7 @@ contract HypERC20Collateral is TokenRouter {
      * @param erc20 Address of the token to keep as collateral
      */
     constructor(address erc20, address _mailbox) TokenRouter(_mailbox) {
+        require(Address.isContract(erc20), "HypERC20Collateral: invalid token");
         wrappedToken = IERC20(erc20);
     }
 

package/contracts/token/extensions/HypERC4626.sol

@@ -22,10 +22,13 @@ import {TokenRouter} from "../libs/TokenRouter.sol";
 
 // ============ External Imports ============
 import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 
 /**
  * @title Hyperlane ERC20 Rebasing Token
  * @author Abacus Works
+ * @notice This contract implements a rebasing token that reflects yields from the origin chain
  */
 contract HypERC4626 is HypERC20 {
     using Math for uint256;
@@ -49,6 +52,67 @@ contract HypERC4626 is HypERC20 {
         _disableInitializers();
     }
 
+    // ============ Public Functions ============
+
+    /// Override transfer to handle underlying amounts while using shares internally
+    /// @inheritdoc ERC20Upgradeable
+    /// @dev the Transfer event emitted from ERC20Upgradeable will be in terms of shares not assets, so it may be misleading
+    function transfer(
+        address to,
+        uint256 amount
+    ) public virtual override returns (bool) {
+        _transfer(_msgSender(), to, assetsToShares(amount));
+        return true;
+    }
+
+    /// Override transferFrom to handle underlying amounts while using shares internally
+    /// @inheritdoc ERC20Upgradeable
+    function transferFrom(
+        address sender,
+        address recipient,
+        uint256 amount
+    ) public virtual override returns (bool) {
+        address spender = _msgSender();
+        uint256 shares = assetsToShares(amount);
+        _spendAllowance(sender, spender, amount);
+        _transfer(sender, recipient, shares);
+        return true;
+    }
+
+    /// Override totalSupply to return the total assets instead of shares. This reflects the actual circulating supply in terms of assets, accounting for rebasing
+    /// @inheritdoc ERC20Upgradeable
+    function totalSupply() public view virtual override returns (uint256) {
+        return sharesToAssets(totalShares());
+    }
+
+    /// This returns the balance of the account in terms of assets, accounting for rebasing
+    /// @inheritdoc ERC20Upgradeable
+    function balanceOf(
+        address account
+    ) public view virtual override returns (uint256) {
+        return sharesToAssets(shareBalanceOf(account));
+    }
+
+    /// This function provides the total supply in terms of shares
+    function totalShares() public view returns (uint256) {
+        return super.totalSupply();
+    }
+
+    ///  This returns the balance of the account in terms of shares
+    function shareBalanceOf(address account) public view returns (uint256) {
+        return super.balanceOf(account);
+    }
+
+    function assetsToShares(uint256 _amount) public view returns (uint256) {
+        return _amount.mulDiv(PRECISION, exchangeRate);
+    }
+
+    function sharesToAssets(uint256 _shares) public view returns (uint256) {
+        return _shares.mulDiv(exchangeRate, PRECISION);
+    }
+
+    // ============ Internal Functions ============
+
     /// Override to send shares instead of assets from synthetic
     /// @inheritdoc TokenRouter
     function _transferRemote(
@@ -78,6 +142,8 @@ contract HypERC4626 is HypERC20 {
         emit SentTransferRemote(_destination, _recipient, _amountOrId);
     }
 
+    /// override _handle to update exchange rate
+    /// @inheritdoc TokenRouter
     function _handle(
         uint32 _origin,
         bytes32 _sender,
@@ -97,33 +163,4 @@ contract HypERC4626 is HypERC20 {
         }
         super._handle(_origin, _sender, _message);
     }
-
-    // Override to send shares locally instead of assets
-    function transfer(
-        address to,
-        uint256 amount
-    ) public virtual override returns (bool) {
-        address owner = _msgSender();
-        _transfer(owner, to, assetsToShares(amount));
-        return true;
-    }
-
-    function shareBalanceOf(address account) public view returns (uint256) {
-        return super.balanceOf(account);
-    }
-
-    function balanceOf(
-        address account
-    ) public view virtual override returns (uint256) {
-        uint256 _balance = super.balanceOf(account);
-        return sharesToAssets(_balance);
-    }
-
-    function assetsToShares(uint256 _amount) public view returns (uint256) {
-        return _amount.mulDiv(PRECISION, exchangeRate);
-    }
-
-    function sharesToAssets(uint256 _shares) public view returns (uint256) {
-        return _shares.mulDiv(exchangeRate, PRECISION);
-    }
 }

package/contracts/token/extensions/HypERC4626Collateral.sol

@@ -66,11 +66,7 @@ contract HypERC4626Collateral is HypERC20Collateral {
         // Can't override _transferFromSender only because we need to pass shares in the token message
         _transferFromSender(_amount);
         uint256 _shares = _depositIntoVault(_amount);
-        uint256 _exchangeRate = PRECISION.mulDiv(
-            vault.totalAssets(),
-            vault.totalSupply(),
-            Math.Rounding.Down
-        );
+        uint256 _exchangeRate = vault.convertToAssets(PRECISION);
 
         rateUpdateNonce++;
         bytes memory _tokenMetadata = abi.encode(
@@ -121,15 +117,19 @@ contract HypERC4626Collateral is HypERC20Collateral {
      * @dev Update the exchange rate on the synthetic token by accounting for additional yield accrued to the underlying vault
      * @param _destinationDomain domain of the vault
      */
-    function rebase(uint32 _destinationDomain) public payable {
+    function rebase(
+        uint32 _destinationDomain,
+        bytes calldata _hookMetadata,
+        address _hook
+    ) public payable {
         // force a rebase with an empty transfer to 0x1
         _transferRemote(
             _destinationDomain,
             NULL_RECIPIENT,
             0,
             msg.value,
-            bytes(""),
-            address(0)
+            _hookMetadata,
+            _hook
         );
     }
 }

package/contracts/token/extensions/WHypERC4626.sol

@@ -0,0 +1,113 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+import {HypERC4626} from "./HypERC4626.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+/**
+ * @title WHypERC4626
+ * @author Abacus Works
+ * @notice A wrapper for HypERC4626 that allows for wrapping and unwrapping of underlying rebasing tokens
+ */
+contract WHypERC4626 is ERC20, PackageVersioned {
+    HypERC4626 public immutable underlying;
+
+    constructor(
+        HypERC4626 _underlying,
+        string memory name,
+        string memory symbol
+    ) ERC20(name, symbol) {
+        underlying = _underlying;
+    }
+
+    /*
+     * @notice Wraps an amount of underlying tokens into wrapped tokens
+     * @param _underlyingAmount The amount of underlying tokens to wrap
+     * @return The amount of wrapped tokens
+     */
+    function wrap(uint256 _underlyingAmount) external returns (uint256) {
+        require(
+            _underlyingAmount > 0,
+            "WHypERC4626: wrap amount must be greater than 0"
+        );
+        uint256 wrappedAmount = underlying.assetsToShares(_underlyingAmount);
+        _mint(msg.sender, wrappedAmount);
+        underlying.transferFrom(msg.sender, address(this), _underlyingAmount);
+        return wrappedAmount;
+    }
+
+    /*
+     * @notice Unwraps an amount of wrapped tokens into underlying tokens
+     * @param _wrappedAmount The amount of wrapped tokens to unwrap
+     * @return The amount of underlying tokens
+     */
+    function unwrap(uint256 _wrappedAmount) external returns (uint256) {
+        require(
+            _wrappedAmount > 0,
+            "WHypERC4626: unwrap amount must be greater than 0"
+        );
+        uint256 underlyingAmount = underlying.sharesToAssets(_wrappedAmount);
+        _burn(msg.sender, _wrappedAmount);
+        underlying.transfer(msg.sender, underlyingAmount);
+        return underlyingAmount;
+    }
+
+    /*
+     * @notice Gets the amount of wrapped tokens for a given amount of underlying tokens
+     * @param _underlyingAmount The amount of underlying tokens
+     * @return The amount of wrapped tokens
+     */
+    function getWrappedAmount(
+        uint256 _underlyingAmount
+    ) external view returns (uint256) {
+        return underlying.assetsToShares(_underlyingAmount);
+    }
+
+    /*
+     * @notice Gets the amount of underlying tokens for a given amount of wrapped tokens
+     * @param _wrappedAmount The amount of wrapped tokens
+     * @return The amount of underlying tokens
+     */
+    function getUnderlyingAmount(
+        uint256 _wrappedAmount
+    ) external view returns (uint256) {
+        return underlying.sharesToAssets(_wrappedAmount);
+    }
+
+    /*
+     * @notice Gets the amount of wrapped tokens for 1 unit of underlying tokens
+     * @return The amount of wrapped tokens
+     */
+    function wrappedPerUnderlying() external view returns (uint256) {
+        return underlying.assetsToShares(1 * 10 ** underlying.decimals());
+    }
+
+    /*
+     * @notice Gets the amount of underlying tokens for 1 unit of wrapped tokens
+     * @return The amount of underlying tokens
+     */
+    function underlyingPerWrapped() external view returns (uint256) {
+        return underlying.sharesToAssets(1 * 10 ** decimals());
+    }
+
+    /*
+     * @notice Gets the decimals of the wrapped token
+     * @return The decimals of the wrapped token
+     */
+    function decimals() public view override returns (uint8) {
+        return underlying.decimals();
+    }
+}