fix: token whitelist for DisputeKitGated and DisputeKitGatedShutter

Author: jaybuidl

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

@@ -204,7 +204,7 @@ abstract contract DisputeKitClassicBase is IDisputeKit, Initializable, UUPSProxi
         uint256 _numberOfChoices,
         bytes calldata _extraData,
         uint256 /*_nbVotes*/
-    ) external override onlyByCore {
+    ) public virtual override onlyByCore {
         uint256 localDisputeID;
         Dispute storage dispute;
         Active storage active = coreDisputeIDToActive[_coreDisputeID];

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

@@ -29,6 +29,12 @@ interface IBalanceHolderERC1155 {
 contract DisputeKitGated is DisputeKitClassicBase {
     string public constant override version = "2.0.0";
 
+    // ************************************* //
+    // *             Storage               * //
+    // ************************************* //
+
+    mapping(address token => bool supported) public supportedTokens; // Whether the token is supported or not.
+
     // ************************************* //
     // *            Constructor            * //
     // ************************************* //
@@ -62,6 +68,34 @@ contract DisputeKitGated is DisputeKitClassicBase {
         // NOP
     }
 
+    /// @notice Changes the supported tokens.
+    /// @param _tokens The tokens to support.
+    /// @param _supported Whether the tokens are supported or not.
+    function changeSupportedTokens(address[] memory _tokens, bool _supported) external onlyByOwner {
+        for (uint256 i = 0; i < _tokens.length; i++) {
+            supportedTokens[_tokens[i]] = _supported;
+        }
+    }
+
+    // ************************************* //
+    // *         State Modifiers           * //
+    // ************************************* //
+
+    /// @inheritdoc DisputeKitClassicBase
+    function createDispute(
+        uint256 _coreDisputeID,
+        uint256 _coreRoundID,
+        uint256 _numberOfChoices,
+        bytes calldata _extraData,
+        uint256 _nbVotes
+    ) public override {
+        (address tokenGate, , ) = _extraDataToTokenInfo(_extraData);
+        if (!supportedTokens[tokenGate]) revert TokenNotSupported(tokenGate);
+
+        // super.createDispute() ensures access control onlyByCore.
+        super.createDispute(_coreDisputeID, _coreRoundID, _numberOfChoices, _extraData, _nbVotes);
+    }
+
     // ************************************* //
     // *            Internal               * //
     // ************************************* //
@@ -78,7 +112,7 @@ contract DisputeKitGated is DisputeKitClassicBase {
     /// @return tokenId The token ID for ERC-1155 tokens (ignored for ERC-20/ERC-721).
     function _extraDataToTokenInfo(
         bytes memory _extraData
-    ) public pure returns (address tokenGate, bool isERC1155, uint256 tokenId) {
+    ) internal pure returns (address tokenGate, bool isERC1155, uint256 tokenId) {
         // Need at least 160 bytes to safely read the parameters
         if (_extraData.length < 160) return (address(0), false, 0);
 
@@ -116,4 +150,10 @@ contract DisputeKitGated is DisputeKitClassicBase {
             return IBalanceHolder(tokenGate).balanceOf(_juror) > 0;
         }
     }
+
+    // ************************************* //
+    // *              Errors               * //
+    // ************************************* //
+
+    error TokenNotSupported(address tokenGate);
 }

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

@@ -34,6 +34,7 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
     // *             Storage               * //
     // ************************************* //
 
+    mapping(address token => bool supported) public supportedTokens; // Whether the token is supported or not.
     mapping(uint256 localDisputeID => mapping(uint256 localRoundID => mapping(uint256 voteID => bytes32 recoveryCommitment)))
         public recoveryCommitments;
 
@@ -96,10 +97,34 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
         // NOP
     }
 
+    /// @notice Changes the supported tokens.
+    /// @param _tokens The tokens to support.
+    /// @param _supported Whether the tokens are supported or not.
+    function changeSupportedTokens(address[] memory _tokens, bool _supported) external onlyByOwner {
+        for (uint256 i = 0; i < _tokens.length; i++) {
+            supportedTokens[_tokens[i]] = _supported;
+        }
+    }
+
     // ************************************* //
     // *         State Modifiers           * //
     // ************************************* //
 
+    /// @inheritdoc DisputeKitClassicBase
+    function createDispute(
+        uint256 _coreDisputeID,
+        uint256 _coreRoundID,
+        uint256 _numberOfChoices,
+        bytes calldata _extraData,
+        uint256 _nbVotes
+    ) public override {
+        (address tokenGate, , ) = _extraDataToTokenInfo(_extraData);
+        if (!supportedTokens[tokenGate]) revert TokenNotSupported(tokenGate);
+
+        // super.createDispute() ensures access control onlyByCore.
+        super.createDispute(_coreDisputeID, _coreRoundID, _numberOfChoices, _extraData, _nbVotes);
+    }
+
     /// @notice Sets the caller's commit for the specified votes.
     ///
     /// @dev It can be called multiple times during the commit period, each call overrides the commits of the previous one.
@@ -209,7 +234,7 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
     /// @return tokenGate The address of the token contract used for gating access.
     /// @return isERC1155 True if the token is an ERC-1155, false for ERC-20/ERC-721.
     /// @return tokenId The token ID for ERC-1155 tokens (ignored for ERC-20/ERC-721).
-    function __extraDataToTokenInfo(
+    function _extraDataToTokenInfo(
         bytes memory _extraData
     ) internal pure returns (address tokenGate, bool isERC1155, uint256 tokenId) {
         // Need at least 160 bytes to safely read the parameters
@@ -237,7 +262,7 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
         // Get the local dispute and extract token info from extraData
         uint256 localDisputeID = coreDisputeIDToLocal[_coreDisputeID];
         Dispute storage dispute = disputes[localDisputeID];
-        (address tokenGate, bool isERC1155, uint256 tokenId) = __extraDataToTokenInfo(dispute.extraData);
+        (address tokenGate, bool isERC1155, uint256 tokenId) = _extraDataToTokenInfo(dispute.extraData);
 
         // If no token gate is specified, allow all jurors
         if (tokenGate == address(0)) return true;
@@ -254,5 +279,6 @@ contract DisputeKitGatedShutter is DisputeKitClassicBase {
     // *              Errors               * //
     // ************************************* //
 
+    error TokenNotSupported(address tokenGate);
     error EmptyRecoveryCommit();
 }

contracts/test/arbitration/dispute-kit-gated.ts

@@ -5,7 +5,7 @@ import {
   KlerosCore,
   SortitionModule,
   IncrementalNG,
-  DisputeKitGated,
+  DisputeKitGatedMock,
   TestERC20,
   TestERC721,
   TestERC1155,
@@ -14,6 +14,7 @@ import { expect } from "chai";
 import { Courts } from "../../deploy/utils";
 import { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers";
 import { deployERC1155, deployERC721 } from "../../deploy/utils/deployTokens";
+import { deployUpgradable } from "../../deploy/utils/deployUpgradable";
 
 /* eslint-disable no-unused-vars */
 /* eslint-disable no-unused-expressions */ // https://github.com/standard/standard/issues/690#issuecomment-278533482
@@ -26,7 +27,7 @@ describe("DisputeKitGated", async () => {
   let deployer: string;
   let juror1: HardhatEthersSigner;
   let juror2: HardhatEthersSigner;
-  let disputeKitGated: DisputeKitGated;
+  let disputeKitGated: DisputeKitGatedMock;
   let pnk: PNK;
   let dai: TestERC20;
   let core: KlerosCore;
@@ -47,12 +48,25 @@ describe("DisputeKitGated", async () => {
       fallbackToGlobal: true,
       keepExistingDeployments: false,
     });
-    disputeKitGated = await ethers.getContract<DisputeKitGated>("DisputeKitGated");
+
     pnk = await ethers.getContract<PNK>("PNK");
     dai = await ethers.getContract<TestERC20>("DAI");
+    const weth = await ethers.getContract<TestERC20>("WETH");
     core = await ethers.getContract<KlerosCore>("KlerosCore");
     sortitionModule = await ethers.getContract<SortitionModule>("SortitionModule");
 
+    const deploymentResult = await deployUpgradable(deployments, "DisputeKitGatedMock", {
+      from: deployer,
+      proxyAlias: "UUPSProxy",
+      args: [deployer, core.target, weth.target, 1],
+      log: true,
+    });
+    await core.addNewDisputeKit(deploymentResult.address);
+    const disputeKitGatedID = (await core.getDisputeKitsLength()) - 1n;
+    await core.enableDisputeKits(Courts.GENERAL, [disputeKitGatedID], true); // enable disputeKitGated on the General Court
+
+    disputeKitGated = await ethers.getContract<DisputeKitGatedMock>("DisputeKitGatedMock");
+
     // Make the tests more deterministic with this dummy RNG
     await deployments.deploy("IncrementalNG", {
       from: deployer,
@@ -123,7 +137,7 @@ describe("DisputeKitGated", async () => {
     const extraData = encodeExtraData(courtId, minJurors, disputeKitId, tokenGate, isERC1155, tokenId);
     // console.log("extraData", extraData);
 
-    const tokenInfo = await disputeKitGated._extraDataToTokenInfo(extraData);
+    const tokenInfo = await disputeKitGated.extraDataToTokenInfo(extraData);
     expect(tokenInfo[0]).to.equal(tokenGate);
     expect(tokenInfo[1]).to.equal(isERC1155);
     expect(tokenInfo[2]).to.equal(tokenId);