@reality.eth/contracts 3.0.45 → 3.0.47

package/development/contracts/RealityETH_ERC20_Factory.sol

@@ -1,48 +1,53 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
-pragma solidity ^0.8.10;
+pragma solidity ^0.8.20;
 
-import "./IRealityETH_ERC20.sol";
-import "./IERC20.sol";
+import {IRealityETH_ERC20} from "./IRealityETH_ERC20.sol";
+import {IERC20} from "./IERC20.sol";
 
+// solhint-disable-next-line contract-name-camelcase
 contract RealityETH_ERC20_Factory {
-
-  address public libraryAddress;
-  mapping(address => address) public deployments;
-
-  event RealityETH_ERC20_deployed (address reality_eth, address token, uint8 decimals, string token_ticker);
-
-  constructor(address _libraryAddress) {
-    libraryAddress = _libraryAddress;
-  }
-
-  /// @notice Returns the address of a proxy based on the specified address
-  /// @dev based on https://github.com/optionality/clone-factory
-  function _deployProxy(address _target)
-  internal returns (address result) {
-     bytes20 targetBytes = bytes20(_target);
-     assembly {
-         let clone := mload(0x40)
-         mstore(clone, 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000000000000000000000)
-         mstore(add(clone, 0x14), targetBytes)
-         mstore(add(clone, 0x28), 0x5af43d82803e903d91602b57fd5bf30000000000000000000000000000000000)
-         result := create(0, clone, 0x37)
-     }
-  }
-
-  function createInstance(address _token) external {
-    require(deployments[_token] == address(0), "There should only be one deployment per version per token");
-    uint8 decimals = IERC20(_token).decimals();
-    string memory ticker = IERC20(_token).symbol();
-    address clone = _deployProxy(libraryAddress);
-    IRealityETH_ERC20(clone).setToken(_token);
-    IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "bool", "category": "%s", "lang": "%s"}');
-    IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "uint", "decimals": 18, "category": "%s", "lang": "%s"}');
-    IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "single-select", "outcomes": [%s], "category": "%s", "lang": "%s"}');
-    IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "multiple-select", "outcomes": [%s], "category": "%s", "lang": "%s"}');
-    IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "datetime", "category": "%s", "lang": "%s"}');
-    deployments[_token] = clone;
-    emit RealityETH_ERC20_deployed(clone, _token, decimals, ticker);
-  }
-
+    /// @notice There should only be one deployment per version per token
+    error ThereShouldOnlyBeOneDeploymentPerVersionPerToken();
+
+    address public libraryAddress;
+    mapping(address => address) public deployments;
+
+    // solhint-disable-next-line event-name-camelcase
+    event RealityETH_ERC20_deployed(address reality_eth, address token, uint8 decimals, string token_ticker);
+
+    constructor(address _libraryAddress) {
+        libraryAddress = _libraryAddress;
+    }
+
+    /// @notice Returns the address of a proxy based on the specified address
+    /// @dev based on https://github.com/optionality/clone-factory
+    function _deployProxy(address _target) internal returns (address result) {
+        bytes20 targetBytes = bytes20(_target);
+        // solhint-disable-next-line no-inline-assembly
+        assembly {
+            let clone := mload(0x40)
+            mstore(clone, 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000000000000000000000)
+            mstore(add(clone, 0x14), targetBytes)
+            mstore(add(clone, 0x28), 0x5af43d82803e903d91602b57fd5bf30000000000000000000000000000000000)
+            result := create(0, clone, 0x37)
+        }
+    }
+
+    function createInstance(address _token) external {
+        if (deployments[_token] != address(0)) revert ThereShouldOnlyBeOneDeploymentPerVersionPerToken();
+        uint8 decimals = IERC20(_token).decimals();
+        string memory ticker = IERC20(_token).symbol();
+        address clone = _deployProxy(libraryAddress);
+        IRealityETH_ERC20(clone).setToken(IERC20(_token));
+        /* solhint-disable quotes */
+        IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "bool", "category": "%s", "lang": "%s"}');
+        IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "uint", "decimals": 18, "category": "%s", "lang": "%s"}');
+        IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "single-select", "outcomes": [%s], "category": "%s", "lang": "%s"}');
+        IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "multiple-select", "outcomes": [%s], "category": "%s", "lang": "%s"}');
+        IRealityETH_ERC20(clone).createTemplate('{"title": "%s", "type": "datetime", "category": "%s", "lang": "%s"}');
+        /* solhint-enable quotes */
+        deployments[_token] = clone;
+        emit RealityETH_ERC20_deployed(clone, _token, decimals, ticker);
+    }
 }

