Initial refactor to use hardhat and typescript and generate docs

harmony-one · May 21, 2022 · f7343ca · f7343ca
1 parent 9b90df5
commit f7343ca
Show file tree

Hide file tree

Showing 120 changed files with 23,071 additions and 5,597 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,3 @@
+ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
+ROPSTEN_URL=https://eth-ropsten.alchemyapi.io/v2/<YOUR ALCHEMY KEY>
+PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,4 @@
+node_modules
+artifacts
+cache
+coverage
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "standard",
+    "plugin:prettier/recommended",
+    "plugin:node/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      { ignores: ["modules"] },
+    ],
+  },
+};
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,11 @@ cache
 
 node_modules
 build/contracts
+
+coverage
+coverage.json
+typechain
+
+#Hardhat files
+cache
+artifacts
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+hardhat.config.ts
+scripts
+test
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,5 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1 @@
+{}
diff --git a/.solhint.json b/.solhint.json
@@ -0,0 +1,7 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
+}
diff --git a/.solhintignore b/.solhintignore
@@ -0,0 +1 @@
+node_modules
diff --git a/contracts/BridgedToken.sol b/contracts/BridgedToken.sol
@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
-import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20BurnableUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20BurnableUpgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
@@ -14,7 +15,8 @@ contract BridgedToken is ERC20Upgradeable, ERC20BurnableUpgradeable, OwnableUpgr
     ) external initializer {
         __ERC20_init(name, symbol);
         __ERC20Burnable_init();
-        _setupDecimals(decimals);
+        // decimals(decimals);
+        // _setupDecimals(decimals);
     }
 
     function mint(address to, uint256 amount) external onlyOwner {

diff --git a/contracts/EthereumLightClient.sol b/contracts/EthereumLightClient.sol
@@ -1,10 +1,11 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
-import "@openzeppelin/contracts-upgradeable/math/SafeMathUpgradeable.sol";
-import "@openzeppelin/contracts-upgradeable/proxy/Initializable.sol";
-import "@openzeppelin/contracts-upgradeable/utils/PausableUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/utils/math/SafeMathUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
 import "./EthereumParser.sol";
 import "./lib/EthUtils.sol";
 import "./ethash/ethash.sol";

diff --git a/contracts/EthereumParser.sol b/contracts/EthereumParser.sol
@@ -1,11 +1,13 @@
+// SPDX-License-Identifier: UNLICENSED
+
 /**
  * Created on 2019-12-28
  * @summary: The EthCommon library contains common structures / functions
  * @author: Tuan Vu (tuanvd@gmail.com)
  */
 
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+pragma solidity ^0.8.0;
 
 import "./lib/RLPReader.sol";
 import "./lib/RLPEncode.sol";

diff --git a/contracts/EthereumProver.sol b/contracts/EthereumProver.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 import "./lib/RLPReader.sol";
 

diff --git a/contracts/FaucetToken.sol b/contracts/FaucetToken.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
@@ -11,7 +12,7 @@ contract FaucetToken is ERC20Upgradeable {
         uint8 decimals
     ) external initializer {
         __ERC20_init(name, symbol);
-        _setupDecimals(decimals);
+        // _setupDecimals(decimals);
     }
 
     function mint() public returns (bool) {

diff --git a/contracts/HarmonyLightClient.sol b/contracts/HarmonyLightClient.sol
@@ -1,15 +1,16 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "./HarmonyParser.sol";
 import "./lib/SafeCast.sol";
-import "@openzeppelin/contracts-upgradeable/math/SafeMathUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/utils/math/SafeMathUpgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
 // import "openzeppelin-solidity/contracts/utils/Pausable.sol";
-import "@openzeppelin/contracts-upgradeable/utils/PausableUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
 // import "openzeppelin-solidity/contracts/proxy/Initializable.sol";
-import "@openzeppelin/contracts-upgradeable/proxy/Initializable.sol";
+import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 
 contract HarmonyLightClient is
     Initializable,

diff --git a/contracts/HarmonyParser.sol b/contracts/HarmonyParser.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "./lib/RLPReader.sol";

diff --git a/contracts/HarmonyProver.sol b/contracts/HarmonyProver.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 // largely based on

diff --git a/contracts/LightClient.sol b/contracts/LightClient.sol
@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
-import "openzeppelin-solidity/contracts/access/Ownable.sol";
+import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
 interface ILightClient {
     function blocksByHeight(uint256, uint256) external returns (uint256); // block number => block hash[]

diff --git a/contracts/Migrations.sol b/contracts/Migrations.sol
@@ -1,5 +1,6 @@
-// SPDX-License-Identifier: MIT
-pragma solidity 0.7.3;
+// SPDX-License-Identifier: UNLICENSED
+
+pragma solidity ^0.8.0;
 
 contract Migrations {
     address public owner;

diff --git a/contracts/TokenLocker.sol b/contracts/TokenLocker.sol
@@ -1,15 +1,16 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "./lib/RLPReader.sol";
 import "./BridgedToken.sol";
 import "./TokenRegistry.sol";
-import "@openzeppelin/contracts-upgradeable/token/ERC20/SafeERC20Upgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
-import "@openzeppelin/contracts-upgradeable/math/SafeMathUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/utils/math/SafeMathUpgradeable.sol";
 // import "openzeppelin-solidity/contracts/token/ERC20/IERC20.sol";
 // import "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol";
 // import "openzeppelin-solidity/contracts/token/ERC20/SafeERC20.sol";

diff --git a/contracts/TokenLockerOnEthereum.sol b/contracts/TokenLockerOnEthereum.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "./HarmonyLightClient.sol";

diff --git a/contracts/TokenLockerOnHarmony.sol b/contracts/TokenLockerOnHarmony.sol
@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
-import "@openzeppelin/contracts-upgradeable/math/SafeMathUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/utils/math/SafeMathUpgradeable.sol";
 import "./EthereumLightClient.sol";
 import "./EthereumProver.sol";
 import "./TokenLocker.sol";

diff --git a/contracts/TokenRegistry.sol b/contracts/TokenRegistry.sol
@@ -1,13 +1,14 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "./lib/RLPReader.sol";
 // import "openzeppelin-solidity/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 // import "openzeppelin-solidity/contracts/token/ERC20/SafeERC20.sol";
-import "@openzeppelin/contracts-upgradeable/token/ERC20/SafeERC20Upgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
 import "./BridgedToken.sol";
 
 contract TokenRegistry {

diff --git a/contracts/ethash/MerkelRoot.sol b/contracts/ethash/MerkelRoot.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 contract MerkelRoots {

diff --git a/contracts/ethash/Prime.sol b/contracts/ethash/Prime.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 // from https://gist.github.com/lhartikk/c7bbc120aa8e58a0e0e781edb9a90497

diff --git a/contracts/ethash/binary.sol b/contracts/ethash/binary.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 library LittleEndian {

diff --git a/contracts/ethash/ethash.sol b/contracts/ethash/ethash.sol
@@ -1,11 +1,12 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "./binary.sol";
 import "./keccak512.sol";
 import "./Prime.sol";
-import "@openzeppelin/contracts-upgradeable/cryptography/MerkleProofUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/utils/cryptography/MerkleProofUpgradeable.sol";
 
 import "./MerkelRoot.sol"; // npm run merkelInit
 

diff --git a/contracts/ethash/keccak512.sol b/contracts/ethash/keccak512.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 pragma experimental ABIEncoderV2;
 
 import "./binary.sol";

diff --git a/contracts/lib/ECVerify.sol b/contracts/lib/ECVerify.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 library ECVerify {
     function ecverify(

diff --git a/contracts/lib/EthUtils.sol b/contracts/lib/EthUtils.sol
@@ -1,11 +1,13 @@
+// SPDX-License-Identifier: UNLICENSED
+
 /**
  * Created on 2019-12-28
  * @summary: The EthUtils library contains utility functions
  * @author: Tuan Vu (tuanvd@gmail.com)
  */
 
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+pragma solidity ^0.8.0;
 
 library EthUtils {
     function bytesToBytes32(bytes memory b, uint256 offset)

diff --git a/contracts/lib/MMR.sol b/contracts/lib/MMR.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 /**
  * @author Wanseob Lim <email@wanseob.com>

diff --git a/contracts/lib/MMRVerifier.sol b/contracts/lib/MMRVerifier.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 /**
  * @author Wanseob Lim <email@wanseob.com>

diff --git a/contracts/lib/MMRWrapper.sol b/contracts/lib/MMRWrapper.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 import "./MMR.sol";
 import "./RLPReader.sol";

diff --git a/contracts/lib/MPT.sol b/contracts/lib/MPT.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 import "./RLPReader.sol";
 

diff --git a/contracts/lib/RLPEncode.sol b/contracts/lib/RLPEncode.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 /**
  * @title RLPEncode

diff --git a/contracts/lib/RLPReader.sol b/contracts/lib/RLPReader.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 /*
  * @author Hamdi Allam hamdi.allam97@gmail.com
@@ -168,7 +169,8 @@ library RLPReader {
         // 1 byte for the length prefix
         require(item.len == 21);
 
-        return address(toUint(item));
+        return address(uint160(toUint(item)));
+        // return address(toUint(item));
     }
 
     function toUint(RLPItem memory item) internal pure returns (uint256) {

diff --git a/contracts/lib/SafeCast.sol b/contracts/lib/SafeCast.sol
@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.7.3;
+
+pragma solidity ^0.8.0;
 
 library SafeCast {
     function toUint200(uint256 value) internal pure returns (uint200) {