Support for Gated Dispute Kits and other improvements #2050

jaybuidl · 2025-07-22T03:05:45Z

This is a follow-up on #2045.

Changes

Support for Gated and GatedShutter dispute kits
Dispute Kit selection: when a court supports only 1 DK, select it by default.
DisputeKits matching by address
Future-proof DK-specific extraData encoding
Cursor focus on the input fields in the Resolver form

PR-Codex overview

This PR introduces support for gated dispute kits, enhancing the dispute management system with new functionalities and adjustments across various components.

Detailed summary

Added address field to disputeKit in useDisputeDetailsQuery.
Included disputeKitDispute with extraData in useRoundDetailsQuery.
Updated SubmitDisputeButton and SubmitBatchDisputesButton to handle disputeKitData.
Modified extractDisputeKitIDFromExtraData function to adjust byte extraction.
Introduced IDisputeKitData, IGatedDisputeData, and ISomeFutureDisputeData types in NewDisputeContext.
Enhanced various components to include isGated prop and functionality for gated dispute kits.
Implemented extraDataToTokenInfo utility to decode token information.
Added new dispute kit types and updated the subgraph configuration for DisputeKitGated and DisputeKitGatedShutter.
Adjusted prepareArbitratorExtradata to handle optional dispute kit data.
Updated voting and funding components to support gated dispute kits.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

New Features
- Added support for "gated" dispute kits with token gating parameters during dispute creation.
- Introduced hooks to fetch dispute kit names and addresses based on blockchain data.
- Enhanced court and dispute kit selection UI to handle gated dispute kits and related inputs.
Improvements
- Dispute kit identification updated to use blockchain addresses with exact name matching.
- Extradata preparation now supports extensible encoding for additional dispute kit data types.
- Added new subgraph data sources for gated dispute kits to improve event tracking.
- Updated dispute-related queries to include additional dispute kit data fields.
User Experience
- Multiple input fields across forms now auto-focus on mount for improved usability.
- Appeal and voting components updated to support gated dispute kits seamlessly.
Bug Fixes
- Enhanced accuracy and reliability in dispute kit name resolution and selection logic.

netlify · 2025-07-22T03:05:49Z

✅ Deploy Preview for kleros-v2-testnet ready!

Name	Link
🔨 Latest commit	`b5fff19`
🔍 Latest deploy log	https://app.netlify.com/projects/kleros-v2-testnet/deploys/6880ccda32474d000842026b
😎 Deploy Preview	https://deploy-preview-2050--kleros-v2-testnet.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-07-22T03:05:49Z

✅ Deploy Preview for kleros-v2-testnet-devtools ready!

Name	Link
🔨 Latest commit	`b5fff19`
🔍 Latest deploy log	https://app.netlify.com/projects/kleros-v2-testnet-devtools/deploys/6880ccda5bd74600088e7601
😎 Deploy Preview	https://deploy-preview-2050--kleros-v2-testnet-devtools.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-07-22T03:05:49Z

❌ Deploy Preview for kleros-v2-neo failed. Why did it fail? →

Name	Link
🔨 Latest commit	`b5fff19`
🔍 Latest deploy log	https://app.netlify.com/projects/kleros-v2-neo/deploys/6880ccdab1587c0008bc4372

coderabbitai · 2025-07-22T03:05:52Z