package/development/contracts/RegisteredWalletArbitrator.sol

@@ -1,7 +1,7 @@
 pragma solidity ^0.4.25;
 
-import './Arbitrator.sol';
-import './IERC20.sol';
+import "./Arbitrator.sol";
+import "./IERC20.sol";
 
 /*
 This contract extends the standard Arbitrator contract to make it possible to make routine fund withdrawals to an address pre-registered by the owner without actually being the owner.
@@ -10,28 +10,24 @@ We do this to facilitate controlling Arbitrator contracts using multisig wallets
 */
 
 contract RegisteredWalletArbitrator is Arbitrator {
-
     address registered_wallet;
 
     /// @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 Usually the arbitrator calls this, but if someone else does that's OK too
-    function callWithdraw() 
-    public {
-        realitio.withdraw(); 
+    function callWithdraw() public {
+        realitio.withdraw();
     }
 
     /// @notice Withdraw money from the arbitrator contract to our registered wallet
-    function withdrawToRegisteredWalletERC20(IERC20 _token)
-    external {
+    function withdrawToRegisteredWalletERC20(IERC20 _token) external {
         require(registered_wallet != 0x0, "No wallet is registered");
         uint256 bal = _token.balanceOf(address(this));
         _token.transfer(registered_wallet, bal);
     }
 
     /// @notice Withdraw money from the arbitrator contract to our registered wallet
-    function withdrawToRegisteredWallet()
-    external {
+    function withdrawToRegisteredWallet() external {
         require(registered_wallet != 0x0, "No wallet is registered");
         registered_wallet.transfer(address(this).balance);
     }
@@ -39,10 +35,7 @@ contract RegisteredWalletArbitrator is Arbitrator {
     /// @notice Change the address of our registered wallet
     /// @param addr The address of the new wallet
     /// @dev Set to 0x0 to not use the registered wallet
-    function updateRegisteredWallet(address addr) 
-        onlyOwner
-    external {
-        registered_wallet= addr;
+    function updateRegisteredWallet(address addr) external onlyOwner {
+        registered_wallet = addr;
     }
-
 }

package/development/contracts/compile.py

@@ -13,6 +13,9 @@ if len(sys.argv) < 2:
 VERSION=sys.argv[1]
 CONTRACT_NAME = None
 
+# If you passed in .sol, strip it
+VERSION = VERSION.replace(".sol", "")
+
 if len(sys.argv) >= 3:
     SOURCE_FILE = sys.argv[2]
 else:

package/development/scripts/string_to_error.py

@@ -0,0 +1,111 @@
+import sys
+import re
+
+def camelcase(s):
+    return ''.join(t.title() for t in s.split())
+
+def stringToError(s):
+    s = s.replace(".", " ")
+    s = s.replace("-", " ")
+    s = s.replace(",", " ")
+    s = s.replace("?", "")
+    return camelcase(s)
+    
+def invert_sign(expr):
+    inversions = {
+        '> 0': '== 0',
+        '==': '!=',
+        '!=': '==',
+        '>=': '<',
+        '<=': '>',
+        '<': '>=',
+        '>': '<='
+    }
+    for before in inversions:
+        after = inversions[before] 
+        new_expr = expr.replace(before, after)
+        if new_expr != expr:
+            return new_expr
+
+    if expr.startswith("!"):
+        return expr[1:]
+    else:
+        return "!"+expr
+
+    return expr
+
+require_pattern = '(.*?)require\((.*?)\,\s+\"(.*?)\"\);'
+revert_pattern = '^(.*?revert)\(\"(.*?)\"\);'
+
+error_list = {}
+
+source_in = sys.argv[1]
+interface_out = None
+if len(sys.argv) > 2:
+    interface_out = sys.argv[2]
+
+with open(source_in) as f:
+    for line in f:
+        l = line.rstrip()
+        require_result = re.match(require_pattern, l)
+        revert_result = re.match(revert_pattern, l)
+
+        if require_result is not None:
+            bits = list(require_result.groups())
+            # Should be padding, then the condition, then the revert string.
+            if len(bits) != 3:
+                out = l + " // TODO FIX ERROR MANUALLY"
+                #print(l)
+            else:
+                err_text = bits.pop()
+                condstr = bits.pop()
+                if "&&" in condstr:
+                    out = l + " // TODO FIX ERROR MANUALLY"
+                else:
+                    # We don't do && because don't have them in our code in require
+                    conds = condstr.split(" || ")
+                    new_conds = []
+                    for cond in conds:
+                        new_conds.append(invert_sign(cond))
+                    new_condstr = " && ".join(new_conds)
+
+                    err_name = stringToError(err_text)
+                    error_list[err_name] = err_text
+                    out = "".join(bits)
+                    out = out + "if ("
+                    out = out + new_condstr
+                    out = out + ") revert "
+                    out = out + err_name
+                    out = out + "();"
+            print(out)
+
+        elif revert_result is not None:
+            bits = list(revert_result.groups())
+            # Should be padding, then the revert string.
+            if len(bits) != 2:
+                out = l + " // TODO FIX ERROR MANUALLY"
+            else: 
+                err_text = bits.pop()
+                err_name = camelcase(err_text)
+                error_list[err_name] = err_text
+                start = bits.pop()
+                out = start
+                out = out + " "
+                out = out + err_name
+                out = out + "();" 
+            print(out)
+        else:
+            print(l)
+            pass
+
+
+    if interface_out is not None:
+        out_fh = open(interface_out+'.sol', 'w')
+        for err_name in error_list:
+            out_fh.write("    /// @notice "+error_list[err_name]+"\n")
+            out_fh.write("    error "+err_name+"();"+"\n")
+                #print(result.groups())
+            #require(questions[question_id].timeout == 0, "question must not exist");
+            #if (!(questions[question_id].timeout == 0)) revert("question must not exist");
+        out_fh.close()
+

package/development/version_checksums/check_matches_flat.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# This script checks that we didn't change our audited code when refactoring.
+# It will compare the binary code generated with the code created by compiling the flat files in flat/ which we do not regenerate.
+# It runs solc with the --no-cbor-metadata flag to prevent solc from appending ipfs metadata, which includes a hash of the source code.
+# It stores the hashes it finds along with the current commit hash.
+
+DIR=`dirname "$0"`
+COMMIT=`git rev-parse HEAD`
+
+for contract in "RealityETH-3.0.sol" "RealityETH_ERC20-3.0.sol"; do
+    HASH=`solc-0.8.20 --no-cbor-metadata --bin "$DIR/../contracts/$contract" | tail -n1 | sha256sum | head -c64`
+    ORIG_HASH=`solc-0.8.20 --no-cbor-metadata --bin "$DIR/../../flat/$contract" | tail -n1 | sha256sum | head -c64`
+    if [ "$HASH" != "$ORIG_HASH" ]; then
+        echo "Hash mismatch"
+        exit 1
+    fi
+    echo "$contract: $HASH" >> $COMMIT
+done
+

package/development/version_checksums/check_matches_last.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# This script checks that we didn't change our audited code when refactoring.
+# It runs solc with the --no-cbor-metadata flag to prevent solc from appending ipfs metadata, which includes a hash of the source code.
+# It stores the hashes it finds along with the current commit hash.
+# If it has already been run on that commit with a different hash, it will exit with an error.
+
+DIR=`dirname "$0"`
+COMMIT=`git rev-parse HEAD`
+SOLC="solc-0.8.20"
+
+for contract in "RealityETH-3.0.sol" "RealityETH_ERC20-3.0.sol" "RealityETH-4.0.sol" "RealityETH_ERC20-4.0.sol"; do
+    if [ ! -f "$DIR/../contracts/$contract" ]; then
+        continue
+    fi
+
+    BIN_HEX=`${SOLC} --no-cbor-metadata --bin "$DIR/../contracts/$contract" | grep -A2 "${contract}:" | tail -n1`
+    if [ -n "$BIN_HEX" ]; then
+        NEW_HASH=`echo "$BIN_HEX" | sha256sum | head -c64`
+        FILE="${contract}-${COMMIT}"
+        if test -f "$FILE"; then
+            ORIG_HASH=`cat $FILE`
+            if [ "$NEW_HASH" != "$ORIG_HASH" ]; then
+                echo "Hash mismatch"
+                exit 1
+            fi
+        else
+            echo "logging $contract for the first time"
+            echo "$NEW_HASH" > $FILE
+        fi
+    else
+        echo "Compile of ${contract} failed"
+        exit 1
+    fi
+done
+
+echo "OK"

package/development/version_checksums/log_bytecode_history.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+# This script helps us checks that we didn't change our audited code when refactoring unless we intended to.
+# It runs solc with the --no-cbor-metadata flag to prevent solc from appending ipfs metadata, which includes a hash of the source code.
+# It will run back through the history up to the specified number of commits.
+# It assumes they all use solc 0.8.20. You need that binary installed. Adjust the SOLC variable if it's installed but not called "solc-0.8.20"
+# It will output a file for each version with the commit, the hash of the compiled code and whether we put in a comment to claim we didn't change it from the previous commit (on the next line)
+# It should put you back at the head of the original branch once it's finished.
+
+if [[ "$1" -lt "1" ]]; then
+    echo "Usage: ./log_bytecode_history.sh <number of commits to go back>"
+    exit 1
+fi
+
+DIR=`dirname "$0"`
+COUNT=$1
+ORIG_BRANCH=`git rev-parse --abbrev-ref HEAD`
+SOLC="solc-0.8.20"
+
+
+for i in $(seq $COUNT); do
+    sleep 1
+    git checkout HEAD^
+    SAME_BYTECODE=`git log HEAD^..HEAD --oneline | grep -c "no bytecode change"`
+    COMMIT=`git rev-parse HEAD`
+    for contract in "RealityETH-3.0.sol" "RealityETH_ERC20-3.0.sol" "RealityETH-4.0.sol" "RealityETH_ERC20-4.0.sol"; do
+        if [ ! -f "$DIR/../contracts/$contract" ]; then
+            continue
+        fi
+        BIN_HEX=`${SOLC} --no-cbor-metadata --bin "$DIR/../contracts/$contract" | grep -A2 "${contract}:" | tail -n1`
+        if [ -n "$BIN_HEX" ]; then
+            NEW_HASH=`echo "$BIN_HEX" | sha256sum | head -c64`
+        else
+            NEW_HASH="COMPILE_FAILED"
+        fi
+        LOG="COMMIT_LOG_${contract}.log"
+        echo "${COMMIT}:${NEW_HASH}:${SAME_BYTECODE}" >> $LOG
+    done
+done
+
+git checkout $ORIG_BRANCH

package/generated/chains.json

@@ -15,13 +15,20 @@
             "wss://ethereum.publicnode.com",
             "https://mainnet.gateway.tenderly.co",
             "wss://mainnet.gateway.tenderly.co",
-            "https://rpc.blocknative.com/boost"
+            "https://rpc.blocknative.com/boost",
+            "https://rpc.flashbots.net",
+            "https://rpc.flashbots.net/fast",
+            "https://rpc.mevblocker.io",
+            "https://rpc.mevblocker.io/fast",
+            "https://rpc.mevblocker.io/noreverts",
+            "https://rpc.mevblocker.io/fullprivacy"
         ],
         "hostedRPC": "https://eth-mainnet.alchemyapi.io/v2/c9uS--nIxEOjVjh0AJlNttMaqUXQy8gR",
         "graphURL": "https://api.thegraph.com/subgraphs/name/realityeth/realityeth",
         "blockExplorerUrls": [
             "https://etherscan.io",
-            "https://eth.blockscout.com"
+            "https://eth.blockscout.com",
+            "https://ethereum.dex.guru"
         ]
     },
     "3": {
@@ -116,7 +123,8 @@
         "graphURL": "https://api.thegraph.com/subgraphs/name/realityeth/realityeth-optimism",
         "blockExplorerUrls": [
             "https://optimistic.etherscan.io",
-            "https://optimism.blockscout.com"
+            "https://optimism.blockscout.com",
+            "https://optimism.dex.guru"
         ]
     },
     "40": {
@@ -166,6 +174,7 @@
         "graphURL": "https://api.thegraph.com/subgraphs/name/realityeth/realityeth-bsc",
         "blockExplorerUrls": [
             "https://bscscan.com",
+            "https://bnb.dex.guru",
             "https://www.bscscan.com"
         ]
     },
@@ -258,7 +267,8 @@
         "graphURL": "https://api.thegraph.com/subgraphs/name/realityeth/realityeth-gnosis",
         "blockExplorerUrls": [
             "https://gnosisscan.io",
-            "https://gnosis.blockscout.com"
+            "https://gnosis.blockscout.com",
+            "https://gnosis.dex.guru"
         ]
     },
     "137": {
@@ -286,6 +296,7 @@
         "graphURL": "https://gateway-arbitrum.network.thegraph.com/api/73380b22a17017c081123ec9c0e34677/subgraphs/id/AWx6jkeKZ3xKRzkrzgfCAMPT7d6Jc3AMcqB8koN3QEqE",
         "blockExplorerUrls": [
             "https://polygonscan.com",
+            "https://polygon.dex.guru",
             "https://polygonscan.com/"
         ]
     },
@@ -308,9 +319,26 @@
             "https://zksync2-testnet.zkscan.io"
         ]
     },
