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.

Sign up for GitHub

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

Jump to bottom

fix(x/accounts/lockup): prevent double withdraw #21619

Merged
merged 3 commits into from
Sep 10, 2024
Merged

fix(x/accounts/lockup): prevent double withdraw #21619

merged 3 commits into from
Sep 10, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 9, 2024 •
edited by coderabbitai bot
Loading

Description

Submitted via Amulet, but can be open publicly as this isn't released software.

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 the withdrawal process to efficiently handle unique denominations, improving overall performance.
    • Introduced new message types for proposals and voting in the multisig account system, enhancing functionality.

  • Bug Fixes

    • Updated tests to validate the withdrawal logic, ensuring correct handling of duplicate tokens and accurate results.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 9, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 9, 2024 •
edited
Loading

Walkthrough

Walkthrough

The changes in this pull request introduce a deduplication step in the WithdrawUnlockedCoins method of the BaseLockup struct, optimizing the processing of unique denominations by using a new map to store them. This reduces redundant balance retrieval calls. Additionally, the TestPeriodicAccountWithdrawUnlockedCoins test function was modified to capture the response of the withdrawal operation and include assertions that validate the expected behavior when handling duplicate denominations. Furthermore, naming conventions in the multisig message types were standardized, and new message types related to proposals and voting were added.

Changes

Files Change Summary
x/accounts/defaults/lockup/lockup.go Added import statements for the maps and slices packages; modified the WithdrawUnlockedCoins method to include a deduplication step for the msg.Denoms slice.
x/accounts/defaults/lockup/periodic_locking_account_test.go Updated the TestPeriodicAccountWithdrawUnlockedCoins test to capture the response of the withdrawal method and added assertions to validate the withdrawal logic.
api/cosmos/accounts/defaults/multisig/v1/multisig.pulsar.go Renamed field descriptors from Config to config for consistency; updated related logic in methods; added comments for new message types.
x/accounts/proto/cosmos/accounts/defaults/multisig/v1/multisig.proto Renamed Config fields to config in MsgInit and MsgUpdateConfig; added new message types for proposals and voting, enhancing the multisig account protocol.

Possibly related issues

  • Epic: x/accounts #17786: This issue tracks the development of the x/accounts module, which includes changes related to the execution and query logic that are addressed by the modifications in this pull request.
Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b0584cd and 3be15d2.

