Release

.github/workflows/contracts-testing.yml

@@ -15,73 +15,129 @@ on:
   pull_request:
     branches:
       - "*"
-      
-permissions:  # added using https://github.com/step-security/secure-workflows
+
+permissions: # added using https://github.com/step-security/secure-workflows
   contents: read
 
 jobs:
-  contracts-testing:
+  # *********************************************************************************** #
+  # ******************************* Hardhat Tests ************************************* #
+  # *********************************************************************************** #
+  hardhat-tests:
     runs-on: ubuntu-latest
     steps:
-    - name: Harden Runner
-      uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
-      with:
-        disable-sudo: false
-        egress-policy: block
-        allowed-endpoints: >
-          binaries.soliditylang.org:443
-          classic.yarnpkg.com:443
-          github.com:443
-          nightly.yarnpkg.com:443
-          nodejs.org:443
-          objects.githubusercontent.com:443
-          registry.yarnpkg.com:443
-          registry.npmjs.org:443
-          54.185.253.63:443
-
-    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      with:
-        submodules: recursive
-
-    - name: Set up corepack (for yarn)
-      run: |
-        corepack enable
-        corepack prepare [email protected] --activate
-        yarn set version 4.9.2
-
-    - name: Setup Node.js environment
-      uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
-      with:
-        node-version: 20.x   
-        cache: yarn
-
-    - name: Cache node modules
-      uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
-      env:
-        cache-name: cache-node-modules
-      with:
-        path: | 
-          ~/.npm
-          **/node_modules
-        key: ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-
-
-    - name: Install contracts dependencies
-      run: yarn workspace @kleros/kleros-v2-contracts install
-
-    - name: Install Foundry
-      uses: foundry-rs/foundry-toolchain@de808b1eea699e761c404bda44ba8f21aba30b2c # v1.3.1
-
-    - name: Install lcov
-      run: sudo apt-get install -y lcov
-
-    - name: Run Hardhat and Foundry tests with coverage
-      run: yarn coverage
-      working-directory: contracts
-
-    - name: Upload a build artifact
-      uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
-      with:    
-        name: code-coverage-report    
-        path: contracts/coverage
+      - name: Harden Runner
+        uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+        with:
+          disable-sudo: false
+          egress-policy: block
+          allowed-endpoints: >
+            binaries.soliditylang.org:443
+            classic.yarnpkg.com:443
+            github.com:443
+            nightly.yarnpkg.com:443
+            nodejs.org:443
+            objects.githubusercontent.com:443
+            registry.yarnpkg.com:443
+            registry.npmjs.org:443
+            54.185.253.63:443
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: recursive
+
+      - name: Set up corepack (for yarn)
+        run: |
+          corepack enable
+          corepack prepare [email protected] --activate
+          yarn set version 4.9.2
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
+        with:
+          node-version: 20.x
+          cache: yarn
+
+      - name: Cache node modules
+        uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: |
+            ~/.npm
+            **/node_modules
+          key: ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-
+
+      - name: Install contracts dependencies
+        run: yarn workspace @kleros/kleros-v2-contracts install
+
+      - name: Run Hardhat tests
+        run: yarn test
+        working-directory: contracts
+
+  # *********************************************************************************** #
+  # ******************************* Foundry Tests ************************************* #
+  # *********************************************************************************** #
+  # COMPILATION FAILS 🤬
+  # foundry-tests:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Harden Runner
+  #       uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
+  #       with:
+  #         disable-sudo: false
+  #         egress-policy: block
+  #         allowed-endpoints: >
+  #           binaries.soliditylang.org:443
+  #           classic.yarnpkg.com:443
+  #           github.com:443
+  #           nightly.yarnpkg.com:443
+  #           nodejs.org:443
+  #           objects.githubusercontent.com:443
+  #           registry.yarnpkg.com:443
+  #           registry.npmjs.org:443
+  #           54.185.253.63:443
+
+  #     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+  #       with:
+  #         submodules: recursive
+
+  #     - name: Set up corepack (for yarn)
+  #       run: |
+  #         corepack enable
+  #         corepack prepare [email protected] --activate
+  #         yarn set version 4.9.2
+
+  #     - name: Setup Node.js environment
+  #       uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
+  #       with:
+  #         node-version: 20.x
+  #         cache: yarn
+
+  #     - name: Cache node modules
+  #       uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
+  #       env:
+  #         cache-name: cache-node-modules
+  #       with:
+  #         path: |
+  #           ~/.npm
+  #           **/node_modules
+  #         key: ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}
+  #         restore-keys: |
+  #           ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-
+
+  #     # - name: Install contracts dependencies
+  #     #   run: yarn workspace @kleros/kleros-v2-contracts install
+
+  #     - name: Install Foundry
+  #       uses: foundry-rs/foundry-toolchain@82dee4ba654bd2146511f85f0d013af94670c4de # v1.4.0
+
+  #     - name: Run Foundry tests
+  #       run: forge test --config-path ./foundry.toml
+  #       working-directory: contracts
+
+  #     - name: Run snapshot
+  #       run: NO_COLOR=1 forge snapshot >> $GITHUB_STEP_SUMMARY
+  #       working-directory: contracts

contracts/.solcover.js

