Merge pull request #12 from kleros/feat/core-plurality-disputekit-jaybuidl

Feat/core plurality disputekit

Author: jaybuidl

.codeclimate.yml

@@ -0,0 +1,6 @@
+engines:
+  tslint:
+    enabled: true
+    checks:
+      quotemark:
+        enabled: false

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
-  "solidity.compileUsingRemoteVersion": "v0.8.9+commit.e5eed63a",
+  "solidity.compileUsingRemoteVersion": "v0.8.10+commit.fc410830",
   "mochaExplorer.files": "contracts/test/**/*.{j,t}s"
 }

contracts/hardhat.config.ts

@@ -6,8 +6,10 @@ import "@nomiclabs/hardhat-waffle";
 import "@typechain/hardhat";
 import "hardhat-gas-reporter";
 import "solidity-coverage";
-import "hardhat-deploy"
-import "hardhat-deploy-ethers"
+import "hardhat-deploy";
+import "hardhat-deploy-ethers";
+import "hardhat-watcher";
+import "hardhat-docgen";
 
 dotenv.config();
 
@@ -43,6 +45,18 @@ const config: HardhatUserConfig = {
       saveDeployments: false,
       tags: ["test", "local"],
     },
+    mainnetFork: {
+      url: `http://127.0.0.1:8545`,
+      chainId: 1,
+      forking: {
+        url: `https://mainnet.infura.io/v3/${process.env.INFURA_API_KEY}`,
+      },
+      accounts: process.env.MAINNET_PRIVATE_KEY !== undefined ? [process.env.MAINNET_PRIVATE_KEY] : [],
+      live: false,
+      saveDeployments: false,
+      tags: ["test", "local"],
+    },
+
     // Home chain ---------------------------------------------------------------------------------
     arbitrumRinkeby: {
       chainId: 421611,
@@ -101,6 +115,25 @@ const config: HardhatUserConfig = {
   etherscan: {
     apiKey: process.env.ETHERSCAN_API_KEY,
   },
+  watcher: {
+    compilation: {
+      tasks: ["compile"],
+      files: ["./contracts"],
+      verbose: true,
+    },
+    testArbitration: {
+      tasks: [
+        { command: "compile", params: { quiet: true } },
+        { command: "test", params: { noCompile: true, testFiles: ["./test/arbitration/index.ts"] } },
+      ],
+      files: ["./test/**/*", "./src/**/*"],
+    },
+  },
+  docgen: {
+    path: './docs',
+    clear: true,
+    runOnCompile: false,
+  },
 };
 
 export default config;

contracts/package.json

@@ -14,12 +14,15 @@
     "build": "hardhat compile",
     "clean": "hardhat clean",
     "deploy": "hardhat deploy",
-    "test": "hardhat test"
+    "test": "hardhat test",
+    "watch": "hardhat watch",
+    "docgen": "hardhat docgen"
   },
   "devDependencies": {
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-etherscan": "^2.1.7",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
+    "@openzeppelin/contracts": "^4.4.1",
     "@typechain/ethers-v5": "^7.2.0",
     "@typechain/hardhat": "^2.3.1",
     "@types/chai": "^4.2.22",
@@ -35,7 +38,9 @@
     "hardhat": "^2.6.8",
     "hardhat-deploy": "^0.9.6",
     "hardhat-deploy-ethers": "^0.3.0-beta.11",
+    "hardhat-docgen": "^1.2.1",
     "hardhat-gas-reporter": "^1.0.4",
+    "hardhat-watcher": "^2.1.1",
     "json-schema": "^0.4.0",
     "mocha": "^9.1.3",
     "solhint": "^3.3.6",

contracts/src/arbitration/ArbitrableExample.sol

@@ -6,7 +6,7 @@ import "./IArbitrable.sol";
 
 /**
  *  @title ArbitrableExample
- *  An example of the arbitrable contract which connects to the arbitator that implements IArbitrator interface.
+ *  An example of an arbitrable contract which connects to the arbitator that implements the updated interface.
  */
 contract ArbitrableExample is IArbitrable {
     struct DisputeStruct {

contracts/src/arbitration/CentralizedArbitrator.sol

@@ -125,7 +125,7 @@ contract CentralizedArbitrator is IArbitrator {
         uint256 _arbitrationFee,
         uint256 _appealDuration,
         uint256 _appealFee
-    ) public {
+    ) {
         arbitrationFee = _arbitrationFee;
         appealDuration = _appealDuration;
         appealFee = _appealFee;