@hyperlane-xyz/core 0.5.2 → 0.5.4-0

package/contracts/Inbox.sol

@@ -1,148 +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 {IMessageRecipient} from "../interfaces/IMessageRecipient.sol";
-import {IInbox} from "../interfaces/IInbox.sol";
-
-// ============ External Imports ============
-import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
-
-/**
- * @title Inbox
- * @author Celo Labs Inc.
- * @notice Track root updates on Outbox, prove and dispatch messages to end
- * recipients.
- */
-contract Inbox is IInbox, ReentrancyGuardUpgradeable, Versioned, Mailbox {
-    // ============ Libraries ============
-
-    using MerkleLib for MerkleLib.Tree;
-    using Message for bytes;
-    using TypeCasts for bytes32;
-
-    // ============ Enums ============
-
-    // Status of Message:
-    //   0 - None - message has not been processed
-    //   1 - Processed - message has been dispatched to recipient
-    enum MessageStatus {
-        None,
-        Processed
-    }
-
-    // ============ Public Storage ============
-
-    // Domain of outbox chain
-    uint32 public override remoteDomain;
-    // Mapping of message leaves to MessageStatus
-    mapping(bytes32 => MessageStatus) public messages;
-
-    // ============ Upgrade Gap ============
-
-    // gap for upgrade safety
-    uint256[48] private __GAP;
-
-    // ============ Events ============
-
-    /**
-     * @notice Emitted when message is processed
-     * @dev This event allows watchers to observe the merkle proof they need
-     * to prove fraud on the Outbox.
-     * @param messageHash Hash of message that was processed.
-     */
-    event Process(bytes32 indexed messageHash);
-
-    // ============ Constructor ============
-
-    // solhint-disable-next-line no-empty-blocks
-    constructor(uint32 _localDomain) Mailbox(_localDomain) {}
-
-    // ============ Initializer ============
-
-    function initialize(uint32 _remoteDomain, address _validatorManager)
-        external
-        initializer
-    {
-        __ReentrancyGuard_init();
-        __Mailbox_initialize(_validatorManager);
-        remoteDomain = _remoteDomain;
-    }
-
-    // ============ External Functions ============
-
-    /**
-     * @notice Attempts to process the provided formatted `message`. Performs
-     * verification against root of the proof
-     * @dev Called by the validator manager, which is responsible for verifying a
-     * quorum of validator signatures on the checkpoint.
-     * @dev Reverts if verification of the message fails.
-     * @param _root The merkle root of the checkpoint used to prove message inclusion.
-     * @param _index The index of the checkpoint used to prove message inclusion.
-     * @param _message Formatted message (refer to Mailbox.sol Message library)
-     * @param _proof Merkle proof of inclusion for message's leaf
-     * @param _leafIndex Index of leaf in outbox's merkle tree
-     */
-    function process(
-        bytes32 _root,
-        uint256 _index,
-        bytes calldata _message,
-        bytes32[32] calldata _proof,
-        uint256 _leafIndex
-    ) external override nonReentrant onlyValidatorManager {
-        require(_index >= _leafIndex, "!index");
-        bytes32 _messageHash = _message.leaf(_leafIndex);
-        // ensure that message has not been processed
-        require(
-            messages[_messageHash] == MessageStatus.None,
-            "!MessageStatus.None"
-        );
-        // calculate the expected root based on the proof
-        bytes32 _calculatedRoot = MerkleLib.branchRoot(
-            _messageHash,
-            _proof,
-            _leafIndex
-        );
-        // verify the merkle proof
-        require(_calculatedRoot == _root, "!proof");
-        _process(_message, _messageHash);
-    }
-
-    // ============ Internal Functions ============
-
-    /**
-     * @notice Marks a message as processed and calls handle on the recipient
-     * @dev Internal function that can be called by contracts like TestInbox
-     * @param _message Formatted message (refer to Mailbox.sol Message library)
-     * @param _messageHash keccak256 hash of the message
-     */
-    function _process(bytes calldata _message, bytes32 _messageHash) internal {
-        (
-            uint32 origin,
-            bytes32 sender,
-            uint32 destination,
-            bytes32 recipient,
-            bytes calldata body
-        ) = _message.destructure();
-
-        // ensure message came from the correct domain
-        require(origin == remoteDomain, "!origin");
-        // ensure message was meant for this domain
-        require(destination == localDomain, "!destination");
-
-        // update message status as processed
-        messages[_messageHash] = MessageStatus.Processed;
-
-        IMessageRecipient(recipient.bytes32ToAddress()).handle(
-            origin,
-            sender,
-            body
-        );
-        emit Process(_messageHash);
-    }
-}

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

package/contracts/test/TestValidatorManager.sol

@@ -1,21 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-import {IInbox} from "../../interfaces/IInbox.sol";
-
-/**
- * Intended for testing Inbox.sol, which requires its validator manager
- * to be a contract.
- */
-contract TestValidatorManager {
-    function process(
-        IInbox _inbox,
-        bytes32 _root,
-        uint256 _index,
-        bytes calldata _message,
-        bytes32[32] calldata _proof,
-        uint256 _leafIndex
-    ) external {
-        _inbox.process(_root, _index, _message, _proof, _leafIndex);
-    }
-}

package/contracts/validator-manager/InboxValidatorManager.sol

@@ -1,58 +0,0 @@
-// SPDX-License-Identifier: MIT OR Apache-2.0
-pragma solidity >=0.8.0;
-
-// ============ Internal Imports ============
-import {IInbox} from "../../interfaces/IInbox.sol";
-import {MultisigValidatorManager} from "./MultisigValidatorManager.sol";
-
-/**
- * @title InboxValidatorManager
- * @notice Verifies checkpoints are signed by a quorum of validators and submits
- * them to an Inbox.
- */
-contract InboxValidatorManager is MultisigValidatorManager {
-    // ============ Constructor ============
-
-    /**
-     * @dev Reverts if `_validators` has any duplicates.
-     * @param _remoteDomain The remote domain of the outbox chain.
-     * @param _validators The set of validator addresses.
-     * @param _threshold The quorum threshold. Must be greater than or equal
-     * to the length of `_validators`.
-     */
-    // solhint-disable-next-line no-empty-blocks
-    constructor(
-        uint32 _remoteDomain,
-        address[] memory _validators,
-        uint256 _threshold
-    ) MultisigValidatorManager(_remoteDomain, _validators, _threshold) {}
-
-    // ============ External Functions ============
-
-    /**
-     * @notice Verifies a signed checkpoint and submits a message for processing.
-     * @dev Reverts if `_signatures` is not a quorum of validator signatures.
-     * @dev Reverts if `_signatures` is not sorted in ascending order by the signer
-     * address, which is required for duplicate detection.
-     * @param _inbox The inbox to submit the message to.
-     * @param _root The merkle root of the signed checkpoint.
-     * @param _index The index of the signed checkpoint.
-     * @param _signatures Signatures over the checkpoint to be checked for a validator
-     * quorum. Must be sorted in ascending order by signer address.
-     * @param _message The message to process.
-     * @param _proof Merkle proof of inclusion for message's leaf
-     * @param _leafIndex Index of leaf in outbox's merkle tree
-     */
-    function process(
-        IInbox _inbox,
-        bytes32 _root,
-        uint256 _index,
-        bytes[] calldata _signatures,
-        bytes calldata _message,
-        bytes32[32] calldata _proof,
-        uint256 _leafIndex
-    ) external {
-        require(isQuorum(_root, _index, _signatures), "!quorum");
-        _inbox.process(_root, _index, _message, _proof, _leafIndex);
-    }
-}