"""

Walkthrough

The changes replace ID- and environment-based dispute kit identification with a static enum and address-based logic. New hooks and types support dispute kit data, including gated kits. Several components are refactored to use address-based dispute kit resolution and to handle extra data for gated kits. UI enhancements enable auto-focusing and gated kit parameter entry.

Changes

File(s)	Change Summary
web/src/consts/index.ts	Removed environment/ID-based `getDisputeKitName` function; introduced static `DisputeKits` enum.
web/src/context/NewDisputeContext.tsx	Extended `IDisputeData` with optional `disputeKitData` (union type for gated/future); added new interfaces/types for dispute kit data.
web/src/hooks/queries/useDisputeDetailsQuery.ts, web/src/hooks/queries/useSupportedDisputeKits.ts	Updated GraphQL queries to include dispute kit `address` field in results.
web/src/hooks/useDisputeKitAddresses.ts	Added new hooks: `useDisputeKitAddresses` and `useDisputeKitAddressesAll` for resolving dispute kit names from addresses.
web/src/pages/Cases/CaseDetails/Appeal/index.tsx, web/src/pages/Cases/CaseDetails/Voting/index.tsx	Refactored to use address-based dispute kit identification via hooks and enum; removed substring checks and old function.
web/src/pages/Resolver/Briefing/Description.tsx, web/src/pages/Resolver/Briefing/Title.tsx, web/src/pages/Resolver/Parameters/Category.tsx, web/src/pages/Resolver/Parameters/VotingOptions/index.tsx	Added logic to auto-focus textarea/input fields on mount using refs and effects.
web/src/pages/Resolver/NavigationButtons/SubmitBatchDisputesButton.tsx, web/src/pages/Resolver/NavigationButtons/SubmitDisputeButton.tsx	Modified contract call argument: now includes `disputeKitData` in extradata preparation.
web/src/pages/Resolver/Parameters/Court.tsx	Major refactor: supports gated dispute kits with new UI fields, state, handlers, and uses address-based kit selection; adds styled components.
web/src/utils/prepareArbitratorExtradata.ts	Refactored to ABI-encode parameters; supports extensible, type-specific encoding for dispute kit data (gated/future); updated function signature.
web/src/hooks/queries/useRoundDetailsQuery.ts	Extended query to fetch `extraData` from `ClassicDispute` under `disputeKitDispute`.
web/src/pages/Resolver/Landing/index.tsx	Added memoized extraction of gated token info from dispute data extraData to update disputeKitData state.
web/src/utils/extradataToTokenInfo.ts	Added utility to decode gated token info (tokenGate, isERC1155, tokenId) from extraData hex string.
subgraph/core/src/utils.ts	Modified extraction of dispute kit ID from fixed slice of extraData bytes instead of from end slice.
subgraph/core/subgraph.template.yaml, subgraph/core/subgraph.yaml	Added new data sources for `DisputeKitGated` and `DisputeKitGatedShutter` with event handlers and ABIs.
web/src/pages/Cases/CaseDetails/Appeal/Classic/Fund.tsx, web/src/pages/Cases/CaseDetails/Appeal/Shutter/Fund.tsx	Extended appeal funding hooks and components to support gated dispute kits with conditional logic and props.
web/src/pages/Cases/CaseDetails/Appeal/Classic/index.tsx, web/src/pages/Cases/CaseDetails/Appeal/Shutter/index.tsx	Added `isGated` prop to appeal components and passed it to child components.
web/src/pages/Cases/CaseDetails/Voting/Classic/Commit.tsx, web/src/pages/Cases/CaseDetails/Voting/Classic/Reveal.tsx	Added `isGated` prop and conditional logic to select appropriate simulation hooks for gated dispute kits.
web/src/pages/Cases/CaseDetails/Voting/Classic/index.tsx	Added `isGated` prop and passed it to `Commit` and `Reveal` components.
web/src/pages/Cases/CaseDetails/Voting/Shutter/Commit.tsx, web/src/pages/Cases/CaseDetails/Voting/Shutter/index.tsx	Added `isGated` prop and conditional logic for gated dispute kits in commit component and parent.
web/src/pages/Cases/CaseDetails/Voting/Shutter/Reveal.tsx	Added `isGated` prop and conditional logic for gated dispute kits in reveal component.
web/src/utils/shutter.ts	Removed unused error parameters in catch blocks; refined return type of `encrypt` function.
web/src/pages/Cases/CaseDetails/MaintenanceButtons/DrawButton.tsx	Changed draw iterations calculation to min(100, 4 * numberOfVotes) for draw simulation hook argument.
web/src/pages/Resolver/Parameters/Jurors.tsx	Changed argument passed to `prepareArbitratorExtradata` from empty string to "0" when numberOfJurors is undefined.

Sequence Diagram(s)

sequenceDiagram participant UI_Component participant useDisputeKitAddresses participant ContractsJSON participant DisputeKitsEnum UI_Component->>useDisputeKitAddresses: Provide disputeKitAddress useDisputeKitAddresses->>ContractsJSON: Load contract addresses for current chain useDisputeKitAddresses->>DisputeKitsEnum: Match address to enum value useDisputeKitAddresses-->>UI_Component: Return {disputeKitName, isLoading, error}

sequenceDiagram participant CourtComponent participant User participant State participant prepareArbitratorExtradata User->>CourtComponent: Select dispute kit (possibly gated) CourtComponent->>State: Update isGatedDisputeKit, disputeKitData User->>CourtComponent: Enter token address/ID if gated CourtComponent->>prepareArbitratorExtradata: Prepare extradata with disputeKitData

Estimated code review effort

4 (~90 minutes)

Possibly related PRs

DisputeKit with token gating #1804: Implements on-chain smart contract logic for gated dispute kit; complements this PR’s frontend support for gated dispute kit data and UI.
feat: allow choosing the disputekit in the resolver flow #1987: Related dispute kit identification and UI selection changes; differs in approach but overlaps in dispute kit handling.
fix: invisible disputekit dropdown if no court selected #2040: Related to dispute kit dropdown rendering and gated dispute kit support in resolver parameters UI.

Suggested reviewers

jaybuidl
alcercu

Poem

A bunny hopped through fields of code,
Swapping IDs for enums in a static mode.
Now addresses lead the way,
With gates for tokens—hip hooray!
The UI’s sharper, the logic’s neat—
This rabbit’s work just can’t be beat! 🐇✨
"""

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce63962 and b5fff19.

📒 Files selected for processing (2)

web/src/pages/Cases/CaseDetails/Voting/Shutter/Reveal.tsx (4 hunks)
web/src/pages/Cases/CaseDetails/Voting/Shutter/index.tsx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

web/src/pages/Cases/CaseDetails/Voting/Shutter/Reveal.tsx
web/src/pages/Cases/CaseDetails/Voting/Shutter/index.tsx

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)

