refactor: interfaces directories (hyperlane-xyz#157)

* Rename Types -> BridgeMessage; Router -> BridgeRouter

* Add BridgeTokenInterface.sol

* Add MessageRecipientInterface.sol

* Add SortitionInterface.sol

* nit: rename Interface to I

* nit: rename Interface to I

Co-authored-by: Erin Hales <[email protected]>

solidity/optics-bridge/contracts/Router.sol → solidity/optics-bridge/contracts/BridgeRouter.sol

@@ -1,20 +1,21 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.6.11;
 
-import {BridgeMessage} from "./Types.sol";
+import {BridgeMessage} from "./BridgeMessage.sol";
 import {TokenRegistry} from "./TokenRegistry.sol";
-import {BridgeTokenI, BridgeToken} from "./BridgeToken.sol";
+import {BridgeToken} from "./BridgeToken.sol";
+import {BridgeTokenI} from "../interfaces/BridgeTokenI.sol";
 
+import {TypeCasts} from "@celo-org/optics-sol/contracts/UsingOptics.sol";
 import {
-    TypeCasts,
-    OpticsHandlerI
-} from "@celo-org/optics-sol/contracts/UsingOptics.sol";
+    MessageRecipientI
+} from "@celo-org/optics-sol/interfaces/MessageRecipientI.sol";
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {TypedMemView} from "@summa-tx/memview-sol/contracts/TypedMemView.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/SafeERC20.sol";
 
