Skip to content

kleros/kleros-v2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9715f74 · May 9, 2022
Jan 21, 2022
Dec 30, 2021
Feb 16, 2022
Jan 21, 2022
Nov 11, 2021
May 9, 2022
Nov 11, 2021
Nov 11, 2021
Dec 4, 2021
Nov 11, 2021
Mar 17, 2022
Nov 11, 2021
Jan 17, 2022
Nov 10, 2021
Nov 10, 2021
Nov 10, 2021
Nov 10, 2021
Nov 10, 2021
Dec 13, 2021
Nov 10, 2021
Nov 10, 2021
Nov 10, 2021
Nov 10, 2021
Jan 21, 2022
Nov 10, 2021
Jan 27, 2022
Jan 21, 2022
Mar 21, 2022

Repository files navigation

Kleros

Kleros v2

Unit testing Conventional Commits Commitizen Friendly Styled with Prettier


Toolchain:

  • Solidity 0.8
  • Hardhat
  • Ethers
  • Waffle
  • Typescript
  • Node 16
  • Yarn 3 without PlugnPlay

Contributing

Pre-Requisites

  • Install NodeJS 16:
    • on Red Hat Linux: dnf module install nodejs:16
    • on Ubuntu Linux: sudo snap install node --classic
    • on MacOS via brew: brew install node
    • on Windows via Chocolatey: choco install nvs
  • Install Yarn v1.22: npm install -g yarn
  • Upgrade Yarn to v3: yarn set version berry

Optional Steps

$ npm i -g hardhat-shorthand

$ hardhat-completion install
✔ Which Shell do you use ? · bash
✔ We will install completion to ~/.bashrc, is it ok ? (y/N) · true

$ . ~/.bashrc

Getting Started

Install the dependencies

$ npm install -g depcheck
$ yarn install

Repo Structure

Each directory at the root of this repository contains code for each individual part that enables this integration:

  • bots/: service to automate some steps of the flow which otherwise would required manual intervention from users.
    • Notice: while this is a centralized service, it exists only for convenience. Anyone can fulfill the role of the bots if they wish to do so.
  • contracts/: Smart contracts running the arbitration system Learn more.
  • dynamic-script/: allows fetching the dynamic content for the arbitration, as described by ERC-1497: Evidence Standard.
  • evidence-display/: display interface that should be used to render the evidence for arbitrators, as described by ERC-1497: Evidence Standard.

Deployment

See contracts/README.md.