GitHub Check: Redirect rules - kleros-v2-university
GitHub Check: Redirect rules - kleros-v2-testnet-devtools
GitHub Check: Header rules - kleros-v2-university
GitHub Check: Header rules - kleros-v2-testnet-devtools
GitHub Check: Redirect rules - kleros-v2-testnet
GitHub Check: Pages changed - kleros-v2-university
GitHub Check: Redirect rules - kleros-v2-testnet
GitHub Check: Analyze (javascript)
GitHub Check: Pages changed - kleros-v2-testnet-devtools
GitHub Check: contracts-testing
GitHub Check: Header rules - kleros-v2-testnet
GitHub Check: Header rules - kleros-v2-testnet
GitHub Check: Pages changed - kleros-v2-testnet
GitHub Check: Pages changed - kleros-v2-testnet

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

netlify · 2025-07-22T03:08:16Z

❌ Deploy Preview for kleros-v2-university failed. Why did it fail? →

Name	Link
🔨 Latest commit	`b5fff19`
🔍 Latest deploy log	https://app.netlify.com/projects/kleros-v2-university/deploys/6880ccdabd085e0008bdb266

coderabbitai

Actionable comments posted: 10

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4ed9a0 and f5c1d67.

📒 Files selected for processing (15)

web/src/consts/index.ts (1 hunks)
web/src/context/NewDisputeContext.tsx (1 hunks)
web/src/hooks/queries/useDisputeDetailsQuery.ts (1 hunks)
web/src/hooks/queries/useSupportedDisputeKits.ts (2 hunks)
web/src/hooks/useDisputeKitAddresses.ts (1 hunks)
web/src/pages/Cases/CaseDetails/Appeal/index.tsx (2 hunks)
web/src/pages/Cases/CaseDetails/Voting/index.tsx (3 hunks)
web/src/pages/Resolver/Briefing/Description.tsx (4 hunks)
web/src/pages/Resolver/Briefing/Title.tsx (3 hunks)
web/src/pages/Resolver/NavigationButtons/SubmitBatchDisputesButton.tsx (1 hunks)
web/src/pages/Resolver/NavigationButtons/SubmitDisputeButton.tsx (1 hunks)
web/src/pages/Resolver/Parameters/Category.tsx (3 hunks)
web/src/pages/Resolver/Parameters/Court.tsx (2 hunks)
web/src/pages/Resolver/Parameters/VotingOptions/index.tsx (3 hunks)
web/src/utils/prepareArbitratorExtradata.ts (1 hunks)

🧠 Learnings (16)

📓 Common learnings

Learnt from: Harman-singh-waraich PR: kleros/kleros-v2#1703 File: kleros-sdk/src/utils/getDispute.ts:38-40 Timestamp: 2024-10-21T10:32:16.970Z Learning: The variables 'arbitrableChainID' and 'externalDisputeID' are required by the context to have uppercase 'ID', so they should remain unchanged even if the corresponding source properties use 'Id'.

Learnt from: tractorss PR: kleros/kleros-v2#1982 File: web/src/pages/Resolver/Landing/index.tsx:62-62 Timestamp: 2025-05-15T06:50:40.859Z Learning: In the Landing component, it's safe to pass `dispute?.dispute?.arbitrated.id as 0x${string}` to `usePopulatedDisputeData` without additional null checks because the hook internally handles undefined parameters through its `isEnabled` flag and won't execute the query unless all required data is available.

Learnt from: Harman-singh-waraich PR: kleros/kleros-v2#1703 File: web/src/hooks/queries/usePopulatedDisputeData.ts:58-61 Timestamp: 2024-10-14T13:58:25.708Z Learning: In `web/src/hooks/queries/usePopulatedDisputeData.ts`, the query and subsequent logic only execute when `disputeData.dispute?.arbitrableChainId` and `disputeData.dispute?.externalDisputeId` are defined, so `initialContext` properties based on these values are safe to use without additional null checks.

web/src/hooks/queries/useDisputeDetailsQuery.ts (12)

Learnt from: Harman-singh-waraich
PR: #1703
File: web/src/hooks/queries/usePopulatedDisputeData.ts:58-61
Timestamp: 2024-10-14T13:58:25.708Z
Learning: In web/src/hooks/queries/usePopulatedDisputeData.ts, the query and subsequent logic only execute when disputeData.dispute?.arbitrableChainId and disputeData.dispute?.externalDisputeId are defined, so initialContext properties based on these values are safe to use without additional null checks.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:62-62
Timestamp: 2025-05-15T06:50:40.859Z
Learning: In the Landing component, it's safe to pass dispute?.dispute?.arbitrated.id as 0x${string} to usePopulatedDisputeData without additional null checks because the hook internally handles undefined parameters through its isEnabled flag and won't execute the query unless all required data is available.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Parameters/NotablePersons/PersonFields.tsx:64-0
Timestamp: 2025-05-09T13:39:15.086Z
Learning: In PersonFields.tsx, the useEffect hook for address validation intentionally uses an empty dependency array to run only once on component mount. This is specifically designed for the dispute duplication flow when aliasesArray is already populated with addresses that need initial validation.

