@hyperlane-xyz/core 0.5.5 → 1.0.0-beta0

package/contracts/middleware/liquidity-layer/adapters/PortalAdapter.sol

@@ -1,215 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.13;
-
-import {Router} from "../../../Router.sol";
-
-import {IPortalTokenBridge} from "../interfaces/portal/IPortalTokenBridge.sol";
-import {ILiquidityLayerAdapter} from "../interfaces/ILiquidityLayerAdapter.sol";
-import {TypeCasts} from "../../../libs/TypeCasts.sol";
-
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-
-contract PortalAdapter is ILiquidityLayerAdapter, Router {
-    /// @notice The Portal TokenBridge contract.
-    IPortalTokenBridge public portalTokenBridge;
-
-    /// @notice The LiquidityLayerRouter contract.
-    address public liquidityLayerRouter;
-
-    /// @notice Hyperlane domain => Wormhole domain.
-    mapping(uint32 => uint16) public hyperlaneDomainToWormholeDomain;
-    /// @notice transferId => token address
-    mapping(bytes32 => address) public portalTransfersProcessed;
-
-    uint32 localDomain;
-    // We could technically use Portal's sequence number here but it doesn't
-    // get passed through, so we would have to parse the VAA twice
-    // 224 bits should be large enough and allows us to pack into a single slot
-    // with a Hyperlane domain
-    uint224 public nonce = 0;
-
-    /**
-     * @notice Emits the nonce of the Portal message when a token is bridged.
-     * @param nonce The nonce of the Portal message.
-     * @param portalSequence The sequence of the Portal message.
-     * @param destination The hyperlane domain of the destination
-     */
-    event BridgedToken(
-        uint256 nonce,
-        uint64 portalSequence,
-        uint32 destination
-    );
-
-    /**
-     * @notice Emitted when the Hyperlane domain to Wormhole domain mapping is updated.
-     * @param hyperlaneDomain The Hyperlane domain.
-     * @param wormholeDomain The Wormhole domain.
-     */
-    event DomainAdded(uint32 indexed hyperlaneDomain, uint32 wormholeDomain);
-
-    modifier onlyLiquidityLayerRouter() {
-        require(msg.sender == liquidityLayerRouter, "!liquidityLayerRouter");
-        _;
-    }
-
-    /**
-     * @param _localDomain The local hyperlane domain
-     * @param _owner The new owner.
-     * @param _portalTokenBridge The Portal TokenBridge contract.
-     * @param _liquidityLayerRouter The LiquidityLayerRouter contract.
-     */
-    function initialize(
-        uint32 _localDomain,
-        address _owner,
-        address _portalTokenBridge,
-        address _liquidityLayerRouter
-    ) public initializer {
-        // Transfer ownership of the contract to deployer
-        _transferOwnership(_owner);
-
-        localDomain = _localDomain;
-        portalTokenBridge = IPortalTokenBridge(_portalTokenBridge);
-        liquidityLayerRouter = _liquidityLayerRouter;
-    }
-
-    /**
-     * Sends tokens as requested by the router
-     * @param _destinationDomain The hyperlane domain of the destination
-     * @param _token The token address
-     * @param _amount The amount of tokens to send
-     */
-    function sendTokens(
-        uint32 _destinationDomain,
-        bytes32, // _recipientAddress, unused
-        address _token,
-        uint256 _amount
-    ) external onlyLiquidityLayerRouter returns (bytes memory) {
-        nonce = nonce + 1;
-        uint16 _wormholeDomain = hyperlaneDomainToWormholeDomain[
-            _destinationDomain
-        ];
-
-        bytes32 _remoteRouter = _mustHaveRemoteRouter(_destinationDomain);
-
-        // Approve the token to Portal. We assume that the LiquidityLayerRouter
-        // has already transferred the token to this contract.
-        require(
-            IERC20(_token).approve(address(portalTokenBridge), _amount),
-            "!approval"
-        );
-
-        uint64 portalSequence = portalTokenBridge.transferTokensWithPayload(
-            _token,
-            _amount,
-            _wormholeDomain,
-            _remoteRouter,
-            // Nonce for grouping Portal messages in the same tx, not relevant for us
-            // https://book.wormhole.com/technical/evm/coreLayer.html#emitting-a-vaa
-            0,
-            // Portal Payload used in completeTransfer
-            abi.encode(localDomain, nonce)
-        );
-
-        emit BridgedToken(nonce, portalSequence, _destinationDomain);
-        return abi.encode(nonce);
-    }
-
-    /**
-     * Sends the tokens to the recipient as requested by the router
-     * @param _originDomain The hyperlane domain of the origin
-     * @param _recipient The address of the recipient
-     * @param _amount The amount of tokens to send
-     * @param _adapterData The adapter data from the origin chain, containing the nonce
-     */
-    function receiveTokens(
-        uint32 _originDomain, // Hyperlane domain
-        address _recipient,
-        uint256 _amount,
-        bytes calldata _adapterData // The adapter data from the message
-    ) external onlyLiquidityLayerRouter returns (address, uint256) {
-        // Get the nonce information from the adapterData
-        uint224 _nonce = abi.decode(_adapterData, (uint224));
-
-        address _tokenAddress = portalTransfersProcessed[
-            transferId(_originDomain, _nonce)
-        ];
-
-        require(
-            _tokenAddress != address(0x0),
-            "Portal Transfer has not yet been completed"
-        );
-
-        IERC20 _token = IERC20(_tokenAddress);
-
-        // Transfer the token out to the recipient
-        // TODO: use safeTransfer
-        // Portal doesn't charge any fee, so we can safely transfer out the
-        // exact amount that was bridged over.
-        require(_token.transfer(_recipient, _amount), "!transfer out");
-        return (_tokenAddress, _amount);
-    }
-
-    /**
-     * Completes the Portal transfer which sends the funds to this adapter.
-     * The router can call receiveTokens to move those funds to the ultimate recipient.
-     * @param encodedVm The VAA from the Wormhole Guardians
-     */
-    function completeTransfer(bytes memory encodedVm) public {
-        bytes memory _tokenBridgeTransferWithPayload = portalTokenBridge
-            .completeTransferWithPayload(encodedVm);
-        IPortalTokenBridge.TransferWithPayload
-            memory _transfer = portalTokenBridge.parseTransferWithPayload(
-                _tokenBridgeTransferWithPayload
-            );
-
-        (uint32 _originDomain, uint224 _nonce) = abi.decode(
-            _transfer.payload,
-            (uint32, uint224)
-        );
-
-        // Logic taken from here https://github.com/wormhole-foundation/wormhole/blob/dev.v2/ethereum/contracts/bridge/Bridge.sol#L503
-        address tokenAddress = _transfer.tokenChain ==
-            hyperlaneDomainToWormholeDomain[localDomain]
-            ? TypeCasts.bytes32ToAddress(_transfer.tokenAddress)
-            : portalTokenBridge.wrappedAsset(
-                _transfer.tokenChain,
-                _transfer.tokenAddress
-            );
-
-        portalTransfersProcessed[
-            transferId(_originDomain, _nonce)
-        ] = tokenAddress;
-    }
-
-    // This contract is only a Router to be aware of remote router addresses,
-    // and doesn't actually send/handle Hyperlane messages directly
-    function _handle(
-        uint32, // origin
-        bytes32, // sender
-        bytes calldata // message
-    ) internal pure override {
-        revert("No messages expected");
-    }
-
-    function addDomain(uint32 _hyperlaneDomain, uint16 _wormholeDomain)
-        external
-        onlyOwner
-    {
-        hyperlaneDomainToWormholeDomain[_hyperlaneDomain] = _wormholeDomain;
-
-        emit DomainAdded(_hyperlaneDomain, _wormholeDomain);
-    }
-
-    /**
-     * The key that is used to track fulfilled Portal transfers
-     * @param _hyperlaneDomain The hyperlane of the origin
-     * @param _nonce The nonce of the adapter on the origin
-     */
-    function transferId(uint32 _hyperlaneDomain, uint224 _nonce)
-        public
-        pure
-        returns (bytes32)
-    {
-        return bytes32(abi.encodePacked(_hyperlaneDomain, _nonce));
-    }
-}

