fix: Naming in Protobuf #3064
fix: Naming in Protobuf #3064
Conversation
meerhat
requested review from
brewmaster012,
kingpinXD,
lumtis,
ws4charlie,
skosito,
swift1337 and
fbac
as code owners
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 Walkthrough📝 WalkthroughWalkthroughThis pull request implements a change in naming conventions for the property Changes
Possibly related PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
⛔ Files ignored due to path filters (1)
x/crosschain/types/cross_chain_tx.pb.gois 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
|
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. |
Description
Fix for #950
Changed the .proto file containing receiver_chainId to receiver_chain_id.
Summary by CodeRabbit
receiver_chainIdtoreceiver_chain_idin the OpenAPI specification for consistency.receiver_chainIdtoreceiver_chain_idin theOutboundParamsmessage to align with naming conventions.These changes enhance clarity and maintain consistency across the documentation and protocol definitions.