Learnt from: Harman-singh-waraich
PR: #1716
File: web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx:29-42
Timestamp: 2024-10-28T05:55:12.728Z
Learning: In the CustomContextInputs component located at web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx, the DisputeRequestParams array is used to exclude certain variables from the custom input since they are already provided in a preceding component. Therefore, converting it to a type is unnecessary.

Learnt from: Harman-singh-waraich
PR: #1755
File: kleros-app/src/lib/atlas/providers/AtlasProvider.tsx:130-144
Timestamp: 2024-11-21T05:47:08.973Z
Learning: In kleros-app/src/lib/atlas/providers/AtlasProvider.tsx, it is acceptable to pass queryClient as a positional parameter to the useQuery hook.

Learnt from: Harman-singh-waraich
PR: #1727
File: web/src/utils/atlas/updateEmail.ts:34-37
Timestamp: 2024-10-28T12:20:19.884Z
Learning: In web/src/utils/atlas/updateEmail.ts, the error coming from the GraphQLError array already has the necessary structure, so additional specificity in error handling is unnecessary.

Learnt from: jaybuidl
PR: #1647
File: web/src/context/NewDisputeContext.tsx:0-0
Timestamp: 2024-10-08T16:23:56.290Z
Learning: The delete operator is used in the constructDisputeTemplate function in web/src/context/NewDisputeContext.tsx to remove the policyURI field if it is an empty string.

Learnt from: jaybuidl
PR: #1647
File: web/src/context/NewDisputeContext.tsx:0-0
Timestamp: 2024-07-25T11:58:27.058Z
Learning: The delete operator is used in the constructDisputeTemplate function in web/src/context/NewDisputeContext.tsx to remove the policyURI field if it is an empty string.

Learnt from: nikhilverma360
PR: #1632
File: web/src/components/DisputeView/DisputeInfo/DisputeInfoList.tsx:37-42
Timestamp: 2024-06-27T10:11:54.861Z
Learning: useMemo is used in DisputeInfoList to optimize the rendering of FieldItems based on changes in fieldItems, ensuring that the mapping and truncation operation are only performed when necessary.

Learnt from: kemuru
PR: #1774
File: web/src/components/CasesDisplay/index.tsx:61-61
Timestamp: 2024-12-06T13:04:50.495Z
Learning: In web/src/components/CasesDisplay/index.tsx, the variables numberDisputes and numberClosedDisputes can sometimes be NaN, and should default to 0 using logical OR (||) to prevent display issues in the StatsAndFilters component.

Learnt from: kemuru
PR: #1702
File: web/src/pages/Home/TopJurors/JurorCard/index.tsx:10-11
Timestamp: 2024-10-08T16:23:56.291Z
Learning: In the kleros-v2 codebase, the property totalResolvedDisputes should remain and should not be renamed to totalResolvedVotes.

Learnt from: kemuru
PR: #1702
File: web/src/pages/Home/TopJurors/JurorCard/index.tsx:10-11
Timestamp: 2024-10-07T06:18:23.427Z
Learning: In the kleros-v2 codebase, the property totalResolvedDisputes should remain and should not be renamed to totalResolvedVotes.

web/src/pages/Resolver/NavigationButtons/SubmitBatchDisputesButton.tsx (10)

Learnt from: Harman-singh-waraich
PR: #1716
File: web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx:29-42
Timestamp: 2024-10-28T05:55:12.728Z
Learning: In the CustomContextInputs component located at web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx, the DisputeRequestParams array is used to exclude certain variables from the custom input since they are already provided in a preceding component. Therefore, converting it to a type is unnecessary.

Learnt from: Harman-singh-waraich
PR: #1703
File: web/src/hooks/queries/usePopulatedDisputeData.ts:58-61
Timestamp: 2024-10-14T13:58:25.708Z
Learning: In web/src/hooks/queries/usePopulatedDisputeData.ts, the query and subsequent logic only execute when disputeData.dispute?.arbitrableChainId and disputeData.dispute?.externalDisputeId are defined, so initialContext properties based on these values are safe to use without additional null checks.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:62-62
Timestamp: 2025-05-15T06:50:40.859Z
Learning: In the Landing component, it's safe to pass dispute?.dispute?.arbitrated.id as 0x${string} to usePopulatedDisputeData without additional null checks because the hook internally handles undefined parameters through its isEnabled flag and won't execute the query unless all required data is available.

Learnt from: jaybuidl
PR: #1647
File: web/src/context/NewDisputeContext.tsx:0-0
Timestamp: 2024-10-08T16:23:56.290Z
Learning: The delete operator is used in the constructDisputeTemplate function in web/src/context/NewDisputeContext.tsx to remove the policyURI field if it is an empty string.

Learnt from: jaybuidl
PR: #1647
File: web/src/context/NewDisputeContext.tsx:0-0
Timestamp: 2024-07-25T11:58:27.058Z
Learning: The delete operator is used in the constructDisputeTemplate function in web/src/context/NewDisputeContext.tsx to remove the policyURI field if it is an empty string.

