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/accounts/default/lockup): Lockup account track undelegation when unbonding entry is mature (backport #22254) #22930

Merged
merged 2 commits into from
Dec 17, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Dec 17, 2024

Description

  • Right now when execute undelegate, the lockup account also call TrackUndelegation to update the delegateLocking and delegateFree amount, this is incorrect behavior since legacy vesting account call TrackUndelegation when we call x/bank UndelegateCoins which is when the unbonding entry already matured. This make delegateLocking updated before the ubd amount actually sent back to the account, which make the spendable amount incorrect when we try to sent token from lockup account
  • Problem right now is, x/accounts is its self contains state and doesnt have a way to be notified when unbonding entry is mature and handled by bank. So there are 2 way i can think of:
    • Lockup account tracks all unbonding entries it made, automatically run check all the entries for matured one then run TrackUndelegation with that entry. This check should be run before every execution the account made.
    • Lockup account tracks all unbonding entries it made, owner can execute a unbonding ack msg to manually TrackUndelegation

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

    • Introduced new message types for unbonding entries, enhancing the lockup account's capabilities.
    • Added functionality to query unbonding entries and spendable amounts related to lockup accounts.
    • Enhanced the integration of query handlers for various locking account types.
    • Removed withdrawal functionality, streamlining the lockup account operations.
  • Bug Fixes

    • Improved test coverage for undelegation and unbonding processes, ensuring accurate state validation.
  • Documentation

    • Updated protocol buffer definitions to include new fields and message types for better tracking of unbonding operations.

This is an automatic backport of pull request #22254 done by [Mergify](https://mergify.com).

…n unbonding entry is mature (#22254)

Co-authored-by: Alexander Peters <[email protected]>
(cherry picked from commit def23f0)

# Conflicts:
#	api/cosmos/accounts/defaults/lockup/v1/lockup.pulsar.go
#	api/cosmos/accounts/defaults/lockup/v1/query.pulsar.go
#	api/cosmos/accounts/defaults/lockup/v1/tx.pulsar.go
@mergify mergify bot requested a review from a team as a code owner December 17, 2024 16:34
Copy link
Contributor Author

mergify bot commented Dec 17, 2024

Cherry-pick of def23f0 has failed:

On branch mergify/bp/release/v0.52.x/pr-22254
Your branch is up to date with 'origin/release/v0.52.x'.

You are currently cherry-picking commit def23f093.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   tests/integration/accounts/lockup/continous_lockup_test_suite.go
	modified:   tests/integration/accounts/lockup/delayed_lockup_test_suite.go
	modified:   tests/integration/accounts/lockup/periodic_lockup_test_suite.go
	modified:   tests/integration/accounts/lockup/permanent_lockup_test_suite.go
	modified:   tests/integration/accounts/lockup/utils.go
	modified:   x/accounts/defaults/lockup/continuous_locking_account.go
	modified:   x/accounts/defaults/lockup/continuous_locking_account_test.go
	modified:   x/accounts/defaults/lockup/delayed_locking_account.go
	modified:   x/accounts/defaults/lockup/delayed_locking_account_test.go
	modified:   x/accounts/defaults/lockup/lockup.go
	modified:   x/accounts/defaults/lockup/lockup_test.go
	modified:   x/accounts/defaults/lockup/periodic_locking_account.go
	modified:   x/accounts/defaults/lockup/periodic_locking_account_test.go
	modified:   x/accounts/defaults/lockup/permanent_locking_account.go
	modified:   x/accounts/defaults/lockup/permanent_locking_account_test.go
	modified:   x/accounts/defaults/lockup/utils_test.go
	modified:   x/accounts/defaults/lockup/v1/lockup.pb.go
	modified:   x/accounts/defaults/lockup/v1/query.pb.go
	modified:   x/accounts/defaults/lockup/v1/tx.pb.go
	modified:   x/accounts/proto/cosmos/accounts/defaults/lockup/v1/lockup.proto
	modified:   x/accounts/proto/cosmos/accounts/defaults/lockup/v1/query.proto
	modified:   x/accounts/proto/cosmos/accounts/defaults/lockup/v1/tx.proto
	modified:   x/staking/keeper/grpc_query.go

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   api/cosmos/accounts/defaults/lockup/v1/lockup.pulsar.go
	deleted by us:   api/cosmos/accounts/defaults/lockup/v1/query.pulsar.go
	deleted by us:   api/cosmos/accounts/defaults/lockup/v1/tx.pulsar.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot added the conflicts label Dec 17, 2024
Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@mergify[bot] your pull request is missing a changelog!

@julienrbrt julienrbrt merged commit b6fa674 into release/v0.52.x Dec 17, 2024
71 of 73 checks passed
@julienrbrt julienrbrt deleted the mergify/bp/release/v0.52.x/pr-22254 branch December 17, 2024 17:03
found := false
// check if the entry is still exist in the unbonding entries
for _, e := range stakingUnbonding {
if e.CompletionTime.Equal(entry.EndTime) && entry.CreationHeight == entry.CreationHeight {

Check warning

Code scanning / CodeQL

Comparison of identical values Warning

This expression compares an
expression
to itself.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants