fix: Naming in Protobuf

[meerhat]

Description

Fix for #950
Changed the .proto file containing receiver_chainId to receiver_chain_id.

Summary by CodeRabbit

• Chores
  • Updated property name from receiver_chainId to receiver_chain_id in the OpenAPI specification for consistency.
  • Renamed field receiver_chainId to receiver_chain_id in the OutboundParams message to align with naming conventions.

These changes enhance clarity and maintain consistency across the documentation and protocol definitions.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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

📝 Walkthrough

📝 Walkthrough

Walkthrough

This pull request implements a change in naming conventions for the property receiver_chainId, which is modified to receiver_chain_id across two files: the OpenAPI specification and a Protocol Buffers definition. The changes ensure consistency in naming conventions by adopting snake_case instead of camelCase. No alterations to the functionality, types, or structure of the existing code are introduced.

Changes

File Path	Change Summary
docs/openapi/openapi.swagger.yaml	Renamed property receiver_chainId to receiver_chain_id in definitions.
proto/zetachain/zetacore/crosschain/cross_chain_tx.proto	Renamed field receiver_chainId to receiver_chain_id in message OutboundParams.

Possibly related PRs

• fix: fix admin e2e tests and bump protocol contracts #3006: The changes in this PR involve renaming the field receiver_chainId to receiver_chain_id in the OutboundParams message, which directly relates to the same property name change in the OpenAPI specification file in the main PR.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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>, 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 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: 1

🧹 Outside diff range and nitpick comments (1)

proto/zetachain/zetacore/crosschain/cross_chain_tx.proto (1)

68-68: Consider documenting the breaking change for JSON compatibility.

While the wire format compatibility is maintained (field number 2 unchanged), this rename affects JSON serialization. Applications using JSON directly with Protocol Buffers should be updated.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9b285c2 and 3f56c9c.

⛔ Files ignored due to path filters (1)

• x/crosschain/types/cross_chain_tx.pb.go is excluded by !**/*.pb.go, !**/*.pb.go

📒 Files selected for processing (2)

• docs/openapi/openapi.swagger.yaml (1 hunks)
• proto/zetachain/zetacore/crosschain/cross_chain_tx.proto (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/openapi/openapi.swagger.yaml

🧰 Additional context used

📓 Path-based instructions (1)

proto/zetachain/zetacore/crosschain/cross_chain_tx.proto (1)

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

🔇 Additional comments (1)

proto/zetachain/zetacore/crosschain/cross_chain_tx.proto (1)

Line range hint 6-7: Address the pending TODO comment about descriptor numbers.

There's an open issue about fixing descriptor numbers that should be addressed.

Let's check the status of the referenced issue:

#!/bin/bash
# Check if the issue is still open
gh issue view 1951 --json state,title,body

[gartnera]

This is a breaking change and needs to be carefully considered.

[lumtis]

Hi @meerhat thanks for the contribution

However, as mentioned in the conversation, this will bring a breaking change. We're looking for now to avoid having breaking changes in the coming upgrades, we will so close this PR for the time being.

Feel free to continue the conversation on the associated issue. Thanks.