package/contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol

@@ -1,87 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.13;
-
-// Portal's interface from their docs
-interface IPortalTokenBridge {
-    struct Transfer {
-        uint8 payloadID;
-        uint256 amount;
-        bytes32 tokenAddress;
-        uint16 tokenChain;
-        bytes32 to;
-        uint16 toChain;
-        uint256 fee;
-    }
-
-    struct TransferWithPayload {
-        uint8 payloadID;
-        uint256 amount;
-        bytes32 tokenAddress;
-        uint16 tokenChain;
-        bytes32 to;
-        uint16 toChain;
-        bytes32 fromAddress;
-        bytes payload;
-    }
-
-    struct AssetMeta {
-        uint8 payloadID;
-        bytes32 tokenAddress;
-        uint16 tokenChain;
-        uint8 decimals;
-        bytes32 symbol;
-        bytes32 name;
-    }
-
-    struct RegisterChain {
-        bytes32 module;
-        uint8 action;
-        uint16 chainId;
-        uint16 emitterChainID;
-        bytes32 emitterAddress;
-    }
-
-    struct UpgradeContract {
-        bytes32 module;
-        uint8 action;
-        uint16 chainId;
-        bytes32 newContract;
-    }
-
-    struct RecoverChainId {
-        bytes32 module;
-        uint8 action;
-        uint256 evmChainId;
-        uint16 newChainId;
-    }
-
-    event ContractUpgraded(
-        address indexed oldContract,
-        address indexed newContract
-    );
-
-    function transferTokensWithPayload(
-        address token,
-        uint256 amount,
-        uint16 recipientChain,
-        bytes32 recipient,
-        uint32 nonce,
-        bytes memory payload
-    ) external payable returns (uint64 sequence);
-
-    function completeTransferWithPayload(bytes memory encodedVm)
-        external
-        returns (bytes memory);
-
-    function parseTransferWithPayload(bytes memory encoded)
-        external
-        pure
-        returns (TransferWithPayload memory transfer);
-
-    function wrappedAsset(uint16 tokenChainId, bytes32 tokenAddress)
-        external
-        view
-        returns (address);
-
-    function isWrappedAsset(address token) external view returns (bool);
-}

