Merge pull request #2127 from kleros/feat/storage-gap

fix: update storage layout

Author: jaybuidl

contracts/CHANGELOG.md

@@ -8,10 +8,11 @@ The format is based on [Common Changelog](https://common-changelog.org/).
 
 ### Changed
 
+- **Breaking:** Add event parameter `KlerosCore.TokenAndETHShift._degreeOfCoherencyFee` and renamed the other parameters to `_degreeOfCoherencyPnk`, `_amountPnk`, `_amountFee` ([#2097](https://github.com/kleros/kleros-v2/issues/2097))
+- **Breaking:** Move state variable `DisputeKitClassicBase.nbVotes` to the `Round` struct ([#2097](https://github.com/kleros/kleros-v2/issues/2097))
 - **Breaking:** Stake the juror's PNK rewards instead of transferring them out ([#2099](https://github.com/kleros/kleros-v2/issues/2099))
 - **Breaking:** Replace `require()` with `revert()` and custom errors outside KlerosCore for consistency and smaller bytecode ([#2084](https://github.com/kleros/kleros-v2/issues/2084))
 - **Breaking:** Rename the interface from `RNG` to `IRNG` ([#2054](https://github.com/kleros/kleros-v2/issues/2054))
-- **Breaking:** Remove the `_block` parameter from `IRNG.requestRandomness()` and `IRNG.receiveRandomness()`, not needed for the primary VRF-based RNG ([#2054](https://github.com/kleros/kleros-v2/issues/2054))
 - **Breaking:** Rename `governor` to `owner` in order to comply with the lightweight ownership standard [ERC-5313](https://eipsinsight.com/ercs/erc-5313) ([#2112](https://github.com/kleros/kleros-v2/issues/2112))
 - **Breaking:** Apply the penalties to the stakes in the Sortition Tree ([#2107](https://github.com/kleros/kleros-v2/issues/2107))
 - **Breaking:** Make `SortitionModule.getJurorBalance().stakedInCourt` include the penalties ([#2107](https://github.com/kleros/kleros-v2/issues/2107))
@@ -32,6 +33,8 @@ The format is based on [Common Changelog](https://common-changelog.org/).
 
 ### Added
 
+- **Breaking:** Add storage gap arrays to `KlerosCore` structs `Round`, `Dispute` and `Court` ([#2097](https://github.com/kleros/kleros-v2/issues/2097))
+- **Breaking:** Add storage gap arrays to `DisputeKitClassicBase` state variables and to the structs `Round`, `Dispute` and `Vote` ([#2097](https://github.com/kleros/kleros-v2/issues/2097))
 - **Breaking:** Add a new field `drawnJurorFromCourtIDs` to the `Round` struct in `KlerosCoreBase` and `KlerosCoreUniversity` ([#2107](https://github.com/kleros/kleros-v2/issues/2107))
 - **Breaking:** Add a new state variable `jumpDisputeKitID` to the `DisputeKitClassicBase` contract ([#2114](https://github.com/kleros/kleros-v2/issues/2114))
 - **Breaking:** Add a parameter `_recoveryCommit` to the event `DisputeKitShutter.CommitCastShutter` ([#2100](https://github.com/kleros/kleros-v2/issues/2100))
@@ -41,6 +44,13 @@ The format is based on [Common Changelog](https://common-changelog.org/).
 - Allow the dispute kits to specify which new dispute kit to use when a court jump occurs ([#2114](https://github.com/kleros/kleros-v2/issues/2114))
 - Allow stake changes to by-pass delayed stakes when initiated by the SortitionModule by setting the `_noDelay` parameter to `true` in `SortitionModule.validateStake()` ([#2107](https://github.com/kleros/kleros-v2/issues/2107))
 
+### Removed
+
+- **Breaking:** Remove unused event parameters `IArbitrableV2.DisputeRequest._templateUri` ([#2097](https://github.com/kleros/kleros-v2/issues/2097))
+- **Breaking:** Remove deprecated `SortitionModule` state variables `alreadyTransferred`, `randomNumberRequestBlock`, `rngLookahead` and `latestDelayedStakeIndex` ([#2097](https://github.com/kleros/kleros-v2/issues/2097))
+- **Breaking:** Remove struct variable `DisputeKitClassicBase.Round.nbVotes` ([#2097](https://github.com/kleros/kleros-v2/issues/2097))
+- **Breaking:** Remove the `_block` parameter from `IRNG.requestRandomness()` and `IRNG.receiveRandomness()`, not needed for the primary VRF-based RNG ([#2054](https://github.com/kleros/kleros-v2/issues/2054))
+
 ### Fixed
 
 - Do not pass to Voting period if all the commits are cast because it breaks the current Shutter auto-reveal process. ([#2085](https://github.com/kleros/kleros-v2/issues/2085))

contracts/foundry.toml

@@ -10,6 +10,9 @@ src = 'src'
 out = 'out'
 libs = ['../node_modules', 'lib']
 
+[lint]
+severity = ['high', 'medium']
+
 [rpc_endpoints]
 arbitrumSepolia = "https://sepolia-rollup.arbitrum.io/rpc"
 arbitrum = "https://arb1.arbitrum.io/rpc"

contracts/package.json

@@ -87,8 +87,6 @@
     "watch": "hardhat watch",
     "natspec-smells": "natspec-smells",
     "docgen": "hardhat docgen",
-    "docserve": "scripts/docPreprocess.sh && forge doc --serve",
-    "docbuild": "scripts/docPreprocess.sh && forge doc --build --out dist && scripts/docPostprocess.sh",
     "populate:courts:devnet": "hardhat populate:courts --from v2_devnet  --network arbitrumSepoliaDevnet",
     "populate:courts:testnet": "hardhat populate:courts --from v2_testnet  --network arbitrumSepolia",
     "populate:courts:mainnet": "hardhat populate:courts --from v2_mainnet  --network arbitrum",

contracts/src/arbitration/DisputeTemplateRegistry.sol

@@ -6,18 +6,18 @@ import "../proxy/Initializable.sol";
 import "./interfaces/IDisputeTemplateRegistry.sol";
 
 /// @title Dispute Template Registry
-/// @dev A contract to maintain a registry of dispute templates.
+/// @notice A contract to maintain a registry of dispute templates.
 contract DisputeTemplateRegistry is IDisputeTemplateRegistry, UUPSProxiable, Initializable {
     string public constant override version = "2.0.0";
 
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
 
-    /// @dev The owner of the contract.
+    /// @notice The owner of the contract.
     address public owner;
 
-    /// @dev The number of templates.
+    /// @notice The number of templates.
     uint256 public templates;
 
     // ************************************* //
@@ -38,7 +38,7 @@ contract DisputeTemplateRegistry is IDisputeTemplateRegistry, UUPSProxiable, Ini
         _disableInitializers();
     }
 
-    /// @dev Initializer
+    /// @notice Initializer
     /// @param _owner Owner of the contract.
     function initialize(address _owner) external initializer {
         owner = _owner;
@@ -54,7 +54,7 @@ contract DisputeTemplateRegistry is IDisputeTemplateRegistry, UUPSProxiable, Ini
         // NOP
     }
 
-    /// @dev Changes the owner of the contract.
+    /// @notice Changes the owner of the contract.
     /// @param _owner The new owner.
     function changeOwner(address _owner) external onlyByOwner {
         owner = _owner;
@@ -64,10 +64,7 @@ contract DisputeTemplateRegistry is IDisputeTemplateRegistry, UUPSProxiable, Ini
     // *         State Modifiers           * //
     // ************************************* //
 
-    /// @dev Registers a new dispute template.
-    /// @param _templateTag The tag of the template (optional).
-    /// @param _templateData The data of the template.
-    /// @param _templateDataMappings The data mappings of the template.
+    /// @inheritdoc IDisputeTemplateRegistry
     function setDisputeTemplate(
         string memory _templateTag,
         string memory _templateData,