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(x/bank): add origin address in event multisend #21460

Merged
merged 3 commits into from
Aug 29, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Aug 29, 2024

Description

Closes: #21414

I'll add a changelog in v0.50 only.


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 transaction traceability by including the sender's address in event emissions during coin transfers.
  • Bug Fixes
    • Improved clarity and completeness of event data in tests by consistently including sender information in event attributes.

@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 Aug 29, 2024
@julienrbrt julienrbrt requested a review from a team as a code owner August 29, 2024 09:24
Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

Walkthrough

The changes enhance the InputOutputCoins function in the BaseSendKeeper structure by adding the sender's address as an event attribute during coin transfers. This update ensures that both the sender's and recipient's addresses, along with the transfer amount, are captured in the emitted events, improving transaction traceability.

Changes

Files Change Summary
x/bank/keeper/send.go Added sender's address as an event attribute in the InputOutputCoins function.
x/bank/keeper/keeper_test.go Updated TestMsgMultiSendEvents to include sender attribute in event creation.

Assessment against linked issues

Objective Addressed Explanation
MsgMultiSend emits transfer event without sender attribute (#21414)

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

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 17d864f and 5370bd3.

Files selected for processing (1)
  • x/bank/keeper/send.go (1 hunks)
Additional context used
Path-based instructions (1)
x/bank/keeper/send.go (1)

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

Additional comments not posted (1)
x/bank/keeper/send.go (1)

175-177: LGTM!

The addition of the sender attribute to the event emission process enhances the traceability of transactions by including the sender's address in the emitted event.

Copy link
Contributor

@julienrbrt your pull request is missing a changelog!

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 5370bd3 and 6eb58e5.

Files selected for processing (1)
  • x/bank/keeper/keeper_test.go (1 hunks)
Additional context used
Path-based instructions (1)
x/bank/keeper/keeper_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (2)
x/bank/keeper/keeper_test.go (2)

1471-1472: Include the sender attribute in the event.

The sender attribute is correctly added to the event attributes.

The code changes are approved.


1482-1483: Include the sender attribute in the event.

The sender attribute is correctly added to the event attributes.

The code changes are approved.

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 5370bd3 and 8d00e4a.

Files selected for processing (1)
  • x/bank/keeper/keeper_test.go (1 hunks)
Additional context used
Path-based instructions (1)
x/bank/keeper/keeper_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (2)
x/bank/keeper/keeper_test.go (2)

1471-1472: LGTM!

The sender attribute is correctly added to the event attributes.


1482-1482: LGTM!

The sender attribute is correctly added to the event attributes.

@julienrbrt julienrbrt added this pull request to the merge queue Aug 29, 2024
Merged via the queue into main with commit 33c463e Aug 29, 2024
75 checks passed
@julienrbrt julienrbrt deleted the julien/bank branch August 29, 2024 12:33
mergify bot pushed a commit that referenced this pull request Aug 29, 2024
mergify bot pushed a commit that referenced this pull request Aug 29, 2024
(cherry picked from commit 33c463e)

# Conflicts:
#	x/bank/keeper/keeper_test.go
#	x/bank/keeper/send.go
tac0turtle pushed a commit that referenced this pull request Aug 29, 2024
julienrbrt added a commit that referenced this pull request Aug 29, 2024
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:x/bank
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: MsgMultiSend emits transfer event without sender attribute
3 participants