Learnt from: Harman-singh-waraich
PR: #1703
File: kleros-sdk/src/utils/getDispute.ts:38-40
Timestamp: 2024-10-21T10:32:16.970Z
Learning: The variables 'arbitrableChainID' and 'externalDisputeID' are required by the context to have uppercase 'ID', so they should remain unchanged even if the corresponding source properties use 'Id'.

Learnt from: kemuru
PR: #1774
File: web/src/components/CasesDisplay/index.tsx:61-61
Timestamp: 2024-12-06T13:04:50.495Z
Learning: In web/src/components/CasesDisplay/index.tsx, the variables numberDisputes and numberClosedDisputes can sometimes be NaN, and should default to 0 using logical OR (||) to prevent display issues in the StatsAndFilters component.

Learnt from: Harman-singh-waraich
PR: #1703
File: kleros-sdk/src/dataMappings/utils/actionTypes.ts:25-25
Timestamp: 2024-10-22T09:35:14.098Z
Learning: In kleros-sdk/src/dataMappings/utils/actionTypes.ts, for the AbiCallMapping type, it's acceptable to use args: any[] since args can be anything.

Learnt from: Harman-singh-waraich
PR: #1703
File: kleros-sdk/src/utils/getDispute.ts:43-43
Timestamp: 2024-10-14T15:29:32.954Z
Learning: In the Kleros SDK, when using the populateTemplate function in kleros-sdk/src/utils/getDispute.ts, missing variables in Mustache templates are acceptable. Mustache fills in blanks, and it's preferable to return the partially populated template without throwing errors, as it's still helpful for the consumer.

Learnt from: Harman-singh-waraich
PR: #1727
File: web/src/context/AtlasProvider.tsx:159-171
Timestamp: 2024-10-29T06:46:13.522Z
Learning: Both SubmitEvidenceModal.tsx and Policy/index.tsx use the uploadFile function from AtlasProvider, which includes the fetchWithAuthErrorHandling error handling utility.

web/src/pages/Resolver/Briefing/Title.tsx (12)

Learnt from: kemuru
PR: #1764
File: web/src/components/ScrollTop.tsx:12-28
Timestamp: 2024-12-03T13:58:53.597Z
Learning: In the React component ScrollTop (web/src/components/ScrollTop.tsx), the effect hook is intentionally designed to execute only once, so dependencies are not added to the dependency array.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Parameters/NotablePersons/PersonFields.tsx:64-0
Timestamp: 2025-05-09T13:39:15.086Z
Learning: In PersonFields.tsx, the useEffect hook for address validation intentionally uses an empty dependency array to run only once on component mount. This is specifically designed for the dispute duplication flow when aliasesArray is already populated with addresses that need initial validation.

Learnt from: jaybuidl
PR: #1582
File: web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx:88-90
Timestamp: 2024-10-09T10:22:41.474Z
Learning: Next.js recommends using the useEffect hook to set isClient and using suppressHydrationWarning as a workaround for handling hydration inconsistencies, especially when dealing with data like knownArbitrables that may differ between server-side and client-side rendering. This approach is acceptable in TypeScript/React applications, such as in web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx.

Learnt from: Harman-singh-waraich
PR: #1794
File: web/src/hooks/useStarredCases.tsx:13-18
Timestamp: 2024-12-16T17:17:32.359Z
Learning: In useStarredCases.tsx, when handling the starredCases Map from local storage, direct mutation is acceptable to prevent the overhead of copying, provided it doesn't adversely affect React's render cycle.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:0-0
Timestamp: 2025-05-15T06:50:45.650Z
Learning: In the Kleros V2 codebase, it's acceptable to use ESLint disable comments for dependency arrays in useEffect hooks when including certain dependencies (like state that is being updated within the effect) would cause infinite loops.

Learnt from: nikhilverma360
PR: #1632
File: web/src/components/DisputeView/DisputeInfo/DisputeInfoList.tsx:37-42
Timestamp: 2024-06-27T10:11:54.861Z
Learning: useMemo is used in DisputeInfoList to optimize the rendering of FieldItems based on changes in fieldItems, ensuring that the mapping and truncation operation are only performed when necessary.

Learnt from: Harman-singh-waraich
PR: #1744
File: web/src/hooks/useGenesisBlock.ts:9-31
Timestamp: 2024-11-19T05:31:48.701Z
Learning: In useGenesisBlock.ts, within the useEffect hook, the conditions (isKlerosUniversity, isKlerosNeo, isTestnetDeployment) are mutually exclusive, so multiple imports won't execute simultaneously, and race conditions are not a concern.

Learnt from: Harman-singh-waraich
PR: #1694
File: web-devtools/package.json:33-35
Timestamp: 2024-09-27T10:07:54.013Z
Learning: react-toastify is used in the web-devtools project, particularly in layout.tsx, and should not be flagged as unused.

Learnt from: Harman-singh-waraich
PR: #1694
File: web-devtools/package.json:33-35
Timestamp: 2024-10-08T16:23:56.291Z
Learning: react-toastify is used in the web-devtools project, particularly in layout.tsx, and should not be flagged as unused.

