@reality.eth/contracts 3.0.45 → 3.0.47

package/chains/deployments/300/ETH/RealityETH-3.0.json

@@ -0,0 +1,7 @@
+{
+    "address": "0x4E346436e99fb7d6567A2bd024d8806Fc10d84D2",
+    "block": 255658,
+    "notes": null,
+    "arbitrators": {
+    }
+}

package/chains/supported.json

@@ -72,6 +72,9 @@
         "explorerURL": "https://zksync2-testnet.zkscan.io",
         "network_name": "zkSync2-testnet"
     },
+    "300": {
+        "network_name": "zksync-era-sepolia"
+    },
     "324": {
         "explorerURL": "https://explorer.zksync.io/",
         "graphURL": "https://api.thegraph.com/subgraphs/name/realityeth/realityeth-zksync-era",

package/development/contracts/.solhint.json

@@ -0,0 +1,9 @@
+{
+  "extends": "solhint:recommended"
+  ,"rules": {
+    "max-line-length": ["error",210]
+    ,"func-visibility": ["warn",{"ignoreConstructors":true}]
+    ,"var-name-mixedcase": "off"
+  }
+
+}

package/development/contracts/Arbitrator.sol

@@ -1,14 +1,13 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
-pragma solidity ^0.8.10;
+pragma solidity ^0.8.20;
 
-import './IArbitrator.sol';
-import './IRealityETH.sol';
-import './IERC20.sol';
-import './Owned.sol';
+import {IArbitrator} from "./IArbitrator.sol";
+import {IRealityETH} from "./IRealityETH.sol";
+import {IERC20} from "./IERC20.sol";
+import {Owned} from "./Owned.sol";
 
 contract Arbitrator is Owned, IArbitrator {
-
     IRealityETH public realitio;
 
     mapping(bytes32 => uint256) public arbitration_bounties;
@@ -18,56 +17,26 @@ contract Arbitrator is Owned, IArbitrator {
 
     string public metadata;
 
-    event LogRequestArbitration(
-        bytes32 indexed question_id,
-        uint256 fee_paid,
-        address requester,
-        uint256 remaining
-    );
-
-    event LogSetRealitio(
-        address realitio
-    );
-
-    event LogSetQuestionFee(
-        uint256 fee
-    );
-
-
-    event LogSetDisputeFee(
-        uint256 fee
-    );
-
-    event LogSetCustomDisputeFee(
-        bytes32 indexed question_id,
-        uint256 fee
-    );
-
     /// @notice Constructor. Sets the deploying address as owner.
     constructor() {
         owner = msg.sender;
     }
 
     /// @notice Returns the Realitio contract address - deprecated in favour of realitio()
-    function realitycheck() 
-    external view returns(IRealityETH) {
+    function realitycheck() external view returns (IRealityETH) {
         return realitio;
     }
 
     /// @notice Set the Reality Check contract address
     /// @param addr The address of the Reality Check contract
-    function setRealitio(address addr) 
-        onlyOwner 
-    public {
+    function setRealitio(address addr) public onlyOwner {
         realitio = IRealityETH(addr);
         emit LogSetRealitio(addr);
     }
 
     /// @notice Set the default fee
     /// @param fee The default fee amount
-    function setDisputeFee(uint256 fee) 
-        onlyOwner 
-    public {
+    function setDisputeFee(uint256 fee) public onlyOwner {
         dispute_fee = fee;
         emit LogSetDisputeFee(fee);
     }
@@ -75,9 +44,7 @@ contract Arbitrator is Owned, IArbitrator {
     /// @notice Set a custom fee for this particular question
     /// @param question_id The question in question
     /// @param fee The fee amount
-    function setCustomDisputeFee(bytes32 question_id, uint256 fee) 
-        onlyOwner 
-    public {
+    function setCustomDisputeFee(bytes32 question_id, uint256 fee) public onlyOwner {
         custom_dispute_fees[question_id] = fee;
         emit LogSetCustomDisputeFee(question_id, fee);
     }
@@ -85,8 +52,7 @@ contract Arbitrator is Owned, IArbitrator {
     /// @notice Return the dispute fee for the specified question. 0 indicates that we won't arbitrate it.
     /// @param question_id The question in question
     /// @dev Uses a general default, but can be over-ridden on a question-by-question basis.
-    function getDisputeFee(bytes32 question_id) 
-    public view returns (uint256) {
+    function getDisputeFee(bytes32 question_id) public view returns (uint256) {
         return (custom_dispute_fees[question_id] > 0) ? custom_dispute_fees[question_id] : dispute_fee;
     }
 
@@ -96,9 +62,7 @@ contract Arbitrator is Owned, IArbitrator {
     /// You could set an impossibly high fee if you want to prevent us being used as arbitrator unless we submit the question.
     /// (Submitting the question ourselves is not implemented here.)
     /// This fee can be used as a revenue source, an anti-spam measure, or both.
-    function setQuestionFee(uint256 fee) 
-        onlyOwner 
-    public {
+    function setQuestionFee(uint256 fee) public onlyOwner {
         realitio.setQuestionFee(fee);
         emit LogSetQuestionFee(fee);
     }
@@ -107,9 +71,7 @@ contract Arbitrator is Owned, IArbitrator {
     /// @param question_id The question in question
     /// @param answer The answer
     /// @param answerer The answerer. If arbitration changed the answer, it should be the payer. If not, the old answerer.
-    function submitAnswerByArbitrator(bytes32 question_id, bytes32 answer, address answerer) 
-        onlyOwner 
-    public {
+    function submitAnswerByArbitrator(bytes32 question_id, bytes32 answer, address answerer) public onlyOwner {
         delete arbitration_bounties[question_id];
         realitio.submitAnswerByArbitrator(question_id, answer, answerer);
     }
@@ -121,9 +83,14 @@ contract Arbitrator is Owned, IArbitrator {
     /// @param last_history_hash The history hash before the final one
     /// @param last_answer_or_commitment_id The last answer given, or the commitment ID if it was a commitment.
     /// @param last_answerer The address that supplied the last answer
-    function assignWinnerAndSubmitAnswerByArbitrator(bytes32 question_id, bytes32 answer, address payee_if_wrong, bytes32 last_history_hash, bytes32 last_answer_or_commitment_id, address last_answerer) 
-        onlyOwner 
-    public {
+    function assignWinnerAndSubmitAnswerByArbitrator(
+        bytes32 question_id,
+        bytes32 answer,
+        address payee_if_wrong,
+        bytes32 last_history_hash,
+        bytes32 last_answer_or_commitment_id,
+        address last_answerer
+    ) public onlyOwner {
         delete arbitration_bounties[question_id];
         realitio.assignWinnerAndSubmitAnswerByArbitrator(question_id, answer, payee_if_wrong, last_history_hash, last_answer_or_commitment_id, last_answerer);
     }
@@ -131,9 +98,7 @@ contract Arbitrator is Owned, IArbitrator {
     /// @notice Cancel a previous arbitration request
     /// @dev This is intended for situations where the arbitration is happening non-atomically and the fee or something change.
     /// @param question_id The question in question
-    function cancelArbitration(bytes32 question_id) 
-        onlyOwner 
-    public {
+    function cancelArbitration(bytes32 question_id) public onlyOwner {
         realitio.cancelArbitration(question_id);
     }
 
@@ -142,11 +107,9 @@ contract Arbitrator is Owned, IArbitrator {
     /// Will trigger an error if the notification fails, eg because the question has already been finalized
     /// @param question_id The question in question
     /// @param max_previous If specified, reverts if a bond higher than this was submitted after you sent your transaction.
-    function requestArbitration(bytes32 question_id, uint256 max_previous) 
-    external payable returns (bool) {
-
+    function requestArbitration(bytes32 question_id, uint256 max_previous) external payable returns (bool) {
         uint256 arbitration_fee = getDisputeFee(question_id);
-        require(arbitration_fee > 0, "The arbitrator must have set a non-zero fee for the question");
+        if (arbitration_fee == 0) revert TheArbitratorMustHaveSetANonZeroFeeForTheQuestion();
 
         arbitration_bounties[question_id] += msg.value;
         uint256 paid = arbitration_bounties[question_id];
@@ -156,50 +119,38 @@ contract Arbitrator is Owned, IArbitrator {
             emit LogRequestArbitration(question_id, msg.value, msg.sender, 0);
             return true;
         } else {
-            require(!realitio.isFinalized(question_id), "The question must not have been finalized");
+            if (realitio.isFinalized(question_id)) revert TheQuestionMustNotHaveBeenFinalized();
             emit LogRequestArbitration(question_id, msg.value, msg.sender, arbitration_fee - paid);
             return false;
         }
-
     }
 
     /// @notice Withdraw any accumulated ETH fees to the specified address
     /// @param addr The address to which the balance should be sent
-    function withdraw(address addr) 
-        onlyOwner 
-    public {
-        payable(addr).transfer(address(this).balance); 
+    function withdraw(address addr) public onlyOwner {
+        payable(addr).transfer(address(this).balance);
     }
 
     /// @notice Withdraw any accumulated token fees to the specified address
     /// @param addr The address to which the balance should be sent
     /// @dev Only needed if the Realitio contract used is using an ERC20 token
     /// @dev Also only normally useful if a per-question fee is set, otherwise we only have ETH.
-    function withdrawERC20(IERC20 _token, address addr) 
-        onlyOwner 
-    public {
+    function withdrawERC20(IERC20 _token, address addr) public onlyOwner {
         uint256 bal = _token.balanceOf(address(this));
-        IERC20(_token).transfer(addr, bal); 
+        IERC20(_token).transfer(addr, bal);
     }
 
-    receive() 
-    external payable {
-    }
+    receive() external payable {}
 
     /// @notice Withdraw any accumulated question fees from the specified address into this contract
     /// @dev Funds can then be liberated from this contract with our withdraw() function
     /// @dev This works in the same way whether the realitio contract is using ETH or an ERC20 token
-    function callWithdraw() 
-        onlyOwner 
-    public {
-        realitio.withdraw(); 
+    function callWithdraw() public onlyOwner {
+        realitio.withdraw();
     }
 
     /// @notice Set a metadata string, expected to be JSON, containing things like arbitrator TOS address
-    function setMetaData(string memory _metadata) 
-        onlyOwner
-    external {
+    function setMetaData(string memory _metadata) external onlyOwner {
         metadata = _metadata;
     }
-
 }

package/development/contracts/BalanceHolder.sol

@@ -1,24 +1,18 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
-pragma solidity ^0.8.10;
+pragma solidity ^0.8.20;
 
-import './IBalanceHolder.sol';
+import {IBalanceHolder} from "./IBalanceHolder.sol";
 
 contract BalanceHolder is IBalanceHolder {
-
     mapping(address => uint256) public balanceOf;
 
-    event LogWithdraw(
-        address indexed user,
-        uint256 amount
-    );
+    event LogWithdraw(address indexed user, uint256 amount);
 
-    function withdraw() 
-    public {
+    function withdraw() public {
         uint256 bal = balanceOf[msg.sender];
         balanceOf[msg.sender] = 0;
         payable(msg.sender).transfer(bal);
         emit LogWithdraw(msg.sender, bal);
     }
-
 }

package/development/contracts/BalanceHolder_ERC20.sol

@@ -1,27 +1,21 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
-pragma solidity ^0.8.10;
+pragma solidity ^0.8.20;
 
-import './IERC20.sol';
-import './IBalanceHolder_ERC20.sol';
+import {IERC20} from "./IERC20.sol";
+import {IBalanceHolder_ERC20} from "./IBalanceHolder_ERC20.sol";
 
 contract BalanceHolder_ERC20 is IBalanceHolder_ERC20 {
-
     IERC20 public token;
 
     mapping(address => uint256) public balanceOf;
 
-    event LogWithdraw(
-        address indexed user,
-        uint256 amount
-    );
+    event LogWithdraw(address indexed user, uint256 amount);
 
-    function withdraw() 
-    public {
+    function withdraw() public {
         uint256 bal = balanceOf[msg.sender];
         balanceOf[msg.sender] = 0;
         require(token.transfer(msg.sender, bal));
         emit LogWithdraw(msg.sender, bal);
     }
-
 }

package/development/contracts/CallbackClient.sol

@@ -1,19 +1,12 @@
 pragma solidity ^0.4.25;
 
 contract CallbackClient {
+    mapping(bytes32 => bytes32) public answers;
 
-    mapping(bytes32=>bytes32) public answers;
+    event LogCallback(bytes32 question_id, bytes32 question_answer, address sender);
 
-    event LogCallback(
-        bytes32 question_id,
-        bytes32 question_answer,
-        address sender
-    );
-
-    function __realitycheck_callback(bytes32 question_id, bytes32 question_answer) 
-    public {
+    function __realitycheck_callback(bytes32 question_id, bytes32 question_answer) public {
         answers[question_id] = question_answer;
         emit LogCallback(question_id, question_answer, msg.sender);
     }
-
 }

package/development/contracts/ERC20Token.sol

@@ -6,8 +6,8 @@ pragma solidity ^0.4.25;
  */
 library SafeMath {
     /**
-    * @dev Multiplies two numbers, reverts on overflow.
-    */
+     * @dev Multiplies two numbers, reverts on overflow.
+     */
     function mul(uint256 a, uint256 b) internal pure returns (uint256) {
         // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
         // benefit is lost if 'b' is also tested.
@@ -23,8 +23,8 @@ library SafeMath {
     }
 
     /**
-    * @dev Integer division of two numbers truncating the quotient, reverts on division by zero.
-    */
+     * @dev Integer division of two numbers truncating the quotient, reverts on division by zero.
+     */
     function div(uint256 a, uint256 b) internal pure returns (uint256) {
         // Solidity only automatically asserts when dividing by 0
         require(b > 0);
@@ -35,8 +35,8 @@ library SafeMath {
     }
 
     /**
-    * @dev Subtracts two numbers, reverts on overflow (i.e. if subtrahend is greater than minuend).
-    */
+     * @dev Subtracts two numbers, reverts on overflow (i.e. if subtrahend is greater than minuend).
+     */
     function sub(uint256 a, uint256 b) internal pure returns (uint256) {
         require(b <= a);
         uint256 c = a - b;
@@ -45,8 +45,8 @@ library SafeMath {
     }
 
     /**
-    * @dev Adds two numbers, reverts on overflow.
-    */
+     * @dev Adds two numbers, reverts on overflow.
+     */
     function add(uint256 a, uint256 b) internal pure returns (uint256) {
         uint256 c = a + b;
         require(c >= a);
@@ -55,9 +55,9 @@ library SafeMath {
     }
 
     /**
-    * @dev Divides two numbers and returns the remainder (unsigned integer modulo),
-    * reverts when dividing by zero.
-    */
+     * @dev Divides two numbers and returns the remainder (unsigned integer modulo),
+     * reverts when dividing by zero.
+     */
     function mod(uint256 a, uint256 b) internal pure returns (uint256) {
         require(b != 0);
         return a % b;
@@ -96,29 +96,28 @@ interface IERC20 {
 contract ERC20 is IERC20 {
     using SafeMath for uint256;
 
-    mapping (address => uint256) private _balances;
+    mapping(address => uint256) private _balances;
 
-    mapping (address => mapping (address => uint256)) private _allowed;
+    mapping(address => mapping(address => uint256)) private _allowed;
 
     uint256 private _totalSupply;
 
-    function mint(address to, uint256 val) 
-    public {
+    function mint(address to, uint256 val) public {
         _mint(to, val);
     }
 
     /**
-    * @dev Total number of tokens in existence
-    */
+     * @dev Total number of tokens in existence
+     */
     function totalSupply() public view returns (uint256) {
         return _totalSupply;
     }
 
     /**
-    * @dev Gets the balance of the specified address.
-    * @param owner The address to query the balance of.
-    * @return An uint256 representing the amount owned by the passed address.
-    */
+     * @dev Gets the balance of the specified address.
+     * @param owner The address to query the balance of.
+     * @return An uint256 representing the amount owned by the passed address.
+     */
     function balanceOf(address owner) public view returns (uint256) {
         return _balances[owner];
     }
@@ -134,10 +133,10 @@ contract ERC20 is IERC20 {
     }
 
     /**
-    * @dev Transfer token for a specified address
-    * @param to The address to transfer to.
-    * @param value The amount to be transferred.
-    */
+     * @dev Transfer token for a specified address
+     * @param to The address to transfer to.
+     * @param value The amount to be transferred.
+     */
     function transfer(address to, uint256 value) public returns (bool) {
         _transfer(msg.sender, to, value);
         return true;
@@ -207,11 +206,11 @@ contract ERC20 is IERC20 {
     }
 
     /**
-    * @dev Transfer token for a specified addresses
-    * @param from The address to transfer from.
-    * @param to The address to transfer to.
-    * @param value The amount to be transferred.
-    */
+     * @dev Transfer token for a specified addresses
+     * @param from The address to transfer from.
+     * @param to The address to transfer to.
+     * @param value The amount to be transferred.
+     */
     function _transfer(address from, address to, uint256 value) internal {
         require(to != address(0));
 

package/development/contracts/ExplodingCallbackClient.sol

@@ -1,16 +1,13 @@
 pragma solidity ^0.4.25;
 
 contract ExplodingCallbackClient {
-
     // Just write some state to avoid warnings that this could be pure
     bool impurity;
 
-    function __realitycheck_callback(bytes32 question_id, bytes32 question_answer) 
-    public {
+    function __realitycheck_callback(bytes32 question_id, bytes32 question_answer) public {
         question_id == 0x0;
         question_answer = 0x0;
         impurity = true;
         revert();
     }
-
 }

package/development/contracts/IArbitrator.sol

@@ -1,25 +1,25 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
-pragma solidity ^0.8.10;
-
-import './IRealityETH.sol';
-import './IERC20.sol';
-import './IOwned.sol';
-
-interface IArbitrator {
-  function metadata (  ) external view returns ( string memory );
-  function arbitration_bounties ( bytes32 ) external view returns ( uint256 );
-  function realitio (  ) external view returns ( IRealityETH );
-  function realitycheck (  ) external view returns ( IRealityETH );
-  function setRealitio ( address addr ) external;
-  function setDisputeFee ( uint256 fee ) external;
-  function setCustomDisputeFee ( bytes32 question_id, uint256 fee ) external;
-  function getDisputeFee ( bytes32 question_id ) external view returns ( uint256 );
-  function setQuestionFee ( uint256 fee ) external;
-  function submitAnswerByArbitrator ( bytes32 question_id, bytes32 answer, address answerer ) external;
-  function requestArbitration ( bytes32 question_id, uint256 max_previous ) external payable returns ( bool );
-  function withdraw ( address addr ) external;
-  function withdrawERC20 ( IERC20 _token, address addr ) external;
-  function callWithdraw (  ) external;
-  function setMetaData ( string memory _metadata ) external;
-}
+pragma solidity 0.8.20;
+
+/*
+This interface describes the Arbitrator contract originally deployed and managed by the reality.eth team. See below for the various parts it comprises.
+For the minimal interface that will be able to interact with the reality.eth UI as an arbitrator, use IArbitratorCore.
+*/
+
+import {IArbitratorCore} from "./IArbitratorCore.sol";
+
+// This provides management functionality to handle ownership, set fees etc.
+import {IArbitratorManagement} from "./IArbitratorManagement.sol";
+
+// This provides the old function realitycheck(), replaced by realitio().
+import {IArbitratorLegacy} from "./IArbitratorLegacy.sol";
+
+// This provides a function for querying the status of crowd-funded arbitration.
+import {IArbitratorCrowdFundable} from "./IArbitratorCrowdFundable.sol";
+
+// Errors (from v4)
+import {IArbitratorErrors} from "./IArbitratorErrors.sol";
+
+/* solhint-disable no-empty-blocks */
+interface IArbitrator is IArbitratorCore, IArbitratorLegacy, IArbitratorManagement, IArbitratorCrowdFundable, IArbitratorErrors {}

package/development/contracts/IArbitratorCore.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: GPL-3.0-only
+
+pragma solidity 0.8.20;
+
+import {IRealityETH} from "./IRealityETH.sol";
+
+interface IArbitratorCore {
+    event LogRequestArbitration(bytes32 indexed question_id, uint256 fee_paid, address requester, uint256 remaining);
+
+    function getDisputeFee(bytes32 question_id) external view returns (uint256);
+    function metadata() external view returns (string memory);
+    function realitio() external view returns (IRealityETH);
+    function requestArbitration(bytes32 question_id, uint256 max_previous) external payable returns (bool);
+}

package/development/contracts/IArbitratorCrowdFundable.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: GPL-3.0-only
+
+pragma solidity 0.8.20;
+
+interface IArbitratorCrowdFundable {
+    /* solhint-disable func-name-mixedcase */
+    function arbitration_bounties(bytes32) external view returns (uint256);
+}

package/development/contracts/IArbitratorErrors.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: GPL-3.0-only
+
+pragma solidity 0.8.20;
+
+interface IArbitratorErrors {
+    /// @notice The arbitrator must have set a non-zero fee for the question
+    error TheArbitratorMustHaveSetANonZeroFeeForTheQuestion();
+    /// @notice The question must not have been finalized
+    error TheQuestionMustNotHaveBeenFinalized();
+}

package/development/contracts/IArbitratorForeignProxy.sol

@@ -1,12 +1,20 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
-pragma solidity ^0.8.10;
+pragma solidity 0.8.20;
 
-import './IArbitrator.sol';
-import './IERC20.sol';
-import './IOwned.sol';
+/*
+This defines the features needed by a "foreign proxy" for a cross-chain arbitrator as created by Kleros, for example see
+https://github.com/kleros/cross-chain-realitio-proxy
 
-interface IArbitrator {
-  function foreignProxy() external returns (address);
-  function foreignChainId() external returns (uint256);
+In this arrangement, the "foreign" side is deployed on the chain where reality.eth is, and the "home" side is deployed on the chain where Kleros is.
+
+If you implement this you should also inherit and implement the functions in IArbitratorCore, with the exception of requestArbitration() which is done on the other chain.
+
+The metadata() string defined in IArbitratorCore should return some JSON to tell the UI that it is dealing with a foreign proxy, like:
+{ foreignProxy: true }
+*/
+
+interface IArbitratorForeignProxy {
+    function foreignProxy() external returns (address);
+    function foreignChainId() external returns (uint256);
 }

package/development/contracts/IArbitratorLegacy.sol

@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: GPL-3.0-only
+
+pragma solidity 0.8.20;
+
+import {IRealityETH} from "./IRealityETH.sol";
+
+interface IArbitratorLegacy {
+    function realitycheck() external view returns (IRealityETH);
+}

package/development/contracts/IArbitratorManagement.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: GPL-3.0-only
+
+pragma solidity 0.8.20;
+
+import {IERC20} from "./IERC20.sol";
+
+interface IArbitratorManagement {
+    event LogSetRealitio(address realitio);
+
+    event LogSetQuestionFee(uint256 fee);
+
+    event LogSetDisputeFee(uint256 fee);
+
+    event LogSetCustomDisputeFee(bytes32 indexed question_id, uint256 fee);
+
+    function setRealitio(address addr) external;
+    function setDisputeFee(uint256 fee) external;
+    function setCustomDisputeFee(bytes32 question_id, uint256 fee) external;
+    function setQuestionFee(uint256 fee) external;
+    function submitAnswerByArbitrator(bytes32 question_id, bytes32 answer, address answerer) external;
+    function withdraw(address addr) external;
+    function withdrawERC20(IERC20 _token, address addr) external;
+    function callWithdraw() external;
+    function setMetaData(string memory _metadata) external;
+}

package/development/contracts/IBalanceHolder.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
-pragma solidity ^0.8.10;
+pragma solidity 0.8.20;
 
 interface IBalanceHolder {
-  function withdraw (  ) external;
-  function balanceOf ( address ) external view returns ( uint256 );
+    function withdraw() external;
+    function balanceOf(address) external view returns (uint256);
 }