@hyperlane-xyz/core 3.10.1-beta1 → 3.11.0

package/contracts/test/ERC20Test.sol

@@ -3,6 +3,9 @@ pragma solidity >=0.8.0;
 
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
+import "../token/interfaces/IXERC20.sol";
+import "../token/interfaces/IFiatToken.sol";
+
 contract ERC20Test is ERC20 {
     uint8 public immutable _decimals;
 
@@ -28,3 +31,38 @@ contract ERC20Test is ERC20 {
         _mint(account, amount);
     }
 }
+
+contract FiatTokenTest is ERC20Test, IFiatToken {
+    constructor(
+        string memory name,
+        string memory symbol,
+        uint256 totalSupply,
+        uint8 __decimals
+    ) ERC20Test(name, symbol, totalSupply, __decimals) {}
+
+    function burn(uint256 amount) public override {
+        _burn(msg.sender, amount);
+    }
+
+    function mint(address account, uint256 amount) public returns (bool) {
+        _mint(account, amount);
+        return true;
+    }
+}
+
+contract XERC20Test is ERC20Test, IXERC20 {
+    constructor(
+        string memory name,
+        string memory symbol,
+        uint256 totalSupply,
+        uint8 __decimals
+    ) ERC20Test(name, symbol, totalSupply, __decimals) {}
+
+    function mint(address account, uint256 amount) public override {
+        _mint(account, amount);
+    }
+
+    function burn(address account, uint256 amount) public override {
+        _burn(account, amount);
+    }
+}

package/contracts/token/{HypERC20CollateralVaultDeposit.sol → extensions/HypERC20CollateralVaultDeposit.sol}

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity >=0.8.0;
 import "@openzeppelin/contracts/token/ERC20/extensions/ERC4626.sol";
-import {HypERC20Collateral} from "./HypERC20Collateral.sol";
+import {HypERC20Collateral} from "../HypERC20Collateral.sol";
 
 /**
  * @title Hyperlane ERC20 Token Collateral with deposits collateral to a vault

package/contracts/token/extensions/HypFiatTokenCollateral.sol

@@ -0,0 +1,32 @@
+pragma solidity >=0.8.0;
+
+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 {
+    constructor(
+        address _fiatToken,
+        address _mailbox
+    ) HypERC20Collateral(_fiatToken, _mailbox) {}
+
+    function _transferFromSender(
+        uint256 _amount
+    ) internal override returns (bytes memory metadata) {
+        // transfer amount to address(this)
+        metadata = super._transferFromSender(_amount);
+        // burn amount of address(this) balance
+        IFiatToken(address(wrappedToken)).burn(_amount);
+    }
+
+    function _transferTo(
+        address _recipient,
+        uint256 _amount,
+        bytes calldata /*metadata*/
+    ) internal override {
+        require(
+            IFiatToken(address(wrappedToken)).mint(_recipient, _amount),
+            "FiatToken mint failed"
+        );
+    }
+}

package/contracts/token/extensions/HypXERC20Collateral.sol

@@ -0,0 +1,26 @@
+pragma solidity >=0.8.0;
+
+import {IXERC20} from "../interfaces/IXERC20.sol";
+import {HypERC20Collateral} from "../HypERC20Collateral.sol";
+
+contract HypXERC20Collateral is HypERC20Collateral {
+    constructor(
+        address _xerc20,
+        address _mailbox
+    ) HypERC20Collateral(_xerc20, _mailbox) {}
+
+    function _transferFromSender(
+        uint256 _amountOrId
+    ) internal override returns (bytes memory metadata) {
+        IXERC20(address(wrappedToken)).burn(msg.sender, _amountOrId);
+        return "";
+    }
+
+    function _transferTo(
+        address _recipient,
+        uint256 _amountOrId,
+        bytes calldata /*metadata*/
+    ) internal override {
+        IXERC20(address(wrappedToken)).mint(_recipient, _amountOrId);
+    }
+}

package/contracts/token/interfaces/IFiatToken.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.0;
+
+// adapted from https://github.com/circlefin/stablecoin-evm
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+interface IFiatToken is IERC20 {
+    /**
+     * @notice Allows a minter to burn some of its own tokens.
+     * @dev The caller must be a minter, must not be blacklisted, and the amount to burn
+     * should be less than or equal to the account's balance.
+     * @param _amount the amount of tokens to be burned.
+     */
+    function burn(uint256 _amount) external;
+
+    /**
+     * @notice Mints fiat tokens to an address.
+     * @param _to The address that will receive the minted tokens.
+     * @param _amount The amount of tokens to mint. Must be less than or equal
+     * to the minterAllowance of the caller.
+     * @return True if the operation was successful.
+     */
+    function mint(address _to, uint256 _amount) external returns (bool);
+}

package/contracts/token/interfaces/IXERC20.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.0;
+
+// adapted from https://github.com/defi-wonderland/xERC20
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+interface IXERC20 is IERC20 {
+    /**
+     * @notice Mints tokens for a user
+     * @dev Can only be called by a minter
+     * @param _user The address of the user who needs tokens minted
+     * @param _amount The amount of tokens being minted
+     */
+    function mint(address _user, uint256 _amount) external;
+
+    /**
+     * @notice Burns tokens for a user
+     * @dev Can only be called by a minter
+     * @param _user The address of the user who needs tokens burned
+     * @param _amount The amount of tokens being burned
+     */
+    function burn(address _user, uint256 _amount) external;
+}

package/dist/buildArtifact.d.ts

@@ -0,0 +1 @@
+export const buildArtifact: any