Learnt from: Harman-singh-waraich
PR: #1716
File: web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx:29-42
Timestamp: 2024-10-28T05:55:12.728Z
Learning: In the CustomContextInputs component located at web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx, the DisputeRequestParams array is used to exclude certain variables from the custom input since they are already provided in a preceding component. Therefore, converting it to a type is unnecessary.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:62-62
Timestamp: 2025-05-15T06:50:40.859Z
Learning: In the Landing component, it's safe to pass dispute?.dispute?.arbitrated.id as 0x${string} to usePopulatedDisputeData without additional null checks because the hook internally handles undefined parameters through its isEnabled flag and won't execute the query unless all required data is available.

Learnt from: Harman-singh-waraich
PR: #1703
File: web/src/hooks/queries/usePopulatedDisputeData.ts:58-61
Timestamp: 2024-10-14T13:58:25.708Z
Learning: In web/src/hooks/queries/usePopulatedDisputeData.ts, the query and subsequent logic only execute when disputeData.dispute?.arbitrableChainId and disputeData.dispute?.externalDisputeId are defined, so initialContext properties based on these values are safe to use without additional null checks.

web/src/pages/Resolver/Briefing/Description.tsx (13)

Learnt from: kemuru
PR: #1764
File: web/src/components/ScrollTop.tsx:12-28
Timestamp: 2024-12-03T13:58:53.597Z
Learning: In the React component ScrollTop (web/src/components/ScrollTop.tsx), the effect hook is intentionally designed to execute only once, so dependencies are not added to the dependency array.

Learnt from: jaybuidl
PR: #1582
File: web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx:88-90
Timestamp: 2024-10-09T10:22:41.474Z
Learning: Next.js recommends using the useEffect hook to set isClient and using suppressHydrationWarning as a workaround for handling hydration inconsistencies, especially when dealing with data like knownArbitrables that may differ between server-side and client-side rendering. This approach is acceptable in TypeScript/React applications, such as in web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Parameters/NotablePersons/PersonFields.tsx:64-0
Timestamp: 2025-05-09T13:39:15.086Z
Learning: In PersonFields.tsx, the useEffect hook for address validation intentionally uses an empty dependency array to run only once on component mount. This is specifically designed for the dispute duplication flow when aliasesArray is already populated with addresses that need initial validation.

Learnt from: Harman-singh-waraich
PR: #1794
File: web/src/hooks/useStarredCases.tsx:13-18
Timestamp: 2024-12-16T17:17:32.359Z
Learning: In useStarredCases.tsx, when handling the starredCases Map from local storage, direct mutation is acceptable to prevent the overhead of copying, provided it doesn't adversely affect React's render cycle.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:0-0
Timestamp: 2025-05-15T06:50:45.650Z
Learning: In the Kleros V2 codebase, it's acceptable to use ESLint disable comments for dependency arrays in useEffect hooks when including certain dependencies (like state that is being updated within the effect) would cause infinite loops.

Learnt from: Harman-singh-waraich
PR: #1694
File: web-devtools/package.json:33-35
Timestamp: 2024-09-27T10:07:54.013Z
Learning: react-toastify is used in the web-devtools project, particularly in layout.tsx, and should not be flagged as unused.

Learnt from: Harman-singh-waraich
PR: #1694
File: web-devtools/package.json:33-35
Timestamp: 2024-10-08T16:23:56.291Z
Learning: react-toastify is used in the web-devtools project, particularly in layout.tsx, and should not be flagged as unused.

Learnt from: alcercu
PR: #1582
File: web-devtools/src/context/RulerContext.tsx:50-59
Timestamp: 2024-10-14T10:25:48.452Z
Learning: In React, setter functions returned by useState are stable between renders and don't need to be included in the dependency array of useEffect hooks.

Learnt from: Harman-singh-waraich
PR: #1716
File: web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx:29-42
Timestamp: 2024-10-28T05:55:12.728Z
Learning: In this project, JSDoc documentation is considered unnecessary for React components.

Learnt from: Harman-singh-waraich
PR: #1716
File: web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx:29-42
Timestamp: 2024-10-28T05:55:12.728Z
Learning: In the CustomContextInputs component located at web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx, the DisputeRequestParams array is used to exclude certain variables from the custom input since they are already provided in a preceding component. Therefore, converting it to a type is unnecessary.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:62-62
Timestamp: 2025-05-15T06:50:40.859Z
Learning: In the Landing component, it's safe to pass dispute?.dispute?.arbitrated.id as 0x${string} to usePopulatedDisputeData without additional null checks because the hook internally handles undefined parameters through its isEnabled flag and won't execute the query unless all required data is available.

Learnt from: nikhilverma360
PR: #1632
File: web/src/components/DisputeView/DisputeInfo/DisputeInfoList.tsx:37-42
Timestamp: 2024-06-27T10:11:54.861Z
Learning: useMemo is used in DisputeInfoList to optimize the rendering of FieldItems based on changes in fieldItems, ensuring that the mapping and truncation operation are only performed when necessary.

