Merge pull request #14 from chimera-defi/ci

chore(ci): cleanup build and run process + add CI

.github/workflows/node.js.yml

@@ -0,0 +1,32 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm install -g yarn
+    - run: yarn install
+    - run: yarn sol
+    - run: yarn test

.prettierrc.yaml

@@ -5,9 +5,9 @@ printWidth: 120
 singleQuote: false
 tabWidth: 2
 trailingComma: all
-
+plugins: ["prettier-plugin-solidity"]
 overrides:
-  - files: "contracts/*.sol"
+  - files: "contracts/**/*.sol"
     options:
       tabWidth: 4
-      explicitTypes: 'always'
+      parser: "solidity-parse"

.solhint.json

@@ -16,11 +16,11 @@
     "constructor-syntax": "error",
     "func-visibility": ["error", {"ignoreConstructors": true}],
     "max-line-length": ["error", 200],
-    "not-rely-on-time": "off",
+    "not-rely-on-time": "warn",
     "avoid-suicide": "error",
     "avoid-sha3": "warn",
     "prettier/prettier": [
-      "error",
+      "warm",
       {
         "endOfLine": "auto"
       }

.solhintignore

@@ -16,3 +16,8 @@ deploy_log.json
 
 contracts/governance/SimpleVesting.sol
 contracts/util/SingleTokenVestingNonRevocable.sol
+contracts/v2/periphery/*.sol
+./**/*.js
+test/**/*
+./**/*.md
+./**/*.json

README.md

@@ -21,13 +21,14 @@ See deploy_log.md for new deployed contract addresses
 ```
 yarn install
 yarn sol
+yarn test
 ```
 
 - Deployments and hardhat
   Run anvil for local host deploy
 
 ```
-anvil --fork-url https://mainnet.sharedtools.org/apecoinrpc
+anvil --fork-url https://rpc.sharedtools.org/rpc
  npx hardhat run --network ...
 ```
 

arguments.js

@@ -1,5 +1 @@
-module.exports = [
-    1000000,
-    32,
-    true
-]
+module.exports = [1000000, 32, true];

contracts/governance/FundDistributor.sol

@@ -10,53 +10,53 @@ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 contract FundDistributor is Ownable, Initializable {
-  using SafeMath for uint256;
-  using SafeERC20 for IERC20;
+    using SafeMath for uint256;
+    using SafeERC20 for IERC20;
 
-  IERC20 public reward;
-  uint256 public missingDecimals;
+    IERC20 public reward;
+    uint256 public missingDecimals;
 
-  // CONTRACTS
-  mapping(address => bool) public requesters;
+    // CONTRACTS
+    mapping(address => bool) public requesters;
 
-  /* ========== EVENTS ========================= */
+    /* ========== EVENTS ========================= */
 
-  event RequesterAdded(address indexed requester);
-  event RequesterRemoved(address indexed requester);
-  event FundRequested(uint256 indexed amount);
+    event RequesterAdded(address indexed requester);
+    event RequesterRemoved(address indexed requester);
+    event FundRequested(uint256 indexed amount);
 
-  /* ========== MODIFIER ========== */
+    /* ========== MODIFIER ========== */
 
-  modifier onlyRequester() {
-    require(requesters[_msgSender()], "FD:NA");
-    _;
-  }
+    modifier onlyRequester() {
+        require(requesters[_msgSender()], "FD:NA");
+        _;
+    }
 
-  function initialize(address _reward) external initializer {
-    reward = IERC20(_reward);
-    missingDecimals = 18 - ERC20(_reward).decimals();
-  }
+    function initialize(address _reward) external initializer {
+        reward = IERC20(_reward);
+        missingDecimals = 18 - ERC20(_reward).decimals();
+    }
 
-  /* ========== MUTATIVE ====================== */
+    /* ========== MUTATIVE ====================== */
 
-  function distributeTo(address _receiver, uint256 _amount) external onlyRequester {
-    require(_receiver != address(0), "FD:0AD");
-    if (_amount > 0) {
-      IERC20(reward).safeTransfer(_receiver, _amount.div(10 ** missingDecimals));
+    function distributeTo(address _receiver, uint256 _amount) external onlyRequester {
+        require(_receiver != address(0), "FD:0AD");
+        if (_amount > 0) {
+            IERC20(reward).safeTransfer(_receiver, _amount.div(10 ** missingDecimals));
+        }
     }
-  }
 
-  /* ========== RESTRICTED FUNCTIONS ========== */
+    /* ========== RESTRICTED FUNCTIONS ========== */
 
-  function addRequester(address _requester) external onlyOwner {
-    require(!requesters[_requester], "FD:AE");
-    requesters[_requester] = true;
-    emit RequesterAdded(_requester);
-  }
+    function addRequester(address _requester) external onlyOwner {
+        require(!requesters[_requester], "FD:AE");
+        requesters[_requester] = true;
+        emit RequesterAdded(_requester);
+    }
 
-  function removeRequester(address _requester) external onlyOwner {
-    require(requesters[_requester], "FD:NA");
-    delete requesters[_requester];
-    emit RequesterRemoved(_requester);
-  }
+    function removeRequester(address _requester) external onlyOwner {
+        require(requesters[_requester], "FD:NA");
+        delete requesters[_requester];
+        emit RequesterRemoved(_requester);
+    }
 }