[Protocol3] replace tslint with eslint and fix some solium issues (#279)

dong77 · web-flow · commit cbbc725edaed · 2019-07-19T15:19:08.000+08:00
diff --git a/packages/loopring_v3/.eslintrc.js b/packages/loopring_v3/.eslintrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: ["plugin:prettier/recommended"]
+};
diff --git a/packages/loopring_v3/.gitignore b/packages/loopring_v3/.gitignore
@@ -4,6 +4,7 @@ transpiled/
 ethsnarks/
 keys/
 blocks/
+package-lock.json
 .DS_Store
 .node-*
 *.log
@@ -14,4 +15,4 @@ __pycache__
 *.pyc
 .idea/
 genkeys/
-EDDSA_KeyPair.json
+EDDSA_KeyPair.json
diff --git a/packages/loopring_v3/.soliumignore b/packages/loopring_v3/.soliumignore
@@ -2,3 +2,4 @@ node_modules
 contracts/Migrations.sol
 contracts/thirdparty/MiMC.sol
 contracts/thirdparty/MerkleTree.sol
+contracts/thirdparty/Proxy.sol
diff --git a/packages/loopring_v3/contracts/iface/IExchange.sol b/packages/loopring_v3/contracts/iface/IExchange.sol
@@ -1057,7 +1057,11 @@ contract IExchange
     function getProtocolFeeValues()
         external
         view
-        returns (uint32 timestamp,
-                 uint8 takerFeeBips, uint8 makerFeeBips,
-                 uint8 previousTakerFeeBips, uint8 previousMakerFeeBips);
+        returns (
+            uint32 timestamp,
+            uint8 takerFeeBips,
+            uint8 makerFeeBips,
+            uint8 previousTakerFeeBips,
+            uint8 previousMakerFeeBips
+        );
 }
diff --git a/packages/loopring_v3/contracts/iface/IProtocolFeeVault.sol b/packages/loopring_v3/contracts/iface/IProtocolFeeVault.sol
@@ -106,8 +106,7 @@ contract IProtocolFeeVault
         address token,
         uint    amount
         )
-        external
-        ;
+        external;
 
     /// @dev Sell a non-LRC token or Ether to LRC, only callable by the owner.
     /// @param token The token or ether (0x0) to sell.
diff --git a/packages/loopring_v3/contracts/iface/IUserStakingPool.sol b/packages/loopring_v3/contracts/iface/IUserStakingPool.sol
@@ -40,8 +40,7 @@ contract IUserStakingPool
     /// @dev Set a new IProtocolFeeVault address, only callable by the owner.
     /// @param _protocolFeeVaultAddress The new IProtocolFeeVault address.
     function setProtocolFeeVault(address _protocolFeeVaultAddress)
-        external
-        ;
+        external;
 
     /// @dev Return the total number of LRC staked.
     function getTotalStaking()
@@ -56,8 +55,8 @@ contract IUserStakingPool
     /// @return stakeAmount The amount of LRC staked.
     /// @return claimableReward The amount of LRC reward waiting to be claimed.
     function getUserStaking(address user)
-        view
         external
