refactor: fixed some confusing names between sender/receiver and home/foreign gateways

jaybuidl · jaybuidl · commit 7055eb654003 · 2023-06-15T14:59:54.000+01:00
diff --git a/contracts/deploy/01-foreign-gateway-on-ethereum.ts b/contracts/deploy/01-foreign-gateway-on-ethereum.ts
@@ -39,7 +39,7 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   const foreignGateway = await deploy("ForeignGatewayOnEthereum", {
     from: deployer,
     contract: "ForeignGateway",
-    args: [deployer, veaOutbox.address, homeGatewayAddress, homeChainIdAsBytes32],
+    args: [deployer, veaOutbox.address, homeChainIdAsBytes32, homeGatewayAddress],
     gasLimit: 4000000,
     log: true,
   });
diff --git a/contracts/deploy/01-foreign-gateway-on-gnosis.ts b/contracts/deploy/01-foreign-gateway-on-gnosis.ts
@@ -68,7 +68,7 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   await deploy("ForeignGatewayOnGnosis", {
     from: deployer,
     contract: "ForeignGatewayOnGnosis",
-    args: [deployer, veaOutbox.address, homeGatewayAddress, homeChainIdAsBytes32, wethAddress],
+    args: [deployer, veaOutbox.address, homeChainIdAsBytes32, homeGatewayAddress, wethAddress],
     log: true,
     maxFeePerGas: ONE_GWEI,
     maxPriorityFeePerGas: ONE_GWEI,
diff --git a/contracts/deploy/02-home-gateway-to-ethereum.ts b/contracts/deploy/02-home-gateway-to-ethereum.ts
@@ -29,7 +29,7 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   await deploy("HomeGatewayToEthereum", {
     from: deployer,
     contract: "HomeGateway",
-    args: [deployer, klerosCore.address, veaInbox.address, foreignGateway.address, foreignChainId],
+    args: [deployer, klerosCore.address, veaInbox.address, foreignChainId, foreignGateway.address],
     log: true,
   }); // nonce+0
 };
diff --git a/contracts/deploy/02-home-gateway-to-gnosis.ts b/contracts/deploy/02-home-gateway-to-gnosis.ts
@@ -28,7 +28,7 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   await deploy("HomeGatewayToGnosis", {
     from: deployer,
     contract: "HomeGateway",
-    args: [deployer, klerosCore.address, veaInbox.address, foreignGateway.address, foreignChainId],
+    args: [deployer, klerosCore.address, veaInbox.address, foreignChainId, foreignGateway.address],
     log: true,
   }); // nonce+0
 };
diff --git a/contracts/deploy/03-vea-mock.ts b/contracts/deploy/03-vea-mock.ts
@@ -31,15 +31,15 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const foreignGateway = await deploy("ForeignGatewayOnEthereum", {
     from: deployer,
     contract: "ForeignGateway",
-    args: [deployer, vea.address, homeGatewayAddress, homeChainIdAsBytes32],
+    args: [deployer, vea.address, homeChainIdAsBytes32, homeGatewayAddress],
     gasLimit: 4000000,
     log: true,
   }); // nonce+0
 
   await deploy("HomeGatewayToEthereum", {
     from: deployer,
     contract: "HomeGateway",
-    args: [deployer, klerosCore.address, vea.address, foreignGateway.address, HARDHAT_NETWORK],
+    args: [deployer, klerosCore.address, vea.address, HARDHAT_NETWORK, foreignGateway.address],
     gasLimit: 4000000,
     log: true,
   }); // nonce+1
diff --git a/contracts/src/gateway/ForeignGateway.sol b/contracts/src/gateway/ForeignGateway.sol
@@ -50,8 +50,8 @@ contract ForeignGateway is IForeignGateway {
     mapping(uint96 => uint256) public feeForJuror; // feeForJuror[courtID], it mirrors the value on KlerosCore.
     address public governor;
     address public veaOutbox;
-    uint256 public immutable senderChainID;
-    address public override senderGateway;
+    uint256 public immutable override homeChainID;
+    address public override homeGateway;
     address public deprecatedVeaOutbox;
     uint256 public deprecatedVeaOutboxExpiration;
     mapping(bytes32 => DisputeData) public disputeHashtoDisputeData;
@@ -66,7 +66,7 @@ contract ForeignGateway is IForeignGateway {
                 (block.timestamp < deprecatedVeaOutboxExpiration && deprecatedVeaOutbox == msg.sender),
             "Access not allowed: Vea Outbox only."
         );
-        require(_messageSender == senderGateway, "Access not allowed: Sender Gateway only.");
+        require(_messageSender == homeGateway, "Access not allowed: HomeGateway only.");
         _;
     }
 
