Merge pull request #5 from 0xJurassicPunk/config-changes

chore: Config changes

.eslintrc

@@ -0,0 +1,17 @@
+{
+  "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"] }]
+  }
+}

.gitignore

@@ -4,11 +4,12 @@ node_modules
 coverage
 coverage.json
 typechain
+.DS_Store
 
 # Hardhat files
 cache
 artifacts
 abis/
 
 # Others 
-lib
+lib

.npmignore

@@ -1,5 +1,19 @@
-hardhat.config.ts
-scripts
-test
+node_modules
+.env
+.env*
+coverage
+coverage.json
+typechain
+
+# Hardhat files
 cache
-.env*
+artifacts
+abis/
+
+# Others 
+lib
+.DS_Store
+
+hardhat.config.ts
+contracts/test
+test/

.prettierrc

@@ -1 +1,3 @@
-{}
+{
+  "printWidth": 120
+}

.solcover.js

@@ -0,0 +1,11 @@
+module.exports = {
+  silent: true,
+  measureStatementCoverage: true,
+  measureFunctionCoverage: true,
+  skipFiles: [
+    "interfaces",
+    "test",
+    "tokenStaking/OperatorControllerForRewards.sol",
+  ],
+  configureYulOptimizer: true,
+};

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 LooksRare
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -2,15 +2,15 @@
 
 This project contains all smart contracts used for staking and other token economics (excluding the airdrop contract).
 
-It is a hybrid Hardhat repo that also requires Forge to run Solidity tests powered by the ds-test library.
+It is a hybrid Hardhat repo that also requires Forge to run Solidity tests powered by the [ds-test library](https://github.com/dapphub/ds-test/).
 
-To install Forge, please follow the instructions [here](https://onbjerg.github.io/foundry-book/getting-started/installation.html#using-foundryup)
+To install Forge, please follow the instructions [here](https://onbjerg.github.io/foundry-book/getting-started/installation.html#using-foundryup).
 
 ## Tests
 
-TypeScript tests are included in the test folder at the root of this repo.
+TypeScript tests are included in the `test` folder at the root of this repo.
 
-Solidity tests are included in the test folder in the contracts folder.
+Solidity tests are included in the `test` folder in the `contracts` folder.
 
 ## Example of Forge commands