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

fix(client/v2): *big.Int unmarshal #21853

Merged
merged 18 commits into from
Oct 8, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 23, 2024

Description

Closes: #20935

I am mostly curious about what has changed between 0.50 to 0.52/main x/tx, which makes us need those extra encoders. For instance marshalling was working fine on 0.50, but regressed in 0.52. Fixed by #22161


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

Summary by CodeRabbit

  • New Features

    • Added support for off-chain signing and verification of files.
    • Introduced support for governance proposals.
    • Launched a transaction factory for enhanced transaction management.
    • Extended keyring interface with new types for improved functionality.
    • Enhanced command building with new scalar type handling for decimal values.
  • Bug Fixes

    • Resolved issues with unmarshalling and marshalling *big.Int in transactions.
    • Improved error messages for better clarity during transaction handling.
  • Documentation

    • Updated changelog to reflect new features and bug fixes.

@github-actions github-actions bot added the C:CLI label Sep 23, 2024
Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates the client/v2 module's changelog, documenting new features such as off-chain signing, governance proposal support, and a transaction factory. It introduces a new constant for handling decimal types and enhances error handling in various methods across multiple files. Notable API breaking changes include the removal of address codecs from specific options. A new file is added for managing decimal values, and bug fixes are implemented for unmarshalling issues related to transactions.

Changes

File Change Summary
client/v2/CHANGELOG.md Updated with new features: off-chain signing, governance proposals, transaction factory, keyring extensions, and bug fixes.
client/v2/autocli/flag/builder.go Added constant DecScalarType and updated init method to include this in the scalarFlagTypes map.
client/v2/autocli/flag/legacy_dec.go Introduced decType and decValue structs with methods for handling decimal values in the flag package.
client/v2/autocli/query.go Modified encoder function to create a customEncoder for enhanced gRPC query handling.
x/auth/tx/builder.go Enhanced error handling in getTx method and simplified SetMsgs method.
x/tx/decode/decode.go Updated Decode method to wrap errors with additional context for better clarity.

Assessment against linked issues

Objective Addressed Explanation
Fix unmarshalling issues with *big.Int in transactions (#20935)

Possibly related PRs

Suggested reviewers

  • kocubinski
  • testinginprod

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 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 changed the title fix(client/v2): support legacydec fix(client/v2): protocolpool issue Oct 3, 2024
@julienrbrt julienrbrt changed the title fix(client/v2): protocolpool issue fix(client/v2): *big.Int marshal/unmarshal Oct 4, 2024
@julienrbrt julienrbrt changed the title fix(client/v2): *big.Int marshal/unmarshal fix(client/v2): *big.Int unmarshal Oct 7, 2024
@julienrbrt julienrbrt marked this pull request as ready for review October 7, 2024 11:50
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 7, 2024

This comment has been minimized.

@julienrbrt
Copy link
Member Author

doing a fix for the marshalling as well.

@julienrbrt julienrbrt changed the title fix(client/v2): *big.Int unmarshal fix(client/v2): *big.Int marshal/unmarshal Oct 7, 2024
client/v2/autocli/query.go Fixed Show fixed Hide fixed
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: 1

🧹 Outside diff range and nitpick comments (1)
client/v2/autocli/query.go (1)

239-241: Improve comment formatting for better readability

The comment is split mid-sentence across multiple lines, which may hinder readability. Consider reformatting it for clarity.

Apply this diff to adjust the comment:

-	// If the decimal doesn't contain a point, we assume it's a value formatted using the legacy
-	// `math.Dec`. So we try to parse it as an integer and then convert it to a
-	// decimal.
+	// If the decimal doesn't contain a point, we assume it's a value formatted using the legacy `math.Dec`.
+	// So we try to parse it as an integer and then convert it to a decimal.
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 310ecea and 0ced709.

📒 Files selected for processing (3)
  • client/v2/CHANGELOG.md (1 hunks)
  • client/v2/autocli/flag/legacy_dec.go (1 hunks)
  • client/v2/autocli/query.go (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • client/v2/CHANGELOG.md
  • client/v2/autocli/flag/legacy_dec.go
🧰 Additional context used
📓 Path-based instructions (1)
client/v2/autocli/query.go (1)

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

🔇 Additional comments (2)
client/v2/autocli/query.go (2)

8-8: Import "math/big" is necessary for big integer operations

The addition of "math/big" is appropriate as it is required for handling big integers in the custom scalar encoding for "cosmos.Dec".


235-259: Custom scalar encoding for "cosmos.Dec" is well-implemented

The custom scalar encoding correctly handles the conversion of legacy-formatted decimals and includes proper error handling for invalid inputs. The implementation aligns with best practices and conforms to the Uber Go style guide.

client/v2/autocli/query.go Outdated Show resolved Hide resolved
@julienrbrt julienrbrt changed the title fix(client/v2): *big.Int marshal/unmarshal fix(client/v2): *big.Int unmarshal Oct 8, 2024
@julienrbrt
Copy link
Member Author

I am mostly curious about what has changed between 0.50 to 0.52/main x/tx, which makes us need those extra encoders. For instance marshalling was working fine on 0.50, but regressed in 0.52.

doing a fix for the marshalling as well.

Reverted the fix for marshalling at e6e4583, as it was indeed not autocli related.
Matt has a fix here: #22161.
The fix for unmarshallling is however, still valid and fixes the original issue (and not the queries)

@julienrbrt julienrbrt enabled auto-merge October 8, 2024 14:48
@julienrbrt julienrbrt added this pull request to the merge queue Oct 8, 2024
Merged via the queue into main with commit 43c41be Oct 8, 2024
74 of 75 checks passed
@julienrbrt julienrbrt deleted the julien/autocli-protocolpool branch October 8, 2024 15:20
mergify bot pushed a commit that referenced this pull request Oct 8, 2024
(cherry picked from commit 43c41be)

# Conflicts:
#	client/v2/CHANGELOG.md
#	x/tx/decode/decode.go
julienrbrt added a commit that referenced this pull request Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:CLI C:x/auth C:x/tx
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: protocolpool create-continuous-pool panics
6 participants