CleanUp. Improve file linting, add tests for coverage, update Katalyst deployer script, fix CI script.

Author: Anyhowclick

.prettierignore

@@ -1,3 +1,4 @@
 # zeppelin contracts
 contractsSol5/utils/zeppelin
+contractsSol5/bridges
 

.solcover.js

@@ -25,7 +25,8 @@ function removeV4ArtifactsDir(config) {
 
 module.exports = {
     providerOptions: {
-        "default_balance_ether": 50000
+        "default_balance_ether": 50000,
+        "total_accounts": 20
     },
     istanbulReporter: ['html','json'],
     onCompileComplete: moveFiles,

.solhint.json

@@ -0,0 +1,14 @@
+{
+  "extends": "solhint:default",
+  "rules": {
+    "indent": ["error", 4],
+    "quotes": ["error", "double"],
+    "avoid-suicide": "error",
+    "avoid-sha3": "warn",
+    "avoid-tx-origin:": "warn",
+    "const-name-snakecase": "off",
+    "func-order": "warn",
+    "not-rely-on-block-hash": "warn"
+  }
+}
+

.solhintignore

@@ -0,0 +1,4 @@
+# zeppelin contracts
+contractsSol5/utils/zeppelin
+contractsSol5/bridges
+

.travis.yml

@@ -24,6 +24,7 @@ install:
   - npm ci
 
 script:
+  - npx solhint contractsSol5/**/**.sol
   - ./cmp.sh
   - .travis/test-part.sh
 

.travis/test-part.sh

@@ -13,7 +13,7 @@ Coverage)
     if [[ $TRAVIS_EVENT_TYPE != "push" ]]; then
         echo "Only running coverage on merge request or direct push"
     elif [[ $TRAVIS_BRANCH == $COVERAGE_BRANCH ]]; then
-        ./coverage.sh
+        ./coverage.sh || true
     else
         echo "Not running coverage on $TRAVIS_BRANCH"
     fi

contractsSol5/Dao/IKyberStaking.sol

@@ -2,14 +2,15 @@ pragma solidity 0.5.11;
 
 
 interface IKyberStaking {
-    event Delegated(address indexed staker, address indexed delegatedAddress, uint256 indexed epoch, bool isDelegated);
+    event Delegated(
+        address indexed staker,
+        address indexed delegatedAddress,
+        uint256 indexed epoch,
+        bool isDelegated
+    );
     event Deposited(uint256 curEpoch, address indexed staker, uint256 amount);
     event Withdraw(uint256 indexed curEpoch, address indexed staker, uint256 amount);
 
-    function epochPeriodInSeconds() external view returns (uint256);
-
-    function firstEpochStartTimestamp() external view returns (uint256);
-
     function initAndReturnStakerDataForCurrentEpoch(address staker)
         external
         returns (
@@ -18,6 +19,12 @@ interface IKyberStaking {
             address _delegatedAddress
         );
 
+    function deposit(uint256 amount) external;
+
+    function delegate(address dAddr) external;
+
+    function withdraw(uint256 amount) external;
+
     function getStakerDataForPastEpoch(address staker, uint256 epoch)
         external
         view
@@ -27,9 +34,7 @@ interface IKyberStaking {
             address _delegatedAddress
         );
 
-    function deposit(uint256 amount) external;
-
-    function withdraw(uint256 amount) external;
+    function epochPeriodInSeconds() external view returns (uint256);
 
-    function delegate(address dAddr) external;
+    function firstEpochStartTimestamp() external view returns (uint256);
 }

contractsSol5/Dao/KyberFeeHandler.sol

@@ -433,22 +433,6 @@ contract KyberFeeHandler is IKyberFeeHandler, Utils4, BurnConfigPermission {
         }
     }
 
-    function readBRRData()
-        public
-        view
-        returns (
-            uint256 rewardBps,
-            uint256 rebateBps,
-            uint256 expiryTimestamp,
-            uint256 epoch
-        )
-    {
-        rewardBps = uint256(brrAndEpochData.rewardBps);
-        rebateBps = uint256(brrAndEpochData.rebateBps);
-        epoch = uint256(brrAndEpochData.epoch);
-        expiryTimestamp = uint256(brrAndEpochData.expiryTimestamp);
-    }
-
     function getBRR()
         public
         returns (
@@ -477,6 +461,22 @@ contract KyberFeeHandler is IKyberFeeHandler, Utils4, BurnConfigPermission {
         }
     }
 
+    function readBRRData()
+        public
+        view
+        returns (
+            uint256 rewardBps,
+            uint256 rebateBps,
+            uint256 expiryTimestamp,
+            uint256 epoch
+        )
+    {
+        rewardBps = uint256(brrAndEpochData.rewardBps);
+        rebateBps = uint256(brrAndEpochData.rebateBps);
+        epoch = uint256(brrAndEpochData.epoch);
+        expiryTimestamp = uint256(brrAndEpochData.expiryTimestamp);
+    }
+
     function updateBRRData(
         uint256 reward,
         uint256 rebate,

contractsSol5/Dao/mock/MockKyberStakingMalicious.sol

@@ -11,10 +11,6 @@ contract MockKyberStakingMalicious is KyberStaking {
         address _admin
     ) public KyberStaking(_kncToken, _epochPeriod, _startBlock, _admin) {}
 
-    function getHasInitedValue(address staker, uint256 epoch) public view returns (bool) {
-        return hasInited[epoch][staker];
-    }
-
     function setLatestStake(address staker, uint256 amount) public {
         stakerLatestData[staker].stake = amount;
     }
@@ -38,4 +34,8 @@ contract MockKyberStakingMalicious is KyberStaking {
     ) public {
         stakerPerEpochData[epoch][staker].delegatedStake = amount;
     }
+
+    function getHasInitedValue(address staker, uint256 epoch) public view returns (bool) {
+        return hasInited[epoch][staker];
+    }
 }

contractsSol5/Dao/mock/MockStakingContract.sol

@@ -11,6 +11,10 @@ contract MockStakingContract is KyberStaking {
         address _admin
     ) public KyberStaking(_kncToken, _epochPeriod, _startBlock, _admin) {}
 
+    function setDAOAddressWithoutCheck(address dao) public {
+        daoContract = IKyberDAO(dao);
+    }
+
     function getHasInitedValue(address staker, uint256 epoch) public view returns (bool) {
         return hasInited[epoch][staker];
     }
@@ -30,8 +34,4 @@ contract MockStakingContract is KyberStaking {
     {
         return stakerPerEpochData[epoch][staker].delegatedAddress;
     }
-
-    function setDAOAddressWithoutCheck(address dao) public {
-        daoContract = IKyberDAO(dao);
-    }
 }

contractsSol5/IKyberNetwork.sol

@@ -4,8 +4,7 @@ import "./IERC20.sol";
 
 
 interface IKyberNetwork {
-
-        event KyberTrade(
+    event KyberTrade(
         address indexed trader,
         IERC20 indexed src,
         IERC20 indexed dest,

contractsSol5/IKyberNetworkProxy.sol

@@ -27,6 +27,18 @@ interface IKyberNetworkProxy {
         bytes calldata hint
     ) external payable returns (uint256);
 
+    function tradeWithHintAndFee(
+        IERC20 src,
+        uint256 srcAmount,
+        IERC20 dest,
+        address payable destAddress,
+        uint256 maxDestAmount,
+        uint256 minConversionRate,
+        address payable platformWallet,
+        uint256 platformFeeBps,
+        bytes calldata hint
+    ) external payable returns (uint256 destAmount);
+
     function trade(
         IERC20 src,
         uint256 srcAmount,
@@ -58,16 +70,4 @@ interface IKyberNetworkProxy {
         uint256 srcQty,
         bytes calldata hint
     ) external view returns (uint256 priceNoFee);
-
-    function tradeWithHintAndFee(
-        IERC20 src,
-        uint256 srcAmount,
-        IERC20 dest,
-        address payable destAddress,
-        uint256 maxDestAmount,
-        uint256 minConversionRate,
-        address payable platformWallet,
-        uint256 platformFeeBps,
-        bytes calldata hint
-    ) external payable returns (uint256 destAmount);
 }

contractsSol5/KyberHintHandler.sol

@@ -14,7 +14,7 @@ import "./IKyberHint.sol";
  *           - Will revert with error message if an error is found
  *           - parse*Hint() returns both reserveIds and reserveAddresses
  *       Internal functions unpackT2THint() and parseHint():
- *           - Are part of ger rate && trade flow
+ *           - Are part of get rate && trade flow
  *           - Don't revert if an error is found
  *           - If an error is found, return no data such that the trade flow
  *             returns 0 rate for bad hint values
@@ -200,7 +200,7 @@ contract KyberHintHandler is IKyberHint, Utils4 {
             HintErrors valid
         )
     {
-        (tradeType, reserveIds, splits) = abi.decode(hint, (TradeType, bytes32[], uint256[]));
+        (tradeType, reserveIds, splits) = abi.decode(hint, (TradeType, bytes32[], uint256[])); // solhint-disable
         valid = verifyData(tradeType, reserveIds, splits);
 
         if (valid != HintErrors.NoError) {

contractsSol5/mock/GenerousKyberNetwork.sol

@@ -75,7 +75,8 @@ contract GenerousKyberNetwork is KyberNetwork {
         if (tData.input.srcAmount == 1313) {
             //signal for "reverse trade" for source token
             emit GenerousTrade(1313, 1755, tData.input.src);
-            // since 1313 src token is transfered to proxy, we must transfer a bigger number to trader to break the check of src Amount
+            // since 1313 src token is transfered to proxy, we must transfer a bigger number to
+            // trader to break the check of src Amount
             tData.input.src.safeTransfer(tData.input.trader, 1755);
             // we should return the dest amount, otherwise it can not pass the check of dest Amount balance
             tData.input.dest.safeTransfer(tData.input.destAddress, destAmount);

contractsSol5/mock/MockReserve.sol

@@ -31,9 +31,11 @@ contract MockReserve is IKyberReserve, Utils4 {
         bool validate
     ) public payable returns (bool) {
         validate;
-        if (srcToken == ETH_TOKEN_ADDRESS)
+        if (srcToken == ETH_TOKEN_ADDRESS) {
             require(msg.value == srcAmount, "ETH sent != srcAmount");
-        else require(msg.value == 0, "ETH was sent for token -> ETH trade");
+        } else {
+            require(msg.value == 0, "ETH was sent for token -> ETH trade");
+        }
 
         uint256 srcDecimals = getDecimals(srcToken);
         uint256 destDecimals = getDecimals(destToken);

contractsSol5/utils/Utils4.sol

@@ -37,16 +37,22 @@ contract Utils4 {
     function setDecimals(IERC20 token) internal {
         if (decimals[address(token)] != 0) return; //already set
 
-        if (token == ETH_TOKEN_ADDRESS) decimals[address(token)] = ETH_DECIMALS;
-        else decimals[address(token)] = token.decimals();
+        if (token == ETH_TOKEN_ADDRESS) {
+            decimals[address(token)] = ETH_DECIMALS;
+        } else {
+            decimals[address(token)] = token.decimals();
+        }
     }
 
     /// @dev get the balance of a user.
     /// @param token The token type
     /// @return The balance
     function getBalance(IERC20 token, address user) internal view returns (uint256) {
-        if (token == ETH_TOKEN_ADDRESS) return user.balance;
-        else return token.balanceOf(user);
+        if (token == ETH_TOKEN_ADDRESS) {
+            return user.balance;
+        } else {
+            return token.balanceOf(user);
+        }
     }
 
     function getDecimals(IERC20 token) internal view returns (uint256) {

coverage.sh

@@ -10,7 +10,7 @@ npx buidler compile --config ./buidlerCoverageSol4.js
 
 if [ -n "$FILE" ]
 then
-    npx buidler coverage --config ./buidlerConfigSol5.js --testfiles $FILE
+    npx buidler coverage --config ./buidlerConfigSol5.js --testfiles $FILE --solcoverjs ".solcover.js" --temp ""
 else
     npx buidler coverage --config ./buidlerConfigSol5.js --testfiles "" --solcoverjs ".solcover.js" --temp ""
 fi