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(x/auth): fix multi file tx reading when no new line in file #22227

Closed
wants to merge 7 commits into from

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Oct 11, 2024

Description

Step to repro:

Create a bank1.json and bank2.json file without a trailing new line.

$ simdv2 tx sign-batch bank1.json bank2.json --from alice
{"body":{"messages":[{"@type":"/cosmos.bank.v1beta1.MsgSend","from_address":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","to_address":"cosmos1cyhshu4we258wcmlmjfw8zkkhhzcvgtx965seq","amount":[{"denom":"stake","amount":"100"}]},{"@type":"/cosmos.bank.v1beta1.MsgSend","from_address":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","to_address":"cosmos1cyhshu4we258wcmlmjfw8zkkhhzcvgtx965seq","amount":[{"denom":"stake","amount":"4"}]}],"memo":"","timeout_height":"0","unordered":false,"timeout_timestamp":"0001-01-01T00:00:00Z","extension_options":[],"non_critical_extension_options":[]},"auth_info":{"signer_infos":[{"public_key":{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AhDC1ZXMhxwKI75/n9x8jhXSI6Eo3ycS8J061YYruipm"},"mode_info":{"single":{"mode":"SIGN_MODE_DIRECT"}},"sequence":"8"}],"fee":{"amount":[],"gas_limit":"200000","payer":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","granter":""},"tip":null},"signatures":["otcHOgJHwdEziYpQifZf12CQrUM0KIxTdmKd0OK713AeID1/gVup2IFNvpEYcJBttasar3WtSdHzGgEZmLYYvA=="]}

After

 $simdv2 tx sign-batch bank1.json bank2.json --from alice
 {"body":{"messages":[{"@type":"/cosmos.bank.v1beta1.MsgSend","from_address":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","to_address":"cosmos1cyhshu4we258wcmlmjfw8zkkhhzcvgtx965seq","amount":[{"denom":"stake","amount":"100"}]},{"@type":"/cosmos.bank.v1beta1.MsgSend","from_address":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","to_address":"cosmos1cyhshu4we258wcmlmjfw8zkkhhzcvgtx965seq","amount":[{"denom":"stake","amount":"4"}]}],"memo":"","timeout_height":"0","unordered":false,"timeout_timestamp":"0001-01-01T00:00:00Z","extension_options":[],"non_critical_extension_options":[]},"auth_info":{"signer_infos":[{"public_key":{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AhDC1ZXMhxwKI75/n9x8jhXSI6Eo3ycS8J061YYruipm"},"mode_info":{"single":{"mode":"SIGN_MODE_DIRECT"}},"sequence":"8"}],"fee":{"amount":[],"gas_limit":"200000","payer":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","granter":""},"tip":null},"signatures":["otcHOgJHwdEziYpQifZf12CQrUM0KIxTdmKd0OK713AeID1/gVup2IFNvpEYcJBttasar3WtSdHzGgEZmLYYvA=="]}
{"body":{"messages":[{"@type":"/cosmos.bank.v1beta1.MsgSend","from_address":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","to_address":"cosmos1cyhshu4we258wcmlmjfw8zkkhhzcvgtx965seq","amount":[{"denom":"stake","amount":"10"}]},{"@type":"/cosmos.bank.v1beta1.MsgSend","from_address":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","to_address":"cosmos1cyhshu4we258wcmlmjfw8zkkhhzcvgtx965seq","amount":[{"denom":"stake","amount":"2"}]}],"memo":"","timeout_height":"0","unordered":false,"timeout_timestamp":"0001-01-01T00:00:00Z","extension_options":[],"non_critical_extension_options":[]},"auth_info":{"signer_infos":[{"public_key":{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AhDC1ZXMhxwKI75/n9x8jhXSI6Eo3ycS8J061YYruipm"},"mode_info":{"single":{"mode":"SIGN_MODE_DIRECT"}},"sequence":"9"}],"fee":{"amount":[],"gas_limit":"200000","payer":"cosmos1320u6jmp4k72947p84zfqyg22vy3vpe5ddnw2k","granter":""},"tip":null},"signatures":["eLbYi3gekpdmG4cQ5lTARoLHIcx3fJL+0Wpr7yvff5EEehQh4jnjOQD1vAp0AxeufVyb6MlfwHTIRcA8sN4NZQ=="]}

Found while reviewing #22149


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

    • Improved transaction data handling by ensuring newline separation for better parsing.
  • Bug Fixes

    • Fixed transaction reading issues by appending newline characters, enhancing input processing reliability.

Copy link
Contributor

coderabbitai bot commented Oct 11, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request focus on modifying the ReadTxsFromInput function in the x/auth/client/tx.go file. The modification ensures that a newline character is appended to transaction data when writing to a buffer, which is essential for the correct parsing of newline-delimited transactions by the input scanner.

Changes

File Path Change Summary
x/auth/client/tx.go Modified ReadTxsFromInput to append a newline character to transaction data written to the buffer.

Suggested labels

C:x/tx

Suggested reviewers

  • facundomedica
  • sontrinh16
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3f9b92a and 214db87.

📒 Files selected for processing (1)
  • x/auth/client/tx.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • x/auth/client/tx.go

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 added backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release 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 and removed C:CLI C:x/auth labels Oct 11, 2024
Copy link
Contributor

@julienrbrt your pull request is missing a changelog!

@julienrbrt
Copy link
Member Author

I'll put a changelog in the v0.50 backport

@julienrbrt
Copy link
Member Author

It looks like the minifier that I used my removing the tailing newline on the json.

@julienrbrt julienrbrt changed the title fix(x/auth): fix multi file tx reading fix(x/auth): fix multi file tx reading when no new line in file Oct 11, 2024
Copy link
Contributor

@akhilkumarpilli akhilkumarpilli left a comment

Choose a reason for hiding this comment

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

lgtm!

@julienrbrt julienrbrt removed the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Oct 11, 2024
@julienrbrt
Copy link
Member Author

It looks like it is unexpectedly breaking other behavior. Will keep as is.

@julienrbrt julienrbrt closed this Oct 27, 2024
@julienrbrt julienrbrt deleted the julien/sign-batch branch October 27, 2024 23:10
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/auth
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants