feat(x/tx): add an option to encode maps using amino json

[johnletey]

Description

Closes: #XXXX

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features
  • Enhanced JSON encoder with optional map marshaling support
• Improvements
  • Added configurable map marshaling option for Amino JSON encoder
  • Provides more flexibility in handling complex data structures during encoding

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce new boolean fields MarshalMappings in EncoderOptions and marshalMappings in Encoder within the Amino JSON encoding package. These additions provide a configurable option to enable marshaling of map types during JSON encoding. The modification allows the encoder to handle map types conditionally, with the ability to use a specific JSON marshaling approach when the marshalMappings option is set to true.

Changes

File	Change Summary
x/tx/signing/aminojson/json_marshal.go	- Added MarshalMappings bool to EncoderOptions struct - Added marshalMappings bool to Encoder struct - Modified marshal method to conditionally handle map type marshaling

Sequence Diagram

sequenceDiagram
    participant Client
    participant Encoder
    participant JSONMarshaler

    Client->>Encoder: Encode with MarshalMappings=true
    Encoder->>JSONMarshaler: jsonMarshal map
    JSONMarshaler-->>Encoder: Marshaled map
    Encoder-->>Client: Encoded result

    Client->>Encoder: Encode with MarshalMappings=false
    Encoder-->>Client: Error: Maps not supported

Loading

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

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

🧹 Nitpick comments (2)

x/tx/signing/aminojson/json_marshal.go (2)

244-246: Enhance map marshaling implementation.

Consider the following improvements:

1. Make the error message more descriptive when marshalMappings is false
2. Add validation for map key types to prevent JSON marshaling errors
3. Consider type-specific handling for complex map values

 if enc.marshalMappings {
+    // Validate that map keys can be marshaled to JSON strings
+    if keyKind := val.MapKey().Kind(); keyKind != protoreflect.StringKind && 
+        !isNumericKind(keyKind) {
+        return fmt.Errorf("map keys of type %s cannot be marshaled to JSON", keyKind)
+    }
     return jsonMarshal(writer, value)
 }
-return errors.New("maps are not supported")
+return errors.New("map marshaling is disabled; enable with MarshalMappings option")

Add this helper function:

func isNumericKind(kind protoreflect.Kind) bool {
    switch kind {
    case protoreflect.Int32Kind, protoreflect.Int64Kind,
         protoreflect.Uint32Kind, protoreflect.Uint64Kind,
         protoreflect.FloatKind, protoreflect.DoubleKind:
        return true
    }
    return false
}

---

41-42: Consider documenting performance implications and usage patterns.

The map marshaling feature would benefit from:

1. Documentation about performance implications for large maps
2. Examples in the package documentation showing recommended usage patterns
3. Guidelines for when to use this feature versus alternative approaches

Also applies to: 62-62, 99-99, 244-246

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e9b16a4 and 94e1a03.

📒 Files selected for processing (1)

• x/tx/signing/aminojson/json_marshal.go (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

x/tx/signing/aminojson/json_marshal.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

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

• GitHub Check: tests (00)
• GitHub Check: Analyze
• GitHub Check: Summary

🔇 Additional comments (3)

x/tx/signing/aminojson/json_marshal.go (3)

41-42: LGTM! Well-documented option field.

The MarshalMappings field is clearly named and properly documented, following Go conventions.

---

62-62: LGTM! Well-structured internal field.

The marshalMappings field follows Go conventions for internal fields and maintains consistency with other encoder fields.

---

99-99: LGTM! Proper field initialization.

The marshalMappings field is correctly initialized from the options struct.

[aljo242]

Hey @johnletey do you mind sharing more about the use case of this feature as well as adding a test for this functionality?

[julienrbrt]

ACK.

I can add a test and changelog in x/tx when I do the wiring for autocli 👍🏾

[julienrbrt]

Hey @johnletey do you mind sharing more about the use case of this feature as well as adding a test for this functionality?

For context, AutoCLI doesn't support queries that have map field in them. AutoCLI uses the x/tx json marshaller, so when we need to extend feature, we extend those features in x/tx as an option.
In a follow-up I can open the PR that wires it to AutoCLI and add test. IIRC John didn't had capacity to add a test this commit: dd3d264 but this is a requested feature, so we can easily have a follow-up on it.