test(DisputeKitPlurality): added basic test, work in progress

Author: jaybuidl

CHANGELOG.md

@@ -1,10 +1,11 @@
-## 0.1.0 (2021-12-18)
+## 0.1.0 (2021-12-28)
 
 - feat: add arbitrum L1 bridge and dependencies ([b412772](https://github.com/kleros/kleros-v2/commit/b412772))
 - feat: add arbitrum L2 bridge ([457b060](https://github.com/kleros/kleros-v2/commit/457b060))
 - feat: dispute kit in progress ([95b8ada](https://github.com/kleros/kleros-v2/commit/95b8ada))
 - feat: modern toolchain setup and simple RNG smart contracts ([17f6a76](https://github.com/kleros/kleros-v2/commit/17f6a76))
 - feat(Arbitration): standard update ([ed930de](https://github.com/kleros/kleros-v2/commit/ed930de))
+- feat(DisputeKitPlurality): dispute creation ([6a2490e](https://github.com/kleros/kleros-v2/commit/6a2490e))
 - feat(DisputeKitPlurality): split the responsibility of drawing jurors between Core and Dispute Kit ([f339e2b](https://github.com/kleros/kleros-v2/commit/f339e2b))
 - refactor: add arbitrator data index getter ([47a1623](https://github.com/kleros/kleros-v2/commit/47a1623))
 - refactor: add evidence contracts ([09a34f3](https://github.com/kleros/kleros-v2/commit/09a34f3))

contracts/hardhat.config.ts

@@ -6,8 +6,9 @@ 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";
 
 dotenv.config();
 
@@ -43,6 +44,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 +114,20 @@ 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/**/*"],
+ },
+ },
 };
 
 export default config;

contracts/package.json

@@ -14,7 +14,8 @@
  "build": "hardhat compile",
  "clean": "hardhat clean",
  "deploy": "hardhat deploy",
- "test": "hardhat test"
+ "test": "hardhat test",
+ "watch": "hardhat watch"
  },
  "devDependencies": {
  "@nomiclabs/hardhat-ethers": "^2.0.2",
@@ -36,6 +37,7 @@
  "hardhat-deploy": "^0.9.6",
  "hardhat-deploy-ethers": "^0.3.0-beta.11",
  "hardhat-gas-reporter": "^1.0.4",
+ "hardhat-watcher": "^2.1.1",
  "mocha": "^9.1.3",
  "solhint": "^3.3.6",
  "solidity-coverage": "^0.7.17",

contracts/src/arbitration/DisputeKitPlurality.sol

@@ -84,7 +84,6 @@ contract DisputeKitPlurality is AbstractDisputeKit {
  Dispute[] public disputes; // Stores the dispute info. disputes[disputeID].
  mapping(uint256 => Round[]) public disputeIDtoRounds; // Maps dispute IDs to Round array that contains the info about crowdfunding.
 
-
  constructor(MockKlerosCore _core, RNG _rng) {
  core = _core;
  rng = _rng;
@@ -120,9 +119,6 @@ contract DisputeKitPlurality is AbstractDisputeKit {
  // uint feeForJuror: paid per juror
  // uint jurorsForCourtJump: evaluated by the appeal logic
 
- // NOTE: the interface should work also for "1 human 1 vote"
-
-
  Dispute storage dispute = disputes.push();
  dispute.arbitratorExtraData = _extraData;
  dispute.choices = _choices;
@@ -141,7 +137,19 @@ contract DisputeKitPlurality is AbstractDisputeKit {
  dispute.penaltiesForRound.push(0);
  dispute.ruling = 0;
 
- disputeIDtoRounds[_disputeID].push();
+ disputeIDtoRounds[_disputeID].push(); 
+ } 
+
+ function getVotes(uint _disputeID) public view returns(Vote[][] memory) {
+ return disputes[_disputeID].votes;
+ }
+
+ function getVotesLength(uint _disputeID) public view returns(uint, uint) {
+ return (disputes[_disputeID].votes.length, disputes[_disputeID].votes[0].length);
+ }
+
+ function getVoteCounter(uint _disputeID) public view returns(bool) {
+ return disputes[_disputeID].voteCounters[disputes[_disputeID].voteCounters.length - 1].tied;
  }
 
  /**
@@ -165,10 +173,7 @@ contract DisputeKitPlurality is AbstractDisputeKit {
  for (uint256 i = 0; i < _iterations; i++) {
  uint256 treeIndex = draw(uint256(keccak256(abi.encodePacked(randomNumber, _disputeID, i))), k, nodes);
  bytes32 id = core.getSortitionSumTreeID(key, treeIndex);
- (
- address drawnAddress, 
- /* subcourtID */
- ) = stakePathIDToAccountAndSubcourtID(id);
+ (address drawnAddress, /* subcourtID */) = stakePathIDToAccountAndSubcourtID(id);
 
  // TODO: Save the vote.
  // dispute.votes[dispute.votes.length - 1][i].account = drawnAddress;

contracts/src/arbitration/mock/MockKlerosCore.sol

@@ -2,14 +2,12 @@
 
 pragma solidity ^0.8;
 
-import {SortitionSumTreeFactory} from "../../data-structures/SortitionSumTreeFactory.sol";
-// import "../DisputeKitPlurality.sol";
+// import {SortitionSumTreeFactory} from "../../data-structures/SortitionSumTreeFactory.sol";
 import "../IArbitrable.sol";
 import "../AbstractDisputeKit.sol";
 
 contract MockKlerosCore {
- using SortitionSumTreeFactory for SortitionSumTreeFactory.SortitionSumTrees; // Use library functions for sortition sum trees.
- SortitionSumTreeFactory.SortitionSumTrees internal sortitionSumTrees; // The sortition sum trees.
+ SortitionSumTrees internal sortitionSumTrees; // The sortition sum trees.
 
  struct Dispute {
  // Note that appeal `0` is equivalent to the first round of the dispute.
@@ -45,6 +43,8 @@ contract MockKlerosCore {
  uint[4] timesPerPeriod; // The time allotted to each dispute period in the form `timesPerPeriod[period]`.
  }
 
+ event DisputeCreation(uint indexed _disputeID, IArbitrable indexed _arbitrable);
+
  uint public constant MIN_JURORS = 3; // The global default minimum number of jurors in a dispute.
 
  Dispute[] public disputes;
@@ -53,7 +53,10 @@ contract MockKlerosCore {
  AbstractDisputeKit disputeKit;
 
  constructor() {
- sortitionSumTrees.createTree(bytes32(0), 3);
+ createTree(sortitionSumTrees, bytes32(0), 3);
+ Court storage court = courts.push();
+ court.minStake = 100;
+ court.feeForJuror = 100;
  }
 
  // TODO: only owner
@@ -76,7 +79,7 @@ contract MockKlerosCore {
  _choices, 
  _extraData);
 
- //emit DisputeCreation(disputeID, IArbitrable(msg.sender));
+ emit DisputeCreation(disputeID, IArbitrable(msg.sender));
  }
 
  function getSortitionSumTree(bytes32 _key)
@@ -88,7 +91,7 @@ contract MockKlerosCore {
  uint256[] memory nodes
  )
  {
- SortitionSumTreeFactory.SortitionSumTree storage tree = sortitionSumTrees.sortitionSumTrees[_key];
+ SortitionSumTree storage tree = sortitionSumTrees.sortitionSumTrees[_key];
  k = tree.K;
  stack = tree.stack;
  nodes = tree.nodes;
@@ -120,4 +123,35 @@ contract MockKlerosCore {
  minJurors = MIN_JURORS;
  }
  }
+
+
+ // SORTITION TREE FACTORY
+
+ struct SortitionSumTree {
+ uint256 K; // The maximum number of childs per node.
+ // We use this to keep track of vacant positions in the tree after removing a leaf. This is for keeping the tree as balanced as possible without spending gas on moving nodes around.
+ uint256[] stack;
+ uint256[] nodes;
+ // Two-way mapping of IDs to node indexes. Note that node index 0 is reserved for the root node, and means the ID does not have a node.
+ mapping(bytes32 => uint256) IDsToNodeIndexes;
+ mapping(uint256 => bytes32) nodeIndexesToIDs;
+ }
+
+ struct SortitionSumTrees {
+ mapping(bytes32 => SortitionSumTree) sortitionSumTrees;
+ }
+
+ function createTree(
+ SortitionSumTrees storage self,
+ bytes32 _key,
+ uint256 _K
+ ) private {
+ SortitionSumTree storage tree = self.sortitionSumTrees[_key];
+ require(tree.K == 0, "Tree already exists.");
+ require(_K > 1, "K must be greater than one.");
+ tree.K = _K;
+ // tree.stack.length = 0;
+ // tree.nodes.length = 0;
+ tree.nodes.push(0);
+ }
 }

contracts/test/arbitration/index.ts

@@ -0,0 +1,63 @@
+import { expect } from "chai";
+import { ethers } from "hardhat";
+import { BigNumber } from "ethers";
+
+const ONE_ETH = BigNumber.from(10).pow(18);
+const WINNER_STAKE_MULTIPLIER = 3000;
+const LOSER_STAKE_MULTIPLIER = 7000;
+const MULTIPLIER_DENOMINATOR = 10000;
+
+function sleep(ms) {
+ return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+describe("DisputeKitPlurality", function () {
+ // eslint-disable-next-line no-unused-vars
+ let deployer, claimant, supporter, challenger, innocentBystander; 
+ let core, disputeKit, arbitrable;
+
+ before("Deploying", async () => {
+ [deployer, claimant, supporter, challenger, innocentBystander] = await ethers.getSigners();
+ [core, disputeKit, arbitrable] = await deployContracts(deployer);
+
+ // To wait for eth gas reporter to fetch data. Remove this line when the issue is fixed. https://github.com/cgewecke/hardhat-gas-reporter/issues/72
+ // await sleep(9000); 
+ });
+
+ it("Should create a dispute", async function () {
+ await expect(disputeKit.connect(deployer).createDispute(0, 0, 0, 0, 0, 0, "0x00"))
+ .to.be.revertedWith("Not allowed: sender is not core");
+
+ await expect(core.connect(deployer).createDispute(2, "0x00", { value: 1000 }))
+ .to.emit(core, "DisputeCreation")
+ .withArgs(0, deployer.address);
+
+ console.log(await disputeKit.disputes(0));
+ console.log(`votes=${await disputeKit.getVotes(0)}`);
+ console.log(`votes=${await disputeKit.getVotesLength(0)}`);
+ console.log(`voteCounter=${await disputeKit.getVoteCounter(0)}`);
+ });
+});
+
+
+async function deployContracts(deployer) {
+ const MockKlerosCoreFactory = await ethers.getContractFactory("MockKlerosCore", deployer);
+ const core = await MockKlerosCoreFactory.deploy();
+ await core.deployed();
+
+ const ConstantNGFactory = await ethers.getContractFactory("ConstantNG", deployer);
+ const rng = await ConstantNGFactory.deploy(42);
+ await rng.deployed();
+
+ const disputeKitFactory = await ethers.getContractFactory("DisputeKitPlurality", deployer);
+ const disputeKit = await disputeKitFactory.deploy(core.address, rng.address);
+ await disputeKit.deployed();
+
+ await core.registerDisputeKit(disputeKit.address);
+
+ const ArbitrableFactory = await ethers.getContractFactory("ArbitrableExample", deployer);
+ const arbitrable = await ArbitrableFactory.deploy(core.address);
+ await arbitrable.deployed();
+
+ return [core, disputeKit, arbitrable];
+}