package/contracts/mock/MockInbox.sol

@@ -1,52 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.0;
-
-import {TypeCasts} from "../libs/TypeCasts.sol";
-import {IMessageRecipient} from "../../interfaces/IMessageRecipient.sol";
-
-contract MockInbox {
-    using TypeCasts for bytes32;
-
-    struct PendingMessage {
-        uint32 originDomain;
-        bytes32 sender;
-        bytes32 recipient;
-        bytes messageBody;
-    }
-
-    mapping(uint256 => PendingMessage) pendingMessages;
-    uint256 totalMessages = 0;
-    uint256 messageProcessed = 0;
-
-    function addPendingMessage(
-        uint32 _originDomain,
-        bytes32 _sender,
-        bytes32 _recipient,
-        bytes memory _messageBody
-    ) external {
-        pendingMessages[totalMessages] = PendingMessage(
-            _originDomain,
-            _sender,
-            _recipient,
-            _messageBody
-        );
-        totalMessages += 1;
-    }
-
-    function processNextPendingMessage() public {
-        PendingMessage memory pendingMessage = pendingMessages[
-            messageProcessed
-        ];
-
-        address recipient = pendingMessage.recipient.bytes32ToAddress();
-
-        IMessageRecipient(recipient).handle(
-            // This is completely arbitrary and consumers should not rely
-            // on domain handling in the mock mailbox contracts.
-            pendingMessage.originDomain,
-            pendingMessage.sender,
-            pendingMessage.messageBody
-        );
-        messageProcessed += 1;
-    }
-}

package/contracts/mock/MockOutbox.sol

@@ -1,30 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.0;
-
-import {MockInbox} from "./MockInbox.sol";
-import {TypeCasts} from "../libs/TypeCasts.sol";
-
-contract MockOutbox {
-    MockInbox inbox;
-    uint32 domain;
-    using TypeCasts for address;
-
-    constructor(uint32 _domain, address _inbox) {
-        domain = _domain;
-        inbox = MockInbox(_inbox);
-    }
-
-    function dispatch(
-        uint32,
-        bytes32 _recipientAddress,
-        bytes calldata _messageBody
-    ) external returns (uint256) {
-        inbox.addPendingMessage(
-            domain,
-            msg.sender.addressToBytes32(),
-            _recipientAddress,
-            _messageBody
-        );
-        return 1;
-    }
-}

package/contracts/mock/MockPortalBridge.sol