@@ -7,6 +7,7 @@ const shell = require("shelljs");
 module.exports = {
   istanbulReporter: ["lcov"],
   configureYulOptimizer: true,
+  irMinimum: true,
   onCompileComplete: async function (_config) {
     await run("typechain");
   },

contracts/CHANGELOG.md

@@ -4,7 +4,71 @@ All notable changes to this package will be documented in this file.
 
 The format is based on [Common Changelog](https://common-changelog.org/).
 
-## [0.11.0] - 2025-08-01
+## [0.13.0] - 2025-08-07 (Not published yet)
+
+### Changed
+
+- **Breaking:** Rename `KlerosCore.TokenAndETHShift` into `KlerosCore.JurorRewardPenalty` ([#2136](https://github.com/kleros/kleros-v2/issues/2136))
+- **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:** 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))
+- Make `IDisputeKit.draw()` and `ISortitionModule.draw()` return the court ID from which the juror was drawn ([#2107](https://github.com/kleros/kleros-v2/issues/2107))
+- Rename `SortitionModule.setJurorInactive()` to `SortitionModule.forcedUnstakeAllCourts()` ([#2107](https://github.com/kleros/kleros-v2/issues/2107))
+- Make the primary VRF-based RNG fall back to `BlockhashRNG` if the VRF request is not fulfilled within a timeout ([#2054](https://github.com/kleros/kleros-v2/issues/2054))
+- Authenticate the calls to the RNGs to prevent 3rd parties from depleting the Chainlink VRF subscription funds ([#2054](https://github.com/kleros/kleros-v2/issues/2054))
+- Use `block.timestamp` rather than `block.number` for `BlockhashRNG` for better reliability on Arbitrum as block production is sporadic depending on network conditions. ([#2054](https://github.com/kleros/kleros-v2/issues/2054))
+- Replace the `bytes32 _key` parameter in `SortitionTrees.createTree()` and `SortitionTrees.draw()` by `uint96 courtID` ([#2113](https://github.com/kleros/kleros-v2/issues/2113))
+- Extract the sortition sum trees logic into a library `SortitionTrees` ([#2113](https://github.com/kleros/kleros-v2/issues/2113))
+- Make `IDisputeKit.getDegreeOfCoherenceReward()` multi-dimensional so different calculations may be applied to PNK rewards, fee rewards and PNK penalties (future-proofing) ([#2090](https://github.com/kleros/kleros-v2/issues/2090))
+- Consolidate the constant `ALPHA_DIVISOR` with `ONE_BASIS_POINTS` ([#2090](https://github.com/kleros/kleros-v2/issues/2090))
+- Set the Hardhat Solidity version to v0.8.30 and enable the IR pipeline ([#2069](https://github.com/kleros/kleros-v2/issues/2069))
+- Set the Foundry Solidity version to v0.8.30 and enable the IR pipeline ([#2073](https://github.com/kleros/kleros-v2/issues/2073))
+- Widen the allowed solc version to any v0.8.x for the interfaces only ([#2083](https://github.com/kleros/kleros-v2/issues/2083))
+- Bump `hardhat` to v2.26.2 ([#2069](https://github.com/kleros/kleros-v2/issues/2069))
+- Bump `@kleros/vea-contracts` to v0.7.0 ([#2073](https://github.com/kleros/kleros-v2/issues/2073))
+
+### 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))
+- **Breaking:** Add a storage variable `recoveryCommitments` to `DisputeKitShutter` ([#2100](https://github.com/kleros/kleros-v2/issues/2100))
+- Allow the Shutter commitment to be recovered by the juror using only the salt and the choice, without having to provide the justification ([#2100](https://github.com/kleros/kleros-v2/issues/2100))
+- Allow the dispute kits to force an early court jump and to override the number of votes after an appeal (future-proofing) ([#2110](https://github.com/kleros/kleros-v2/issues/2110))
+- 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))
+- Do not emit the `KlerosCore.TokenAndETHShift` event if the both the PNK and fee amounts are zero ([#2135](https://github.com/kleros/kleros-v2/issues/2135))
+- Do not make PNK or ETH transfers if the amounts are zero ([#2135](https://github.com/kleros/kleros-v2/issues/2135))
+
+## [0.12.0] - 2025-08-05
+
+### Changed
+
+- **Breaking:** Make `viem` a peer dependency, it should be provided by the consuming package ([`4594536`](https://github.com/kleros/kleros-v2/commit/4594536c))
+
+### Added
+
+- Add helper function `getDisputeKitsViem` to retrieve a deployment's available dispute kit infos including their capabilities (`isShutter`, `isGated`) ([`5a81f9e`](https://github.com/kleros/kleros-v2/commit/5a81f9ec))
+
+## [0.11.0] - 2025-08-02
 
 ### Changed
 
@@ -107,6 +171,8 @@ The format is based on [Common Changelog](https://common-changelog.org/).
 
 ## [0.8.1] - 2025-04-10
 
+[0.13.0]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%[email protected]
+[0.12.0]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%[email protected]
 [0.11.0]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%[email protected]
 [0.10.0]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%[email protected]
 [0.9.4]: https://github.com/kleros/kleros-v2/releases/tag/@kleros%[email protected]