test: add evidence contract tests

Author: fnanni-0

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## 0.1.0 (2021-12-13)
 
+- 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))
+- refactor: add interfaces + capped math ([e25b21f](https://github.com/kleros/kleros-v2/commit/e25b21f))
+- refactor: remove foreign evidence interface ([ff8c50c](https://github.com/kleros/kleros-v2/commit/ff8c50c))
+- refactor(sdk): rename ([3241d10](https://github.com/kleros/kleros-v2/commit/3241d10))
 - test: added a test for IncrementalNG ([65a996b](https://github.com/kleros/kleros-v2/commit/65a996b))
 - test(EvidenceModule): add test file ([9f00f98](https://github.com/kleros/kleros-v2/commit/9f00f98))
 - chore: added GitHub code scanning ([4a70475](https://github.com/kleros/kleros-v2/commit/4a70475))
@@ -14,10 +19,6 @@
 - fix(IArbitrator): change name to arbitration cost ([0ba4f29](https://github.com/kleros/kleros-v2/commit/0ba4f29))
 - fix(IArbitrator): interface simplification ([e81fb8b](https://github.com/kleros/kleros-v2/commit/e81fb8b))
 - fix(IArbitrator): replaced appealCost with fundingStatus ([f189dd9](https://github.com/kleros/kleros-v2/commit/f189dd9))
-- refactor: add evidence contracts ([09a34f3](https://github.com/kleros/kleros-v2/commit/09a34f3))
-- refactor: add interfaces + capped math ([e25b21f](https://github.com/kleros/kleros-v2/commit/e25b21f))
-- refactor: remove foreign evidence interface ([ff8c50c](https://github.com/kleros/kleros-v2/commit/ff8c50c))
-- refactor(sdk): rename ([3241d10](https://github.com/kleros/kleros-v2/commit/3241d10))
 - 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))
 - docs: initial commit ([23356e7](https://github.com/kleros/kleros-v2/commit/23356e7))

contracts/test/evidence/index.ts

@@ -0,0 +1,276 @@
+import { use, expect } from "chai";
+import { ethers } from "hardhat";
+import { BigNumber } from "ethers";
+import { solidity } from 'ethereum-waffle';
+const hre = require('hardhat')
+
+use(solidity)
+
+const Party = {
+ None: 0,
+ Submitter: 1, 
+ Moderator: 2
+}
+
+function getEmittedEvent(eventName: any, receipt: any) {
+ return receipt.events.find(({ event }) => event === eventName)
+}
+
+describe('Home Evidence contract', async () => {
+ const arbitrationFee = 1000
+ const appealFee = arbitrationFee
+ const arbitratorExtraData = '0x85'
+ const appealTimeout = 100
+ const bondTimeout = 60 * 10
+ const totalCostMultiplier = 15000
+ const initialDepositMultiplier = 625
+ const metaEvidenceUri = 'https://kleros.io'
+ const MULTIPLIER_DIVISOR = BigNumber.from(10000)
+ const totalCost = BigNumber.from(arbitrationFee).mul(BigNumber.from(totalCostMultiplier)).div(MULTIPLIER_DIVISOR)
+ const minRequiredDeposit = totalCost.mul(BigNumber.from(initialDepositMultiplier)).div(MULTIPLIER_DIVISOR)
+ const ZERO = BigNumber.from(0)
+
+ let deployer
+ let user1
+ let user2
+ let user3
+ let user4
+ let evidenceID
+
+ let arbitrator
+ let evidenceModule
+ 
+ beforeEach('Setup contracts', async () => {
+ ;[
+ deployer,
+ user1,
+ user2,
+ user3,
+ user4
+ ] = await ethers.getSigners()
+
+ const Arbitrator = await ethers.getContractFactory('CentralizedArbitrator')
+ arbitrator = await Arbitrator.deploy(
+ String(arbitrationFee),
+ appealTimeout,
+ String(appealFee)
+ )
+
+ const EvidenceModule = await ethers.getContractFactory('EvidenceModule')
+ evidenceModule = await EvidenceModule.deploy(
+ arbitrator.address,
+ deployer.address, // governor
+ totalCostMultiplier,
+ initialDepositMultiplier,
+ bondTimeout,
+ arbitratorExtraData,
+ metaEvidenceUri
+ )
+ })
+
+ describe("Governance", function () {
+ it("Should change parameters correctly", async function () {
+ const newGovernor = await user2.getAddress()
+ await evidenceModule.changeGovernor(newGovernor)
+ expect(await evidenceModule.governor()).to.equal(newGovernor)
+ await evidenceModule.connect(user2).changeGovernor(await deployer.getAddress())
+
+ await evidenceModule.changeInitialDepositMultiplier(1)
+ expect(await evidenceModule.initialDepositMultiplier()).to.equal(1)
+
+ await evidenceModule.changeTotalCostMultiplier(1)
+ expect(await evidenceModule.totalCostMultiplier()).to.equal(1)
+
+ await evidenceModule.changeBondTimeout(1)
+ expect(await evidenceModule.bondTimeout()).to.equal(1)
+
+ const newMetaEvidenceUri = 'https://kleros.io/new'
+ let tx = await evidenceModule.changeMetaEvidence(newMetaEvidenceUri)
+ let receipt = await tx.wait()
+ let lastArbitratorIndex = await evidenceModule.getCurrentArbitratorIndex()
+ let newArbitratorData = await evidenceModule.arbitratorDataList(lastArbitratorIndex)
+ let oldArbitratorData = await evidenceModule.arbitratorDataList(lastArbitratorIndex.sub(BigNumber.from(1)))
+
+ expect(
+ newArbitratorData.metaEvidenceUpdates
+ ).to.equal(oldArbitratorData.metaEvidenceUpdates.add(BigNumber.from(1)))
+ expect(
+ newArbitratorData.arbitratorExtraData
+ ).to.equal(oldArbitratorData.arbitratorExtraData)
+ const [newMetaEvidenceUpdates ,newMetaEvidence] = getEmittedEvent('MetaEvidence', receipt).args
+ expect(newMetaEvidence).to.equal(newMetaEvidenceUri, 'Wrong MetaEvidence.')
+ expect(newMetaEvidenceUpdates).to.equal(newArbitratorData.metaEvidenceUpdates, 'Wrong MetaEvidence ID.')
+
+ const newArbitratorExtraData = '0x86'
+ await evidenceModule.changeArbitratorExtraData(newArbitratorExtraData)
+ newArbitratorData = await evidenceModule.arbitratorDataList(lastArbitratorIndex.add(BigNumber.from(1)))
+ expect(
+ newArbitratorData.arbitratorExtraData
+ ).to.equal(newArbitratorExtraData, 'Wrong extraData')
+ });
+
+ it("Should revert if the caller is not the governor", async function () {
+ await expect(evidenceModule.
+ connect(user2).changeGovernor(await user2.getAddress())
+ ).to.be.revertedWith('The caller must be the governor')
+
+ await expect(evidenceModule.
+ connect(user2).changeInitialDepositMultiplier(0)
+ ).to.be.revertedWith('The caller must be the governor')
+
+ await expect(evidenceModule.
+ connect(user2).changeTotalCostMultiplier(0)
+ ).to.be.revertedWith('The caller must be the governor')
+
+ await expect(evidenceModule.
+ connect(user2).changeBondTimeout(0)
+ ).to.be.revertedWith('The caller must be the governor')
+
+ await expect(evidenceModule.
+ connect(user2).changeMetaEvidence(metaEvidenceUri)
+ ).to.be.revertedWith('The caller must be the governor')
+
+ await expect(evidenceModule.
+ connect(user2).changeArbitratorExtraData(arbitratorExtraData)
+ ).to.be.revertedWith('The caller must be the governor')
+ });
+ });
+ 
+ describe('Evidence Submission', () => {
+ it('Should submit evidence correctly.', async () => {
+ const newEvidence = 'Irrefutable evidence'
+ const tx = await evidenceModule.connect(user1).submitEvidence(1234, newEvidence, {
+ value: minRequiredDeposit
+ }) // id: 0
+ const receipt = await tx.wait()
+ const evidenceID = ethers.utils.solidityKeccak256(["uint", "string"], [1234, newEvidence]);
+
+ const [
+ arbitratorAddress, 
+ evidenceGroupID, 
+ submitter, 
+ evidenceStr
+ ] = getEmittedEvent('Evidence', receipt).args
+ expect(arbitratorAddress).to.equal(arbitrator.address, 'Wrong arbitrator.')
+ expect(evidenceGroupID).to.equal(1234, 'Wrong evidence group ID.')
+ expect(submitter).to.equal(user1.address, 'Wrong submitter.')
+ expect(evidenceStr).to.equal(newEvidence, 'Wrong evidence message.')
+
+ let contributions = await evidenceModule.getContributions(evidenceID, 0, user1.address)
+ expect(contributions).to.deep.equal([ZERO,minRequiredDeposit,ZERO], 'Wrong contributions.')
+ })
+
+ it('Should not allowed the same evidence twice for the same evidence group id.', async () => {
+ const newEvidence = 'Irrefutable evidence'
+ await evidenceModule.submitEvidence(1234, newEvidence, {
+ value: minRequiredDeposit
+ })
+ await expect(evidenceModule.
+ submitEvidence(1234, newEvidence, {
+ value: minRequiredDeposit
+ })).to.be.revertedWith('Evidence already submitted.')
+ })
+
+ it('Should revert if deposit is too low.', async () => {
+ const newEvidence = 'Irrefutable evidence'
+ await expect(evidenceModule.
+ submitEvidence(1234, newEvidence, {
+ value: minRequiredDeposit.sub(BigNumber.from(1))
+ })).to.be.revertedWith('Insufficient funding.')
+ })
+ })
+ 
+ describe('Moderation', () => {
+ beforeEach('Initialize posts and comments', async () => {
+ const newEvidence = 'Irrefutable evidence'
+ await evidenceModule.connect(user1).submitEvidence(1234, newEvidence, {
+ value: minRequiredDeposit
+ })
+ evidenceID = ethers.utils.solidityKeccak256(["uint", "string"], [1234, newEvidence]);
+ })
+
+ it('Should not allow moderation after bond timeout passed.', async () => {
+ await expect(evidenceModule.
+ resolveModerationMarket(evidenceID)
+ ).to.be.revertedWith('Moderation still ongoing.')
+
+ await hre.ethers.provider.send('evm_increaseTime', [60 * 10]);
+
+ // Moderate
+ await expect(evidenceModule.
+ moderate(evidenceID, Party.Moderator, {
+ value: totalCost
+ })).to.be.revertedWith('Moderation market is closed.')
+
+ await evidenceModule.resolveModerationMarket(evidenceID)
+ 
+ // After market has been closed, moderation can re-open.
+ await evidenceModule.moderate(evidenceID, Party.Submitter, {
+ value: totalCost
+ })
+ })
+
+ it('Should create dispute after moderation escalation is complete.', async () => {
+ await evidenceModule.connect(user2).moderate(evidenceID, Party.Moderator, {
+ value: minRequiredDeposit.mul(2)
+ })
+
+ let moderationInfo = await evidenceModule.getModerationInfo(evidenceID, 0)
+ let paidFees = moderationInfo.paidFees
+ let depositRequired = paidFees[Party.Moderator].mul(2).
+ sub(paidFees[Party.Submitter])
+ await evidenceModule.connect(user4).moderate(evidenceID, Party.Submitter, {
+ value: depositRequired
+ })
+
+ moderationInfo = await evidenceModule.getModerationInfo(evidenceID, 0)
+ paidFees = moderationInfo.paidFees
+ depositRequired = paidFees[Party.Submitter].mul(2).
+ sub(paidFees[Party.Moderator])
+ await evidenceModule.connect(user2).moderate(evidenceID, Party.Moderator, {
+ value: depositRequired
+ })
+
+ moderationInfo = await evidenceModule.getModerationInfo(evidenceID, 0)
+ paidFees = moderationInfo.paidFees
+ depositRequired = paidFees[Party.Moderator].mul(2).
+ sub(paidFees[Party.Submitter])
+ await evidenceModule.connect(user4).moderate(evidenceID, Party.Submitter, {
+ value: depositRequired
+ })
+
+ moderationInfo = await evidenceModule.getModerationInfo(evidenceID, 0)
+ paidFees = moderationInfo.paidFees
+ depositRequired = paidFees[Party.Submitter].mul(2).
+ sub(paidFees[Party.Moderator])
+ await evidenceModule.connect(user2).moderate(evidenceID, Party.Moderator, {
+ value: depositRequired
+ })
+
+ moderationInfo = await evidenceModule.getModerationInfo(evidenceID, 0)
+ paidFees = moderationInfo.paidFees
+ depositRequired = paidFees[Party.Moderator].mul(2).
+ sub(paidFees[Party.Submitter])
+ let tx = await evidenceModule.connect(user4).moderate(evidenceID, Party.Submitter, {
+ value: depositRequired // Less is actually needed. Overpaid fees are reimbursed
+ })
+ let receipt = await tx.wait()
+
+ let [_arbitrator, disputeID, metaEvidenceID, _evidenceID] = getEmittedEvent('Dispute', receipt).args
+ expect(_arbitrator).to.equal(arbitrator.address, 'Wrong arbitrator.')
+ expect(disputeID).to.equal(0, 'Wrong dispute ID.')
+ expect(metaEvidenceID).to.equal(0, 'Wrong meta-evidence ID.')
+ expect(_evidenceID).to.equal(evidenceID, 'Wrong evidence ID.')
+
+ await expect(evidenceModule.
+ connect(user2).moderate(evidenceID, Party.Moderator, {
+ value: totalCost
+ })
+ ).to.be.revertedWith('Evidence already disputed.')
+
+ await expect(evidenceModule.
+ connect(user2).resolveModerationMarket(evidenceID)
+ ).to.be.revertedWith('Evidence already disputed.')
+ })
+ })
+})

contracts/tsconfig.json

@@ -6,7 +6,8 @@
  "esModuleInterop": true,
  "outDir": "dist",
  "declaration": true,
- "sourceMap": true
+ "sourceMap": true,
+ "noImplicitAny": false
  },
  "include": [
  "./src",