@@ -1,89 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.13;
-
-import {IPortalTokenBridge} from "../middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol";
-import {MockToken} from "./MockToken.sol";
-import {TypeCasts} from "../libs/TypeCasts.sol";
-
-contract MockPortalBridge is IPortalTokenBridge {
-    uint256 nextNonce = 0;
-    MockToken token;
-
-    constructor(MockToken _token) {
-        token = _token;
-    }
-
-    function transferTokensWithPayload(
-        address,
-        uint256 amount,
-        uint16,
-        bytes32,
-        uint32,
-        bytes memory
-    ) external payable returns (uint64 sequence) {
-        nextNonce = nextNonce + 1;
-        token.transferFrom(msg.sender, address(this), amount);
-        token.burn(amount);
-        return uint64(nextNonce);
-    }
-
-    function wrappedAsset(uint16, bytes32) external view returns (address) {
-        return address(token);
-    }
-
-    function isWrappedAsset(address) external pure returns (bool) {
-        return true;
-    }
-
-    function completeTransferWithPayload(bytes memory encodedVm)
-        external
-        returns (bytes memory)
-    {
-        (uint32 _originDomain, uint224 _nonce, uint256 _amount) = abi.decode(
-            encodedVm,
-            (uint32, uint224, uint256)
-        );
-
-        token.mint(msg.sender, _amount);
-        // Format it so that parseTransferWithPayload returns the desired payload
-        return
-            abi.encode(
-                TypeCasts.addressToBytes32(address(token)),
-                adapterData(_originDomain, _nonce, address(token))
-            );
-    }
-
-    function parseTransferWithPayload(bytes memory encoded)
-        external
-        pure
-        returns (TransferWithPayload memory transfer)
-    {
-        (bytes32 tokenAddress, bytes memory payload) = abi.decode(
-            encoded,
-            (bytes32, bytes)
-        );
-        transfer.payload = payload;
-        transfer.tokenAddress = tokenAddress;
-    }
-
-    function adapterData(
-        uint32 _originDomain,
-        uint224 _nonce,
-        address _token
-    ) public pure returns (bytes memory) {
-        return
-            abi.encode(
-                _originDomain,
-                _nonce,
-                TypeCasts.addressToBytes32(_token)
-            );
-    }
-
-    function mockPortalVaa(
-        uint32 _originDomain,
-        uint224 _nonce,
-        uint256 _amount
-    ) public pure returns (bytes memory) {
-        return abi.encode(_originDomain, _nonce, _amount);
-    }
-}

package/contracts/test/MysteryMath.sol

@@ -1,21 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity >=0.8.0;
-
-abstract contract MysteryMath {
-    uint256 public stateVar;
-
-    function setState(uint256 _var) external {
-        stateVar = _var;
-    }
-
-    function getState() external view returns (uint256) {
-        return stateVar;
-    }
-
-    function doMath(uint256 a, uint256 b)
-        external
-        pure
-        virtual
-        returns (uint256 _result);
-}

package/contracts/test/MysteryMathV1.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity >=0.8.0;
-
-import "./MysteryMath.sol";
-
-contract MysteryMathV1 is MysteryMath {
-    uint32 public immutable version;
-
-    constructor() {
-        version = 1;
-    }
-
-    function doMath(uint256 a, uint256 b)
-        external
-        pure
-        override
-        returns (uint256 _result)
-    {
-        _result = a + b;
-    }
-}

package/contracts/test/MysteryMathV2.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity >=0.8.0;
-
-import "./MysteryMath.sol";
-
-contract MysteryMathV2 is MysteryMath {
-    uint32 public immutable version;
-
-    constructor() {
-        version = 2;
-    }
-
-    function doMath(uint256 a, uint256 b)
-        external
-        pure
-        override
-        returns (uint256 _result)
-    {
-        _result = a * b;
-    }
-}

package/contracts/test/TestAbacusConnectionClient.sol

@@ -1,23 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.6.11;
-import {IOutbox} from "../../interfaces/IOutbox.sol";
-
-import "../AbacusConnectionClient.sol";
-
-contract TestAbacusConnectionClient is AbacusConnectionClient {
-    function initialize(address _abacusConnectionManager) external initializer {
-        __AbacusConnectionClient_initialize(_abacusConnectionManager);
-    }
-
-    function outbox() external view returns (IOutbox) {
-        return _outbox();
-    }
-
-    function isInbox(address _potentialInbox) external view returns (bool) {
-        return _isInbox(_potentialInbox);
-    }
-
-    function localDomain() external view returns (uint32) {
-        return _localDomain();
-    }
-}

