kleros / kleros-v2

Kleros version 2
https://v2.kleros.builders
MIT License
58 stars 41 forks source link

Refactor/evidence refactors #1634

Closed Harman-singh-waraich closed 1 month ago

Harman-singh-waraich commented 1 month ago

⚠️ Will need contract redeploys, natspec has been updated for EvidenceModule.

more info and context : https://hackmd.io/@-cmxt73kRVi2uFMhhabm4A/BkGylT58R

To be done :-


PR-Codex overview

This PR updates the Kleros v2 subgraph, adds full-text search feature, improves evidence submission handling, and enhances UI components.

Detailed summary

The following files were skipped due to too many changes: web/src/components/EvidenceCard.tsx, web/src/pages/Cases/CaseDetails/Evidence/SubmitEvidenceModal.tsx, subgraph/core/src/EvidenceModule.ts, web/src/pages/Cases/CaseDetails/Evidence/index.tsx

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

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes across various modules and files center around updating the way evidence is handled in the arbitration system. Instead of using IPFS paths, the system now expects a stringified JSON object containing fields like "name", "description", and "fileURI". Additionally, full-text search capabilities have been introduced, and several components were refactored to support these updates.

Changes

File Path Summary of Changes
contracts/src/arbitration/.../EvidenceModule.sol Changed submitEvidence to accept a stringified evidence object instead of an IPFS path.
contracts/src/arbitration/.../ModeratedEvidenceModule.sol Updated event and function parameter descriptions to use a stringified evidence object format.
contracts/src/arbitration/.../IEvidence.sol Modified Evidence event parameter to accept a stringified evidence object.
subgraph/core/schema.graphql Added fields like name, description, fileURI, fileTypeExtension to Evidence and ClassicEvidence types.
subgraph/core-neo/subgraph.yaml, subgraph/core-university/subgraph.yaml, subgraph/core/subgraph.yaml Introduced fullTextSearch feature and added KlerosCore data source for Ethereum.
subgraph/core/src/EvidenceModule.ts Enhanced handleEvidenceEvent to parse and extract fields from stringified evidence objects, with added error handling.
subgraph/package.json Updated project version from 0.5.1 to 0.7.0.
web/src/components/EvidenceCard.tsx Refactored EvidenceCard component to use new props for rendering evidence, removing reliance on useIPFSQuery.
web/src/hooks/queries/useEvidences.ts Updated evidencesQuery to include new evidence fields and specified type parameter for useQuery.
web/src/pages/Cases/CaseDetails/.../SubmitEvidenceModal.tsx Refactored submitEvidence function to handle evidence submission more efficiently and improved error handling.
web/src/pages/Cases/CaseDetails/.../index.tsx Refactored evidence display logic, added scroll-to-latest feature, and replaced several hooks and components.
web/src/pages/Cases/CaseDetails/.../EvidenceSearch.tsx Introduced EvidenceSearch component for searching evidence with dynamic filtering and blockchain connectivity checks.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend
    participant SmartContract
    participant IPFS

    User->>Frontend: SubmitEvidence (name, description, fileURI)
    Frontend->>IPFS: Upload file
    IPFS-->>Frontend: fileURI
    Frontend->>SmartContract: submitEvidence(externalDisputeID, evidenceJSON)
    SmartContract->>Frontend: Emit Evidence Event
    Frontend->>Frontend: handleEvidenceEvent
    Frontend->>Database: Save Evidence (parsed JSON)

Poem

A change in code, so swift and bright,
Evidence now in JSON light.
Fields of name, and description too,
Full-text search to find what's true.
A bunny hops with joy, delight,
For updates come and bugs take flight.
🌟🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@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.` 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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 1 month ago

Deploy Preview for kleros-v2 ready!

Name Link
Latest commit d1b6fe2b9b456562c5b034748509e06579c95dd8
Latest deploy log https://app.netlify.com/sites/kleros-v2/deploys/66992be2b15ba90008e05caa
Deploy Preview https://deploy-preview-1634--kleros-v2.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

netlify[bot] commented 1 month ago

Deploy Preview for kleros-v2-neo ready!

Name Link
Latest commit d1b6fe2b9b456562c5b034748509e06579c95dd8
Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/66992be2bd7df80008b18163
Deploy Preview https://deploy-preview-1634--kleros-v2-neo.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

netlify[bot] commented 1 month ago

Deploy Preview for kleros-v2-university ready!

Name Link
Latest commit d1b6fe2b9b456562c5b034748509e06579c95dd8
Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/66992be2e03865000889387a
Deploy Preview https://deploy-preview-1634--kleros-v2-university.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

codeclimate[bot] commented 1 month ago

Code Climate has analyzed commit d1b6fe2b and detected 15 issues on this pull request.

Here's the issue category breakdown:

Category Count
Complexity 2
Duplication 2
Style 11

View more on Code Climate.

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud