Fixes `TotalValueLocked` out of sync in nomination pools #3052

gpestana · 2024-01-24T18:43:41Z

The TotalLockedValue storage value in nomination pools pallet may get out of sync if the staking pallet does implicit withdrawal of unlocking chunks belonging to a bonded pool stash. This fix is based on a new method in the OnStakingUpdate traits, on_withdraw, which allows the nomination pools pallet to adjust the TotalLockedValue every time there is an implicit or explicit withdrawal from a bonded pool's stash.

This PR also adds a migration that checks and updates the on-chain TVL if it got out of sync due to the bug this PR fixes.

Changes to trait OnStakingUpdate

In order for staking to notify the nomination pools pallet that chunks where withdrew, we add a new method, on_withdraw to the OnStakingUpdate trait. The nomination pools pallet filters the withdraws that are related to bonded pool accounts and updates the TotalValueLocked accordingly.

Others

Adds try-state checks to the EPM/staking e2e tests
Adds tests for auto withdrawing in the context of nomination pools

To-do

check if we need a migration to fix the current TotalValueLocked (run try-runtime)
migrations to fix the current on-chain TVL value

✅ Kusama:

TotalValueLocked: 99.4559 kKSM
TotalValueLocked (calculated) 99.4559 kKSM

⚠️ Westend:

TotalValueLocked: 18.4060 kWND
TotalValueLocked (calculated) 18.4050 kWND

Polkadot: TVL not released yet.

Closes #3055

gpestana · 2024-01-25T00:06:02Z

bot fmt

command-bot · 2024-01-25T00:06:08Z

@gpestana https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/5024240 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 21-b3c66b89-5687-4693-a834-052339423958 to cancel this command or bot cancel to cancel all commands in this pull request.

command-bot · 2024-01-25T00:07:09Z

@gpestana Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/5024240 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/5024240/artifacts/download.

prdoc/pr_3052.prdoc

rossbulat

This warning comment for EventListeners should probably be updated to reflect the additional on_withdraw use case.

substrate/frame/staking/src/pallet/impls.rs

substrate/frame/nomination-pools/src/lib.rs

prdoc/pr_3052.prdoc

rossbulat

Neat solution of fixing the issue and removing a function on the pools side. Looks like a good approval once the migration has been determined.

kianenigma · 2024-01-26T15:00:09Z

substrate/frame/nomination-pools/src/lib.rs

@@ -2265,7 +2244,8 @@ pub mod pallet {

 			// Before calculating the `balance_to_unbond`, we call withdraw unbonded to ensure the
 			// `transferrable_balance` is correct.
-			let stash_killed = bonded_pool.withdraw_from_staking(num_slashing_spans)?;
+			let stash_killed =


Can we not update the TVL here, instead of needing the on_withdraw?

That's what the fn withdraw_from_staking was doing. However that's insufficient because staking may withdraw unlocking chunks from a bonded pool account without an explicit request from pools. If that happens, the TVL in the pool is not updated.

This is the culprit code on the staking side: https://github.com/paritytech/polkadot-sdk/blob/master/substrate/frame/staking/src/pallet/mod.rs#L1029-L1039.

Co-authored-by: Ross Bulat <ross@parity.io>

paritytech-cicd-pr · 2024-02-07T16:16:51Z

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: test-linux-stable 2/3
Logs: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/5142739

paritytech-cicd-pr · 2024-02-07T16:16:51Z

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: test-linux-stable 1/3
Logs: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/5142738

substrate/frame/nomination-pools/src/lib.rs

seadanda

LGTM - sorry for the grammatical tweaks 😀

substrate/frame/election-provider-multi-phase/test-staking-e2e/src/lib.rs

substrate/frame/nomination-pools/src/lib.rs

substrate/frame/nomination-pools/src/migration.rs

substrate/frame/nomination-pools/src/mock.rs

Co-authored-by: Dónal Murray <donal.murray@parity.io>

…/src/lib.rs Co-authored-by: Dónal Murray <donal.murray@parity.io>

Co-authored-by: Dónal Murray <donal.murray@parity.io>

…3052) The `TotalLockedValue` storage value in nomination pools pallet may get out of sync if the staking pallet does implicit withdrawal of unlocking chunks belonging to a bonded pool stash. This fix is based on a new method in the `OnStakingUpdate` traits, `on_withdraw`, which allows the nomination pools pallet to adjust the `TotalLockedValue` every time there is an implicit or explicit withdrawal from a bonded pool's stash. This PR also adds a migration that checks and updates the on-chain TVL if it got out of sync due to the bug this PR fixes. **Changes to `trait OnStakingUpdate`** In order for staking to notify the nomination pools pallet that chunks where withdrew, we add a new method, `on_withdraw` to the `OnStakingUpdate` trait. The nomination pools pallet filters the withdraws that are related to bonded pool accounts and updates the `TotalValueLocked` accordingly. **Others** - Adds try-state checks to the EPM/staking e2e tests - Adds tests for auto withdrawing in the context of nomination pools **To-do** - [x] check if we need a migration to fix the current `TotalValueLocked` (run try-runtime) - [x] migrations to fix the current on-chain TVL value ✅ **Kusama**: ``` TotalValueLocked: 99.4559 kKSM TotalValueLocked (calculated) 99.4559 kKSM ``` ⚠️ **Westend**: ``` TotalValueLocked: 18.4060 kWND TotalValueLocked (calculated) 18.4050 kWND ``` **Polkadot**: TVL not released yet. Closes paritytech#3055 --------- Co-authored-by: command-bot <> Co-authored-by: Ross Bulat <ross@parity.io> Co-authored-by: Dónal Murray <donal.murray@parity.io>

Adds e2e tests for auto withdrawing in the context of pools

625550d

gpestana added the T10-tests This PR/Issue is related to tests. label Jan 24, 2024

gpestana self-assigned this Jan 24, 2024

gpestana requested review from a team January 24, 2024 18:43

gpestana marked this pull request as draft January 24, 2024 18:43

gpestana changed the title ~~Adds e2e tests for auto withdrawing in the context of pools~~ Fixes TotalValueLocked out of sync in nomination pools Jan 24, 2024

gpestana added 2 commits January 25, 2024 00:36

Fixes TotalLockedValue out of sync

fe4a5ef

Adds prdoc

5fddc45

gpestana marked this pull request as ready for review January 24, 2024 23:45

gpestana added T1-FRAME This PR/Issue is related to core FRAME, the framework. T8-polkadot This PR/Issue is related to/affects the Polkadot network. labels Jan 24, 2024

Renames prdoc

640c99e

".git/.scripts/commands/fmt/fmt.sh"

a0f7b55