Skip to content

Commit 2670af8

Browse files
jaybuidljaybuidl
committed
refactor: voting and commitment casting events
1 parent e11467b commit 2670af8

File tree

4 files changed

+64
-10
lines changed

4 files changed

+64
-10
lines changed

‎contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol

+29-4
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,25 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
6868
// * Events * //
6969
// ************************************* //
7070

71+
/// @dev To be emitted when a dispute is created.
72+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
73+
/// @param _numberOfChoices The number of choices available in the dispute.
74+
/// @param _extraData The extra data for the dispute.
7175
event DisputeCreation(uint256 indexed _coreDisputeID, uint256 _numberOfChoices, bytes _extraData);
7276

73-
event CommitCast(uint256 indexed _coreDisputeID, uint256[] _voteIDs, bytes32 _commit);
74-
77+
/// @dev To be emitted when a vote commitment is cast.
78+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
79+
/// @param _juror The address of the juror casting the vote commitment.
80+
/// @param _voteIDs The identifiers of the votes in the dispute.
81+
/// @param _commit The commitment of the juror.
82+
event CommitCast(uint256 indexed _coreDisputeID, address indexed _juror, uint256[] _voteIDs, bytes32 _commit);
83+
84+
/// @dev To be emitted when a funding contribution is made.
85+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
86+
/// @param _coreRoundID The identifier of the round in the Arbitrator contract.
87+
/// @param _choice The choice that is being funded.
88+
/// @param _contributor The address of the contributor.
89+
/// @param _amount The amount contributed.
7590
event Contribution(
7691
uint256 indexed _coreDisputeID,
7792
uint256 indexed _coreRoundID,
@@ -80,6 +95,12 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
8095
uint256 _amount
8196
);
8297

98+
/// @dev To be emitted when the contributed funds are withdrawn.
99+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
100+
/// @param _coreRoundID The identifier of the round in the Arbitrator contract.
101+
/// @param _choice The choice that is being funded.
102+
/// @param _contributor The address of the contributor.
103+
/// @param _amount The amount withdrawn.
83104
event Withdrawal(
84105
uint256 indexed _coreDisputeID,
85106
uint256 indexed _coreRoundID,
@@ -88,6 +109,10 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
88109
uint256 _amount
89110
);
90111

112+
/// @dev To be emitted when a choice is fully funded for an appeal.
113+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
114+
/// @param _coreRoundID The identifier of the round in the Arbitrator contract.
115+
/// @param _choice The choice that is being funded.
91116
event ChoiceFunded(uint256 indexed _coreDisputeID, uint256 indexed _coreRoundID, uint256 indexed _choice);
92117

93118
// ************************************* //
@@ -200,7 +225,7 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
200225
round.votes[_voteIDs[i]].commit = _commit;
201226
}
202227
round.totalCommitted += _voteIDs.length;
203-
emit CommitCast(_coreDisputeID, _voteIDs, _commit);
228+
emit CommitCast(_coreDisputeID, msg.sender, _voteIDs, _commit);
204229
}
205230

206231
/// @dev Sets the caller's choices for the specified votes.
@@ -258,7 +283,7 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
258283
round.tied = false;
259284
}
260285
}
261-
emit Justification(_coreDisputeID, msg.sender, _choice, _justification);
286+
emit VoteCast(_coreDisputeID, msg.sender, _voteIDs, _choice, _justification);
262287
}
263288

264289
/// @dev Manages contributions, and appeals a dispute if at least two choices are fully funded.

‎contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol

+29-4
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,25 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
7878
// * Events * //
7979
// ************************************* //
8080

81+
/// @dev To be emitted when a dispute is created.
82+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
83+
/// @param _numberOfChoices The number of choices available in the dispute.
84+
/// @param _extraData The extra data for the dispute.
8185
event DisputeCreation(uint256 indexed _coreDisputeID, uint256 _numberOfChoices, bytes _extraData);
8286