package/contracts/test/TestInbox.sol

@@ -1,54 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-import "../Inbox.sol";
-
-contract TestInbox is Inbox {
-    using Message for bytes32;
-    using TypeCasts for bytes32;
-
-    constructor(uint32 _localDomain) Inbox(_localDomain) {} // solhint-disable-line no-empty-blocks
-
-    function testBranchRoot(
-        bytes32 leaf,
-        bytes32[32] calldata proof,
-        uint256 index
-    ) external pure returns (bytes32) {
-        return MerkleLib.branchRoot(leaf, proof, index);
-    }
-
-    function testProcess(bytes calldata _message, uint256 leafIndex) external {
-        bytes32 _messageHash = keccak256(abi.encodePacked(_message, leafIndex));
-        _process(_message, _messageHash);
-    }
-
-    function testHandle(
-        uint32 origin,
-        bytes32 sender,
-        bytes32 recipient,
-        bytes calldata body
-    ) external {
-        IMessageRecipient(recipient.bytes32ToAddress()).handle(
-            origin,
-            sender,
-            body
-        );
-    }
-
-    function setMessageStatus(bytes32 _leaf, MessageStatus status) external {
-        messages[_leaf] = status;
-    }
-
-    function getRevertMsg(bytes calldata _res)
-        internal
-        pure
-        returns (string memory)
-    {
-        // If the _res length is less than 68, then the transaction failed
-        // silently (without a revert message)
-        if (_res.length < 68) return "Transaction reverted silently";
-
-        // Remove the selector (first 4 bytes) and decode revert string
-        return abi.decode(_res[4:], (string));
-    }
-}

package/contracts/test/TestMultisigValidatorManager.sol

@@ -1,26 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-import {MultisigValidatorManager} from "../validator-manager/MultisigValidatorManager.sol";
-
-/**
- * This contract exists to test MultisigValidatorManager.sol, which is abstract
- * and cannot be deployed directly.
- */
-contract TestMultisigValidatorManager is MultisigValidatorManager {
-    // solhint-disable-next-line no-empty-blocks
-    constructor(
-        uint32 _domain,
-        address[] memory _validators,
-        uint256 _threshold
-    ) MultisigValidatorManager(_domain, _validators, _threshold) {}
-
-    /**
-     * @notice Hash of domain concatenated with "ABACUS".
-     * @dev This is a public getter of _domainHash to test with.
-     * @param _domain The domain to hash.
-     */
-    function getDomainHash(uint32 _domain) external pure returns (bytes32) {
-        return _domainHash(_domain);
-    }
-}

package/contracts/test/TestOutbox.sol

@@ -1,46 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-// ============ Internal Imports ============
-import "../Outbox.sol";
-import {MerkleLib} from "../libs/Merkle.sol";
-
-contract TestOutbox is Outbox {
-    constructor(uint32 _localDomain) Outbox(_localDomain) {} // solhint-disable-line no-empty-blocks
-
-    /**
-     * @notice Set the validator manager
-     * @param _validatorManager Address of the validator manager
-     */
-    function testSetValidatorManager(address _validatorManager) external {
-        validatorManager = _validatorManager;
-    }
-
-    function proof() external view returns (bytes32[32] memory) {
-        bytes32[32] memory _zeroes = MerkleLib.zeroHashes();
-        uint256 _index = tree.count - 1;
-        bytes32[32] memory _proof;
-
-        for (uint256 i = 0; i < 32; i++) {
-            uint256 _ithBit = (_index >> i) & 0x01;
-            if (_ithBit == 1) {
-                _proof[i] = tree.branch[i];
-            } else {
-                _proof[i] = _zeroes[i];
-            }
-        }
-        return _proof;
-    }
-
-    function branch() external view returns (bytes32[32] memory) {
-        return tree.branch;
-    }
-
-    function branchRoot(
-        bytes32 _item,
-        bytes32[32] memory _branch,
-        uint256 _index
-    ) external pure returns (bytes32) {
-        return MerkleLib.branchRoot(_item, _branch, _index);
-    }
-}