search

zeta-chain / protocol-contracts

Protocol contracts implementing the core logic of the protocol, deployed on ZetaChain and on connected chains
MIT License
68 stars 55 forks source link

refactor: custody withdraw args swap #304

Closed skosito closed 1 month ago

skosito commented 1 month ago

swap token and recipient args in erc20 custody to keep compatibility with v1

did for all custody methods so that contract methods are consistent, no need to swap these args in other contracts imo, but if there is a need we can do it in other issue

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The overall change involves reordering parameters in the ERC20Custody contract's withdrawal functions for improved clarity and consistency. This adjustment affects function signatures, emitted events, and related tests across multiple files. The new order prioritizes the recipient address over the token address, enhancing usability and readability while maintaining the contract's underlying logic.

Changes

Files Change Summary
v2/pkg/.../erc20custody.go, v2/src/.../ERC20Custody.sol, v2/test/.../ERC20Custody.t.sol, v2/typechain-types/.../ERC20Custody.ts, v2/typechain-types/.../ERC20CustodyEchidnaTest.ts, v2/typechain-types/.../factories/ERC20Custody__factory.ts Parameter order changes in withdrawal methods (withdraw, withdrawAndCall, withdrawAndRevert) to improve clarity by placing the recipient address first. Updates to emitted events and tests are included.
v2/test/.../GatewayZEVM.t.sol Renaming and reordering test functions for clarity in zero address and zero amount conditions, enhancing maintainability.
v2/typechain-types/.../factories/GatewayEVMEchidnaTest__factory.ts Updates to bytecode and constructor parameters for improved type safety and clarity, reflecting optimizations in the contract's implementation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ERC20Custody
    participant Token

    User->>ERC20Custody: withdraw(to, token, amount)
    ERC20Custody->>Token: transfer(to, amount)
    ERC20Custody-->>User: Emit Withdraw Event

Poem

🐰 In the meadow where tokens play,
A rabbit hops with joy today.
Parameters danced, swapped around,
Clarity found on the ground.
With every change, we cheer and sing,
For simpler calls make our hearts spring! 🌼

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.
lumtis commented 1 month ago

@skosito another one that I think we could address in this PR: https://github.com/zeta-chain/protocol-contracts/issues/306

codecov-commenter commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.27%. Comparing base (6486dd8) to head (1df9eec).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #304 +/- ## ======================================= Coverage 83.27% 83.27% ======================================= Files 7 7 Lines 287 287 Branches 95 95 ======================================= Hits 239 239 Misses 48 48 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

skosito commented 1 month ago

@skosito another one that I think we could address in this PR: #306

@lumtis done, i changed all v2 events to be in past tense