[Staking] Currency <> Fungible migration #5501

Ank4n · 2024-08-27T12:19:46Z

Migrate staking currency from traits::LockableCurrency to traits::fungible::holds.

Resolves part of #226.

Changes

Nomination Pool

TransferStake is now incompatible with fungible migration as old pools were not meant to have additional ED. Since they are anyways deprecated, removed its usage from all test runtimes.

Staking

Config: Currency becomes of type Fungible while OldCurrency is the LockableCurrency used before.
Lazy migration of accounts. Any ledger update will create a new hold with no extra reads/writes. A permissionless extrinsic migrate_currency() releases the old lock along with some housekeeping.
Staking now requires ED to be left free. It also adds no consumer to staking accounts.
If hold cannot be applied to all stake, the un-holdable part is force withdrawn from the ledger.

Delegated Staking

The pallet does not add provider for agents anymore.
TODO: check again if unclaimed withdrawals would be affected by this.

Migration stats (needs update)

Polkadot

Total accounts that can be migrated: 59564
Accounts failing to migrate: 0
Accounts with some stake force withdrawn: 59
Total force withdrawal: 29591.26 DOT

Kusama

Total accounts that can be migrated: 26311
Accounts failing to migrate: 0
Accounts with some stake force withdrawn: 48
Total force withdrawal: 1036.05 KSM

Full logs here.

Note about locks (freeze) vs holds

With locks or freezes, staking could use total balance of an account. But with holds, the account needs to be left with at least Existential Deposit in free balance. This would also affect nomination pools which till now has been able to stake all funds contributed to it. An alternate version of this PR is #5658 where staking pallet does not add any provider, but means pools and delegated-staking pallet has to provide for these accounts and makes the end to end logic (of provider and consumer ref) lot less intuitive and prone to bug.

This PR now introduces requirement for stakers to maintain ED in their free balance. This helps with removing the bug prone incrementing and decrementing of consumers and providers.

TODO

Followup

Ensure nomination pool members can directly stake and vice versa. #5742

balance hold checks both frozen and reserved wip: around 25 tests failing check Holds instead of locks 20 tests failing fmt 11 fails 4 fails 2 failing 1 fail all tests pass but pending a hygiene check of code fix compile minor refactor remove T::Currency calls from asset mod

…staking-migrate-currency-to-fungible-2

paritytech-workflow-stopper · 2024-11-28T13:10:37Z

All GitHub workflows were cancelled due to failure one of the required jobs.
Failed workflow url: https://github.com/paritytech/polkadot-sdk/actions/runs/12069377708
Failed job name: test-linux-stable

paritytech-workflow-stopper · 2024-11-28T13:10:40Z

All GitHub workflows were cancelled due to failure one of the required jobs.
Failed workflow url: https://github.com/paritytech/polkadot-sdk/actions/runs/12069377705
Failed job name: cargo-clippy

Ank4n · 2024-11-28T11:17:52Z

substrate/bin/node/testing/src/genesis.rs

@@ -38,9 +38,9 @@ pub fn config_endowed(extra_endowed: Vec<AccountId>) -> RuntimeGenesisConfig {
 		(alice(), 111 * DOLLARS),
 		(bob(), 100 * DOLLARS),
 		(charlie(), 100_000_000 * DOLLARS),
-		(dave(), 111 * DOLLARS),
+		(dave(), 112 * DOLLARS),


Bumping up the balance by ED for stakers here. With this PR, we require at least ED to be left free in the staking account.

Ank4n · 2024-11-28T11:21:48Z

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

@@ -77,7 +79,7 @@ frame_support::construct_runtime!(
 	}
 );

-pub(crate) type AccountId = u64;
+pub(crate) type AccountId = u128;


with u64, pool pot accounts have collisions.

Ank4n · 2024-11-28T11:22:38Z

substrate/frame/fast-unstake/src/mock.rs

-				.chain(validators_range.clone().map(|x| (x, 7 + 100)))
-				.chain(nominators_range.clone().map(|x| (x, 7 + 100)))
+				// give stakers enough balance for stake, ed and fast unstake deposit.
+				.chain(validators_range.clone().map(|x| (x, 7 + 1 + 100)))


providing additional ED to stakers.

Ank4n · 2024-11-28T11:44:46Z

substrate/frame/offences/benchmarking/src/inner.rs

