search

zeta-chain / protocol-contracts

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

feat: setters for name and symbol in zrc20 #329

Closed skosito closed 3 months ago

skosito commented 3 months ago

closes: #327

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (14) * `v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayzevm.sol/gatewayzevm.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/senderzevm.sol/senderzevm.go` is excluded by `!v2/pkg/**` * `v2/pkg/systemcontract.sol/systemcontract.go` is excluded by `!v2/pkg/**` * `v2/pkg/systemcontractmock.sol/systemcontractmock.go` is excluded by `!v2/pkg/**` * `v2/pkg/zrc20.sol/zrc20.go` is excluded by `!v2/pkg/**` * `v2/pkg/zrc20.t.sol/zrc20test.go` is excluded by `!v2/pkg/**` * `v2/types/factories/GatewayZEVM__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/SenderZEVM__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/SystemContract.sol/SystemContract__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/SystemContractMock.sol/SystemContractMock__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ZRC20.sol/ZRC20__factory.ts` is excluded by `!v2/types/**`

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough ## Walkthrough The recent changes to the `ZRC20` contract introduce two new external functions, `setName` and `setSymbol`, which allow the designated `fungibleModule` to update the token's name and symbol dynamically. This enhancement improves the contract's flexibility, enabling it to adapt its metadata according to evolving requirements. Additionally, corresponding updates were made to the `IZRC20` interface and associated tests to ensure access control and functionality are properly validated. ## Changes | Files | Change Summary | |------------------------------------------|-----------------------------------------------------------------------------------------------| | `v2/src/zevm/ZRC20.sol`, `v2/src/zevm/interfaces/IZRC20.sol` | Added `setName` and `setSymbol` functions for dynamic token metadata updates, restricted to fungible accounts. | | `v2/test/ZRC20.t.sol` | Implemented tests for updating name and symbol, including access control verification. | ## Assessment against linked issues | Objective | Addressed | Explanation | |---------------------------------------------------------|-----------|-----------------------------------------| | Add a SetName and SetSymbol function in ZRC20 (✔️327) | ✅ | |

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.
codecov-commenter commented 3 months ago

Codecov Report

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

Please upload report for BASE (main@1261cb4). Learn more about missing BASE report.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #329 +/- ## ======================================= Coverage ? 82.35% ======================================= Files ? 7 Lines ? 306 Branches ? 99 ======================================= Hits ? 252 Misses ? 54 Partials ? 0 ```

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