Config (sushiswap#23)

* MirinMath: Cleanup and Tests

Removed all unused constants and functions
only sqrt() is left

* chore: reorg prettier config to js, and require @sushiswap/prettier-config

* chore: add solcover.js and ignore flat, interfaces & mocks

* chore: remove unused contract/tests

* chore: move MirinMathTest to mocks/MirinMathConsumerMock and update test

* chore: re-enable forking config, issue was fixed some time ago

* chore: better define example env

* chore: move examples to examples directory

* chore: remove redudent MirinMathNew

* chore: network configuration

* chore: explicitly set paths

* chore: explicitly typechain config

* chore: remove archieved version of typechain

* chore: compileUsingRemoteVersion 0.8.2

* chore: ignore types

* chore: solthintignore

* config: prettier

* config: prettierignore

* config: husky

* config: lint staged

Co-authored-by: nori <nori@sushi.com>
Co-authored-by: Mudit Gupta <guptamudit@ymail.com>

.env.example

@@ -2,8 +2,12 @@ ALCHEMY_API_KEY=
 COINMARKETCAP_API_KEY=
 ETHERSCAN_API_KEY=
 FORKING=false
+HARDHAT_NETWORK=hardhat
+HARDHAT_MAX_MEMORY=4096
+HARDHAT_SHOW_STACK_TRACES=true
+HARDHAT_VERBOSE=true
 INFURA_API_KEY=
 MNEMONIC="test test test test test test test test test test test junk"
-REPORT_GAS=false
+REPORT_GAS=git 
 TENDERLY_PROJECT=
 TENDERLY_USERNAME=

.gitignore

@@ -9,7 +9,7 @@ artifacts/
 deployments/
 
 # Typechain
-typechain/
+types/
 
 # Env
 .env

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged
+yarn test

.prettierignore

@@ -0,0 +1,8 @@
+export/
+deployments/
+artifacts/
+cache/
+coverage/
+node_modules/
+package.json
+types/

.prettierrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+    ...require("@sushiswap/prettier-config"),
+    // TODO: If a non-default solidity config is needed, we could add this to our
+    // config repo and import as @sushiswap/prettier-config/solidity. Also, feel
+    // free to add to the default config which is required above.
+    overrides: [
+        {
+            files: '*.sol',
+            options: {
+            printWidth: 120,
+            tabWidth: 4,
+            singleQuote: false,
+            bracketSpacing: false,
+            explicitTypes: 'always',
+            },
+        },
+    ],
+};

.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+    skipFiles: ["interfaces", "flat", "mocks"],
+};

.solhintignore

@@ -0,0 +1,7 @@
+export/
+deployments/
+artifacts/
+cache/
+coverage/
+node_modules/
+types/

.vscode/settings.json

@@ -2,13 +2,12 @@
   "mochaExplorer.files": "test/**/*.{j,t}s",
   "mochaExplorer.fullTrace": true,
   "mochaExplorer.exit": true,
-  "solidity.enableLocalNodeCompiler": false,
-  "solidity.compileUsingRemoteVersion": "v0.6.12+commit.27d51765",
+  "solidity.compileUsingRemoteVersion": "v0.8.2+commit.661d1103",
   "solidity.compilerOptimization": 200,
   "solidity.compileUsingLocalVersion": "",
   "solidity.linter": "solhint",
   "solidity.packageDefaultDependenciesContractsDirectory": "",
+  "solidity.packageDefaultDependenciesDirectory": "node_modules",
   "solidity.enabledAsYouTypeCompilationErrorCheck": true,
   "solidity.validationDelay": 1500,
-  "solidity.packageDefaultDependenciesDirectory": "node_modules"
 }

contracts/mocks/MirinMathConsumerMock.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+pragma solidity ^0.8.2;
+
+import "../libraries/MirinMath.sol";
+
+contract MirinMathConsumerMock {
+    function sqrt(uint256 x) public pure returns (uint256) {
+        return MirinMath.sqrt(x);
+    }
+}