+        view
         returns (
             uint withdrawalWaitTime,
             uint rewardWaitTime,
diff --git a/packages/loopring_v3/contracts/impl/ProtocolFeeVault.sol b/packages/loopring_v3/contracts/impl/ProtocolFeeVault.sol
@@ -18,7 +18,8 @@ pragma solidity 0.5.7;
 
 import "../iface/IProtocolFeeVault.sol";
 
-import "..//lib/Claimable.sol";
+import "../lib/AddressUtil.sol";
+import "../lib/Claimable.sol";
 import "../lib/BurnableERC20.sol";
 import "../lib/ERC20.sol";
 import "../lib/ERC20SafeTransfer.sol";
@@ -71,6 +72,8 @@ contract IAuction {
 contract ProtocolFeeVault is IProtocolFeeVault, Claimable
 {
     uint public constant MIN_ETHER_TO_KEEP = 1 ether;
+    using AddressUtil       for address;
+    using AddressUtil       for address payable;
     using ERC20SafeTransfer for address;
     using MathUint          for uint;
 
@@ -168,8 +171,7 @@ contract ProtocolFeeVault is IProtocolFeeVault, Claimable
         require(token != lrcAddress, "INVALD_TOKEN");
 
         if (token == address(0)) {
-            address payable recipient = address(uint160(owner));
-            require(recipient.send(amount), "TRANSFER_FAILURE");
+            owner.transferETH(amount, gasleft());
         } else {
             require(token.safeTransfer(owner, amount), "TRANSFER_FAILURE");
         }
@@ -244,9 +246,7 @@ contract ProtocolFeeVault is IProtocolFeeVault, Claimable
         );
 
         if (tokenS == address(0)) {
-            bool success;
-            (success, ) = auctionAddr.call.value(amountS)("");
-            require(success, "TRANSFER_FAILURE");
+            auctionAddr.transferETH(amountS, gasleft());
         } else {
             require(ERC20(tokenS).approve(auctionAddr, amountS), "AUTH_FAILED");
             IAuction(auctionAddr).ask(amountS);
diff --git a/packages/loopring_v3/contracts/impl/UserStakingPool.sol b/packages/loopring_v3/contracts/impl/UserStakingPool.sol
@@ -64,16 +64,16 @@ contract UserStakingPool is IUserStakingPool, Claimable
     }
 
     function getTotalStaking()
-        view
         external
+        view
         returns (uint)
     {
         return total.stake;
     }
 
     function getUserStaking(address user)
-        view
         external
+        view
         returns (
             uint withdrawalWaitTime,
             uint rewardWaitTime,
@@ -139,11 +139,11 @@ contract UserStakingPool is IUserStakingPool, Claimable
 
     function withdraw(uint amount)
         external
-    { 
-        require(userWithdrawalWaitTime(msg.sender) == 0);
+    {
+        require(userWithdrawalWaitTime(msg.sender) == 0, "NEED_TO_WAIT");
 
         Stake storage user = users[msg.sender];
-        require(user.stake >= amount);
+        require(user.stake >= amount, "INSUFFICIENT_FUND");
 
         uint _amount = amount == 0 ? user.stake : amount;
 
@@ -167,7 +167,7 @@ contract UserStakingPool is IUserStakingPool, Claimable
         external
         returns (uint claimedAmount)
     {
-        require(userClaimWaitTime(msg.sender) == 0);
+        require(userClaimWaitTime(msg.sender) == 0, "NEED_TO_WAIT");
 
         uint totalPoints;
         uint userPoints;
@@ -191,26 +191,26 @@ contract UserStakingPool is IUserStakingPool, Claimable
     // -- Private Function --
 
     function userWithdrawalWaitTime(address user)
-        view
         private
+        view
         returns (uint _seconds)
     {
         if (users[user].depositedAt.add(MIN_WITHDRAW_DELAY) <= now) return 0;
         else return users[user].depositedAt.add(MIN_WITHDRAW_DELAY).sub(now);
     }
 
     function userClaimWaitTime(address user)
-        view
         private
+        view
         returns (uint minutes_)
     {
-       if (users[user].claimedAt.add(MIN_CLAIM_DELAY) <= now) return 0;
-       else return users[user].claimedAt.add(MIN_CLAIM_DELAY).sub(now);
+        if (users[user].claimedAt.add(MIN_CLAIM_DELAY) <= now) return 0;
+        else return users[user].claimedAt.add(MIN_CLAIM_DELAY).sub(now);
     }
 
     function userOutstandingReward(address userAddress)
-        view
         private
+        view
         returns (
             uint userPoints,
             uint totalPoints,
diff --git a/packages/loopring_v3/contracts/impl/libexchange/ExchangeBlocks.sol b/packages/loopring_v3/contracts/impl/libexchange/ExchangeBlocks.sol
@@ -346,13 +346,10 @@ library ExchangeBlocks
                 require(inputEndingHash == endingHash, "INVALID_ENDING_HASH");
                 numWithdrawalRequestsCommitted += uint32(count);
             }
-        } else if (blockType == ExchangeData.BlockType.OFFCHAIN_WITHDRAWAL) {
-            // Do nothing
-        } else if (blockType == ExchangeData.BlockType.ORDER_CANCELLATION) {
-            // Do nothing
-        } else if (blockType == ExchangeData.BlockType.TRANSFER) {
-            // Do nothing
-        } else {
+        } else if (
+            blockType != ExchangeData.BlockType.OFFCHAIN_WITHDRAWAL &&
+            blockType != ExchangeData.BlockType.ORDER_CANCELLATION &&
+            blockType != ExchangeData.BlockType.TRANSFER) {
             revert("UNSUPPORTED_BLOCK_TYPE");
         }
 
@@ -429,7 +426,7 @@ library ExchangeBlocks
         }
         // The given fee values are valid if they are the current or previous protocol fee values
         return (takerFeeBips == data.takerFeeBips && makerFeeBips == data.makerFeeBips) ||
-               (takerFeeBips == data.previousTakerFeeBips && makerFeeBips == data.previousMakerFeeBips);
+            (takerFeeBips == data.previousTakerFeeBips && makerFeeBips == data.previousMakerFeeBips);
     }
 
     function isDepositRequestForced(
diff --git a/packages/loopring_v3/contracts/impl/libexchange/ExchangeWithdrawals.sol b/packages/loopring_v3/contracts/impl/libexchange/ExchangeWithdrawals.sol
@@ -333,27 +333,27 @@ library ExchangeWithdrawals
         uint feeAmount = 0;
         uint32 lastRequestTimestamp = 0;
         {
-            uint startIndex = previousBlock.numDepositRequestsCommitted;
-            uint endIndex = requestedBlock.numDepositRequestsCommitted;
+        uint startIndex = previousBlock.numDepositRequestsCommitted;
+        uint endIndex = requestedBlock.numDepositRequestsCommitted;
+        if(endIndex > startIndex) {
+            feeAmount = S.depositChain[endIndex - 1].accumulatedFee.sub(
+                S.depositChain[startIndex - 1].accumulatedFee
+            );
+            lastRequestTimestamp = S.depositChain[endIndex - 1].timestamp;
+        } else {
+            startIndex = previousBlock.numWithdrawalRequestsCommitted;
+            endIndex = requestedBlock.numWithdrawalRequestsCommitted;
+
             if(endIndex > startIndex) {
-                feeAmount = S.depositChain[endIndex - 1].accumulatedFee.sub(
-                    S.depositChain[startIndex - 1].accumulatedFee
+                feeAmount = S.withdrawalChain[endIndex - 1].accumulatedFee.sub(
+                    S.withdrawalChain[startIndex - 1].accumulatedFee
                 );
-                lastRequestTimestamp = S.depositChain[endIndex - 1].timestamp;
+                lastRequestTimestamp = S.withdrawalChain[endIndex - 1].timestamp;
             } else {
-                startIndex = previousBlock.numWithdrawalRequestsCommitted;
-                endIndex = requestedBlock.numWithdrawalRequestsCommitted;
-
-                if(endIndex > startIndex) {
-                    feeAmount = S.withdrawalChain[endIndex - 1].accumulatedFee.sub(
-                        S.withdrawalChain[startIndex - 1].accumulatedFee
-                    );
-                    lastRequestTimestamp = S.withdrawalChain[endIndex - 1].timestamp;
-                } else {
-                    revert("BLOCK_HAS_NO_OPERATOR_FEE");
-                }
+                revert("BLOCK_HAS_NO_OPERATOR_FEE");
             }
         }
+        }
 
         // Calculate how much of the fee the operator gets for the block
         // If there are many requests than lastRequestTimestamp ~= firstRequestTimestamp so
@@ -393,8 +393,12 @@ library ExchangeWithdrawals
         ExchangeData.Block storage withdrawBlock = S.blocks[blockIdx];
 
         // Check if this is a withdrawal block
-        require(withdrawBlock.blockType == ExchangeData.BlockType.ONCHAIN_WITHDRAWAL ||
-                withdrawBlock.blockType == ExchangeData.BlockType.OFFCHAIN_WITHDRAWAL, "INVALID_BLOCK_TYPE");
+        require(
+            withdrawBlock.blockType == ExchangeData.BlockType.ONCHAIN_WITHDRAWAL ||
+            withdrawBlock.blockType == ExchangeData.BlockType.OFFCHAIN_WITHDRAWAL,
+            "INVALID_BLOCK_TYPE"
+        );
+
         // Only allow withdrawing on finalized blocks
         require(blockIdx < S.numBlocksFinalized, "BLOCK_NOT_FINALIZED");
         // Check if the withdrawals were already completely distributed
diff --git a/packages/loopring_v3/contracts/lib/AddressUtil.sol b/packages/loopring_v3/contracts/lib/AddressUtil.sol
@@ -47,6 +47,7 @@ library AddressUtil
     }
 
     // Works like address.send but with a customizable gas limit
+    // Make sure your code is safe for reentrancy when using this function!
     function sendETH(
         address to,
         uint    amount,
@@ -59,10 +60,12 @@ library AddressUtil
             return true;
         }
         address payable recipient = to.toPayable();
+        /* solium-disable-next-line */
         (success, ) = recipient.call.value(amount).gas(gasLimit)("");
     }
 
     // Works like address.transfer but with a customizable gas limit
+    // Make sure your code is safe for reentrancy when using this function!
     function transferETH(
         address to,
         uint    amount,
diff --git a/packages/loopring_v3/contracts/lib/RoleBasedOperators.sol b/packages/loopring_v3/contracts/lib/RoleBasedOperators.sol
@@ -20,7 +20,7 @@ pragma solidity 0.5.7;
 /// @title RoleBasedOperators
 /// @dev A Role-based operator manager.
 /// @author Daniel Wang - <daniel@loopring.org>
-contract RoleBasedOperators 
+contract RoleBasedOperators
 {
     struct Operator {
         uint256 id;
@@ -142,7 +142,7 @@ contract RoleBasedOperators
 
         if (operator.id != 0) {
             uint256 num = operatorAddresses.length;
-            if (operator.id !=  num) {
+            if (operator.id != num) {
                 address lastOperator = operatorAddresses[num - 1];
                 operatorAddresses[operator.id - 1] = lastOperator;
                 operatorMap[lastOperator].id = operator.id;
diff --git a/packages/loopring_v3/package.json b/packages/loopring_v3/package.json
@@ -19,6 +19,11 @@
       "delay": 10000
     }
   },
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged"
+    }
+  },
   "scripts": {
     "watch": "npm-watch compile",
     "transpile": "rm -rf ./transpiled; copyfiles ./build/**/* ./transpiled && tsc",
@@ -42,18 +47,26 @@
     "@types/lodash": "^4.14.123",
     "@types/node": "9.3.0",
     "@types/request-promise-native": "^1.0.15",
+    "@typescript-eslint/eslint-plugin": "^1.12.0",
+    "@typescript-eslint/parser": "^1.12.0",
     "ajv": "^6.10.0",
     "chai": "^4.2.0",
     "copyfiles": "^2.1.0",
     "dirty-chai": "^2.0.1",
+    "eslint": "^6.0.1",
+    "eslint-config-google": "^0.13.0",
+    "eslint-config-prettier": "^6.0.0",
+    "eslint-plugin-prettier": "^3.1.0",
     "ganache-cli": "6.4.3",
+    "husky": "^3.0.0",
     "mocha": "^5.2.0",
     "node": "^10.15.3",
     "npm": "^6.9.2",
     "npm-watch": "^0.6.0",
+    "prettier": "^1.18.2",
+    "pretty-quick": "^1.11.1",
     "solidity-coverage": "^0.5.11",
-    "solium": "^1.2.4",
-    "tslint": "^5.11.0",
+    "ethlint": "^1.2.4",
     "types-bn": "0.0.1",
     "typescript": "3.1.6",
     "web3-typescript-typings": "0.10.2",
@@ -65,6 +78,7 @@
     "bignumber.js": "^4.1.0",
     "bitwise-xor": "0.0.0",
     "blake-hash": "^1.1.0",
+    "blake2b": "^2.1.3",
     "bluebird": "^3.5.1",
     "bn.js": "^4.11.8",
     "braces": "^2.3.2",
diff --git a/packages/loopring_v3/tslint.json b/packages/loopring_v3/tslint.json

Original file line number	Diff line number	Diff line change
`@@ -106,8 +106,7 @@ contract IProtocolFeeVault`
`106`	`106`	`address token,`
`107`	`107`	`uint amount`
`108`	`108`	`)`
`109`		`- external`
`110`		`- ;`
	`109`	`+ external;`
`111`	`110`
`112`	`111`	`/// @dev Sell a non-LRC token or Ether to LRC, only callable by the owner.`
`113`	`112`	`/// @param token The token or ether (0x0) to sell.`
Original file line number	Diff line number	Diff line change
`@@ -346,13 +346,10 @@ library ExchangeBlocks`
`346`	`346`	`require(inputEndingHash == endingHash, "INVALID_ENDING_HASH");`
`347`	`347`	`numWithdrawalRequestsCommitted += uint32(count);`
`348`	`348`	`}`
`349`		`- } else if (blockType == ExchangeData.BlockType.OFFCHAIN_WITHDRAWAL) {`
`350`		`- // Do nothing`
`351`		`- } else if (blockType == ExchangeData.BlockType.ORDER_CANCELLATION) {`
`352`		`- // Do nothing`
`353`		`- } else if (blockType == ExchangeData.BlockType.TRANSFER) {`
`354`		`- // Do nothing`
`355`		`- } else {`
	`349`	`+ } else if (`
	`350`	`+ blockType != ExchangeData.BlockType.OFFCHAIN_WITHDRAWAL &&`
	`351`	`+ blockType != ExchangeData.BlockType.ORDER_CANCELLATION &&`
	`352`	`+ blockType != ExchangeData.BlockType.TRANSFER) {`
`356`	`353`	`revert("UNSUPPORTED_BLOCK_TYPE");`
`357`	`354`	`}`
`358`	`355`
`@@ -429,7 +426,7 @@ library ExchangeBlocks`
`429`	`426`	`}`
`430`	`427`	`// The given fee values are valid if they are the current or previous protocol fee values`
`431`	`428`	`return (takerFeeBips == data.takerFeeBips && makerFeeBips == data.makerFeeBips) \|\|`
`432`		`- (takerFeeBips == data.previousTakerFeeBips && makerFeeBips == data.previousMakerFeeBips);`
	`429`	`+ (takerFeeBips == data.previousTakerFeeBips && makerFeeBips == data.previousMakerFeeBips);`
`433`	`430`	`}`
`434`	`431`
`435`	`432`	`function isDepositRequestForced(`