Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Dispute Kit Forest #57

Merged
merged 7 commits into from
Apr 16, 2022
Merged

feat: Dispute Kit Forest #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bdb9d17
feat(KlerosCore): dispute kit forest implementation
unknownunknown1 Mar 14, 2022
64825e8
fix(KlerosCore): don't create new dispute without DK switch
unknownunknown1 Mar 16, 2022
37b8a63
feat: refactor passPeriod(), new events CourtJump + DisputeKitJump, e…
jaybuidl Apr 15, 2022
41ba880
refactor(KlerosCore): minor changes in appeal() and execute() for rea…
jaybuidl Apr 15, 2022
2ee3c09
refactor(KlerosCore): moved nbVotes from Dispute struct to Round struct
jaybuidl Apr 15, 2022
9b739d4
refactor(KlerosCore): introduced the NULL_DISPUTE_KIT constant
jaybuidl Apr 15, 2022
bafb199
refactor(DisputeKit): renamed params coreDisputeID/coreRoundID to avo…
jaybuidl Apr 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 40 additions & 21 deletions contracts/src/arbitration/IDisputeKit.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,67 +24,86 @@ interface IDisputeKit {

/** @dev Creates a local dispute and maps it to the dispute ID in the Core contract.
* Note: Access restricted to Kleros Core only.
* @param _disputeID The ID of the dispute in Kleros Core.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @param _numberOfChoices Number of choices of the dispute
* @param _extraData Additional info about the dispute, for possible use in future dispute kits.
*/
function createDispute(
uint256 _disputeID,
uint256 _coreDisputeID,
uint256 _numberOfChoices,
bytes calldata _extraData
) external;

/** @dev Draws the juror from the sortition tree. The drawn address is picked up by Kleros Core.
* Note: Access restricted to Kleros Core only.
* @param _disputeID The ID of the dispute in Kleros Core.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @return drawnAddress The drawn address.
*/
function draw(uint256 _disputeID) external returns (address drawnAddress);
function draw(uint256 _coreDisputeID) external returns (address drawnAddress);

// ************************************* //
// * Public Views * //
// ************************************* //

/** @dev Gets the current ruling of a specified dispute.
* @param _disputeID The ID of the dispute in Kleros Core.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @return ruling The current ruling.
*/
function currentRuling(uint256 _disputeID) external view returns (uint256 ruling);
function currentRuling(uint256 _coreDisputeID) external view returns (uint256 ruling);

/** @dev Returns the voting data from the most relevant round.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @return winningChoiece The winning choice of this round.
* @return tied Whether it's a tie or not.
*/
function getLastRoundResult(uint256 _coreDisputeID) external view returns (uint256 winningChoiece, bool tied);

/** @dev Gets the degree of coherence of a particular voter. This function is called by Kleros Core in order to determine the amount of the reward.
* @param _disputeID The ID of the dispute in Kleros Core.
* @param _round The ID of the round.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @param _coreRoundID The ID of the round in Kleros Core, not in the Dispute Kit.
* @param _voteID The ID of the vote.
* @return The degree of coherence in basis points.
*/
function getDegreeOfCoherence(
uint256 _disputeID,
uint256 _round,
uint256 _coreDisputeID,
uint256 _coreRoundID,
uint256 _voteID
) external view returns (uint256);

/** @dev Gets the number of jurors who are eligible to a reward in this round.
* @param _disputeID The ID of the dispute in Kleros Core.
* @param _round The ID of the round.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @param _coreRoundID The ID of the round in Kleros Core, not in the Dispute Kit.
* @return The number of coherent jurors.
*/
function getCoherentCount(uint256 _disputeID, uint256 _round) external view returns (uint256);
function getCoherentCount(uint256 _coreDisputeID, uint256 _coreRoundID) external view returns (uint256);

/** @dev Returns true if all of the jurors have cast their commits for the last round.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @return Whether all of the jurors have cast their commits for the last round.
*/
function areCommitsAllCast(uint256 _coreDisputeID) external view returns (bool);

/** @dev Returns true if all of the jurors have cast their votes for the last round.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @return Whether all of the jurors have cast their votes for the last round.
*/
function areVotesAllCast(uint256 _coreDisputeID) external view returns (bool);

/** @dev Returns true if the specified voter was active in this round.
* @param _disputeID The ID of the dispute in Kleros Core.
* @param _round The ID of the round.
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
* @param _coreRoundID The ID of the round in Kleros Core, not in the Dispute Kit.
* @param _voteID The ID of the voter.
* @return Whether the voter was active or not.
*/
function isVoteActive(
uint256 _disputeID,
uint256 _round,
uint256 _coreDisputeID,
uint256 _coreRoundID,
uint256 _voteID
) external view returns (bool);

function getRoundInfo(
uint256 _disputeID,
uint256 _round,
uint256 _coreDisputeID,
uint256 _coreRoundID,
uint256 _choice
)
external
Expand All @@ -99,8 +118,8 @@ interface IDisputeKit {
);

function getVoteInfo(
uint256 _disputeID,
uint256 _round,
uint256 _coreDisputeID,
uint256 _coreRoundID,
uint256 _voteID
)
external
Expand Down
Loading