-			// account endowed + some funds rescinded from issuance.
-			assert_eq!(System::<T>::read_events_for_pallet::<pallet_balances::Event<T>>().len(), 2 * (n + 1) as usize + 3);
+			// deposit to reporter + reporter account endowed.
+			assert_eq!(System::<T>::read_events_for_pallet::<pallet_balances::Event<T>>().len(), 2);


changes in which events are emitted is due to moving from Currency to Fungibles trait.

Ank4n · 2024-11-28T11:45:49Z

substrate/frame/root-offences/src/mock.rs

-				(21, self.balance_factor * 1000),
-				(31, self.balance_factor * 500),
-				(41, self.balance_factor * 1000),
+				(11, self.balance_factor * 1500),


minting some extra balance into stakers so they always have at least ED as free balance.

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

Zebedeusz · 2024-12-09T11:14:57Z

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

+		// Get rid of the extra consumer we used to have with OldCurrency.
+		frame_system::Pallet::<T>::dec_consumers(&stash);
+
+		Self::deposit_event(Event::<T>::CurrencyMigrated { stash: stash.clone(), force_withdraw });


Is this event suppossed to notify of how much funds were migrated?
Because by looking at the if-else above it looks like it's more like funds_still_locked_in_old_currency.

Not sure if I understand funds_still_locked_in_old_currency ? Once we get here, there should be nothing locked with old currency.

The event is meant to notify clients that the given account has migrated to new currency along with the information if their ledger has reduced by some balance because of this operation.

I understood that the "else" condition is when someone has more funds locked for staking than in their free balance thus we cannot "hold" as much as is needed so we go just for as much as possible.
Regarding funds_still_locked_in_old_currency, I called it so because in if zero value is returned and in else it's the difference between staked and free balance and since the free balance will be held then the result is what's left to unlock and move to hold.
Is my reasoning correct?

Zebedeusz · 2024-12-09T11:17:37Z

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

