fix(evm): JSON encoding for the EIP55Addr struct was not following the Go conventions and needed to include double quotes around the hexadecimal string.

[Unique-Divine]

Purpose / Abstract

• Closes bug(evm): tx result of funtoken creation is invalid json #2128

Summary by CodeRabbit

• Bug Fixes

  • Improved JSON encoding for Ethereum addresses to follow Go conventions
  • Enhanced error handling during JSON marshaling and unmarshaling of addresses

• Tests

  • Added new test cases for JSON serialization of Ethereum addresses and message types
  • Verified JSON marshaling and unmarshaling integrity

[coderabbitai]

Walkthrough

This pull request addresses a bug in JSON encoding for the EIP55Addr struct in the Nibiru EVM module. The changes modify the JSON marshaling and unmarshaling methods to ensure proper encoding with double quotes around hexadecimal address strings. The modifications improve JSON serialization consistency and error handling across multiple files, including eth/eip55.go, eth/eip55_test.go, and x/evm/msg_test.go.

Changes

File	Change Summary
CHANGELOG.md	Added entry for bug fix #2154 related to JSON encoding
eth/eip55.go	Updated MarshalJSON and UnmarshalJSON methods to improve JSON handling and error reporting
eth/eip55_test.go	Modified test cases to reflect new JSON string formatting expectations
x/evm/msg_test.go	Added new TestMarshalJSON test function for JSON marshaling and unmarshaling

Assessment against linked issues

Objective	Addressed	Explanation
Fix invalid JSON for funtoken creation TX [#2128]	✅

Possibly related PRs

• fix(evm): erc20 born funtoken: properly burn bank coins after convert… #2139: Related to ERC20 funtoken bug fix involving JSON format handling
• fix(precompile): consume gas before returning error #2152: Improvements in JSON marshaling and error handling for Ethereum transactions

Suggested reviewers

• k-yang
• onikonychev

Poem

🐰 In the realm of bytes and JSON's might,
A rabbit hops to set encoding right
Double quotes now dance with glee
Around addresses, perfectly free!
JSON marshaling, no longer a fright! 🌈

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9c56a9 and 36e8d2f.

📒 Files selected for processing (4)

• CHANGELOG.md (1 hunks)
• eth/eip55.go (3 hunks)
• eth/eip55_test.go (4 hunks)
• x/evm/msg_test.go (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: integration-tests

🔇 Additional comments (6)

eth/eip55.go (2)

45-47: LGTM! Proper JSON encoding implementation.

The change to use json.Marshal ensures proper JSON encoding with quotes around the hexadecimal string, following Go conventions.

---

Line range hint 71-82: LGTM! Improved error handling and validation.

The UnmarshalJSON implementation now:

1. Properly unmarshals JSON string with validation
2. Provides descriptive error messages
3. Reuses existing validation logic through NewEIP55AddrFromStr

eth/eip55_test.go (2)

120-130: LGTM! Test cases properly verify JSON encoding.

The test cases correctly verify that addresses are JSON-encoded with quotes, aligning with the updated MarshalJSON implementation.

---

192-197: LGTM! Consistent test for string encoding.

The test properly verifies the JSON string format using fmt.Sprintf to construct the expected quoted output.

x/evm/msg_test.go (1)

986-1024: LGTM! Comprehensive JSON marshaling tests.

The test function thoroughly verifies:

1. JSON marshaling of Ethereum addresses
2. Round-trip marshaling of MsgCreateFunToken
3. Direct JSON unmarshaling from string literals

CHANGELOG.md (1)

72-74: LGTM! Clear and well-placed changelog entry.

The entry properly documents the JSON encoding fix for the EIP55Addr struct, with clear description and correct PR reference.

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

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