@hyperlane-xyz/core 3.1.2 → 3.1.3

package/contracts/token/HypERC20.sol

@@ -37,7 +37,9 @@ contract HypERC20 is ERC20Upgradeable, TokenRouter {
         return _decimals;
     }
 
-    function balanceOf(address _account)
+    function balanceOf(
+        address _account
+    )
         public
         view
         virtual
@@ -51,11 +53,9 @@ contract HypERC20 is ERC20Upgradeable, TokenRouter {
      * @dev Burns `_amount` of token from `msg.sender` balance.
      * @inheritdoc TokenRouter
      */
-    function _transferFromSender(uint256 _amount)
-        internal
-        override
-        returns (bytes memory)
-    {
+    function _transferFromSender(
+        uint256 _amount
+    ) internal override returns (bytes memory) {
         _burn(msg.sender, _amount);
         return bytes(""); // no metadata
     }

package/contracts/token/HypERC20Collateral.sol

@@ -25,12 +25,9 @@ contract HypERC20Collateral is TokenRouter {
         wrappedToken = IERC20(erc20);
     }
 
-    function balanceOf(address _account)
-        external
-        view
-        override
-        returns (uint256)
-    {
+    function balanceOf(
+        address _account
+    ) external view override returns (uint256) {
         return wrappedToken.balanceOf(_account);
     }
 
@@ -38,11 +35,9 @@ contract HypERC20Collateral is TokenRouter {
      * @dev Transfers `_amount` of `wrappedToken` from `msg.sender` to this contract.
      * @inheritdoc TokenRouter
      */
-    function _transferFromSender(uint256 _amount)
-        internal
-        override
-        returns (bytes memory)
-    {
+    function _transferFromSender(
+        uint256 _amount
+    ) internal override returns (bytes memory) {
         wrappedToken.safeTransferFrom(msg.sender, address(this), _amount);
         return bytes(""); // no metadata
     }

package/contracts/token/HypERC721.sol

@@ -34,7 +34,9 @@ contract HypERC721 is ERC721EnumerableUpgradeable, TokenRouter {
         }
     }
 
-    function balanceOf(address _account)
+    function balanceOf(
+        address _account
+    )
         public
         view
         virtual
@@ -48,12 +50,9 @@ contract HypERC721 is ERC721EnumerableUpgradeable, TokenRouter {
      * @dev Asserts `msg.sender` is owner and burns `_tokenId`.
      * @inheritdoc TokenRouter
      */
-    function _transferFromSender(uint256 _tokenId)
-        internal
-        virtual
-        override
-        returns (bytes memory)
-    {
+    function _transferFromSender(
+        uint256 _tokenId
+    ) internal virtual override returns (bytes memory) {
         require(ownerOf(_tokenId) == msg.sender, "!owner");
         _burn(_tokenId);
         return bytes(""); // no metadata

package/contracts/token/HypERC721Collateral.sol

@@ -29,12 +29,9 @@ contract HypERC721Collateral is TokenRouter {
      * @dev Returns the balance of `_account` for `wrappedToken`.
      * @inheritdoc TokenRouter
      */
-    function balanceOf(address _account)
-        external
-        view
-        override
-        returns (uint256)
-    {
+    function balanceOf(
+        address _account
+    ) external view override returns (uint256) {
         return IERC721(wrappedToken).balanceOf(_account);
     }
 
@@ -42,12 +39,9 @@ contract HypERC721Collateral is TokenRouter {
      * @dev Transfers `_tokenId` of `wrappedToken` from `msg.sender` to this contract.
      * @inheritdoc TokenRouter
      */
-    function _transferFromSender(uint256 _tokenId)
-        internal
-        virtual
-        override
-        returns (bytes memory)
-    {
+    function _transferFromSender(
+        uint256 _tokenId
+    ) internal virtual override returns (bytes memory) {
         // safeTransferFrom not used here because recipient is this contract
         wrappedToken.transferFrom(msg.sender, address(this), _tokenId);
         return bytes(""); // no metadata

package/contracts/token/HypNative.sol

@@ -34,12 +34,9 @@ contract HypNative is TokenRouter {
         return _transferRemote(_destination, _recipient, _amount, gasPayment);
     }
 
-    function balanceOf(address _account)
-        external
-        view
-        override
-        returns (uint256)
-    {
+    function balanceOf(
+        address _account
+    ) external view override returns (uint256) {
         return _account.balance;
     }
 
@@ -48,12 +45,9 @@ contract HypNative is 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)
-    {
+    function _transferFromSender(
+        uint256
+    ) internal pure override returns (bytes memory) {
         return bytes(""); // no metadata
     }
 

package/contracts/token/README.md

@@ -65,7 +65,6 @@ interface TokenRouter {
     uint256 amount
   ) public returns (bytes32 messageId);
 }
-
 ```
 
 **NOTE:** The [Relayer](https://docs.hyperlane.xyz/docs/protocol/agents/relayer) shown below must be compensated. Please refer to the relevant guide on [paying for interchain gas](https://docs.hyperlane.xyz/docs/build-with-hyperlane/guides/paying-for-interchain-gas) on the `messageID` returned from the `transferRemote` call.

package/contracts/token/extensions/FastHypERC20.sol

@@ -13,9 +13,10 @@ import {ERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/
  * @dev Supply on each chain is not constant but the aggregate supply across all chains is.
  */
 contract FastHypERC20 is FastTokenRouter, HypERC20 {
-    constructor(uint8 __decimals, address _mailbox)
-        HypERC20(__decimals, _mailbox)
-    {}
+    constructor(
+        uint8 __decimals,
+        address _mailbox
+    ) HypERC20(__decimals, _mailbox) {}
 
     /**
      * @dev delegates transfer logic to `_transferTo`.
@@ -33,10 +34,10 @@ contract FastHypERC20 is FastTokenRouter, HypERC20 {
      * @dev Mints `_amount` of tokens to `_recipient`.
      * @inheritdoc FastTokenRouter
      */
-    function _fastTransferTo(address _recipient, uint256 _amount)
-        internal
-        override
-    {
+    function _fastTransferTo(
+        address _recipient,
+        uint256 _amount
+    ) internal override {
         _mint(_recipient, _amount);
     }
 
@@ -44,20 +45,16 @@ contract FastHypERC20 is FastTokenRouter, HypERC20 {
      * @dev Burns `_amount` of tokens from `_recipient`.
      * @inheritdoc FastTokenRouter
      */
-    function _fastRecieveFrom(address _sender, uint256 _amount)
-        internal
-        override
-    {
+    function _fastRecieveFrom(
+        address _sender,
+        uint256 _amount
+    ) internal override {
         _burn(_sender, _amount);
     }
 
-    function balanceOf(address _account)
-        public
-        view
-        virtual
-        override(HypERC20, TokenRouter)
-        returns (uint256)
-    {
+    function balanceOf(
+        address _account
+    ) public view virtual override(HypERC20, TokenRouter) returns (uint256) {
         return ERC20Upgradeable.balanceOf(_account);
     }
 }

package/contracts/token/extensions/FastHypERC20Collateral.sol

@@ -19,9 +19,10 @@ contract FastHypERC20Collateral is FastTokenRouter, HypERC20Collateral {
      * @notice Constructor
      * @param erc20 Address of the token to keep as collateral
      */
-    constructor(address erc20, address _mailbox)
-        HypERC20Collateral(erc20, _mailbox)
-    {}
+    constructor(
+        address erc20,
+        address _mailbox
+    ) HypERC20Collateral(erc20, _mailbox) {}
 
     /**
      * @dev delegates transfer logic to `_transferTo`.
@@ -39,10 +40,10 @@ contract FastHypERC20Collateral is FastTokenRouter, HypERC20Collateral {
      * @dev Transfers `_amount` of `wrappedToken` to `_recipient`.
      * @inheritdoc FastTokenRouter
      */
-    function _fastTransferTo(address _recipient, uint256 _amount)
-        internal
-        override
-    {
+    function _fastTransferTo(
+        address _recipient,
+        uint256 _amount
+    ) internal override {
         wrappedToken.safeTransfer(_recipient, _amount);
     }
 
@@ -50,10 +51,10 @@ contract FastHypERC20Collateral is FastTokenRouter, HypERC20Collateral {
      * @dev Transfers in `_amount` of `wrappedToken` from `_recipient`.
      * @inheritdoc FastTokenRouter
      */
-    function _fastRecieveFrom(address _sender, uint256 _amount)
-        internal
-        override
-    {
+    function _fastRecieveFrom(
+        address _sender,
+        uint256 _amount
+    ) internal override {
         wrappedToken.safeTransferFrom(_sender, address(this), _amount);
     }
 }

package/contracts/token/extensions/HypERC721URICollateral.sol

@@ -11,20 +11,19 @@ import {IERC721MetadataUpgradeable} from "@openzeppelin/contracts-upgradeable/to
  */
 contract HypERC721URICollateral is HypERC721Collateral {
     // solhint-disable-next-line no-empty-blocks
-    constructor(address erc721, address _mailbox)
-        HypERC721Collateral(erc721, _mailbox)
-    {}
+    constructor(
+        address erc721,
+        address _mailbox
+    ) HypERC721Collateral(erc721, _mailbox) {}
 
     /**
      * @dev Transfers `_tokenId` of `wrappedToken` from `msg.sender` to this contract.
      * @return The URI of `_tokenId` on `wrappedToken`.
      * @inheritdoc HypERC721Collateral
      */
-    function _transferFromSender(uint256 _tokenId)
-        internal
-        override
-        returns (bytes memory)
-    {
+    function _transferFromSender(
+        uint256 _tokenId
+    ) internal override returns (bytes memory) {
         HypERC721Collateral._transferFromSender(_tokenId);
         return
             bytes(

package/contracts/token/extensions/HypERC721URIStorage.sol

@@ -6,6 +6,7 @@ import {HypERC721} from "../HypERC721.sol";
 import {ERC721URIStorageUpgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721URIStorageUpgradeable.sol";
 import {ERC721EnumerableUpgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/extensions/ERC721EnumerableUpgradeable.sol";
 import {ERC721Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";
+import {IERC721Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol";
 
 /**
  * @title Hyperlane ERC721 Token that extends ERC721URIStorage with remote transfer and URI relay functionality.
@@ -14,10 +15,12 @@ import {ERC721Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC72
 contract HypERC721URIStorage is HypERC721, ERC721URIStorageUpgradeable {
     constructor(address _mailbox) HypERC721(_mailbox) {}
 
-    function balanceOf(address account)
+    function balanceOf(
+        address account
+    )
         public
         view
-        override(HypERC721, ERC721Upgradeable)
+        override(HypERC721, ERC721Upgradeable, IERC721Upgradeable)
         returns (uint256)
     {
         return HypERC721.balanceOf(account);
@@ -27,11 +30,9 @@ contract HypERC721URIStorage is HypERC721, ERC721URIStorageUpgradeable {
      * @return _tokenURI The URI of `_tokenId`.
      * @inheritdoc HypERC721
      */
-    function _transferFromSender(uint256 _tokenId)
-        internal
-        override
-        returns (bytes memory _tokenURI)
-    {
+    function _transferFromSender(
+        uint256 _tokenId
+    ) internal override returns (bytes memory _tokenURI) {
         _tokenURI = bytes(tokenURI(_tokenId)); // requires minted
         HypERC721._transferFromSender(_tokenId);
     }
@@ -49,7 +50,9 @@ contract HypERC721URIStorage is HypERC721, ERC721URIStorageUpgradeable {
         _setTokenURI(_tokenId, string(_tokenURI)); // requires minted
     }
 
-    function tokenURI(uint256 tokenId)
+    function tokenURI(
+        uint256 tokenId
+    )
         public
         view
         override(ERC721Upgradeable, ERC721URIStorageUpgradeable)
@@ -72,19 +75,20 @@ contract HypERC721URIStorage is HypERC721, ERC721URIStorageUpgradeable {
         );
     }
 
-    function supportsInterface(bytes4 interfaceId)
+    function supportsInterface(
+        bytes4 interfaceId
+    )
         public
         view
-        override(ERC721EnumerableUpgradeable, ERC721Upgradeable)
+        override(ERC721EnumerableUpgradeable, ERC721URIStorageUpgradeable)
         returns (bool)
     {
         return ERC721EnumerableUpgradeable.supportsInterface(interfaceId);
     }
 
-    function _burn(uint256 tokenId)
-        internal
-        override(ERC721URIStorageUpgradeable, ERC721Upgradeable)
-    {
+    function _burn(
+        uint256 tokenId
+    ) internal override(ERC721URIStorageUpgradeable, ERC721Upgradeable) {
         ERC721URIStorageUpgradeable._burn(tokenId);
     }
 }

package/contracts/token/libs/FastTokenRouter.sol

@@ -192,15 +192,17 @@ abstract contract FastTokenRouter is TokenRouter {
      * @dev Should transfer `_amount` of tokens to `_recipient`.
      * @dev The implementation is delegated.
      */
-    function _fastTransferTo(address _recipient, uint256 _amount)
-        internal
-        virtual;
+    function _fastTransferTo(
+        address _recipient,
+        uint256 _amount
+    ) internal virtual;
 
     /**
      * @dev Should collect `amount` of tokens from `_sender`.
      * @dev The implementation is delegated.
      */
-    function _fastRecieveFrom(address _sender, uint256 _amount)
-        internal
-        virtual;
+    function _fastRecieveFrom(
+        address _sender,
+        uint256 _amount
+    ) internal virtual;
 }

package/contracts/token/libs/TokenMessage.sol

@@ -23,11 +23,9 @@ library TokenMessage {
         return amount(message);
     }
 
-    function metadata(bytes calldata message)
-        internal
-        pure
-        returns (bytes calldata)
-    {
+    function metadata(
+        bytes calldata message
+    ) internal pure returns (bytes calldata) {
         return message[64:];
     }
 }

package/contracts/token/libs/TokenRouter.sol

@@ -89,10 +89,9 @@ abstract contract TokenRouter is GasRouter {
      * @dev Called by `transferRemote` before message dispatch.
      * @dev Optionally returns `metadata` associated with the transfer to be passed in message.
      */
-    function _transferFromSender(uint256 _amountOrId)
-        internal
-        virtual
-        returns (bytes memory metadata);
+    function _transferFromSender(
+        uint256 _amountOrId
+    ) internal virtual returns (bytes memory metadata);
 
     /**
      * @notice Returns the balance of `account` on this token router.