-contract BridgeRouter is OpticsHandlerI, TokenRegistry {
+contract BridgeRouter is MessageRecipientI, TokenRegistry {
     using TypedMemView for bytes;
     using TypedMemView for bytes29;
     using BridgeMessage for bytes29;

solidity/optics-bridge/contracts/BridgeToken.sol

@@ -2,28 +2,9 @@
 pragma solidity >=0.6.11;
 
 import {ERC20} from "./OZERC20.sol";
-
-import {TypeCasts} from "@celo-org/optics-sol/contracts/UsingOptics.sol";
-
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
-
-interface BridgeTokenI {
-    function name() external returns (string memory);
-
-    function symbol() external returns (string memory);
-
-    function decimals() external returns (uint8);
-
-    function burn(address from, uint256 amnt) external;
-
-    function mint(address to, uint256 amnt) external;
-
-    function setDetails(
-        bytes32 _name,
-        bytes32 _symbol,
-        uint8 _decimals
-    ) external;
-}
+import {TypeCasts} from "@celo-org/optics-sol/contracts/UsingOptics.sol";
+import {BridgeTokenI} from "../interfaces/BridgeTokenI.sol";
 
 contract BridgeToken is BridgeTokenI, Ownable, ERC20 {
     /**

solidity/optics-bridge/contracts/TokenRegistry.sol

@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.6.11;
 
-import {BridgeMessage} from "./Types.sol";
-import {BridgeTokenI, BridgeToken} from "./BridgeToken.sol";
+import {BridgeMessage} from "./BridgeMessage.sol";
+import {BridgeToken} from "./BridgeToken.sol";
+import {BridgeTokenI} from "../interfaces/BridgeTokenI.sol";
 
 import {
     UsingOptics,

solidity/optics-bridge/interfaces/BridgeTokenI.sol

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+interface BridgeTokenI {
+    function name() external returns (string memory);
+
+    function symbol() external returns (string memory);
+
+    function decimals() external returns (uint8);
+
+    function burn(address from, uint256 amnt) external;
+
+    function mint(address to, uint256 amnt) external;
+
+    function setDetails(
+        bytes32 _name,
+        bytes32 _symbol,
+        uint8 _decimals
+    ) external;
+}

solidity/optics-core/contracts/Home.sol

@@ -4,7 +4,7 @@ pragma solidity >=0.6.11;
 import "./Common.sol";
 import "./Merkle.sol";
 import "./Queue.sol";
-import "./Sortition.sol";
+import "../interfaces/SortitionI.sol";
 
 /**
  * @title Home
@@ -20,7 +20,7 @@ contract Home is MerkleTreeManager, QueueManager, Common {
     mapping(uint32 => uint32) public sequences;
 
     // TODO: removing sortition?
-    ISortition internal sortition;
+    SortitionI internal sortition;
 
     /**
      * @notice Event emitted when new message is enqueued
@@ -47,8 +47,8 @@ contract Home is MerkleTreeManager, QueueManager, Common {
         QueueManager()
         Common(_originDomain, address(0), bytes32(0))
     {
-        sortition = ISortition(_sortition);
-        updater = ISortition(_sortition).current();
+        sortition = SortitionI(_sortition);
+        updater = SortitionI(_sortition).current();
     }
 
     /// @notice Sets contract state to FAILED and slashes updater

solidity/optics-core/contracts/Replica.sol

@@ -5,7 +5,7 @@ import "@summa-tx/memview-sol/contracts/TypedMemView.sol";
 import "./Common.sol";
 import "./Merkle.sol";
 import "./Queue.sol";
-import {OpticsHandlerI} from "./UsingOptics.sol";
+import {MessageRecipientI} from "../interfaces/MessageRecipientI.sol";
 
 /**
  * @title Replica
@@ -227,7 +227,7 @@ contract ProcessingReplica is Replica {
         // transparently return.
 
         try
-            OpticsHandlerI(recipient).handle{gas: PROCESS_GAS}(
+            MessageRecipientI(recipient).handle{gas: PROCESS_GAS}(
                 _m.origin(),
                 _m.sender(),
                 payload

solidity/optics-core/contracts/UsingOptics.sol

@@ -6,14 +6,6 @@ import "./Home.sol";
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@summa-tx/memview-sol/contracts/TypedMemView.sol";
 
-interface OpticsHandlerI {
-    function handle(
-        uint32 origin,
-        bytes32 sender,
-        bytes memory message
-    ) external returns (bytes memory);
-}
-
 abstract contract UsingOptics is Ownable {
     mapping(address => uint32) public replicas;
     Home public home;

solidity/optics-core/contracts/test/MockRecipient.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.6.11;
 
-import {OpticsHandlerI} from "../UsingOptics.sol";
+import {MessageRecipientI} from "../../interfaces/MessageRecipientI.sol";
 
-contract MockRecipient is OpticsHandlerI {
+contract MockRecipient is MessageRecipientI {
     // solhint-disable-next-line no-empty-blocks
     constructor() {}
 

solidity/optics-core/contracts/test/TestSortition.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.6.11;
 
-import {ISortition} from "../Sortition.sol";
+import {SortitionI} from "../../interfaces/SortitionI.sol";
 
-contract TestSortition is ISortition {
+contract TestSortition is SortitionI {
     address internal updater;
     address internal home;
 

solidity/optics-core/interfaces/MessageRecipientI.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+interface MessageRecipientI {
+    function handle(
+        uint32 origin,
+        bytes32 sender,
+        bytes memory message
+    ) external returns (bytes memory);
+}

solidity/optics-core/contracts/Sortition.sol → solidity/optics-core/interfaces/SortitionI.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.6.11;
 
-interface ISortition {
+interface SortitionI {
     function current() external view returns (address);
 
     function slash(address payable _reporter) external;

solidity/optics-governance/contracts/GovernanceRouter.sol

@@ -5,14 +5,17 @@ pragma experimental ABIEncoderV2;
 import {TypedMemView} from "@summa-tx/memview-sol/contracts/TypedMemView.sol";
 
 import {
-    OpticsHandlerI,
     UsingOptics,
     TypeCasts
 } from "@celo-org/optics-sol/contracts/UsingOptics.sol";
 
+import {
+    MessageRecipientI
+} from "@celo-org/optics-sol/interfaces/MessageRecipientI.sol";
+
 import {GovernanceMessage} from "./GovernanceMessage.sol";
 
-contract GovernanceRouter is OpticsHandlerI {
+contract GovernanceRouter is MessageRecipientI {
     using TypedMemView for bytes;
     using TypedMemView for bytes29;
     using GovernanceMessage for bytes29;