Learnt from: Harman-singh-waraich
PR: #1703
File: web/src/hooks/queries/usePopulatedDisputeData.ts:58-61
Timestamp: 2024-10-14T13:58:25.708Z
Learning: In web/src/hooks/queries/usePopulatedDisputeData.ts, the query and subsequent logic only execute when disputeData.dispute?.arbitrableChainId and disputeData.dispute?.externalDisputeId are defined, so initialContext properties based on these values are safe to use without additional null checks.

web/src/hooks/queries/useSupportedDisputeKits.ts (12)

Learnt from: Harman-singh-waraich
PR: #1703
File: web/src/hooks/queries/usePopulatedDisputeData.ts:58-61
Timestamp: 2024-10-14T13:58:25.708Z
Learning: In web/src/hooks/queries/usePopulatedDisputeData.ts, the query and subsequent logic only execute when disputeData.dispute?.arbitrableChainId and disputeData.dispute?.externalDisputeId are defined, so initialContext properties based on these values are safe to use without additional null checks.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:62-62
Timestamp: 2025-05-15T06:50:40.859Z
Learning: In the Landing component, it's safe to pass dispute?.dispute?.arbitrated.id as 0x${string} to usePopulatedDisputeData without additional null checks because the hook internally handles undefined parameters through its isEnabled flag and won't execute the query unless all required data is available.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Parameters/NotablePersons/PersonFields.tsx:64-0
Timestamp: 2025-05-09T13:39:15.086Z
Learning: In PersonFields.tsx, the useEffect hook for address validation intentionally uses an empty dependency array to run only once on component mount. This is specifically designed for the dispute duplication flow when aliasesArray is already populated with addresses that need initial validation.

Learnt from: Harman-singh-waraich
PR: #1716
File: web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx:29-42
Timestamp: 2024-10-28T05:55:12.728Z
Learning: In the CustomContextInputs component located at web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx, the DisputeRequestParams array is used to exclude certain variables from the custom input since they are already provided in a preceding component. Therefore, converting it to a type is unnecessary.

Learnt from: Harman-singh-waraich
PR: #1755
File: kleros-app/src/lib/atlas/providers/AtlasProvider.tsx:130-144
Timestamp: 2024-11-21T05:47:08.973Z
Learning: In kleros-app/src/lib/atlas/providers/AtlasProvider.tsx, it is acceptable to pass queryClient as a positional parameter to the useQuery hook.

Learnt from: Harman-singh-waraich
PR: #1850
File: web/src/context/GraphqlBatcher.tsx:25-41
Timestamp: 2025-01-27T11:25:08.246Z
Learning: In GraphQL batch operations using Promise.all, individual request errors should be caught and handled (e.g., returning {data: {}}) rather than thrown, to prevent a single failure from causing the entire batch to fail.

Learnt from: Harman-singh-waraich
PR: #1703
File: kleros-sdk/src/requests/fetchDisputeDetails.ts:14-27
Timestamp: 2024-10-23T14:05:15.987Z
Learning: Avoid using graphql-request in built libraries as it behaves unexpectedly.

Learnt from: jaybuidl
PR: #1582
File: web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx:88-90
Timestamp: 2024-10-09T10:22:41.474Z
Learning: Next.js recommends using the useEffect hook to set isClient and using suppressHydrationWarning as a workaround for handling hydration inconsistencies, especially when dealing with data like knownArbitrables that may differ between server-side and client-side rendering. This approach is acceptable in TypeScript/React applications, such as in web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx.

Learnt from: Harman-singh-waraich
PR: #1744
File: web/src/hooks/useGenesisBlock.ts:9-31
Timestamp: 2024-11-19T05:31:48.701Z
Learning: In useGenesisBlock.ts, within the useEffect hook, the conditions (isKlerosUniversity, isKlerosNeo, isTestnetDeployment) are mutually exclusive, so multiple imports won't execute simultaneously, and race conditions are not a concern.

Learnt from: Harman-singh-waraich
PR: #1703
File: kleros-sdk/src/requests/gqlClient.ts:18-18
Timestamp: 2024-10-24T08:16:02.749Z
Learning: In this TypeScript project, when a file (such as kleros-sdk/src/requests/gqlClient.ts) exports only a single entity, it's acceptable to use default exports instead of named exports.

Learnt from: nikhilverma360
PR: #1632
File: web/src/components/DisputeView/DisputeInfo/DisputeInfoList.tsx:37-42
Timestamp: 2024-06-27T10:11:54.861Z
Learning: useMemo is used in DisputeInfoList to optimize the rendering of FieldItems based on changes in fieldItems, ensuring that the mapping and truncation operation are only performed when necessary.

Learnt from: jaybuidl
PR: #1746
File: contracts/config/courts.v2.mainnet-neo.json:3-17
Timestamp: 2024-11-19T16:09:41.467Z
Learning: In contracts/config/courts.v2.mainnet-neo.json, the General Court (ID: 1) can have its parent ID set to itself ("parent": 1), as there is no parent court with ID 0 currently.