83-
event CommitCast(uint256 indexed _coreDisputeID, uint256[] _voteIDs, bytes32 _commit);
84-
87+
/// @dev To be emitted when a vote commitment is cast.
88+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
89+
/// @param _juror The address of the juror casting the vote commitment.
90+
/// @param _voteIDs The identifiers of the votes in the dispute.
91+
/// @param _commit The commitment of the juror.
92+
event CommitCast(uint256 indexed _coreDisputeID, address indexed _juror, uint256[] _voteIDs, bytes32 _commit);
93+
94+
/// @dev To be emitted when a funding contribution is made.
95+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
96+
/// @param _coreRoundID The identifier of the round in the Arbitrator contract.
97+
/// @param _choice The choice that is being funded.
98+
/// @param _contributor The address of the contributor.
99+
/// @param _amount The amount contributed.
85100
event Contribution(
86101
uint256 indexed _coreDisputeID,
87102
uint256 indexed _coreRoundID,
@@ -90,6 +105,12 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
90105
uint256 _amount
91106
);
92107

108+
/// @dev To be emitted when the contributed funds are withdrawn.
109+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
110+
/// @param _coreRoundID The identifier of the round in the Arbitrator contract.
111+
/// @param _choice The choice that is being funded.
112+
/// @param _contributor The address of the contributor.
113+
/// @param _amount The amount withdrawn.
93114
event Withdrawal(
94115
uint256 indexed _coreDisputeID,
95116
uint256 indexed _coreRoundID,
@@ -98,6 +119,10 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
98119
uint256 _amount
99120
);
100121

122+
/// @dev To be emitted when a choice is fully funded for an appeal.
123+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
124+
/// @param _coreRoundID The identifier of the round in the Arbitrator contract.
125+
/// @param _choice The choice that is being funded.
101126
event ChoiceFunded(uint256 indexed _coreDisputeID, uint256 indexed _coreRoundID, uint256 indexed _choice);
102127

103128
// ************************************* //
@@ -220,7 +245,7 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
220245
round.votes[_voteIDs[i]].commit = _commit;
221246
}
222247
round.totalCommitted += _voteIDs.length;
223-
emit CommitCast(_coreDisputeID, _voteIDs, _commit);
248+
emit CommitCast(_coreDisputeID, msg.sender, _voteIDs, _commit);
224249
}
225250

226251
/// @dev Sets the caller's choices for the specified votes.
@@ -278,7 +303,7 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
278303
round.tied = false;
279304
}
280305
}
281-
emit Justification(_coreDisputeID, msg.sender, _choice, _justification);
306+
emit VoteCast(_coreDisputeID, msg.sender, _voteIDs, _choice, _justification);
282307
}
283308

284309
/// @dev Manages contributions, and appeals a dispute if at least two choices are fully funded.

‎contracts/src/arbitration/interfaces/IDisputeKit.sol

+4-2
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@ interface IDisputeKit {
1919
// ************************************ //
2020

2121
/// @dev Emitted when casting a vote to provide the justification of juror's choice.
22-
/// @param _coreDisputeID ID of the dispute in the core contract.
22+
/// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
2323
/// @param _juror Address of the juror.
24+
/// @param _voteIDs The identifiers of the votes in the dispute.
2425
/// @param _choice The choice juror voted for.
2526
/// @param _justification Justification of the choice.
26-
event Justification(
27+
event VoteCast(
2728
uint256 indexed _coreDisputeID,
2829
address indexed _juror,
30+
uint256[] _voteIDs,
2931
uint256 indexed _choice,
3032
string _justification
3133
);

‎contracts/src/gateway/interfaces/IForeignGateway.sol

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ interface IForeignGateway is IArbitratorV2, IReceiverGateway {
1616
/// @param _foreignBlockHash foreignBlockHash
1717
/// @param _foreignArbitrable The address of the Arbitrable contract.
1818
/// @param _foreignDisputeID The identifier of the dispute in the Arbitrable contract.
19+
/// @param _choices The number of choices the arbitrator can choose from in this dispute.
20+
/// @param _extraData Any extra data to attach.
1921
event CrossChainDisputeOutgoing(
2022
bytes32 _foreignBlockHash,
2123
address indexed _foreignArbitrable,

0 commit comments

Comments
 (0)