[Pools] Fix issues with member migration to `DelegateStake` by Ank4n · Pull Request #4822 · paritytech/polkadot-sdk

Ank4n · 2024-06-18T19:20:38Z

Context

Pool members using the old TransferStake strategy were able to transfer all their funds to the pool. With DelegateStake changes, we want to ensure similar behaviour by allowing members to delegate all their stake to the pool.

Changes

Ensure all the balance including ED of an account can be delegated (and used in the pool) by adding a provider for delegators.
Gates calls that mutates the pool or pool member if they are in unmigrated state.
Adds remote test to migrate all pools and members to DelegateStake which can be used with Kusama and Polkadot runtime state. closes [Pools] Remote Externalities test for DelegateStake strategy #4629.
Add new runtime apis to read pool and member balance.

Addressing possible migration errors

Pool members migrating can run into two types of errors:

Already Staking: If the pool member is already staking, we cannot migrate them to DelegateStake since this may mean they are able to use the same staked funds in the pool. Users would need to withdraw all their funds from staking, in order to migrate their pool funds.
Pool contribution below ED: For these cases transfer from pool account to member account would fail. The affected users can top up their accounts and redo migration.

Another error that was earlier possible was when member's free balance is below ED. This PR adds a provider to delegator allowing all user balance including ED can be contributed towards the pool. This helps 1095 accounts in Polkadot and 41 accounts in Kusama to migrate now which would have earlier failed.

Results from RemoteExternalities Tests.

Kusama

Migration stats: success: 3017, direct_stakers: 361, unexpected_errors: 0

Polkadot

Migration stats: success: 42859, direct_stakers: 643, unexpected_errors: 0

TODO

Add runtime api for member total balance.
New issue to reap pool members with contribution below ED.
Add provider for delegators so whole balance including ED can be held while contributing to pools.
Gate all pool extrinsics if pool/member is in non-migrated state.

paritytech-cicd-pr · 2024-08-13T23:57:23Z

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: cargo-clippy
Logs: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7000318

gpestana · 2024-08-14T12:54:29Z

polkadot/runtime/westend/src/tests.rs

 	);
 }
+
+#[cfg(all(test, feature = "try-runtime"))]


substrate/frame/delegated-staking/src/lib.rs

gpestana · 2024-08-14T12:57:54Z

substrate/frame/delegated-staking/src/types.rs