+    "300": {
+        "chainId": "0x12c",
+        "chainName": "zkSync Sepolia Testnet",
+        "nativeCurrency": {
+            "name": "Ether",
+            "symbol": "ETH",
+            "decimals": 18
+        },
+        "network_name": "zksync-era-sepolia",
+        "rpcUrls": [
+            "https://sepolia.era.zksync.dev"
+        ],
+        "hostedRPC": "https://sepolia.era.zksync.dev",
+        "blockExplorerUrls": [
+            "https://sepolia.explorer.zksync.io"
+        ]
+    },
     "324": {
         "chainId": "0x144",
-        "chainName": "zkSync Era Mainnet",
+        "chainName": "zkSync Mainnet",
         "nativeCurrency": {
             "name": "Ether",
             "symbol": "ETH",

package/generated/tokens.json

@@ -39,6 +39,7 @@
             "5": true,
             "42": true,
             "280": true,
+            "300": true,
             "324": true,
             "1101": true,
             "534353": true,

package/non_standard_deployments/zksync/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Matter Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/non_standard_deployments/zksync/README.md

@@ -0,0 +1,51 @@
+# zkSync Hardhat project template
+
+This project was scaffolded with [zksync-cli](https://github.com/matter-labs/zksync-cli).
+
+## Project Layout
+
+- `/contracts`: Contains solidity smart contracts.
+- `/deploy`: Scripts for contract deployment and interaction.
+- `/test`: Test files.
+- `hardhat.config.ts`: Configuration settings.
+
+## How to Use
+
+- `npm run compile`: Compiles contracts.
+- `npm run deploy`: Deploys using script `/deploy/deploy.ts`.
+- `npm run interact`: Interacts with the deployed contract using `/deploy/interact.ts`.
+- `npm run test`: Tests the contracts.
+
+Note: Both `npm run deploy` and `npm run interact` are set in the `package.json`. You can also run your files directly, for example: `npx hardhat deploy-zksync --script deploy.ts`
+
+### Environment Settings
+
+To keep private keys safe, this project pulls in environment variables from `.env` files. Primarily, it fetches the wallet's private key.
+
+Rename `.env.example` to `.env` and fill in your private key:
+
+```
+WALLET_PRIVATE_KEY=your_private_key_here...
+```
+
+### Network Support
+
+`hardhat.config.ts` comes with a list of networks to deploy and test contracts. Add more by adjusting the `networks` section in the `hardhat.config.ts`. To make a network the default, set the `defaultNetwork` to its name. You can also override the default using the `--network` option, like: `hardhat test --network dockerizedNode`.
+
+### Local Tests
+
+Running `npm run test` by default runs the [zkSync In-memory Node](https://era.zksync.io/docs/tools/testing/era-test-node.html) provided by the [@matterlabs/hardhat-zksync-node](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-node.html) tool.
+
+Important: zkSync In-memory Node currently supports only the L2 node. If contracts also need L1, use another testing environment like Dockerized Node. Refer to [test documentation](https://era.zksync.io/docs/tools/testing/) for details.
+
+## Useful Links
+
+- [Docs](https://era.zksync.io/docs/dev/)
+- [Official Site](https://zksync.io/)
+- [GitHub](https://github.com/matter-labs)
+- [Twitter](https://twitter.com/zksync)
+- [Discord](https://join.zksync.dev/)
+
+## License
+
+This project is under the [MIT](./LICENSE) license.

package/non_standard_deployments/zksync/deploy/deploy.ts

@@ -0,0 +1,11 @@
+import { deployContract } from "./utils";
+
+// An example of a basic deploy script
+// It will deploy a Greeter contract to selected network
+// as well as verify it on Block Explorer if possible for the network
+export default async function () {
+  const contractArtifactName = "RealityETH_zksync_v3_0";
+  const constructorArguments = [];
+  await deployContract(contractArtifactName, constructorArguments);
+}
+