web/src/pages/Resolver/Parameters/VotingOptions/index.tsx (14)

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Parameters/NotablePersons/PersonFields.tsx:64-0
Timestamp: 2025-05-09T13:39:15.086Z
Learning: In PersonFields.tsx, the useEffect hook for address validation intentionally uses an empty dependency array to run only once on component mount. This is specifically designed for the dispute duplication flow when aliasesArray is already populated with addresses that need initial validation.

Learnt from: kemuru
PR: #1764
File: web/src/components/ScrollTop.tsx:12-28
Timestamp: 2024-12-03T13:58:53.597Z
Learning: In the React component ScrollTop (web/src/components/ScrollTop.tsx), the effect hook is intentionally designed to execute only once, so dependencies are not added to the dependency array.

Learnt from: jaybuidl
PR: #1582
File: web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx:88-90
Timestamp: 2024-10-09T10:22:41.474Z
Learning: Next.js recommends using the useEffect hook to set isClient and using suppressHydrationWarning as a workaround for handling hydration inconsistencies, especially when dealing with data like knownArbitrables that may differ between server-side and client-side rendering. This approach is acceptable in TypeScript/React applications, such as in web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx.

Learnt from: Harman-singh-waraich
PR: #1716
File: web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx:29-42
Timestamp: 2024-10-28T05:55:12.728Z
Learning: In the CustomContextInputs component located at web-devtools/src/app/(main)/dispute-template/CustomContextInputs.tsx, the DisputeRequestParams array is used to exclude certain variables from the custom input since they are already provided in a preceding component. Therefore, converting it to a type is unnecessary.

Learnt from: jaybuidl
PR: #1582
File: web-devtools/src/app/(main)/ruler/SelectArbitrable.tsx:98-103
Timestamp: 2024-10-09T10:23:39.325Z
Learning: In SelectArbitrable.tsx of the web-devtools project (React/TypeScript), direct DOM manipulation using child.click() is acceptable when considered reasonably safe.

Learnt from: Harman-singh-waraich
PR: #1739
File: web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx:22-26
Timestamp: 2024-11-07T10:48:16.774Z
Learning: In the Coherency component (web/src/pages/Home/TopJurors/JurorCard/Coherency.tsx), totalResolvedVotes is always greater than or equal to totalCoherentVotes. When both are zero, 0/0 results in NaN, which is acceptable in this context.

Learnt from: Harman-singh-waraich
PR: #1694
File: web-devtools/package.json:33-35
Timestamp: 2024-09-27T10:07:54.013Z
Learning: react-toastify is used in the web-devtools project, particularly in layout.tsx, and should not be flagged as unused.

Learnt from: Harman-singh-waraich
PR: #1694
File: web-devtools/package.json:33-35
Timestamp: 2024-10-08T16:23:56.291Z
Learning: react-toastify is used in the web-devtools project, particularly in layout.tsx, and should not be flagged as unused.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:0-0
Timestamp: 2025-05-15T06:50:45.650Z
Learning: In the Kleros V2 codebase, it's acceptable to use ESLint disable comments for dependency arrays in useEffect hooks when including certain dependencies (like state that is being updated within the effect) would cause infinite loops.

Learnt from: Harman-singh-waraich
PR: #1759
File: web/src/pages/Cases/CaseDetails/Appeal/Classic/Fund.tsx:140-143
Timestamp: 2024-11-26T10:50:23.399Z
Learning: In the Kleros-v2 React project, errors are handled by the wrapWithToast function, which displays error messages to users via toast notifications.

Learnt from: Harman-singh-waraich
PR: #1744
File: web/src/hooks/useGenesisBlock.ts:9-31
Timestamp: 2024-11-19T05:31:48.701Z
Learning: In useGenesisBlock.ts, within the useEffect hook, the conditions (isKlerosUniversity, isKlerosNeo, isTestnetDeployment) are mutually exclusive, so multiple imports won't execute simultaneously, and race conditions are not a concern.

Learnt from: tractorss
PR: #1982
File: web/src/pages/Resolver/Landing/index.tsx:62-62
Timestamp: 2025-05-15T06:50:40.859Z
Learning: In the Landing component, it's safe to pass dispute?.dispute?.arbitrated.id as 0x${string} to usePopulatedDisputeData without additional null checks because the hook internally handles undefined parameters through its isEnabled flag and won't execute the query unless all required data is available.

Learnt from: Harman-singh-waraich
PR: #1703
File: web/src/hooks/queries/usePopulatedDisputeData.ts:58-61
Timestamp: 2024-10-14T13:58:25.708Z
Learning: In web/src/hooks/queries/usePopulatedDisputeData.ts, the query and subsequent logic only execute when disputeData.dispute?.arbitrableChainId and disputeData.dispute?.externalDisputeId are defined, so initialContext properties based on these values are safe to use without additional null checks.

Learnt from: nikhilverma360
PR: #1632
File: web/src/components/DisputeView/DisputeInfo/DisputeInfoList.tsx:37-42
Timestamp: 2024-06-27T10:11:54.861Z
Learning: useMemo is used in DisputeInfoList to optimize the rendering of FieldItems based on changes in fieldItems, ensuring that the mapping and truncation operation are only performed when necessary.

web/src/pages/Resolver/Parameters/Category.tsx (11)