+	/// Remove self from storage.
+	pub(crate) fn remove(key: &T::AccountId) {
+		debug_assert!(<Agents<T>>::contains_key(key), "Agent should exist in storage");
+		<Agents<T>>::remove(key);


Suggested change

<Agents<T>>::remove(key);

Agents::<T>::remove(key);

(same suggestion for fn update)

* master: (167 commits) Upgrade accidentally downgraded deps (#5365) [Pools] Fix issues with member migration to `DelegateStake` (#4822) Unify `no_genesis` check (#5360) [CI] Fix prdoc command (#5358) Beefy: add benchmarks for `report_fork_voting()` (#5188) Fix OurViewChange small race (#5356) Make ticket non-optional and add ensure_successful method to Consideration trait (#5359) [tests] dedup test code, add more tests, improve naming and docs (#5338) Stop running the wishlist workflow on forks (#5297) Migrate foreign assets v3::Location to v4::Location (#4129) Minor clean up (#5284) [Pools] Ensure members can always exit the pool gracefully (#4998) StorageWeightReclaim: set to node pov size if higher (#5281) [Bot] Add prdoc generation (#5331) Small nits found accidentally along the way (#5341) Create subsystem-benchmarks.yml (#5325) Bump libp2p-identity from 0.2.8 to 0.2.9 (#5232) Bump authoring duration for async backing to 2s. (#5195) Fix spelling issues (#5206) Bump the known_good_semver group across 1 directory with 3 updates (#5315) ...

* master: Remove redundant minimal template workspace (#5330) approval-distribution: Fix handling of conclude (#5375) More logs in `is_potential_spam` from `dispute-coordinator` (#5252) Fix zombienet bridges test (#5373) Update Readme of the `polkadot` crate (#5326) allow for `u8` to be used as hold/freeze reason (#5348) Moving cargo check for runtimes to GHA (#5340) Update links in the documentation (#5175) fix visibility for `pallet_nfts` types used as call arguments (#3634) Correct some typos in crates' descriptions (#5262) Aura: Ensure we are building on each relay chain fork (#5352) Update Identity pallet README.md (#5183) Bump trie-db from 0.29.0 to 0.29.1 (#5231) [Coretime] Always include UnpaidExecution, not just when revenue is > 0 (#5369) [Pools] fix derivation of pool account (#4999) Upgrade accidentally downgraded deps (#5365) [Pools] Fix issues with member migration to `DelegateStake` (#4822) Unify `no_genesis` check (#5360) [CI] Fix prdoc command (#5358) Beefy: add benchmarks for `report_fork_voting()` (#5188)

…ct-candidate-weight * ao-fix-parainclusion-weight-overestimation: Remove redundant minimal template workspace (#5330) approval-distribution: Fix handling of conclude (#5375) More logs in `is_potential_spam` from `dispute-coordinator` (#5252) Fix zombienet bridges test (#5373) Update Readme of the `polkadot` crate (#5326) allow for `u8` to be used as hold/freeze reason (#5348) Moving cargo check for runtimes to GHA (#5340) Update links in the documentation (#5175) fix visibility for `pallet_nfts` types used as call arguments (#3634) Correct some typos in crates' descriptions (#5262) Aura: Ensure we are building on each relay chain fork (#5352) Update Identity pallet README.md (#5183) Bump trie-db from 0.29.0 to 0.29.1 (#5231) [Coretime] Always include UnpaidExecution, not just when revenue is > 0 (#5369) [Pools] fix derivation of pool account (#4999) Upgrade accidentally downgraded deps (#5365) [Pools] Fix issues with member migration to `DelegateStake` (#4822) Unify `no_genesis` check (#5360) [CI] Fix prdoc command (#5358) Beefy: add benchmarks for `report_fork_voting()` (#5188)

FlorianFranzen · 2025-04-25T11:34:19Z

@Ank4n Any chance that this change might reap accounts that withdraw on chains that never used a non-delegated nomination pool to begin with?

Ank4n · 2025-04-25T12:24:32Z

@Ank4n Any chance that this change might reap accounts that withdraw on chains that never used a non-delegated nomination pool to begin with?

Can you elaborate? In a delegated pool, the user fund should stay with the user account as a hold amount when in the pool, or free balance when withdrawn. Or do I misunderstand your question?

FlorianFranzen · 2025-04-25T12:33:04Z

We currently have the issue that accounts get reaped when the try and withdraw their unbounded funds and it seems one of the few changes to the runtime that alters provider count handling that which might cause the accidental reaping seems to be this PR (at least after some preliminary investigation).

The account had thousand of staked and free tokens before triggering the withdrawal, far above the existential deposit.

EDIT: I was now able to replicate the issue in testing. Seems if the funds are unbonded on an old runtime (v1.15), they will lead to the account to be reaped if the withdrawal happens after an upgrade to new runtime (v1.17):

Ank4n · 2025-04-25T15:57:12Z

@FlorianFranzen So accounts are getting reaped even when they have more than ED balance? That's not good.
I looked at the code and it seems the provider count is increased for members when members are migrated, and decremented when they withdraw everything. I believe what you are seeing is not this behaviour?

Can you share your test code?

FlorianFranzen · 2025-04-25T16:09:46Z

The test "code" is rather simple: Run a chain with nomination pool and delegated staking on v1.15, unbond funds from any pool, upgrade to v1.17 (v1.16 might be similar) and withdrawn the unbonded funds.

I will be able to provided some ready to use example once I am done downgrading out mainnet and reimbursing effected users. 🤞

Ank4n added 13 commits June 29, 2024 02:23

migration test

11a0c44

fmt

efd3324

undo pool changes

3f8d2fc

fixes all NotEnoughFunds error

7388573

return false if pool does not exist

6634d25

fix transfer on hold amount should still be held in dst acc

a3901a9

fmt

462be1f

unexpected errors check

c7e9f6c

all non staking accounts succeed when given minimum balance

9a68720

assert migrate tests

268d0a5

remove clone

000762f

uncomment

a904fc8

incrementing provider fixes users migrating with zero balance

0c776b8

Ank4n force-pushed the ankan/delegate-stake-remote-tests branch from 396dded to 0c776b8 Compare June 29, 2024 00:24

Ank4n and others added 16 commits July 3, 2024 19:15

Merge branch 'master' into ankan/delegate-stake-remote-tests

699a2ec

Merge branch 'master' into ankan/delegate-stake-remote-tests

c3fa887

test for clean up accounts

3d2379e

providers are incremented correctly when migration agent/delegators

ec9035c

migrated agents/delegators are also cleaned up correctly

a9d4595

improve remote tests

8a27ae0

Merge branch 'master' into ankan/delegate-stake-remote-tests

8f77ac4

add runtime api for total member balance

7fd484a

ensure member can't bond extra if they are in unmigrated state

9925a9f

gate all calls if non migrated state as defensive measure

4a9f35f

ensure all calls are gated

bc3ce11

add runtime api for pool balance

5b91644

remove unused imports

6ceb1ba

fix import

de48083

Merge branch 'master' into ankan/delegate-stake-remote-tests

fd8a451

fix test

ab2317b

Ank4n added 4 commits August 14, 2024 01:12

Merge branch 'master' into ankan/delegate-stake-remote-tests

5082542

refactor inc dec of providers

bce9803

gate extrinsics on top level function

ae9a370

fix clippy

251ba4c

gpestana approved these changes Aug 14, 2024

View reviewed changes

Ank4n added this pull request to the merge queue Aug 14, 2024

Merged via the queue into master with commit feacf2f Aug 14, 2024

Ank4n deleted the ankan/delegate-stake-remote-tests branch August 14, 2024 20:18

ggwpez mentioned this pull request Sep 9, 2024

Parent issue for stable2409 LTS release #5583

Closed

github-actions bot mentioned this pull request Oct 8, 2024

Update polkadot-sdk from stable2407 to stable2409 moonbeam-foundation/moonbeam#2994

Closed

github-actions bot mentioned this pull request Dec 5, 2024

Update polkadot-sdk from stable2407 to stable2409-2 moonbeam-foundation/moonbeam#3075

Closed

This was referenced Apr 27, 2025

delegated-staking: missing migration can lead to accounts being reaped after delegation is released #8352

Open

delegated-staking: add and force missing delegator migration #8353

Open

pgherveou added this to [preview] release tracker Mar 20, 2026

github-project-automation bot moved this to Todo in [preview] release tracker Mar 20, 2026

github-project-automation bot moved this from Todo to Done in [preview] release tracker Mar 20, 2026

pgherveou removed this from [preview] release tracker Mar 20, 2026

pgherveou added this to [preview] release tracker Mar 23, 2026

github-project-automation bot moved this to Todo in [preview] release tracker Mar 23, 2026

github-project-automation bot moved this from Todo to Done in [preview] release tracker Mar 23, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Pools] Fix issues with member migration to `DelegateStake`#4822

[Pools] Fix issues with member migration to `DelegateStake`#4822
Ank4n merged 54 commits intomasterfrom
ankan/delegate-stake-remote-tests

Ank4n commented Jun 18, 2024 •

edited

Loading

Uh oh!

paritytech-cicd-pr commented Aug 13, 2024

Uh oh!

gpestana Aug 14, 2024

Uh oh!

Uh oh!

gpestana Aug 14, 2024

Uh oh!

FlorianFranzen commented Apr 25, 2025

Uh oh!

Ank4n commented Apr 25, 2025

Uh oh!

FlorianFranzen commented Apr 25, 2025 •

edited

Loading

Uh oh!

Ank4n commented Apr 25, 2025 •

edited

Loading

Uh oh!

FlorianFranzen commented Apr 25, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

Ank4n commented Jun 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Changes

Addressing possible migration errors

Results from RemoteExternalities Tests.

Kusama

Polkadot

TODO

Uh oh!

paritytech-cicd-pr commented Aug 13, 2024

Uh oh!

gpestana Aug 14, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gpestana Aug 14, 2024

Choose a reason for hiding this comment

Uh oh!

FlorianFranzen commented Apr 25, 2025

Uh oh!

Ank4n commented Apr 25, 2025

Uh oh!

FlorianFranzen commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ank4n commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FlorianFranzen commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Ank4n commented Jun 18, 2024 •

edited

Loading

FlorianFranzen commented Apr 25, 2025 •

edited

Loading

Ank4n commented Apr 25, 2025 •

edited

Loading

FlorianFranzen commented Apr 25, 2025 •

edited

Loading