Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(client/v2): add map support #23544

Merged
merged 3 commits into from
Jan 29, 2025
Merged

feat(client/v2): add map support #23544

merged 3 commits into from
Jan 29, 2025

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jan 28, 2025

Description

Follow-up of #23539


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

    • Added support for maps in queries for autocli
  • Dependency Updates

    • Updated cosmossdk.io/x/tx from v1.0.1 to v1.1.0 across multiple modules
  • Documentation

    • Updated changelog for x/tx module to version v0.13.8
    • Improved formatting in client/v2/CHANGELOG.md

@julienrbrt julienrbrt added backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release labels Jan 28, 2025
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

📝 Walkthrough

Walkthrough

This pull request introduces updates across multiple modules, primarily focusing on the x/tx module. The changes include supporting map marshalling in Amino JSON encoding, updating dependency versions from v1.0.1 to v1.1.0 in various go.mod files, and modifying the client/v2/CHANGELOG.md to reflect new functionality. The updates are consistent across different modules, suggesting a coordinated enhancement to the transaction and encoding capabilities.

Changes

File Change Summary
client/v2/CHANGELOG.md - Added support for maps in queries for autocli
- Updated note formatting about client.Context
client/v2/autocli/query.go Added MarshalMappings field to aminojson.EncoderOptions
**/go.mod Updated cosmossdk.io/x/tx dependency from v1.0.1 to v1.1.0
x/tx/CHANGELOG.md - Updated version to v0.13.8
- Added map marshalling support entry

Sequence Diagram

sequenceDiagram
    participant Client
    participant AutoCLI
    participant EncoderOptions
    participant QueryMethod

    Client->>AutoCLI: Request query with map
    AutoCLI->>EncoderOptions: Configure MarshalMappings
    EncoderOptions-->>QueryMethod: Apply map marshalling
    QueryMethod-->>Client: Return encoded result
Loading

Possibly related PRs

Suggested Labels

C:x/tx, C:collections, C:Simulations

Suggested Reviewers

  • kocubinski
  • testinginprod
  • aaronc
  • tac0turtle
✨ 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
🪧 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.

@julienrbrt julienrbrt marked this pull request as ready for review January 28, 2025 20:13
@julienrbrt julienrbrt requested review from a team and JulianToledano as code owners January 28, 2025 20:13
@julienrbrt julienrbrt requested a review from aljo242 January 28, 2025 20:14
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
x/tx/CHANGELOG.md (1)

64-71: Consider consolidating duplicate changelog entries.

The same feature (map marshalling support) is documented in both v1.1.0 and v0.13.8 entries, referencing the same PRs (#23513, #23539). Consider consolidating these entries to avoid confusion.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e2027bf and 7658d62.

⛔ Files ignored due to path filters (7)
  • client/v2/go.sum is excluded by !**/*.sum
  • simapp/v2/go.sum is excluded by !**/*.sum
  • tests/go.sum is excluded by !**/*.sum
  • x/feegrant/go.sum is excluded by !**/*.sum
  • x/gov/go.sum is excluded by !**/*.sum
  • x/group/go.sum is excluded by !**/*.sum
  • x/upgrade/go.sum is excluded by !**/*.sum
📒 Files selected for processing (10)
  • client/v2/CHANGELOG.md (2 hunks)
  • client/v2/autocli/query.go (1 hunks)
  • client/v2/go.mod (1 hunks)
  • simapp/v2/go.mod (1 hunks)
  • tests/go.mod (1 hunks)
  • x/feegrant/go.mod (1 hunks)
  • x/gov/go.mod (1 hunks)
  • x/group/go.mod (1 hunks)
  • x/tx/CHANGELOG.md (1 hunks)
  • x/upgrade/go.mod (1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
client/v2/autocli/query.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"

x/tx/CHANGELOG.md (1)

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

tests/go.mod (1)

Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"

🪛 markdownlint-cli2 (0.17.2)
client/v2/CHANGELOG.md

113-113: Unordered list indentation
Expected: 4; Actual: 2

(MD007, ul-indent)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: tests (00)
  • GitHub Check: Analyze
  • GitHub Check: Summary
🔇 Additional comments (10)
client/v2/autocli/query.go (1)

127-127: LGTM: Map support enabled in encoder options.

The addition of MarshalMappings field to aminojson.EncoderOptions enables map support in queries for autocli, which aligns with the PR's objective.

client/v2/CHANGELOG.md (2)

40-40: LGTM: Clear changelog entry for map support.

The changelog entry clearly documents the addition of map support in queries for autocli.


113-113: LGTM: Improved formatting.

The indentation fix improves the readability of the note about client.Context requirement.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

113-113: Unordered list indentation
Expected: 4; Actual: 2

(MD007, ul-indent)

client/v2/go.mod (1)

10-10: LGTM: Updated tx module version.

The update to cosmossdk.io/x/tx v1.1.0 aligns with similar updates across other modules in this PR.

x/group/go.mod (1)

38-38: LGTM: Consistent tx module version update.

The update to cosmossdk.io/x/tx v1.1.0 maintains version consistency with other modules.

x/gov/go.mod (1)

38-38: LGTM: Version update aligns with new feature.

The update to cosmossdk.io/x/tx v1.1.0 is appropriate as it includes the new map marshalling support feature.

x/feegrant/go.mod (1)

44-44: LGTM: Consistent version update.

The update to cosmossdk.io/x/tx v1.1.0 maintains version consistency across modules.

x/upgrade/go.mod (1)

14-14: LGTM: Consistent version update.

The update to cosmossdk.io/x/tx v1.1.0 maintains version consistency across modules.

tests/go.mod (1)

14-14: LGTM: Consistent version update.

The update to cosmossdk.io/x/tx v1.1.0 maintains version consistency across modules.

simapp/v2/go.mod (1)

71-71: LGTM! Version update aligns with map support feature.

The update of cosmossdk.io/x/tx from v1.0.1 to v1.1.0 is consistent with adding map support functionality.

Let's verify this version for any security advisories:

✅ Verification successful

Version update to v1.1.0 is safe from known security vulnerabilities

The security advisory ASA-2024-0012/0013 only affects versions below 0.13.7, and we're using v1.1.0 which is a different major version series not impacted by this vulnerability.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for security advisories for cosmossdk.io/x/tx

gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: GO, package: "cosmossdk.io/x/tx") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
      firstPatchedVersion {
        identifier
      }
    }
  }
}'

Length of output: 629

@julienrbrt julienrbrt added this pull request to the merge queue Jan 29, 2025
Merged via the queue into main with commit d8ea6a9 Jan 29, 2025
74 of 76 checks passed
@julienrbrt julienrbrt deleted the julien/wire-autocli branch January 29, 2025 15:46
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
(cherry picked from commit d8ea6a9)

# Conflicts:
#	client/v2/CHANGELOG.md
#	client/v2/go.mod
#	client/v2/go.sum
#	simapp/go.mod
#	simapp/go.sum
#	tests/go.mod
#	tests/go.sum
#	x/feegrant/go.mod
#	x/feegrant/go.sum
#	x/gov/go.sum
#	x/group/go.mod
#	x/group/go.sum
#	x/tx/CHANGELOG.md
#	x/upgrade/go.mod
#	x/upgrade/go.sum
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
(cherry picked from commit d8ea6a9)

# Conflicts:
#	client/v2/CHANGELOG.md
#	client/v2/go.mod
#	client/v2/go.sum
#	simapp/go.sum
#	simapp/v2/go.mod
#	tests/go.mod
#	tests/go.sum
#	x/feegrant/go.mod
#	x/feegrant/go.sum
#	x/gov/go.mod
#	x/gov/go.sum
#	x/group/go.mod
#	x/group/go.sum
#	x/tx/CHANGELOG.md
#	x/upgrade/go.mod
#	x/upgrade/go.sum
julienrbrt added a commit that referenced this pull request Jan 29, 2025
julienrbrt added a commit that referenced this pull request Jan 29, 2025
alpe added a commit that referenced this pull request Jan 30, 2025
* main: (61 commits)
  build(deps): Bump cosmossdk.io/x/tx from 1.0.1 to 1.1.0 (#23547)
  feat(client/v2): add map support (#23544)
  fix(db): Fix pebbleDB integration (#23552)
  build(deps): Bump buf.build/gen/go/cometbft/cometbft/protocolbuffers/go from 1.36.3-20241120201313-68e42a58b301.1 to 1.36.4-20241120201313-68e42a58b301.1 in /api (#23520)
  build(deps): Bump github.com/golang/glog from 1.2.3 to 1.2.4 in /tools/hubl (#23541)
  fix(x/tx): add an option to encode maps using amino json (ref #23513) (#23539)
  build(deps): Bump cosmossdk.io/collections from 1.0.0 to 1.1.0 (#23534)
  build(deps): Bump github.com/bytedance/sonic from 1.12.7 to 1.12.8 in /log (#23516)
  chore: fix changelog for `v0.52.0-rc.2` (#23502)
  build(deps): Bump google.golang.org/protobuf from 1.36.3 to 1.36.4 in /x/upgrade (#23512)
  chore(collections): bring in `protocodec` in collections directly (#23515)
  feat(x/tx): add an option to encode maps using amino json (#23513)
  fix(codec): provide legacy amino og type (#23504)
  chore: remove unecessary SDKGasMeter impl (#23503)
  refactor: replace `golang.org/x/exp` with stdlib (#23501)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /tools/cosmovisor (#23496)
  build(deps): Bump google.golang.org/grpc from 1.69.4 to 1.70.0 in /store (#23494)
  build(deps): Bump github.com/hashicorp/go-plugin from 1.6.2 to 1.6.3 in /store (#23493)
  ci: Fix Ci job target (#23500)
  feat(server/v2): add swagger server component (#23486)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:CLI C:x/feegrant C:x/gov C:x/group C:x/tx C:x/upgrade
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants