search

zeta-chain / toolkit

A library of ZetaChain helper utilities, contracts, and Hardhat tasks for smart-contract development
MIT License
43 stars 22 forks source link

Refactor gateway functions #186

Closed fadeev closed 1 month ago

fadeev commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
:memo: Walkthrough ## Walkthrough The changes involve significant modifications to several functions within the codebase, primarily focusing on restructuring their parameter handling. The functions now accept a unified `args` object that includes nested `revertOptions` and `txOptions`, replacing multiple individual parameters. This restructuring applies to functions such as `evmCall`, `evmDeposit`, `evmDepositAndCall`, `zetachainCall`, `zetachainWithdraw`, and `zetachainWithdrawAndCall`. Additionally, new TypeScript types for `revertOptions` and `txOptions` have been introduced to standardize the handling of transaction and revert-related parameters. ## Changes | Files | Change Summary | |--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `packages/client/src/evmCall.ts` | Updated `evmCall` to accept a structured `args` object with `revertOptions` and `txOptions`, replacing multiple parameters. Changed `types` from a JSON string to an array of strings. | | `packages/client/src/evmDeposit.ts` | Modified `evmDeposit` to use a structured `args` object, consolidating parameters into `revertOptions` and `txOptions`. | | `packages/client/src/evmDepositAndCall.ts`| Restructured `evmDepositAndCall` to include `revertOptions` and `txOptions` in the `args` object, simplifying parameter handling. | | `packages/client/src/types.ts` | Introduced new TypeScript types: `revertOptions` and `txOptions` for structured handling of transaction and revert scenarios. | | `packages/client/src/zetachainCall.ts` | Updated `zetachainCall` to utilize a structured `args` object with `revertOptions` and `txOptions`, removing several individual parameters. | | `packages/client/src/zetachainWithdraw.ts`| Modified `zetachainWithdraw` to accept a structured `args` object, consolidating multiple parameters into `revertOptions` and `txOptions`. | | `packages/client/src/zetachainWithdrawAndCall.ts` | Restructured `zetachainWithdrawAndCall` to include `revertOptions` and `txOptions` in the `args` object, enhancing clarity and organization. | | `packages/tasks/src/evmCall.ts` | Updated `evmCall` task to reflect changes in parameter structure, grouping related options into `revertOptions` and `txOptions`. | | `packages/tasks/src/evmDeposit.ts` | Modified `evmDeposit` task to encapsulate parameters into `revertOptions` and `txOptions` objects. | | `packages/tasks/src/evmDepositAndCall.ts` | Restructured `evmDepositAndCall` task to include `revertOptions` and `txOptions`, updating parameter handling accordingly. | | `packages/tasks/src/zetachainCall.ts` | Updated `zetachainCall` task to reorganize parameters into nested objects for clarity, reflecting changes in the function's signature. | | `packages/tasks/src/zetachainWithdraw.ts` | Modified `zetachainWithdraw` task to consolidate parameters into `revertOptions` and `txOptions`, ensuring consistency with function changes. | | `packages/tasks/src/zetachainWithdrawAndCall.ts` | Restructured `zetachainWithdrawAndCall` task to include `revertOptions` and `txOptions`, updating parameter definitions for clarity. | ## Possibly related PRs - **#183**: The changes in the `evmCall`, `evmDeposit`, and `evmDepositAndCall` functions involve restructuring parameters to include `revertOptions` and `txOptions`, which aligns with the updates made in the `Revert.sol` file that introduces `RevertOptions` for managing revert scenarios.

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?

:heart: 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)
:placard: 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 , please review it.` - `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 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 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 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 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` anywhere in the PR title to generate the title automatically. ### 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.
fadeev commented 1 month ago

@coderabbitai review

coderabbitai[bot] commented 1 month ago
:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
fadeev commented 1 month ago

@zeta-chain/fullstack @andresaiello please, review.