refactor: rename name to zrc20_address for MsgRemoveForeignCoin by mohitsethia · Pull Request #2484 · zeta-chain/node

mohitsethia · 2024-07-15T16:57:50Z

Description

fixes: #1650

MsgRemoveForeignCoin is used to remove a foreign coin (object tracking ZRC20s)

The message contains a field "Name" that represents the index. The actual index is the address of the ZRC20

Name field should therefore be renamed into ZRC20Address

How Has This Been Tested?

Summary by CodeRabbit

Documentation
- Updated documentation to reflect the change from name to zrc20_address in the MsgRemoveForeignCoin message.
Refactor
- Renamed the name field to zrc20_address in message structures and function signatures across various files for consistency and clarity.

coderabbitai · 2024-07-15T16:57:57Z

Walkthrough

The primary change involves renaming the name field to zrc20_address in the MsgRemoveForeignCoin message across multiple files, ensuring consistency and clarity in addressing ZRC20 tokens. This affects various layers, including documentation, protocol buffers, TypeScript definitions, and Go code, aligning the message structure with its intended usage.

Changes

Files/Paths	Change Summary
`docs/spec/fungible/messages.md`	Renamed `name` field to `zrc20_address` in `MsgRemoveForeignCoin` message structure.
`proto/zetachain/zetacore/fungible/tx.proto`	Modified `MsgRemoveForeignCoin` by changing the `name` field to `zrc20_address`.
`typescript/zetachain/zetacore/fungible/tx_pb.d.ts`	Renamed `name` to `zrc20Address` in `MsgRemoveForeignCoin` class.
`x/fungible/types/message_remove_foreign_coin.go`	Changed `NewMsgRemoveForeignCoin` function signature to replace `name` with `zrc20_address`.
`x/fungible/keeper/msg_server_remove_foreign_coin.go`	Updated `RemoveForeignCoin` function to use `msg.Zrc20Address` instead of `msg.Name` for indexing.

Assessment against linked issues

Objective	Addressed	Explanation
Rename `Name` field to `ZRC20Address` in `MsgRemoveForeignCoin`	✅

Poem

In code's vast land, a change we've made,
From name to zrc20_address, it's clear in trade.
Tokens now align with precise address,
A small tweak, yet ensuring no mess.
Code flows, like a river's grace,
Proclaiming progress, in every space.
Hooray for clarity, in the codebase race! 🌟

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- 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 Configration 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 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7363b33 and 0ebb1c9.

Files ignored due to path filters (1)

x/fungible/types/tx.pb.go is excluded by !**/*.pb.go, !**/*.pb.go

Files selected for processing (5)

docs/spec/fungible/messages.md (1 hunks)
proto/zetachain/zetacore/fungible/tx.proto (1 hunks)
typescript/zetachain/zetacore/fungible/tx_pb.d.ts (1 hunks)
x/fungible/keeper/msg_server_remove_foreign_coin.go (1 hunks)
x/fungible/types/message_remove_foreign_coin.go (1 hunks)

Files skipped from review due to trivial changes (1)

x/fungible/keeper/msg_server_remove_foreign_coin.go

Additional context used

Path-based instructions (2)

x/fungible/types/message_remove_foreign_coin.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

proto/zetachain/zetacore/fungible/tx.proto (1)

Pattern **/*.proto: Review the Protobuf definitions, point out issues relative to compatibility, and expressiveness.

Markdownlint

docs/spec/fungible/messages.md

59-59: Column: 1
Hard tabs

(MD010, no-hard-tabs)

Additional comments not posted (4)

x/fungible/types/message_remove_foreign_coin.go (1)

13-16: LGTM!

The renaming from name to zrc20_address is consistent and improves clarity.

proto/zetachain/zetacore/fungible/tx.proto (1)

76-76: LGTM!

The renaming from name to zrc20_address is consistent and improves clarity.

docs/spec/fungible/messages.md (1)

59-59: LGTM!

The renaming from name to zrc20_address is consistent and improves clarity.

Tools

Markdownlint

59-59: Column: 1
Hard tabs

(MD010, no-hard-tabs)

typescript/zetachain/zetacore/fungible/tx_pb.d.ts (1)

279-281: LGTM!

The renaming from name to zrc20Address is consistent and improves clarity.

x/fungible/types/message_remove_foreign_coin.go

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0ebb1c9 and b8664c6.

Files selected for processing (1)

x/fungible/types/message_remove_foreign_coin.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

x/fungible/types/message_remove_foreign_coin.go

* rename name to zrc20_address for MsgRemoveForeignCoin * update variable name

rename name to zrc20_address for MsgRemoveForeignCoin

0ebb1c9

mohitsethia requested review from brewmaster012, fbac, kingpinXD, lumtis, skosito, swift1337 and ws4charlie as code owners July 15, 2024 16:57

github-actions bot added the breaking:proto label Jul 15, 2024

coderabbitai bot reviewed Jul 15, 2024

View reviewed changes

lumtis reviewed Jul 16, 2024

View reviewed changes

x/fungible/types/message_remove_foreign_coin.go Outdated Show resolved Hide resolved

update variable name

b8664c6

coderabbitai bot reviewed Jul 16, 2024

View reviewed changes

lumtis approved these changes Jul 16, 2024

View reviewed changes

fbac approved these changes Jul 17, 2024

View reviewed changes

fbac added this pull request to the merge queue Jul 17, 2024

Merged via the queue into zeta-chain:develop with commit abc15c8 Jul 17, 2024

mohitsethia deleted the refactor-MsgRemoveForeignCoin-name-field branch July 17, 2024 10:21

morde08 pushed a commit that referenced this pull request Jul 17, 2024

refactor: rename name to zrc20_address for MsgRemoveForeignCoin (#2484)

d29bc63

* rename name to zrc20_address for MsgRemoveForeignCoin * update variable name

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: rename name to zrc20_address for MsgRemoveForeignCoin#2484

refactor: rename name to zrc20_address for MsgRemoveForeignCoin#2484
fbac merged 2 commits intozeta-chain:developfrom
mohitsethia:refactor-MsgRemoveForeignCoin-name-field

mohitsethia commented Jul 15, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 15, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

mohitsethia commented Jul 15, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mohitsethia commented Jul 15, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 15, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)