@@ -89,13 +93,27 @@ pub mod pallet {

 	#[pallet::config(with_default)]
 	pub trait Config: frame_system::Config {
+		/// The old trait for staking balance. Deprecated and only used for migrating old ledgers.


Shouldn't the pallet be annotated with deprecated then?

Not pallet but yeah may be config item can be annotated as deprecated (if its possible).

Ank4n · 2024-12-09T12:02:25Z

substrate/frame/staking/src/asset.rs

+///
+/// Does not include the current stake.
+pub fn free_to_stake<T: Config>(who: &T::AccountId) -> BalanceOf<T> {
+	// since we want to be able to use frozen funds for staking, we force the reduction.


The note was related to the usage of Fortitude::Force. Any funds that is locked or frozen (such as for governance or vesting) should still be usable for staking.

Zebedeusz · 2024-12-09T13:38:31Z

substrate/frame/staking/src/asset.rs

+		let _ = T::Currency::set_balance(who, value - staked_balance + ed);
+	} else {
+		// else reduce the staked balance.
+		update_stake::<T>(who, value).expect("can remove from what is staked");


Suggested change

update_stake::<T>(who, value).expect("can remove from what is staked");

update_stake::<T>(who, value).expect("cannot remove from what is staked");

Zebedeusz · 2024-12-10T08:08:25Z

substrate/frame/staking/src/tests.rs

+	#[test]
+	fn ledger_update_creates_hold() {
+		ExtBuilder::default().has_stakers(true).build_and_execute(|| {
+			// GIVEN alice who is a nominator with old currency


Suggested change

// GIVEN alice who is a nominator with old currency

// GIVEN alice who is a nominator with new currency

Ank4n and others added 21 commits August 18, 2024 20:02

prep for abstracting out all currency calls in a separate mod

02d3a70

replace ED calls

fa1064f

replace ti, burn, and set balance calls

babc205

add read balance and update lock fn to asset

2f0cd28

replace all currency call with existing asset fn

4af4aee

add remaining currency fn

1995e06

all currency fn replaced

f3a3081

fix imports

6a03abb

remove unused import

040c630

Merge branch 'master' into ankan/staking-migrate-currency-to-fungible

3d3ceac

fix clippy

61eb7b7

repalce Balances api calls in test to asset as well

b8a0e4b

clippy

2926255

Merge branch 'master' into ankan/staking-migrate-currency-to-fungible

9e38e8e

rustdoc update

34e1d48

refactor

31c6467

reorder

851c5f3

rustdoc fix

ebf60ef

rename Fungible to Currency

07e3ca9

add support for fungible imbalance handler in pallet treasury

58e8e83

Ank4n changed the base branch from master to ankan/staking-migrate-currency-to-fungible August 27, 2024 12:20

Ank4n mentioned this pull request Aug 27, 2024

[Staking] Noop refactor to prep pallet for currency fungible migration #5399

Merged

Ank4n and others added 7 commits August 27, 2024 14:28

add license

fe893a8

Merge branch 'master' into ankan/staking-migrate-currency-to-fungible

087692b

fix unused imports

a9d0345

fix rust doc

67bd3fa

Merge branch 'ankan/staking-migrate-currency-to-fungible' into ankan/…

5157b3b

…staking-migrate-currency-to-fungible-2

missing import

e6c705e

conditional import of fun mutate

c4a9c9d

Ank4n added 4 commits November 28, 2024 12:15

remove fungible compat

637321e

keep migration tests in test-delegate-stake

0a97a04

remove purge_keys

3182687

revert treasury changes

60b0018

Ank4n marked this pull request as ready for review November 28, 2024 12:13

Ank4n mentioned this pull request Nov 28, 2024

Remove TransferStake impl from Pools #6631

Closed

Ank4n and others added 2 commits November 28, 2024 19:17

Merge branch 'master' into ankan/staking-migrate-currency-to-fungible-2

08c1f31

fmt

5483e96

Ank4n added 5 commits November 28, 2024 14:30

remove unused import

7c9a4b9

fix staking stake balance

5cdc785

fix tests

07b5e3c

fmt

1a31c65

replace stakeable balance with free to stake

1cd44d1

Ank4n commented Dec 5, 2024

View reviewed changes

Ank4n and others added 2 commits December 5, 2024 09:41

Merge branch 'master' into ankan/staking-migrate-currency-to-fungible-2

8f9777c

fmt

ecb87d9

Ank4n requested a review from Zebedeusz December 5, 2024 10:19

Ank4n and others added 3 commits December 5, 2024 11:20

remove todo from code

7a2365a

Merge branch 'master' into ankan/staking-migrate-currency-to-fungible-2

fb2fa6b

add test to ensure locked amount can be staked

8f9b0c6

Zebedeusz reviewed Dec 9, 2024

View reviewed changes

substrate/frame/staking/src/pallet/impls.rs Show resolved Hide resolved

Zebedeusz reviewed Dec 9, 2024

View reviewed changes

substrate/frame/staking/src/pallet/impls.rs Show resolved Hide resolved

Zebedeusz reviewed Dec 9, 2024

View reviewed changes

Ank4n commented Dec 9, 2024

View reviewed changes

gpestana self-requested a review December 9, 2024 13:19

Zebedeusz reviewed Dec 9, 2024

View reviewed changes

Zebedeusz reviewed Dec 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Staking] Currency <> Fungible migration #5501

[Staking] Currency <> Fungible migration #5501

Ank4n commented Aug 27, 2024 •

edited

Loading

paritytech-workflow-stopper bot commented Nov 28, 2024

paritytech-workflow-stopper bot commented Nov 28, 2024

Ank4n Nov 28, 2024

Ank4n Nov 28, 2024

Ank4n Nov 28, 2024

Ank4n Nov 28, 2024

Ank4n Nov 28, 2024

Zebedeusz Dec 9, 2024

Ank4n Dec 9, 2024

Zebedeusz Dec 9, 2024

Zebedeusz Dec 9, 2024

Ank4n Dec 9, 2024

Ank4n Dec 9, 2024

Zebedeusz Dec 9, 2024

Zebedeusz Dec 10, 2024

	update_stake::<T>(who, value).expect("can remove from what is staked");
	update_stake::<T>(who, value).expect("cannot remove from what is staked");

	// GIVEN alice who is a nominator with old currency
	// GIVEN alice who is a nominator with new currency

[Staking] Currency <> Fungible migration #5501

Are you sure you want to change the base?

[Staking] Currency <> Fungible migration #5501

Conversation

Ank4n commented Aug 27, 2024 • edited Loading

Changes

Nomination Pool

Staking

Delegated Staking

Migration stats (needs update)

Polkadot

Kusama

Note about locks (freeze) vs holds

TODO

Followup

paritytech-workflow-stopper bot commented Nov 28, 2024

paritytech-workflow-stopper bot commented Nov 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ank4n commented Aug 27, 2024 •

edited

Loading