Initial development environment setup

Initial development environment setup based on keep-network/tbtc-v2 and
keep-network/coverage-pools. Hardhat, eslint, solhint, prettier,
slither. Proven weapons for our upcoming Solidity battle.

Author: pdyraga

.eslintrc

@@ -0,0 +1,14 @@
+{
+  "extends": ["eslint-config-keep"],
+  "parserOptions": {
+    "ecmaVersion": 2017,
+    "sourceType": "module"
+  },
+  "env": {
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    "new-cap": "off"
+  }
+}

.gitattributes

@@ -0,0 +1 @@
+*.sol linguist-language=Solidity

.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+artifacts/
+cache/
+typechain/
+.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/keep-network/pre-commit-hooks.git
+    rev: v1.3.0
+    hooks:
+      - id: check-added-large-files
+  - repo: local
+    hooks:
+      - id: lint-js
+        name: "lint js"
+        entry: /usr/bin/env bash -c "npx run lint:js"
+        files: '\.js$'
+        language: script
+        description: "Checks JS code according to the package's linter configuration"
+      - id: lint-sol
+        name: "lint solidity"
+        entry: /usr/bin/env bash -c "npx run lint:sol"
+        files: '\.sol$'
+        language: script
+        description: "Checks Solidity code according to the package's linter configuration"
+      - id: prettier
+        name: "prettier"
+        entry: /usr/bin/env bash -c "npx prettier --check ."
+        language: script
+        description: "Checks code according to the package's formatting configuration"

.prettierignore

@@ -0,0 +1,4 @@
+artifacts/
+build/
+cache/
+deployments/

.prettierrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  ...require("@keep-network/prettier-config-keep"),
+  plugins: ["prettier-plugin-sh"],
+}

.solhint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "keep",
+  "plugins": [],
+  "rules": {
+    "func-visibility": ["error", { "ignoreConstructors": true }]
+  }
+}

.solhintignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -1 +1 @@
-# solidity-contracts
+# solidity-contracts

contracts/token/TToken.sol

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity 0.8.4;
+
+contract TToken {}

hardhat.config.js

@@ -0,0 +1,8 @@
+require("@nomiclabs/hardhat-waffle")
+require("hardhat-gas-reporter")
+
+module.exports = {
+  solidity: {
+    version: "0.8.4",
+  },
+}

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@t-network/solidity-contracts",
+  "version": "0.0.1",
+  "license": "MIT",
+  "scripts": {
+    "build": "hardhat compile",
+    "format": "npm run lint && prettier --check .",
+    "format:fix": "npm run lint:fix && prettier --write .",
+    "lint": "npm run lint:js && npm run lint:sol",
+    "lint:fix": "npm run lint:fix:js && npm run lint:fix:sol",
+    "lint:fix:js": "eslint . --fix",
+    "lint:fix:sol": "solhint 'contracts/**/*.sol' --fix",
+    "lint:js": "eslint . ",
+    "lint:sol": "solhint 'contracts/**/*.sol'",
+    "test": "hardhat test"
+  },
+  "devDependencies": {
+    "@keep-network/prettier-config-keep": "github:keep-network/prettier-config-keep#d6ec02e",
+    "@nomiclabs/hardhat-ethers": "^2.0.2",
+    "@nomiclabs/hardhat-waffle": "^2.0.1",
+    "chai": "^4.3.4",
+    "eslint": "^7.27.0",
+    "eslint-config-keep": "github:keep-network/eslint-config-keep#0c27ade",
+    "ethereum-waffle": "^3.4.0",
+    "ethers": "^5.4.1",
+    "hardhat": "^2.4.3",
+    "hardhat-gas-reporter": "^1.0.4",
+    "prettier": "^2.3.2",
+    "prettier-plugin-sh": "^0.7.1",
+    "prettier-plugin-solidity": "^1.0.0-beta.14 ",
+    "solhint": "^3.3.6",
+    "solhint-config-keep": "github:keep-network/solhint-config-keep",
+    "typescript": "^4.3.2"
+  }
+}

slither.config.json

@@ -0,0 +1,4 @@
+{
+  "detectors_to_exclude": "assembly,naming-convention,solc-version,timestamp,too-many-digits",
+  "filter_paths": "contracts/test|node_modules"
+}

test/token/TToken.test.js

@@ -0,0 +1,7 @@
+const { expect } = require("chai")
+
+describe("TToken", () => {
+  it("should work", async () => {
+    expect(true).to.be.true
+  })
+})