Skip to content

Commit 26c9955

Browse files
committed
refactor(DisputeKit): renamed params coreDisputeID/coreRoundID to avoid confusion with local IDs
1 parent 3a5b98a commit 26c9955

File tree

3 files changed

+207
-183
lines changed

3 files changed

+207
-183
lines changed

contracts/src/arbitration/IDisputeKit.sol

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -24,86 +24,86 @@ interface IDisputeKit {
2424

2525
/** @dev Creates a local dispute and maps it to the dispute ID in the Core contract.
2626
* Note: Access restricted to Kleros Core only.
27-
* @param _disputeID The ID of the dispute in Kleros Core.
27+
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
2828
* @param _numberOfChoices Number of choices of the dispute
2929
* @param _extraData Additional info about the dispute, for possible use in future dispute kits.
3030
*/
3131
function createDispute(
32-
uint256 _disputeID,
32+
uint256 _coreDisputeID,
3333
uint256 _numberOfChoices,
3434
bytes calldata _extraData
3535
) external;
3636

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

4444
// ************************************* //
4545
// * Public Views * //
4646
// ************************************* //
4747

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

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

6161
/** @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.
62-
* @param _disputeID The ID of the dispute in Kleros Core.
63-
* @param _round The ID of the round.
62+
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
63+
* @param _coreRoundID The ID of the round in Kleros Core, not in the Dispute Kit.
6464
* @param _voteID The ID of the vote.
6565
* @return The degree of coherence in basis points.
6666
*/
6767
function getDegreeOfCoherence(
68-
uint256 _disputeID,
69-
uint256 _round,
68+
uint256 _coreDisputeID,
69+
uint256 _coreRoundID,
7070
uint256 _voteID
7171
) external view returns (uint256);
7272

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

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

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

9292
/** @dev Returns true if the specified voter was active in this round.
93-
* @param _disputeID The ID of the dispute in Kleros Core.
94-
* @param _round The ID of the round.
93+
* @param _coreDisputeID The ID of the dispute in Kleros Core, not in the Dispute Kit.
94+
* @param _coreRoundID The ID of the round in Kleros Core, not in the Dispute Kit.
9595
* @param _voteID The ID of the voter.
9696
* @return Whether the voter was active or not.
9797
*/
9898
function isVoteActive(
99-
uint256 _disputeID,
100-
uint256 _round,
99+
uint256 _coreDisputeID,
100+
uint256 _coreRoundID,
101101
uint256 _voteID
102102
) external view returns (bool);
103103

104104
function getRoundInfo(
105-
uint256 _disputeID,
106-
uint256 _round,
105+
uint256 _coreDisputeID,
106+
uint256 _coreRoundID,
107107
uint256 _choice
108108
)
109109
external
@@ -118,8 +118,8 @@ interface IDisputeKit {
118118
);
119119

120120
function getVoteInfo(
121-
uint256 _disputeID,
122-
uint256 _round,
121+
uint256 _coreDisputeID,
122+
uint256 _coreRoundID,
123123
uint256 _voteID
124124
)
125125
external

0 commit comments

Comments
 (0)