@hyperlane-xyz/core 0.5.5 → 1.0.0-beta1

package/contracts/MerkleTreeManager.sol

@@ -1,32 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-// ============ Internal Imports ============
-import {MerkleLib} from "./libs/Merkle.sol";
-
-/**
- * @title MerkleTreeManager
- * @author Celo Labs Inc.
- * @notice Contains a Merkle tree instance and
- * exposes view functions for the tree.
- */
-contract MerkleTreeManager {
-    // ============ Libraries ============
-
-    using MerkleLib for MerkleLib.Tree;
-    MerkleLib.Tree public tree;
-
-    // ============ Upgrade Gap ============
-
-    // gap for upgrade safety
-    uint256[49] private __GAP;
-
-    // ============ Public Functions ============
-
-    /**
-     * @notice Calculates and returns tree's current root
-     */
-    function root() public view returns (bytes32) {
-        return tree.root();
-    }
-}

package/contracts/Outbox.sol

@@ -1,191 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-// ============ Internal Imports ============
-import {Versioned} from "./upgrade/Versioned.sol";
-import {Mailbox} from "./Mailbox.sol";
-import {MerkleLib} from "./libs/Merkle.sol";
-import {Message} from "./libs/Message.sol";
-import {TypeCasts} from "./libs/TypeCasts.sol";
-import {MerkleTreeManager} from "./MerkleTreeManager.sol";
-import {IOutbox} from "../interfaces/IOutbox.sol";
-
-/**
- * @title Outbox
- * @author Celo Labs Inc.
- * @notice Accepts messages to be dispatched to remote chains,
- * constructs a Merkle tree of the messages,
- * and accepts signatures from a bonded Validator
- * which notarize the Merkle tree roots.
- * Accepts submissions of fraudulent signatures
- * by the Validator and slashes the Validator in this case.
- */
-contract Outbox is IOutbox, Versioned, MerkleTreeManager, Mailbox {
-    // ============ Libraries ============
-
-    using MerkleLib for MerkleLib.Tree;
-    using TypeCasts for address;
-
-    // ============ Constants ============
-
-    // Maximum bytes per message = 2 KiB
-    // (somewhat arbitrarily set to begin)
-    uint256 public constant MAX_MESSAGE_BODY_BYTES = 2 * 2**10;
-
-    // ============ Enums ============
-
-    // States:
-    //   0 - UnInitialized - before initialize function is called
-    //   note: the contract is initialized at deploy time, so it should never be in this state
-    //   1 - Active - as long as the contract has not become fraudulent
-    //   2 - Failed - after a valid fraud proof has been submitted;
-    //   contract will no longer accept updates or new messages
-    enum States {
-        UnInitialized,
-        Active,
-        Failed
-    }
-
-    // ============ Public Storage Variables ============
-
-    // Cached checkpoints, mapping root => leaf index.
-    // Cached checkpoints must have index > 0 as the presence of such
-    // a checkpoint cannot be distinguished from its absence.
-    mapping(bytes32 => uint256) public cachedCheckpoints;
-    // The latest cached root
-    bytes32 public latestCachedRoot;
-    // Current state of contract
-    States public state;
-
-    // ============ Upgrade Gap ============
-
-    // gap for upgrade safety
-    uint256[47] private __GAP;
-
-    // ============ Events ============
-
-    /**
-     * @notice Emitted when a checkpoint is cached.
-     * @param root Merkle root
-     * @param index Leaf index
-     */
-    event CheckpointCached(bytes32 indexed root, uint256 indexed index);
-
-    /**
-     * @notice Emitted when a new message is dispatched via Abacus
-     * @param leafIndex Index of message's leaf in merkle tree
-     * @param message Raw bytes of message
-     */
-    event Dispatch(uint256 indexed leafIndex, bytes message);
-
-    event Fail();
-
-    // ============ Constructor ============
-
-    constructor(uint32 _localDomain) Mailbox(_localDomain) {} // solhint-disable-line no-empty-blocks
-
-    // ============ Initializer ============
-
-    function initialize(address _validatorManager) external initializer {
-        __Mailbox_initialize(_validatorManager);
-        state = States.Active;
-    }
-
-    // ============ Modifiers ============
-
-    /**
-     * @notice Ensures that contract state != FAILED when the function is called
-     */
-    modifier notFailed() {
-        require(state != States.Failed, "failed state");
-        _;
-    }
-
-    // ============ External Functions  ============
-
-    /**
-     * @notice Dispatch the message it to the destination domain & recipient
-     * @dev Format the message, insert its hash into Merkle tree,
-     * and emit `Dispatch` event with message information.
-     * @param _destinationDomain Domain of destination chain
-     * @param _recipientAddress Address of recipient on destination chain as bytes32
-     * @param _messageBody Raw bytes content of message
-     * @return The leaf index of the dispatched message's hash in the Merkle tree.
-     */
-    function dispatch(
-        uint32 _destinationDomain,
-        bytes32 _recipientAddress,
-        bytes calldata _messageBody
-    ) external override notFailed returns (uint256) {
-        require(_messageBody.length <= MAX_MESSAGE_BODY_BYTES, "msg too long");
-        // The leaf has not been inserted yet at this point
-        uint256 _leafIndex = count();
-        // format the message into packed bytes
-        bytes memory _message = Message.formatMessage(
-            localDomain,
-            msg.sender.addressToBytes32(),
-            _destinationDomain,
-            _recipientAddress,
-            _messageBody
-        );
-        // insert the hashed message into the Merkle tree
-        bytes32 _messageHash = keccak256(
-            abi.encodePacked(_message, _leafIndex)
-        );
-        tree.insert(_messageHash);
-        emit Dispatch(_leafIndex, _message);
-        return _leafIndex;
-    }
-
-    /**
-     * @notice Caches the current merkle root and index.
-     * @dev emits CheckpointCached event
-     */
-    function cacheCheckpoint() external override notFailed {
-        (bytes32 _root, uint256 _index) = latestCheckpoint();
-        require(_index > 0, "!index");
-        cachedCheckpoints[_root] = _index;
-        latestCachedRoot = _root;
-        emit CheckpointCached(_root, _index);
-    }
-
-    /**
-     * @notice Set contract state to FAILED.
-     * @dev Called by the validator manager when fraud is proven.
-     */
-    function fail() external override onlyValidatorManager {
-        // set contract to FAILED
-        state = States.Failed;
-        emit Fail();
-    }
-
-    /**
-     * @notice Returns the latest entry in the checkpoint cache.
-     * @return root Latest cached root
-     * @return index Latest cached index
-     */
-    function latestCachedCheckpoint()
-        external
-        view
-        returns (bytes32 root, uint256 index)
-    {
-        root = latestCachedRoot;
-        index = cachedCheckpoints[root];
-    }
-
-    /**
-     * @notice Returns the number of inserted leaves in the tree
-     */
-    function count() public view returns (uint256) {
-        return tree.count;
-    }
-
-    /**
-     * @notice Returns a checkpoint representing the current merkle tree.
-     * @return root The root of the Outbox's merkle tree.
-     * @return index The index of the last element in the tree.
-     */
-    function latestCheckpoint() public view returns (bytes32, uint256) {
-        return (root(), count() - 1);
-    }
-}

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