feat(sdk): use zod directly for validating dispute templates

kemuru commented 1 month ago

regarding zod, I've put some logs detailing exactly why the template validation failed in case it did, you can check with F12 when you're inside a dispute

Summary by CodeRabbit

New Features
- Enhanced validation with new isHexAddress and isHexId functions.
Improvements
- Made several fields optional in schemas to increase flexibility (e.g., attachment, frontendUrl, category, lang, specification, aliases).
- Introduced a new property arbitrableChainID for better context in dispute data.
Refactor
- Updated validation logic to use DisputeDetailsSchema for improved consistency and error handling.
- Renamed properties for clarity regarding their purpose (e.g., arbitrable to arbitrableAddress).

PR-Codex overview

The focus of this PR is to update addresses and add validation in dispute-related functionalities.

Detailed summary

Updated addresses in various files for consistency
Replaced DisputeDetailsValidator with DisputeDetailsSchema for validation
Added DEFAULT_CHAIN import for cross-chain disputes
Improved address validation in disputeDetailsSchema
Made certain fields optional in AnswerSchema and AliasSchema
Added optional fields and refined validations in DisputeDetailsSchema

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

coderabbitai[bot] commented 1 month ago

Walkthrough

These updates significantly enhance the validation and schema structure within the Kleros SDK. New utility functions for validating hexadecimal strings improve address validation, while several schema fields have been made optional to increase flexibility. The transition to a record type for aliases and the temporary use of strings for addresses indicate a clear path for future enhancements, ensuring the SDK remains robust and adaptable.

Changes

File	Change Summary
kleros-sdk/src/dataMappings/utils/disputeDetailsSchema.ts	Added `isHexAddress` and `isHexId` validation functions; made fields optional in `AnswerSchema` and `DisputeDetailsSchema`; changed `AliasSchema` to a record type; updated address fields to temporary string usage.
kleros-sdk/src/dataMappings/utils/populateTemplate.ts	Replaced `DisputeDetailsValidator` with `DisputeDetailsSchema` for validation, updating the logic accordingly.
kleros-sdk/src/dataMappings/executeActions.ts	Changed parameter from `context.arbitrable` to `context.arbitrableAddress` in `executeAction` function.
web/src/hooks/queries/usePopulatedDisputeData.ts	Renamed `arbitrable` to `arbitrableAddress` and introduced `arbitrableChainID` based on dispute context.
web/src/pages/DisputeTemplateView/index.tsx	Renamed properties `arbitrator` and `arbitrable` to `arbitratorAddress` and `arbitrableAddress` in `initialContext`.

Poem

In the land of code where bits align,
Hex checks bloom on the vine.
Fields optional, schemas wise,
Flexibility now takes the prize.
Bugs beware, for we refine,
Our dispute chain divine. 🐰💻🎉

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-university ready!

Name	Link
Latest commit	df2b3d92476369e08712810c9da434a3e7ba6dca
Latest deploy log	https://app.netlify.com/sites/kleros-v2-university/deploys/66aa7d5a4421ef0008c64cf7
Deploy Preview	https://deploy-preview-1635--kleros-v2-university.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 site configuration.

netlify[bot] commented 1 month ago

Deploy Preview for kleros-v2-neo ready!

Name	Link
Latest commit	df2b3d92476369e08712810c9da434a3e7ba6dca
Latest deploy log	https://app.netlify.com/sites/kleros-v2-neo/deploys/66aa7d5a431f5c000845a8be
Deploy Preview	https://deploy-preview-1635--kleros-v2-neo.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 site configuration.

netlify[bot] commented 1 month ago

Deploy Preview for kleros-v2-testnet ready!

Name	Link
Latest commit	df2b3d92476369e08712810c9da434a3e7ba6dca
Latest deploy log	https://app.netlify.com/sites/kleros-v2-testnet/deploys/66aa7d5b971ba700070167dc
Deploy Preview	https://deploy-preview-1635--kleros-v2-testnet.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.