AA-30: Add eslint task to the repository (eth-infinitism#97)

Co-authored-by: Dror Tirosh <dror@opengsn.org>

Author: forshtat

.eslintrc.js

@@ -0,0 +1,78 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    jest: true,
+    mocha: true,
+    node: true
+  },
+  globals: {
+    artifacts: false,
+    assert: false,
+    contract: false,
+    web3: false
+  },
+  extends:
+    [
+      'standard-with-typescript'
+    ],
+  // This is needed to add configuration to rules with type information
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: ['./tsconfig.json']
+  },
+  ignorePatterns: [
+    '.eslintrc.js',
+    '**/types/truffle-contracts',
+    'dist/'
+  ],
+  rules: {
+    'no-console': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/return-await': 'off',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+    '@typescript-eslint/require-array-sort-compare': ['error',
+      {
+        ignoreStringArrays: true
+      }
+    ]
+  },
+  overrides: [
+    {
+      files: '*',
+      rules: {
+        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/restrict-template-expressions': 'off'
+      }
+    },
+    {
+      files: [
+        '**/test/**/*.ts'
+      ],
+      rules: {
+        'no-unused-expressions': 'off',
+        // chai assertions trigger this rule
+        '@typescript-eslint/no-unused-expressions': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off'
+      }
+    },
+    {
+      // otherwise it will raise an error in every JavaScript file
+      files: ['*.ts'],
+      rules: {
+        '@typescript-eslint/prefer-ts-expect-error': 'off',
+        // allow using '${val}' with numbers, bool and null types
+        '@typescript-eslint/restrict-template-expressions': [
+          'error',
+          {
+            allowNumber: true,
+            allowBoolean: true,
+            allowNullish: true,
+            allowNullable: true
+          }
+        ]
+      }
+    }
+  ]
+}

.github/workflows/build.yml

@@ -29,6 +29,20 @@ jobs:
 
       - run: yarn run ci
 
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14'
+      - uses: actions/checkout@v1
+      - uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-${{ hashFiles('yarn.lock') }}
+      - run: yarn install
+      - run: yarn lint
+
   coverage:
     runs-on: ubuntu-latest
     steps:

.solhint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+  "compiler-version": ["error",">=0.7.5"],
+    "func-visibility": ["off",{"ignoreConstructors":true}],
+    "mark-callable-contracts": ["off"]
+  }
+}

contracts/BasePaymaster.sol

@@ -1,5 +1,9 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.12;
+
+
+/* solhint-disable reason-string */
+
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "./IPaymaster.sol";
 import "./EntryPoint.sol";

contracts/BaseWallet.sol

@@ -1,6 +1,10 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.12;
 
+/* solhint-disable avoid-low-level-calls */
+/* solhint-disable no-inline-assembly */
+/* solhint-disable reason-string */
+
 import "./IWallet.sol";
 import "./EntryPoint.sol";
 

contracts/EntryPoint.sol

@@ -5,6 +5,10 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.12;
 
+/* solhint-disable avoid-low-level-calls */
+/* solhint-disable no-inline-assembly */
+/* solhint-disable reason-string */
+
 import "./StakeManager.sol";
 import "./UserOperation.sol";
 import "./IWallet.sol";
@@ -251,6 +255,7 @@ contract EntryPoint is StakeManager {
             uint256 bal = balanceOf(sender);
             missingWalletFunds = bal > requiredPrefund ? 0 : requiredPrefund - bal;
         }
+        // solhint-disable-next-line no-empty-blocks
         try IWallet(sender).validateUserOp{gas : op.verificationGas}(op, requestId, missingWalletFunds) {
         } catch Error(string memory revertReason) {
             revert FailedOp(opIndex, address(0), revertReason);
@@ -363,6 +368,7 @@ contract EntryPoint is StakeManager {
                 if (mode != IPaymaster.PostOpMode.postOpReverted) {
                     IPaymaster(paymaster).postOp{gas : op.verificationGas}(mode, context, actualGasCost);
                 } else {
+                    // solhint-disable-next-line no-empty-blocks
                     try IPaymaster(paymaster).postOp{gas : op.verificationGas}(mode, context, actualGasCost) {}
                     catch Error(string memory reason) {
                         revert FailedOp(opIndex, paymaster, reason);

contracts/StakeManager.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity ^0.8.12;
 
+/* solhint-disable avoid-low-level-calls */
+/* solhint-disable not-rely-on-time */
 /**
  * manage deposits and stakes.
  * deposit is just a balance used to pay for UserOperations (either by a paymaster or a wallet)
@@ -92,7 +94,7 @@ abstract contract StakeManager {
     function internalIncrementDeposit(address account, uint256 amount) internal {
         DepositInfo storage info = deposits[account];
         uint256 newAmount = info.deposit + amount;
-        require(newAmount <= type(uint112).max, 'deposit overflow');
+        require(newAmount <= type(uint112).max, "deposit overflow");
         info.deposit = uint112(newAmount);
     }
 

contracts/UserOperation.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.12;
 
+/* solhint-disable no-inline-assembly */
+
     /**
      * User Operation struct
      * @param sender the sender account of this request

contracts/samples/DepositPaymaster.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.12;
 
+/* solhint-disable reason-string */
+
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
@@ -28,9 +30,9 @@ contract DepositPaymaster is BasePaymaster {
     using SafeERC20 for IERC20;
 
     //calculated cost of the postOp
-    uint256 constant COST_OF_POST = 35000;
+    uint256 constant public COST_OF_POST = 35000;
 
-    IOracle private constant nullOracle = IOracle(address(0));
+    IOracle private constant NULL_ORACLE = IOracle(address(0));
     mapping(IERC20 => IOracle) public oracles;
     mapping(IERC20 => mapping(address => uint256)) public balances;
     mapping(address => uint256) public unlockBlock;
@@ -44,7 +46,7 @@ contract DepositPaymaster is BasePaymaster {
      * owner of the paymaster should add supported tokens
      */
     function addToken(IERC20 token, IOracle tokenPriceOracle) external onlyOwner {
-        require(oracles[token] == nullOracle);
+        require(oracles[token] == NULL_ORACLE);
         oracles[token] = tokenPriceOracle;
     }
 
@@ -61,7 +63,7 @@ contract DepositPaymaster is BasePaymaster {
     function addDepositFor(IERC20 token, address account, uint256 amount) external {
         //(sender must have approval for the paymaster)
         token.safeTransferFrom(msg.sender, address(this), amount);
-        require(oracles[token] != nullOracle, "unsupported token");
+        require(oracles[token] != NULL_ORACLE, "unsupported token");
         balances[token][account] += amount;
         if (msg.sender == account) {
             lockTokenDeposit();
@@ -110,7 +112,7 @@ contract DepositPaymaster is BasePaymaster {
      */
     function getTokenValueOfEth(IERC20 token, uint256 ethBought) internal view virtual returns (uint256 requiredTokens) {
         IOracle oracle = oracles[token];
-        require(oracle != nullOracle, "DepositPaymaster: unsupported token");
+        require(oracle != NULL_ORACLE, "DepositPaymaster: unsupported token");
         return oracle.getTokenValueOfEth(ethBought);
     }
 

contracts/samples/SimpleWallet.sol

@@ -1,6 +1,10 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity ^0.8.12;
 
+/* solhint-disable avoid-low-level-calls */
+/* solhint-disable no-inline-assembly */
+/* solhint-disable reason-string */
+
 import "../BaseWallet.sol";
 import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 
@@ -30,6 +34,7 @@ contract SimpleWallet is BaseWallet {
 
     event EntryPointChanged(address indexed oldEntryPoint, address indexed newEntryPoint);
 
+    // solhint-disable-next-line no-empty-blocks
     receive() external payable {}
 
     constructor(EntryPoint anEntryPoint, address anOwner) {