feat: applied the changes to the GatedShutter DK

Author: jaybuidl

contracts/src/arbitration/dispute-kits/DisputeKitGatedShutter.sol

@@ -30,6 +30,19 @@ interface IBalanceHolderERC1155 {
 contract DisputeKitGatedShutter is DisputeKitClassicBase {
     string public constant override version = "0.13.0";
 
+    // ************************************* //
+    // *             Storage               * //
+    // ************************************* //
+
+    mapping(uint256 localDisputeID => mapping(uint256 localRoundID => mapping(uint256 voteID => bytes32 recoveryCommitment)))
+        public recoveryCommitments;
+
+    // ************************************* //
+    // *        Transient Storage          * //
+    // ************************************* //
+
+    bool transient callerIsJuror;
+
     // ************************************* //
     // *              Events               * //
     // ************************************* //
@@ -38,12 +51,14 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
     /// @param _coreDisputeID The identifier of the dispute in the Arbitrator contract.
     /// @param _juror The address of the juror casting the vote commitment.
     /// @param _commit The commitment hash.
+    /// @param _recoveryCommit The commitment hash without the justification.
     /// @param _identity The Shutter identity used for encryption.
     /// @param _encryptedVote The Shutter encrypted vote.
     event CommitCastShutter(
         uint256 indexed _coreDisputeID,
         address indexed _juror,
         bytes32 indexed _commit,
+        bytes32 _recoveryCommit,
         bytes32 _identity,
         bytes _encryptedVote
     );
@@ -96,17 +111,29 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
     /// @param _coreDisputeID The ID of the dispute in Kleros Core.
     /// @param _voteIDs The IDs of the votes.
     /// @param _commit The commitment hash including the justification.
+    /// @param _recoveryCommit The commitment hash without the justification.
     /// @param _identity The Shutter identity used for encryption.
     /// @param _encryptedVote The Shutter encrypted vote.
     function castCommitShutter(
         uint256 _coreDisputeID,
         uint256[] calldata _voteIDs,
         bytes32 _commit,
+        bytes32 _recoveryCommit,
         bytes32 _identity,
         bytes calldata _encryptedVote
     ) external notJumped(_coreDisputeID) {
+        if (_recoveryCommit == bytes32(0)) revert EmptyRecoveryCommit();
+
+        uint256 localDisputeID = coreDisputeIDToLocal[_coreDisputeID];
+        Dispute storage dispute = disputes[localDisputeID];
+        uint256 localRoundID = dispute.rounds.length - 1;
+        for (uint256 i = 0; i < _voteIDs.length; i++) {
+            recoveryCommitments[localDisputeID][localRoundID][_voteIDs[i]] = _recoveryCommit;
+        }
+
+        // `_castCommit()` ensures that the caller owns the vote
         _castCommit(_coreDisputeID, _voteIDs, _commit);
-        emit CommitCastShutter(_coreDisputeID, msg.sender, _commit, _identity, _encryptedVote);
+        emit CommitCastShutter(_coreDisputeID, msg.sender, _commit, _recoveryCommit, _identity, _encryptedVote);
     }
 
     function castVoteShutter(
@@ -119,8 +146,12 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
         Dispute storage dispute = disputes[coreDisputeIDToLocal[_coreDisputeID]];
         address juror = dispute.rounds[dispute.rounds.length - 1].votes[_voteIDs[0]].account;
 
-        // _castVote() ensures that all the _voteIDs do belong to `juror`
+        callerIsJuror = juror == msg.sender;
+
+        // `_castVote()` ensures that all the `_voteIDs` do belong to `juror`
         _castVote(_coreDisputeID, _voteIDs, _choice, _salt, _justification, juror);
+
+        callerIsJuror = false;
     }
 
     // ************************************* //
@@ -138,15 +169,38 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
         uint256 _choice,
         uint256 _salt,
         string memory _justification
-    ) public pure override returns (bytes32) {
-        bytes32 justificationHash = keccak256(bytes(_justification));
-        return keccak256(abi.encode(_choice, _salt, justificationHash));
+    ) public view override returns (bytes32) {
+        if (callerIsJuror) {
+            // Caller is the juror, hash without `_justification` to facilitate recovery.
+            return keccak256(abi.encodePacked(_choice, _salt));
+        } else {
+            // Caller is not the juror, hash with `_justification`.
+            bytes32 justificationHash = keccak256(bytes(_justification));
+            return keccak256(abi.encode(_choice, _salt, justificationHash));
+        }
     }
 
     // ************************************* //
     // *            Internal               * //
     // ************************************* //
 
+    /// @dev Returns the expected vote hash for a given vote.
+    /// @param _localDisputeID The ID of the dispute in the Dispute Kit.
+    /// @param _localRoundID The ID of the round in the Dispute Kit.
+    /// @param _voteID The ID of the vote.
+    /// @return The expected vote hash.
+    function _getExpectedVoteHash(
+        uint256 _localDisputeID,
+        uint256 _localRoundID,
+        uint256 _voteID
+    ) internal view override returns (bytes32) {
+        if (callerIsJuror) {
+            return recoveryCommitments[_localDisputeID][_localRoundID][_voteID];
+        } else {
+            return disputes[_localDisputeID].rounds[_localRoundID].votes[_voteID].commit;
+        }
+    }
+
     /// @dev Extracts token gating information from the extra data.
     /// @param _extraData The extra data bytes array with the following encoding:
     ///        - bytes 0-31: uint96 courtID, not used here
@@ -197,4 +251,10 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
             return IBalanceHolder(tokenGate).balanceOf(_juror) > 0;
         }
     }
+
+    // ************************************* //
+    // *              Errors               * //
+    // ************************************* //
+
+    error EmptyRecoveryCommit();
 }