chore!: remove duplicate non-hexlified event attributes.

[DimitrisJim]

Description

closes: #5990

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

• Targeted PR against the correct branch (see CONTRIBUTING.md).
• Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
• Code follows the module structure standards and Go style guide.
• Wrote unit and integration tests.
• Updated relevant documentation (docs/).
• Added relevant godoc comments.
• Provide a conventional commit message to follow the repository standards.
• Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
• Re-reviewed Files changed in the GitHub PR explorer.
• Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

• Refactor
  • Updated packet data handling to use hexadecimal encoding, improving data consistency and readability.
• Bug Fixes
  • Deprecated older attributes to streamline event handling processes.
• Tests
  • Enhanced testing for packet and acknowledgment data handling to ensure reliability in hexadecimal format decoding.

[coderabbitai]

Walkthrough

The code changes involve transitioning from deprecated attributes related to packet data handling to their hex-encoded versions. This transition ensures that event attributes are valid UTF-8 strings, aligning with newer technologies like CometBFT.

Changes

File Path	Change Summary
modules/core/04-channel/keeper/events.go	Removed deprecated attributes and replaced them with hex-encoded versions for packet data handling.
modules/core/04-channel/types/events.go	Deprecated old attributes in favor of hex-encoded versions for packet data.
testing/events.go	Updated parsing functions to handle hex-encoded data for packets and acknowledgments.
testing/events_test.go	Updated tests to use hex encoding for compatibility with the new attribute keys.

Assessment against linked issues

Objective	Addressed	Explanation
Remove deprecated packet_data and packet_ack attributes (#5990)	✅	The deprecated attributes have been replaced with hex-encoded versions, addressing the removal objective.
Ensure event attributes are valid UTF-8 strings to comply with Protobuf specification (#5990)	✅	The transition to hex-encoded versions ensures compliance with the Protobuf specification, meeting the requirement.
Streamline event data to contain only essential attributes, reducing redundancy (#5901)	❌	The changes focus on encoding adjustments rather than explicitly reducing the quantity of emitted data to streamline event attributes. Further evaluation may be needed for alignment with the objective.

Possibly related issues

• Trimming events to contain essential attributes only #5901: The changes in this PR could be considered a step towards optimizing event attributes by ensuring data integrity and compatibility, aligning with the broader objective of streamlining event data.

---

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>.
  • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[DimitrisJim]

Reminder: changelog entry.

[faddat]

nice one, thank you!

[DimitrisJim]

interchaintest appears to be using these.

[DimitrisJim]

gtg pending merge of strangelove-ventures/interchaintest#1077

[crodriguezvega]

Looks good to me. Thanks for opening the PR to interchaintest.

Once we merge this to main, should we trigger a run of the main compatibility tests just to check nothing breaks?

And we should add an entry in the migration docs for this (fine if you add the link to the PR for now and we can write the details later on).

[coderabbitai]

Actionable comments posted: 2

[damiannolan]

Nice one!

[damiannolan]

Do we wanna changelog this?

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (2)

CHANGELOG.md (2)

Line range hint 167-167: Consider using descriptive text for URLs to improve readability and accessibility.

---

Line range hint 182-182: Remove trailing spaces to maintain clean and professional formatting in the document.

- * (core/04-channel) [\#220](https://github.com/cosmos/ibc-go/pull/220) Channel legacy handler functions were removed. Please use the MsgServer functions or directly call the channel keeper's handshake function. 
+ * (core/04-channel) [\#220](https://github.com/cosmos/ibc-go/pull/220) Channel legacy handler functions were removed. Please use the MsgServer functions or directly call the channel keeper's handshake function.

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (4)

docs/docs/05-migrations/13-v8-to-v9.md (4)

Line range hint 8-8: Multiple top-level headings detected.

Consider using only one top-level heading to improve document structure and readability.

---

Line range hint 29-30: Add a space between sentences.

Consider adding a space after periods to improve readability in the document.

---

Line range hint 34-35: Trailing spaces detected.

Please remove trailing spaces to maintain clean and professional documentation.

---

Line range hint 78-78: Hard tabs detected in the document.

Replace hard tabs with spaces to maintain consistency in indentation across the document.

[colin-axner]

ACK

Note: this can be backported as a patch release if desired

[sonarcloud]

Quality Gate passed for 'ibc-go'

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud