Initial development setup

Hardhat-based development environment with Solidity and JS linting based
on Keep rules. Configuration for Slither static analyzer from Trail Of
Bits included as well.

Author: pdyraga

.gitattributes

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

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+artifacts/
+cache/
+typechain/

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+ - repo: https://github.com/keep-network/pre-commit-hooks.git
+   rev: v1.3.0
+   hooks:
+    - id: check-added-large-files
+    - id: pretty-format-json
+      args: ['--autofix']
+ - repo: local
+   hooks:
+    - id: lint-js
+      name: 'lint js'
+      entry: /usr/bin/env bash -c "cd solidity && npm 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 "cd solidity && npm run lint:sol"
+      files: '\.sol$'
+      language: script
+      description: "Checks Solidity code according to the package's linter configuration"

solidity/.eslintrc

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

solidity/.solhint.json

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

solidity/.solhintignore

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

solidity/contracts/TBTCToken.sol

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity <0.9.0;
+
+contract TBTCToken {}

solidity/hardhat.config.js

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

solidity/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@keep-network/tbtc-v2",
+    "license": "MIT",
+    "dependencies": {
+      "@openzeppelin/contracts": "^3.3.0"
+    },
+    "devDependencies": {
+      "@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#0.3.0",
+      "ethereum-waffle": "^3.3.0",
+      "ethers": "^5.3.0",
+      "hardhat": "^2.3.0",
+      "hardhat-gas-reporter": "^1.0.4",
+      "prettier": "^2.3.0",
+      "prettier-plugin-solidity": "^1.0.0-beta.11 ",
+      "solhint": "^3.3.6",
+      "solhint-config-keep": "github:keep-network/solhint-config-keep",
+      "typescript": "^4.3.2"
+    },
+    "scripts": {
+      "build": "hardhat compile",
+      "lint": "npm run lint:js && npm run lint:sol",
+      "lint:fix:js": "eslint . --fix",
+      "lint:fix:sol": "solhint 'contracts/**/*.sol' --fix && prettier --write '**/*.sol'",
+      "lint:js": "eslint . ",
+      "lint:sol": "solhint 'contracts/**/*.sol' && prettier --check '**/*.sol'",
+      "test": "hardhat test"
+    }
+  }
+  

solidity/slither.config.json

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

solidity/test/TBTCToken.test.js

@@ -0,0 +1,7 @@
+const { expect } = require("chai")
+
+describe("TBTCToken", () => {
+  it("works", async () => {
+    expect(1).is.equal(1)
+  })
+})