Files ignored due to path filters (1)
  • x/accounts/defaults/multisig/v1/multisig.pb.go is excluded by !**/*.pb.go
Files selected for processing (3)
  • api/cosmos/accounts/defaults/multisig/v1/multisig.pulsar.go (44 hunks)
  • x/accounts/defaults/lockup/lockup.go (3 hunks)
  • x/accounts/proto/cosmos/accounts/defaults/multisig/v1/multisig.proto (5 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/accounts/defaults/lockup/lockup.go
Additional context used
Path-based instructions (1)
api/cosmos/accounts/defaults/multisig/v1/multisig.pulsar.go (1)

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

Additional comments not posted (16)
x/accounts/proto/cosmos/accounts/defaults/multisig/v1/multisig.proto (12)

13-13: LGTM!

The change aligns the field name with the common convention of using camelCase for field names in Protocol Buffers.

19-22: LGTM!

The addition of the MsgCreateProposal message enhances the functionality of the multisig account system by enabling the creation of proposals.

24-27: LGTM!

The addition of the MsgCreateProposalResponse message complements the MsgCreateProposal message and provides the necessary response structure.

29-33: LGTM!

The addition of the MsgVote message enhances the functionality of the multisig account system by enabling voting on proposals.

35-36: LGTM!

The addition of the MsgVoteResponse message complements the MsgVote message and provides the necessary response structure.

38-41: LGTM!

The addition of the MsgExecuteProposal message enhances the functionality of the multisig account system by enabling the execution of proposals.

43-46: LGTM!

The addition of the MsgExecuteProposalResponse message complements the MsgExecuteProposal message and provides the necessary response structure.

54-54: LGTM!

The change aligns the field name with the common convention of using camelCase for field names in Protocol Buffers.

57-58: LGTM!

The addition of the MsgUpdateConfigResponse message complements the MsgUpdateConfig message and provides the necessary response structure.

106-107: LGTM!

The addition of the QueryConfig message enables querying the configuration of the multisig account.

113-113: LGTM!

The change aligns the field name with the common convention of using camelCase for field names in Protocol Buffers.

116-124: LGTM!

The addition of the QueryProposal and QueryProposalResponse messages enables querying individual proposals within the multisig account system.

api/cosmos/accounts/defaults/multisig/v1/multisig.pulsar.go (4)

72-72: Rename field descriptors for consistency.

The field descriptors for the Config field in MsgInit are renamed from fd_MsgInit_Config to fd_MsgInit_config to follow the Go naming convention of using lowercase for unexported fields.

Also applies to: 79-79

155-155: Update method logic to use renamed field descriptors.

The logic within the Has, Clear, Get, Set, Mutable, and NewField methods of MsgInit is updated to use the new lowercase fd_MsgInit_config field descriptor name.

Also applies to: 176-176, 196-196, 220-220, 247-247, 275-275, 296-296

3546-3546: Rename field descriptors for consistency.

Similar to the changes in MsgInit, the field descriptors for the Config field in MsgUpdateConfig are renamed from fd_MsgUpdateConfig_Config to fd_MsgUpdateConfig_config for consistency with the Go naming convention.

Also applies to: 3553-3553, 3629-3629, 3650-3650, 3670-3670, 3694-3694, 3721-3721, 3749-3749, 3770-3770

8941-8941: Add new message types with comments.

New message types MsgCreateProposal, MsgCreateProposalResponse, MsgVote, MsgVoteResponse, MsgExecuteProposal, and MsgExecuteProposalResponse are added to the file. Each message type is accompanied by a comment describing its purpose, such as creating a proposal, voting on a proposal, or executing a proposal.

Also applies to: 8977-8977, 9013-9013, 9057-9057, 9084-9084, 9120-9120

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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 9, 2024

@julienrbrt your pull request is missing a changelog!

coderabbitai[bot]
coderabbitai bot reviewed Sep 9, 2024
View reviewed changes
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 5028893 and 3c0a903.

Files selected for processing (2)
  • x/accounts/defaults/lockup/lockup.go (2 hunks)
  • x/accounts/defaults/lockup/periodic_locking_account_test.go (1 hunks)
Files not reviewed due to server errors (2)
  • x/accounts/defaults/lockup/periodic_locking_account_test.go
  • x/accounts/defaults/lockup/lockup.go
Additional context used
Path-based instructions (2)
x/accounts/defaults/lockup/periodic_locking_account_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"

x/accounts/defaults/lockup/lockup.go (1)

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

@julienrbrt julienrbrt added this pull request to the merge queue Sep 10, 2024
Merged via the queue into main with commit 298792f Sep 10, 2024
74 of 75 checks passed
@julienrbrt julienrbrt deleted the julien/lockup branch September 10, 2024 20:23
mergify bot pushed a commit that referenced this pull request Sep 10, 2024
@julienrbrt @mergify
fix(x/accounts/lockup): prevent double withdraw (#21619)
550afa7 
(cherry picked from commit 298792f)

# Conflicts:
#	api/cosmos/accounts/defaults/multisig/v1/multisig.pulsar.go
@mergify mergify bot mentioned this pull request Sep 10, 2024
Merged
12 tasks
julienrbrt added a commit that referenced this pull request Sep 11, 2024
@mergify @julienrbrt
fix(x/accounts/lockup): prevent double withdraw (backport #21619) (#2…
7c3945f 
…1641)

Co-authored-by: Julien Robert <julien@rbrt.fr>
This was referenced Sep 11, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

@sontrinh16 sontrinh16 sontrinh16 approved these changes

@testinginprod testinginprod testinginprod approved these changes

Assignees

@sontrinh16 sontrinh16

@testinginprod testinginprod

Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/accounts/lockup C:x/accounts/multisig C:x/accounts
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@julienrbrt @sontrinh16 @testinginprod