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

imp: omit tokens from ledger device display when empty #6498

Merged
merged 2 commits into from
Jun 5, 2024

Conversation

damiannolan
Copy link
Contributor

@damiannolan damiannolan commented Jun 5, 2024

Description

Tested with the following repo, using the ledger signing section.
https://github.com/damiannolan/simd-scripts/tree/main

closes: #6465


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

  • Refactor
    • Simplified the tokens field in the transfer message to improve compatibility and maintainability.

Copy link
Contributor

coderabbitai bot commented Jun 5, 2024

Walkthrough

Walkthrough

The change involves removing the (amino.dont_omitempty) = true option from the tokens field declaration in the MsgTransfer message within the tx.proto file. This alteration is likely aimed at addressing issues related to Ledger support for the MsgTransfer message with ics20-2.

Changes

File Path Change Summary
proto/ibc/applications/transfer/v1/tx.proto Removed (amino.dont_omitempty) = true option from the tokens field declaration in MsgTransfer

Sequence Diagram(s) (Beta)

The changes are too simple to warrant a sequence diagram.

Assessment against linked issues

Objective Addressed Explanation
Ledger support regression for MsgTransfer with ics20-2 (#6465)
Protobuf annotations may be required for new fields on MsgTransfer (#6465)

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>.
    • 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 show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@damiannolan damiannolan marked this pull request as ready for review June 5, 2024 10:28
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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fc6867e and 773a474.

Files ignored due to path filters (1)
  • modules/apps/transfer/types/tx.pb.go is excluded by !**/*.pb.go, !**/*.pb.go
Files selected for processing (1)
  • proto/ibc/applications/transfer/v1/tx.proto (1 hunks)
Additional comments not posted (1)
proto/ibc/applications/transfer/v1/tx.proto (1)

53-53: The removal of (amino.dont_omitempty) = true from the tokens field is aligned with the PR's objective to omit empty tokens from the Ledger device display. This change should ensure that empty tokens are not serialized, which is crucial for the correct display behavior on Ledger devices.

@@ -50,7 +50,7 @@ message MsgTransfer {
// optional memo
string memo = 8;
// tokens to be transferred
repeated cosmos.base.v1beta1.Coin tokens = 9 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
Copy link
Contributor

Choose a reason for hiding this comment

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

could we then remove this tag from the token?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it doesn't seem to have any effect because for a single token amount always shows as a "0" string because the amount field is a custom into sdkmath.Int.

@chatton and I tested a bunch of different variations this morning.

Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

fabulous as always!

@damiannolan damiannolan enabled auto-merge (squash) June 5, 2024 10:53
@damiannolan damiannolan merged commit f1a0a05 into main Jun 5, 2024
76 of 77 checks passed
@damiannolan damiannolan deleted the damian/imp-ledger-device-display branch June 5, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ledger support regression for MsgTransfer with ics20-2
3 participants