feat(x/tx): add aminoNameAsTypeURL option in aminojson encoder

[julienrbrt]

Description

Closes: #21261

Afterwards, I'll tag a new x/tx and bump it in autocli for 0.52 and 0.50 to make use of that new option.

before

$ simd q feegrant grant alice bob
allowance:
  allowance:
    type: cosmos-sdk/BasicAllowance
    value:
      spend_limit:
      - amount: "100"
        denom: stake
  grantee: cosmos18ac8zvrnaezk9unff26sre7c22r07frzw4yavs
  granter: cosmos1x4gsc5t9n646y5csw2wqz3rjsym0dz2fczkztf

after

$ simd q feegrant grant alice bob
  allowance:
    allowance:
      type: /cosmos.feegrant.v1beta1.BasicAllowance
      value:
        spend_limit:
        - amount: "100"
          denom: stake
    grantee: cosmos18ac8zvrnaezk9unff26sre7c22r07frzw4yavs
    granter: cosmos1x4gsc5t9n646y5csw2wqz3rjsym0dz2fczkztf

---

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 query handling with the type field now represented as a proto message URL.
  • Added support for off-chain signing and verification of files.
  • Introduced governance proposals for improved SDK functionality.

• Improvements

  • Improved Amino JSON encoder with the new AminoNameAsTypeURL option for better type URL handling.
  • Enhanced thread safety in context management for signers.

• Bug Fixes

  • Updated marshaling processes to accommodate new parameters for better encoding flexibility.

[coderabbitai]

Walkthrough

Walkthrough

The pull request introduces significant changes across multiple files in the client/v2 and x/tx modules. Key updates include enhancements to how the type field is marshaled in queries, shifting from amino name format to proto message URL. Additionally, support for off-chain signing and verification of files is added, along with modifications to the encoder options for improved handling of type URLs. The changes also involve the removal of address codecs from certain structures, necessitating adjustments in client implementations.

Changes

File Path	Change Summary
client/v2/CHANGELOG.md	Updated to include improvements in marshaling type field as proto message URL and added off-chain signing support. Noted API-breaking changes.
x/tx/CHANGELOG.md	Introduced AminoNameAsTypeURL option in Amino JSON encoder and improved context management with sync.Map.
x/tx/signing/aminojson/json_marshal.go	Added AminoNameAsTypeURL option in EncoderOptions, modified Marshal method, and updated beginMarshal to accommodate new parameters.
x/tx/signing/aminojson/json_marshal_test.go	Added TestAminoNameAsTypeURL to test marshaling with the new AminoNameAsTypeURL option.

Assessment against linked issues

Objective	Addressed	Explanation
AutoCLI deserializes Proto types into Amino types (#21261)	✅
Ensure type is represented as proto message name in responses (#21261)	✅

---

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 generate interesting stats about this repository and render them as a table.
  -- @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: 0

Outside diff range and nitpick comments (2)

client/v2/CHANGELOG.md (1)

46-49: Add the pull request number for reference.

The addition of the "Improvements" section and the description of the change to marshal the type field as a proto message URL in queries is well-documented.

However, please add the pull request number in the format [#<pr-number>](https://github.com/cosmos/cosmos-sdk/pull/<pr-number>) for reference.

x/tx/CHANGELOG.md (1)

38-38: Add the pull request number for traceability.

The addition of the AminoNameAsTypeURL option to the Amino JSON encoder aligns with the PR objective of improving the serialization of Proto types into Amino types.

Please add the pull request number in the format [#<pr-number>] for better traceability:

-* [#](https://github.com/cosmos/cosmos-sdk/pull/) Add `AminoNameAsTypeURL` option to Amino JSON encoder.
+* [#21712](https://github.com/cosmos/cosmos-sdk/pull/21712) Add `AminoNameAsTypeURL` option to Amino JSON encoder.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9fc6675 and 5ec09c6.

Files selected for processing (6)

• client/v2/CHANGELOG.md (1 hunks)
• client/v2/autocli/query.go (1 hunks)
• x/tx/CHANGELOG.md (1 hunks)
• x/tx/signing/aminojson/any.go (2 hunks)
• x/tx/signing/aminojson/json_marshal.go (5 hunks)
• x/tx/signing/aminojson/options.go (1 hunks)

Additional context used

Path-based instructions (6)

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

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

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

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

client/v2/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

client/v2/autocli/query.go (1)

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

x/tx/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

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.

Additional comments not posted (11)

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

53-53: LGTM!

The change to include the aminoNameAsTypeURL option in the beginMarshal call is consistent with the PR objective and does not introduce any new issues.

---

76-76: LGTM!

The change to include the aminoNameAsTypeURL option in the beginMarshal call is applied consistently and does not introduce any new issues.

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

35-36: LGTM!

The change enhances the modularity of the code by separating the URL retrieval logic into its own function. This improves readability and maintainability while preserving the overall functionality.

---

Line range hint 38-51: LGTM!

The new getMessageTypeURL function correctly retrieves the message URL using the message's full name or gogoproto.MessageName. It handles the case when the message URL is not found by returning an empty string. The function is well-structured and follows the Uber Go Style Guide.

client/v2/CHANGELOG.md (1)

48-49: The missing pull request number has already been addressed in the previous comment.

client/v2/autocli/query.go (1)

122-127: LGTM!

The addition of the AminoNameAsTypeURL field to the EncoderOptions struct, with a value of true, aligns with the PR objective of treating Amino names as Type URLs when serializing messages. This change should improve the handling of the type field in queries, shifting from the amino name format to the proto message URL format.

The code change follows the Uber Go Style Guide, and the existing fields in the struct remain unchanged, maintaining the overall structure and behavior.

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

35-37: LGTM!

The new AminoNameAsTypeURL field in the EncoderOptions struct is well-documented and provides a useful option for configuring the JSON output.

---

56-56: LGTM!

The new aminoNameAsTypeURL field in the Encoder struct aligns with the corresponding option in EncoderOptions.

---

87-92: LGTM!

The NewEncoder function correctly initializes the aminoNameAsTypeURL field and other fields based on the provided options.

---

171-172: LGTM!

The Marshal method correctly passes the enc.aminoNameAsTypeURL value to the beginMarshal method to control the encoding behavior.

---

Line range hint 188-200: LGTM!

The changes to the beginMarshal method introduce the flexibility to use either the type URL or the amino name based on the useTypeUrl flag. The logic for determining the message name is clear and covers all possible scenarios.

[julienrbrt]

Something is up with system tests, having a look