@@ -75,11 +75,15 @@ contract ForeignGateway is IForeignGateway {
         _;
     }
 
-    constructor(address _governor, address _veaOutbox, address _senderGateway, uint256 _senderChainID) {
+    // ************************************* //
+    // *            Constructor            * //
+    // ************************************* //
+
+    constructor(address _governor, address _veaOutbox, uint256 _homeChainID, address _homeGateway) {
         governor = _governor;
         veaOutbox = _veaOutbox;
-        senderGateway = _senderGateway;
-        senderChainID = _senderChainID;
+        homeChainID = _homeChainID;
+        homeGateway = _homeGateway;
     }
 
     // ************************************* //
@@ -103,11 +107,11 @@ contract ForeignGateway is IForeignGateway {
         veaOutbox = _veaOutbox;
     }
 
-    /// @dev Changes the sender gateway.
-    /// @param _senderGateway The address of the new sender gateway.
-    function changeReceiverGateway(address _senderGateway) external {
+    /// @dev Changes the home gateway.
+    /// @param _homeGateway The address of the new home gateway.
+    function changeHomeGateway(address _homeGateway) external {
         require(governor == msg.sender, "Access not allowed: Governor only.");
-        senderGateway = _senderGateway;
+        homeGateway = _homeGateway;
     }
 
     /// @dev Changes the `feeForJuror` property value of a specified court.
@@ -122,6 +126,7 @@ contract ForeignGateway is IForeignGateway {
     // *         State Modifiers           * //
     // ************************************* //
 
+    /// @inheritdoc IArbitrator
     function createDispute(
         uint256 _choices,
         bytes calldata _extraData
@@ -165,12 +170,13 @@ contract ForeignGateway is IForeignGateway {
         revert("Not supported yet");
     }
 
+    /// @inheritdoc IArbitrator
     function arbitrationCost(bytes calldata _extraData) public view override returns (uint256 cost) {
         (uint96 courtID, uint256 minJurors) = extraDataToCourtIDMinJurors(_extraData);
         cost = feeForJuror[courtID] * minJurors;
     }
 
-    /// Relay the rule call from the home gateway to the arbitrable.
+    /// @inheritdoc IForeignGateway
     function relayRule(
         address _messageSender,
         bytes32 _disputeHash,
@@ -189,6 +195,7 @@ contract ForeignGateway is IForeignGateway {
         arbitrable.rule(dispute.id, _ruling);
     }
 
+    /// @inheritdoc IForeignGateway
     function withdrawFees(bytes32 _disputeHash) external override {
         DisputeData storage dispute = disputeHashtoDisputeData[_disputeHash];
         require(dispute.id != 0, "Dispute does not exist");
@@ -203,10 +210,21 @@ contract ForeignGateway is IForeignGateway {
     // *           Public Views            * //
     // ************************************* //
 
+    /// @inheritdoc IForeignGateway
     function disputeHashToForeignID(bytes32 _disputeHash) external view override returns (uint256) {
         return disputeHashtoDisputeData[_disputeHash].id;
     }
 
+    /// @inheritdoc IReceiverGateway
+    function senderGateway() external view returns (address) {
+        return homeGateway;
+    }
+
+    /// @inheritdoc IForeignGateway
+    function feeToken() external view returns (IERC20) {
+        revert("Not supported yet");
+    }
+
     // ************************ //
     // *       Internal       * //
     // ************************ //
diff --git a/contracts/src/gateway/ForeignGatewayOnGnosis.sol b/contracts/src/gateway/ForeignGatewayOnGnosis.sol
@@ -10,7 +10,6 @@ pragma solidity 0.8.18;
 
 import "../arbitration/IArbitrable.sol";
 import "./interfaces/IForeignGateway.sol";
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 /// Foreign Gateway
 /// Counterpart of `HomeGateway`
@@ -47,16 +46,16 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
     // ************************************* //
 
     uint256 public constant DEFAULT_NB_OF_JURORS = 3; // The default number of jurors in a dispute.
-    IERC20 public immutable weth; // WETH token on xDai.
     uint256 internal localDisputeID = 1; // The disputeID must start from 1 as the KlerosV1 proxy governor depends on this implementation. We now also depend on localDisputeID not ever being zero.
     mapping(uint96 => uint256) public feeForJuror; // feeForJuror[courtID], it mirrors the value on KlerosCore.
     address public governor;
     address public veaOutbox;
-    uint256 public immutable senderChainID;
-    address public override senderGateway;
+    uint256 public immutable override homeChainID;
+    address public override homeGateway;
     address public deprecatedVeaOutbox;
     uint256 public deprecatedVeaOutboxExpiration;
     mapping(bytes32 => DisputeData) public disputeHashtoDisputeData;
+    IERC20 public immutable weth; // WETH token on xDai.
 
     // ************************************* //
     // *        Function Modifiers         * //
@@ -68,7 +67,7 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
                 (block.timestamp < deprecatedVeaOutboxExpiration && deprecatedVeaOutbox == msg.sender),
             "Access not allowed: Vea Outbox only."
         );
-        require(_messageSender == senderGateway, "Access not allowed: Sender Gateway only.");
+        require(_messageSender == homeGateway, "Access not allowed: HomeGateway only.");
         _;
     }
 
@@ -77,11 +76,15 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
         _;
     }
 
-    constructor(address _governor, address _veaOutbox, address _senderGateway, uint256 _senderChainID, IERC20 _weth) {
+    // ************************************* //
+    // *            Constructor            * //
+    // ************************************* //
+
+    constructor(address _governor, address _veaOutbox, uint256 _homeChainID, address _homeGateway, IERC20 _weth) {
         governor = _governor;
         veaOutbox = _veaOutbox;
-        senderGateway = _senderGateway;
-        senderChainID = _senderChainID;
+        homeChainID = _homeChainID;
+        homeGateway = _homeGateway;
         weth = _weth;
     }
 
@@ -106,11 +109,11 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
         veaOutbox = _veaOutbox;
     }
 
-    /// @dev Changes the sender gateway.
-    /// @param _senderGateway The address of the new sender gateway.
-    function changeReceiverGateway(address _senderGateway) external {
+    /// @dev Changes the home gateway.
+    /// @param _homeGateway The address of the new home gateway.
+    function changeHomeGateway(address _homeGateway) external {
         require(governor == msg.sender, "Access not allowed: Governor only.");
-        senderGateway = _senderGateway;
+        homeGateway = _homeGateway;
     }
 
     /// @dev Changes the `feeForJuror` property value of a specified court.
@@ -125,6 +128,7 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
     // *         State Modifiers           * //
     // ************************************* //
 
+    /// @inheritdoc IArbitrator
     function createDispute(
         uint256 /*_choices*/,
         bytes calldata /*_extraData*/
@@ -174,7 +178,7 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
         cost = feeForJuror[courtID] * minJurors;
     }
 
-    /// Relay the rule call from the home gateway to the arbitrable.
+    /// @inheritdoc IForeignGateway
     function relayRule(
         address _messageSender,
         bytes32 _disputeHash,
@@ -193,6 +197,7 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
         arbitrable.rule(dispute.id, _ruling);
     }
 
+    /// @inheritdoc IForeignGateway
     function withdrawFees(bytes32 _disputeHash) external override {
         DisputeData storage dispute = disputeHashtoDisputeData[_disputeHash];
         require(dispute.id != 0, "Dispute does not exist");
@@ -207,10 +212,21 @@ contract ForeignGatewayOnGnosis is IForeignGateway {
     // *           Public Views            * //
     // ************************************* //
 
+    /// @inheritdoc IForeignGateway
     function disputeHashToForeignID(bytes32 _disputeHash) external view override returns (uint256) {
         return disputeHashtoDisputeData[_disputeHash].id;
     }
 
+    /// @inheritdoc IReceiverGateway
+    function senderGateway() external view returns (address) {
+        return homeGateway;
+    }
+
+    /// @inheritdoc IForeignGateway
+    function feeToken() external view returns (IERC20) {
+        return weth;
+    }
+
     // ************************ //
     // *       Internal       * //
     // ************************ //
diff --git a/contracts/src/gateway/HomeGateway.sol b/contracts/src/gateway/HomeGateway.sol
@@ -31,24 +31,28 @@ contract HomeGateway is IHomeGateway {
     address public governor;
     IArbitrator public arbitrator;
     IVeaInbox public veaInbox;
-    address public override receiverGateway;
-    uint256 public immutable receiverChainID;
+    uint256 public immutable override foreignChainID;
+    address public override foreignGateway;
     mapping(uint256 => bytes32) public disputeIDtoHash;
     mapping(bytes32 => uint256) public disputeHashtoID;
     mapping(bytes32 => RelayedData) public disputeHashtoRelayedData;
 
+    // ************************************* //
+    // *            Constructor            * //
+    // ************************************* //
+
     constructor(
         address _governor,
         IArbitrator _arbitrator,
         IVeaInbox _veaInbox,
-        address _receiverGateway,
-        uint256 _receiverChainID
+        uint256 _foreignChainID,
+        address _foreignGateway
     ) {
         governor = _governor;
         arbitrator = _arbitrator;
         veaInbox = _veaInbox;
-        receiverGateway = _receiverGateway;
-        receiverChainID = _receiverChainID;
+        foreignChainID = _foreignChainID;
+        foreignGateway = _foreignGateway;
 
         emit MetaEvidence(0, "BRIDGE");
     }
@@ -78,24 +82,18 @@ contract HomeGateway is IHomeGateway {
         veaInbox = _veaInbox;
     }
 
-    /// @dev Changes the receiver gateway.
-    /// @param _receiverGateway The address of the new receiver gateway.
-    function changeReceiverGateway(address _receiverGateway) external {
+    /// @dev Changes the foreign gateway.
+    /// @param _foreignGateway The address of the new foreign gateway.
+    function changeForeignGateway(address _foreignGateway) external {
         require(governor == msg.sender, "Access not allowed: Governor only.");
-        receiverGateway = _receiverGateway;
+        foreignGateway = _foreignGateway;
     }
 
     // ************************************* //
     // *         State Modifiers           * //
     // ************************************* //
 
-    /// @dev Provide the same parameters as on the foreignChain while creating a dispute. Providing incorrect parameters will create a different hash than on the foreignChain and will not affect the actual dispute/arbitrable's ruling.
-    /// @param _foreignChainID foreignChainId
-    /// @param _foreignBlockHash foreignBlockHash
-    /// @param _foreignDisputeID foreignDisputeID
-    /// @param _choices number of ruling choices
-    /// @param _extraData extraData
-    /// @param _arbitrable arbitrable
+    /// @inheritdoc IHomeGateway
     function relayCreateDispute(
         uint256 _foreignChainID,
         bytes32 _foreignBlockHash,
@@ -115,6 +113,8 @@ contract HomeGateway is IHomeGateway {
                 _arbitrable
             )
         );
+        require(_foreignChainID == foreignChainID, "Foreign chain ID not supported");
+
         RelayedData storage relayedData = disputeHashtoRelayedData[disputeHash];
         require(relayedData.relayer == address(0), "Dispute already relayed");
 
@@ -130,10 +130,7 @@ contract HomeGateway is IHomeGateway {
         emit Dispute(arbitrator, disputeID, 0, 0);
     }
 
-    /// @dev Give a ruling for a dispute. Must be called by the arbitrator.
-    /// The purpose of this function is to ensure that the address calling it has the right to rule on the contract.
-    /// @param _disputeID ID of the dispute in the Arbitrator contract.
-    /// @param _ruling Ruling given by the arbitrator. Note that 0 is reserved for "Not able/wanting to make a decision".
+    /// @inheritdoc IArbitrable
     function rule(uint256 _disputeID, uint256 _ruling) external override {
         require(msg.sender == address(arbitrator), "Only Arbitrator");
 
@@ -144,12 +141,20 @@ contract HomeGateway is IHomeGateway {
         // because Vea takes care of inserting it for security reasons.
         bytes4 methodSelector = IForeignGateway.relayRule.selector;
         bytes memory data = abi.encode(disputeHash, _ruling, relayedData.relayer);
-        veaInbox.sendMessage(receiverGateway, methodSelector, data);
+        veaInbox.sendMessage(foreignGateway, methodSelector, data);
     }
 
-    /// @dev Looks up the local home disputeID for a disputeHash. For cross-chain Evidence standard.
-    /// @param _disputeHash dispute hash
+    // ************************************* //
+    // *           Public Views            * //
+    // ************************************* //
+
+    /// @inheritdoc IHomeGateway
     function disputeHashToHomeID(bytes32 _disputeHash) external view override returns (uint256) {
         return disputeHashtoID[_disputeHash];
     }
+
+    /// @inheritdoc ISenderGateway
+    function receiverGateway() external view override returns (address) {
+        return foreignGateway;
+    }
 }
diff --git a/contracts/src/gateway/interfaces/IForeignGateway.sol b/contracts/src/gateway/interfaces/IForeignGateway.sol
diff --git a/contracts/src/gateway/interfaces/IHomeGateway.sol b/contracts/src/gateway/interfaces/IHomeGateway.sol
