@hyperlane-xyz/core 3.12.1-alpha.0 → 3.13.0-next.0

package/README.md

@@ -28,7 +28,7 @@ yarn test
 
 ### Fixtures
 
-Some forge tests may generate fixtures in the [fixtures](./fixtures/) directory. This allows [SDK](../typescript/sdk) tests to leverage forge fuzzing. These are git ignored and should not be committed.
+Some forge tests may generate fixtures. This allows the [SDK](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/main/typescript/sdk) tests to leverage forge fuzzing. These are git ignored and should not be committed.
 
 ## License
 

package/contracts/test/ERC20Test.sol

@@ -65,4 +65,16 @@ contract XERC20Test is ERC20Test, IXERC20 {
     function burn(address account, uint256 amount) public override {
         _burn(account, amount);
     }
+
+    function setLimits(
+        address _bridge,
+        uint256 _mintingLimit,
+        uint256 _burningLimit
+    ) external {
+        require(false);
+    }
+
+    function owner() external returns (address) {
+        return address(0x0);
+    }
 }

package/contracts/token/extensions/{HypFiatTokenCollateral.sol → HypFiatToken.sol}

@@ -5,7 +5,7 @@ import {IFiatToken} from "../interfaces/IFiatToken.sol";
 import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 
 // see https://github.com/circlefin/stablecoin-evm/blob/master/doc/tokendesign.md#issuing-and-destroying-tokens
-contract HypFiatTokenCollateral is HypERC20Collateral {
+contract HypFiatToken is HypERC20Collateral {
     constructor(
         address _fiatToken,
         address _mailbox

package/contracts/token/extensions/{HypXERC20Collateral.sol → HypXERC20.sol}

@@ -4,7 +4,7 @@ pragma solidity >=0.8.0;
 import {IXERC20} from "../interfaces/IXERC20.sol";
 import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 
-contract HypXERC20Collateral is HypERC20Collateral {
+contract HypXERC20 is HypERC20Collateral {
     constructor(
         address _xerc20,
         address _mailbox

package/contracts/token/extensions/HypXERC20Lockbox.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+import {IXERC20Lockbox} from "../interfaces/IXERC20Lockbox.sol";
+import {IXERC20, IERC20} from "../interfaces/IXERC20.sol";
+import {HypERC20Collateral} from "../HypERC20Collateral.sol";
+
+contract HypXERC20Lockbox is HypERC20Collateral {
+    uint256 constant MAX_INT = 2 ** 256 - 1;
+
+    IXERC20Lockbox public immutable lockbox;
+    IXERC20 public immutable xERC20;
+
+    constructor(
+        address _lockbox,
+        address _mailbox
+    ) HypERC20Collateral(address(IXERC20Lockbox(_lockbox).ERC20()), _mailbox) {
+        lockbox = IXERC20Lockbox(_lockbox);
+        xERC20 = lockbox.XERC20();
+
+        // grant infinite approvals to lockbox
+        IERC20(wrappedToken).approve(_lockbox, MAX_INT);
+        xERC20.approve(_lockbox, MAX_INT);
+    }
+
+    function _transferFromSender(
+        uint256 _amount
+    ) internal override returns (bytes memory) {
+        // transfer erc20 from sender
+        super._transferFromSender(_amount);
+        // convert erc20 to xERC20
+        lockbox.deposit(_amount);
+        // burn xERC20
+        xERC20.burn(address(this), _amount);
+        return bytes("");
+    }
+
+    function _transferTo(
+        address _recipient,
+        uint256 _amount,
+        bytes calldata /*metadata*/
+    ) internal override {
+        // mint xERC20
+        xERC20.mint(address(this), _amount);
+        // convert xERC20 to erc20
+        lockbox.withdrawTo(_recipient, _amount);
+    }
+}

package/contracts/token/interfaces/IXERC20.sol

@@ -21,4 +21,19 @@ interface IXERC20 is IERC20 {
      * @param _amount The amount of tokens being burned
      */
     function burn(address _user, uint256 _amount) external;
+
+    /**
+     * @notice Updates the limits of any bridge
+     * @dev Can only be called by the owner
+     * @param _mintingLimit The updated minting limit we are setting to the bridge
+     * @param _burningLimit The updated burning limit we are setting to the bridge
+     * @param _bridge The address of the bridge we are setting the limits too
+     */
+    function setLimits(
+        address _bridge,
+        uint256 _mintingLimit,
+        uint256 _burningLimit
+    ) external;
+
+    function owner() external returns (address);
 }

package/contracts/token/interfaces/IXERC20Lockbox.sol

@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.4 <0.9.0;
+
+// adapted from https://github.com/defi-wonderland/xERC20
+
+import {IXERC20} from "./IXERC20.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+interface IXERC20Lockbox {
+    /**
+     * @notice The XERC20 token of this contract
+     */
+    function XERC20() external returns (IXERC20);
+
+    /**
+     * @notice The ERC20 token of this contract
+     */
+    function ERC20() external returns (IERC20);
+
+    /**
+     * @notice Deposit ERC20 tokens into the lockbox
+     *
+     * @param _amount The amount of tokens to deposit
+     */
+
+    function deposit(uint256 _amount) external;
+
+    /**
+     * @notice Deposit ERC20 tokens into the lockbox, and send the XERC20 to a user
+     *
+     * @param _user The user to send the XERC20 to
+     * @param _amount The amount of tokens to deposit
+     */
+
+    function depositTo(address _user, uint256 _amount) external;
+
+    /**
+     * @notice Deposit the native asset into the lockbox, and send the XERC20 to a user
+     *
+     * @param _user The user to send the XERC20 to
+     */
+
+    function depositNativeTo(address _user) external payable;
+
+    /**
+     * @notice Withdraw ERC20 tokens from the lockbox
+     *
+     * @param _amount The amount of tokens to withdraw
+     */
+
+    function withdraw(uint256 _amount) external;
+
+    /**
+     * @notice Withdraw ERC20 tokens from the lockbox
+     *
+     * @param _user The user to withdraw to
+     * @param _amount The amount of tokens to withdraw
+     */
+
+    function withdrawTo(address _user, uint256 _amount) external;
+}

package/contracts/token/libs/TokenMessage.sol

@@ -10,6 +10,13 @@ library TokenMessage {
         return abi.encodePacked(_recipient, _amount, _metadata);
     }
 
+    function format(
+        bytes32 _recipient,
+        uint256 _amount
+    ) internal pure returns (bytes memory) {
+        return abi.encodePacked(_recipient, _amount);
+    }
+
     function recipient(bytes calldata message) internal pure returns (bytes32) {
         return bytes32(message[0:32]);
     }