@hyperlane-xyz/core 5.4.2-superchain.1 → 5.6.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.4.2-superchain.0";
+    string public constant PACKAGE_VERSION = "5.6.0";
 }

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/interfaces/IInterchainSecurityModule.sol

@@ -14,8 +14,7 @@ interface IInterchainSecurityModule {
         ARB_L2_TO_L1,
         WEIGHTED_MERKLE_ROOT_MULTISIG,
         WEIGHTED_MESSAGE_ID_MULTISIG,
-        OP_L2_TO_L1,
-        SUPERCHAIN
+        OP_L2_TO_L1
     }
 
     /**

package/contracts/interfaces/hooks/IPostDispatchHook.sol

@@ -27,8 +27,7 @@ interface IPostDispatchHook {
         LAYER_ZERO_V1,
         RATE_LIMITED,
         ARB_L2_TO_L1,
-        OP_L2_TO_L1,
-        SUPERCHAIN
+        OP_L2_TO_L1
     }
 
     /**

package/contracts/isms/TrustedRelayerIsm.sol

@@ -3,6 +3,7 @@ pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
 import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {Message} from "../libs/Message.sol";
 import {Mailbox} from "../Mailbox.sol";
 import {PackageVersioned} from "contracts/PackageVersioned.sol";
@@ -15,6 +16,14 @@ contract TrustedRelayerIsm is IInterchainSecurityModule, PackageVersioned {
     address public immutable trustedRelayer;
 
     constructor(address _mailbox, address _trustedRelayer) {
+        require(
+            _trustedRelayer != address(0),
+            "TrustedRelayerIsm: invalid relayer"
+        );
+        require(
+            Address.isContract(_mailbox),
+            "TrustedRelayerIsm: invalid mailbox"
+        );
         mailbox = Mailbox(_mailbox);
         trustedRelayer = _trustedRelayer;
     }

package/contracts/isms/hook/ArbL2ToL1Ism.sol

@@ -63,6 +63,7 @@ contract ArbL2ToL1Ism is
     ) external override returns (bool) {
         if (!isVerified(message)) {
             _verifyWithOutboxCall(metadata, message);
+            require(isVerified(message), "ArbL2ToL1Ism: message not verified");
         }
         releaseValueToRecipient(message);
         return true;

package/contracts/isms/hook/OPL2ToL1Ism.sol

@@ -66,9 +66,9 @@ contract OPL2ToL1Ism is
         bytes calldata metadata,
         bytes calldata message
     ) external override returns (bool) {
-        bool verified = isVerified(message);
-        if (!verified) {
+        if (!isVerified(message)) {
             _verifyWithPortalCall(metadata, message);
+            require(isVerified(message), "OPL2ToL1Ism: message not verified");
         }
         releaseValueToRecipient(message);
         return true;

package/contracts/isms/multisig/AbstractWeightedMultisigIsm.sol

@@ -73,11 +73,14 @@ abstract contract AbstractStaticWeightedMultisigIsm is
 
         // assumes that signatures are ordered by validator
         for (
-            uint256 i = 0;
-            _totalWeight < _thresholdWeight && i < _validatorCount;
-            ++i
+            uint256 signatureIndex = 0;
+            _totalWeight < _thresholdWeight && signatureIndex < _validatorCount;
+            ++signatureIndex
         ) {
-            address _signer = ECDSA.recover(_digest, signatureAt(_metadata, i));
+            address _signer = ECDSA.recover(
+                _digest,
+                signatureAt(_metadata, signatureIndex)
+            );
             // loop through remaining validators until we find a match
             while (
                 _validatorIndex < _validatorCount &&
@@ -90,6 +93,7 @@ abstract contract AbstractStaticWeightedMultisigIsm is
 
             // add the weight of the current validator
             _totalWeight += _validators[_validatorIndex].weight;
+            ++_validatorIndex;
         }
         require(
             _totalWeight >= _thresholdWeight,

package/contracts/libs/RateLimited.sol

@@ -1,5 +1,19 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
+
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ External Imports ============
 import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
 /**
@@ -7,16 +21,26 @@ import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/Own
  * @notice A contract used to keep track of an address sender's token amount limits.
  * @dev Implements a modified token bucket algorithm where the bucket is full in the beginning and gradually refills
  * See: https://dev.to/satrobit/rate-limiting-using-the-token-bucket-algorithm-3cjh
- **/
+ *
+ */
 contract RateLimited is OwnableUpgradeable {
     uint256 public constant DURATION = 1 days; // 86400
-    uint256 public filledLevel; /// @notice Current filled level
-    uint256 public refillRate; /// @notice Tokens per second refill rate
-    uint256 public lastUpdated; /// @notice Timestamp of the last time an action has been taken TODO prob can be uint40
+    /// @notice Current filled level
+    uint256 public filledLevel;
+    /// @notice Tokens per second refill rate
+    uint256 public refillRate;
+    /// @notice Timestamp of the last time an action has been taken
+    uint256 public lastUpdated;
 
     event RateLimitSet(uint256 _oldCapacity, uint256 _newCapacity);
 
+    event ConsumedFilledLevel(uint256 filledLevel, uint256 lastUpdated);
+
     constructor(uint256 _capacity) {
+        require(
+            _capacity >= DURATION,
+            "Capacity must be greater than DURATION"
+        );
         _transferOwnership(msg.sender);
         setRefillRate(_capacity);
         filledLevel = _capacity;
@@ -88,20 +112,22 @@ contract RateLimited is OwnableUpgradeable {
 
     /**
      * Validate an amount and decreases the currentCapacity
-     * @param _newAmount The amount to consume the fill level
+     * @param _consumedAmount The amount to consume the fill level
      * @return The new filled level
      */
     function validateAndConsumeFilledLevel(
-        uint256 _newAmount
+        uint256 _consumedAmount
     ) public returns (uint256) {
         uint256 adjustedFilledLevel = calculateCurrentLevel();
-        require(_newAmount <= adjustedFilledLevel, "RateLimitExceeded");
+        require(_consumedAmount <= adjustedFilledLevel, "RateLimitExceeded");
 
         // Reduce the filledLevel and update lastUpdated
-        uint256 _filledLevel = adjustedFilledLevel - _newAmount;
+        uint256 _filledLevel = adjustedFilledLevel - _consumedAmount;
         filledLevel = _filledLevel;
         lastUpdated = block.timestamp;
 
+        emit ConsumedFilledLevel(filledLevel, lastUpdated);
+
         return _filledLevel;
     }
 }

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/mock/MockMailbox.sol

@@ -77,4 +77,9 @@ contract MockMailbox is Mailbox {
         Mailbox(address(this)).process{value: msg.value}("", _message);
         inboundProcessedNonce++;
     }
+
+    function processInboundMessage(uint32 _nonce) public {
+        bytes memory _message = inboundMessages[_nonce];
+        Mailbox(address(this)).process("", _message);
+    }
 }

package/contracts/mock/MockOptimism.sol

@@ -4,10 +4,7 @@ pragma solidity ^0.8.0;
 import {CallLib} from "../middleware/libs/Call.sol";
 import {TypeCasts} from "../libs/TypeCasts.sol";
 import {ICrossDomainMessenger} from "../interfaces/optimism/ICrossDomainMessenger.sol";
-import {IL2toL2CrossDomainMessenger} from "../interfaces/optimism/IL2toL2CrossDomainMessenger.sol";
-import {ICrossL2Inbox} from "../interfaces/optimism/ICrossL2Inbox.sol";
 import {IOptimismPortal} from "../interfaces/optimism/IOptimismPortal.sol";
-import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 
 // for both L1 and L2
 contract MockOptimismMessenger is ICrossDomainMessenger {
@@ -62,73 +59,3 @@ contract MockOptimismPortal is IOptimismPortal {
         CallLib.call(call);
     }
 }
-
-contract MockL2toL2CrossDomainMessenger is IL2toL2CrossDomainMessenger {
-    uint256 public messageNonce;
-    bool passMessages = true;
-    address originCaller;
-
-    function encodeCall(
-        address _originCaller,
-        address target,
-        bytes calldata call
-    ) public view returns (bytes memory) {
-        return abi.encode(_originCaller, target, call);
-    }
-
-    function sendMessage(
-        uint256 _destination,
-        address _target,
-        bytes calldata _message
-    ) external returns (bytes32 msgHash_) {}
-
-    /// @notice Relays a message that was sent by the other CrossDomainMessenger contract. Can only
-    ///         be executed via cross-chain call from the other messenger OR if the message was
-    ///         already received once and is currently being replayed.
-    /// @param _id          Identifier of the SentMessage event to be relayed
-    /// @param _sentMessage Message payload of the `SentMessage` event
-    function relayMessage(
-        ICrossL2Inbox.Identifier calldata _id,
-        bytes calldata _sentMessage
-    ) external payable {
-        require(
-            passMessages,
-            "MockL2toL2CrossDomainMessenger: passMessages is false"
-        );
-        (address _originCaller, address target, bytes memory call) = abi.decode(
-            _sentMessage,
-            (address, address, bytes)
-        );
-        originCaller = _originCaller;
-        Address.functionCall(target, call);
-    }
-
-    /// @notice Mapping of message hashes to boolean receipt values. Note that a message will only
-    ///         be present in this mapping if it has successfully been relayed on this chain, and
-    ///         can therefore not be relayed again.
-    /// @param _msgHash message hash to check.
-    /// @return Returns true if the message corresponding to the `_msgHash` was successfully relayed.
-    function successfulMessages(bytes32 _msgHash) external view returns (bool) {
-        return true;
-    }
-
-    /// @notice Retrieves the sender of the current cross domain message.
-    /// @return sender_ Address of the sender of the current cross domain message.
-    function crossDomainMessageSender()
-        external
-        view
-        returns (address sender_)
-    {
-        return originCaller;
-    }
-
-    /// @notice Retrieves the source of the current cross domain message.
-    /// @return source_ Chain ID of the source of the current cross domain message.
-    function crossDomainMessageSource()
-        external
-        view
-        returns (uint256 source_)
-    {
-        return 0;
-    }
-}

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

@@ -1,13 +1,28 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
 
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
 import {IXERC20} from "../interfaces/IXERC20.sol";
 import {HypERC20} from "../HypERC20.sol";
-import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
 import {Message} from "../../libs/Message.sol";
 import {TokenMessage} from "../libs/TokenMessage.sol";
 import {TokenRouter} from "../libs/TokenRouter.sol";
 
+// ============ External Imports ============
+import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
+
 /**
  * @title Hyperlane ERC20 Rebasing Token
  * @author Abacus Works
@@ -17,9 +32,12 @@ contract HypERC4626 is HypERC20 {
     using Message for bytes;
     using TokenMessage for bytes;
 
+    event ExchangeRateUpdated(uint256 newExchangeRate, uint32 rateUpdateNonce);
+
     uint256 public constant PRECISION = 1e10;
     uint32 public immutable collateralDomain;
     uint256 public exchangeRate; // 1e10
+    uint32 public previousNonce;
 
     constructor(
         uint8 _decimals,
@@ -66,7 +84,16 @@ contract HypERC4626 is HypERC20 {
         bytes calldata _message
     ) internal virtual override {
         if (_origin == collateralDomain) {
-            exchangeRate = abi.decode(_message.metadata(), (uint256));
+            (uint256 newExchangeRate, uint32 rateUpdateNonce) = abi.decode(
+                _message.metadata(),
+                (uint256, uint32)
+            );
+            // only update if the nonce is greater than the previous nonce
+            if (rateUpdateNonce > previousNonce) {
+                exchangeRate = newExchangeRate;
+                previousNonce = rateUpdateNonce;
+                emit ExchangeRateUpdated(exchangeRate, rateUpdateNonce);
+            }
         }
         super._handle(_origin, _sender, _message);
     }

package/contracts/token/extensions/HypERC4626Collateral.sol

@@ -1,11 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity >=0.8.0;
 
-import "@openzeppelin/contracts/token/ERC20/extensions/ERC4626.sol";
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
 import {TokenMessage} from "../libs/TokenMessage.sol";
 import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 import {TypeCasts} from "../../libs/TypeCasts.sol";
 
+// ============ External Imports ============
+import "@openzeppelin/contracts/token/ERC20/extensions/ERC4626.sol";
+
 /**
  * @title Hyperlane ERC4626 Token Collateral with deposits collateral to a vault
  * @author Abacus Works
@@ -17,9 +32,13 @@ contract HypERC4626Collateral is HypERC20Collateral {
 
     // Address of the ERC4626 compatible vault
     ERC4626 public immutable vault;
+    // Precision for the exchange rate
     uint256 public constant PRECISION = 1e10;
+    // Null recipient for rebase transfer
     bytes32 public constant NULL_RECIPIENT =
         0x0000000000000000000000000000000000000000000000000000000000000001;
+    // Nonce for the rate update, to ensure sequential updates
+    uint32 public rateUpdateNonce;
 
     constructor(
         ERC4626 _vault,
@@ -47,12 +66,13 @@ 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(
+            _exchangeRate,
+            rateUpdateNonce
         );
-        bytes memory _tokenMetadata = abi.encode(_exchangeRate);
 
         bytes memory _tokenMessage = TokenMessage.format(
             _recipient,
@@ -97,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/HypERC4626OwnerCollateral.sol

@@ -1,9 +1,24 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity >=0.8.0;
 
-import "@openzeppelin/contracts/token/ERC20/extensions/ERC4626.sol";
+/*@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+     @@@@@  HYPERLANE  @@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@@@
+   @@@@@@@@@       @@@@@@@@@
+  @@@@@@@@@       @@@@@@@@@
+ @@@@@@@@@       @@@@@@@@@
+@@@@@@@@@       @@@@@@@@*/
+
+// ============ Internal Imports ============
 import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 
+// ============ External Imports ============
+import {ERC4626} from "@openzeppelin/contracts/token/ERC20/extensions/ERC4626.sol";
+
 /**
  * @title Hyperlane ERC20 Token Collateral with deposits collateral to a vault, the yield goes to the owner
  * @author ltyu
@@ -11,9 +26,12 @@ import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 contract HypERC4626OwnerCollateral is HypERC20Collateral {
     // Address of the ERC4626 compatible vault
     ERC4626 public immutable vault;
-
+    // standby precision for exchange rate
+    uint256 public constant PRECISION = 1e10;
     // Internal balance of total asset deposited
     uint256 public assetDeposited;
+    // Nonce for the rate update, to ensure sequential updates (not necessary for Owner variant but for compatibility with HypERC4626)
+    uint32 public rateUpdateNonce;
 
     event ExcessSharesSwept(uint256 amount, uint256 assetsRedeemed);
 
@@ -40,8 +58,11 @@ contract HypERC4626OwnerCollateral is HypERC20Collateral {
     function _transferFromSender(
         uint256 _amount
     ) internal override returns (bytes memory metadata) {
-        metadata = super._transferFromSender(_amount);
+        super._transferFromSender(_amount);
         _depositIntoVault(_amount);
+        rateUpdateNonce++;
+
+        return abi.encode(PRECISION, rateUpdateNonce);
     }
 
     /**

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();
+    }
+}