[Staking] Noop refactor to prep pallet for currency fungible migration #5399
Conversation
Ank4n
changed the title
|
The CI pipeline was cancelled due to failure one of the required jobs. |
| /// Stakeable balance of `who`. | ||
| /// | ||
| /// This includes balance free to stake along with any balance that is already staked. | ||
| pub fn stakeable_balance<T: Config>(who: &T::AccountId) -> BalanceOf<T> { |
There was a problem hiding this comment.
How about we do it from another perspective and expose both:
fn asset::stakedandfn asset::free_to_stake
And the remove fn stakeable_balance, which can be calculated by summing "staked + free_to_stake".
There was a problem hiding this comment.
This makes sense in this PR but probably not here.
There was a problem hiding this comment.
Clarification: The only way to calculate free_to_stake in currency::locks world is by checking free_balance (aka stakeable_balance) - locked_balance.
| /// Kill the stake of `who`. | ||
| /// | ||
| /// All locked amount is unlocked. | ||
| pub fn kill_stake<T: Config>(who: &T::AccountId) { |
There was a problem hiding this comment.
Maybe unlock_all_stake instead? Kill stake is very similar to kill ledger etc, although in a completely different context.
There was a problem hiding this comment.
I actually named it keeping in convention with kill ledger. This is only to be used while killing ledger.
Can rename if you still think it is confusing.
| @@ -269,7 +261,7 @@ impl<T: Config> StakingLedger<T> { | |||
| // kill virtual staker if it exists. | |||
| if <VirtualStakers<T>>::take(&stash).is_none() { | |||
| // if not virtual staker, clear locks. | |||
| T::Currency::remove_lock(STAKING_ID, &ledger.stash); | |||
| asset::kill_stake::<T>(&ledger.stash); | |||
There was a problem hiding this comment.
| asset::kill_stake::<T>(&ledger.stash); | |
| asset::unlock_all_stake::<T>(&ledger.stash); |
nit
| /// Mint `value` into an existing account `who`. | ||
| /// | ||
| /// This does not increase the total issuance. | ||
| pub fn mint_existing<T: Config>( |
There was a problem hiding this comment.
It seems to me that one goal of this module is to abstract the asset interface so that we can make the currency->fungible refactor and ensure the changes are concentrated in this module. I think this is a good idea. How about going a step forward and ensure the naming does not need to change in future designs of the inflation/rewards? E.g. in Plaza, we are not expected to "mint_into" but rather transfer or reward into an account. wdyt?
There was a problem hiding this comment.
Yeah makes sense. I can call it mint_reward? OTOH, this would be a simple rename in future so we probably don't need to worry about it much.
| @@ -779,7 +779,7 @@ pub mod pallet { | |||
| status | |||
| ); | |||
| assert!( | |||
| T::Currency::free_balance(stash) >= balance, | |||
| asset::stakeable_balance::<T>(stash) >= balance, | |||
There was a problem hiding this comment.
| asset::stakeable_balance::<T>(stash) >= balance, | |
| asset::free_to_stake::<T>(stash) >= balance, |
Just an idea, as per my comment in the asset module.
| @@ -619,7 +619,7 @@ pub trait DelegationMigrator { | |||
| /// | |||
| /// Also removed from [`StakingUnchecked`] as a Virtual Staker. Useful for testing. | |||
| #[cfg(feature = "runtime-benchmarks")] | |||
| fn migrate_to_direct_staker(agent: Agent<Self::AccountId>); | |||
| fn force_kill_agent(agent: Agent<Self::AccountId>); | |||
There was a problem hiding this comment.
I backported some changes from #5501 to minimise diff in the other one. Earlier DelegationMigrator::migrate_to_direct_staker would kill agent + migrate to direct staker in staking. But due to the fungible changes this is not possible anymore (freezes can apply even without enough balance but for holds, we need to kill agent, transfer all funds from delegators to agent and then make it a direct staker).
It is also cleaner like this.
| @@ -124,7 +124,7 @@ impl<T: Config> DelegationMigrator for Pallet<T> { | |||
|
|
|||
| /// Only used for testing. | |||
| #[cfg(feature = "runtime-benchmarks")] | |||
| fn migrate_to_direct_staker(agent: Agent<Self::AccountId>) { | |||
There was a problem hiding this comment.
renamed this since it does not actually migrate to direct staker anymore but only kills agent.
| #[cfg(feature = "runtime-benchmarks")] | ||
| pub fn burn<T: Config>(amount: BalanceOf<T>) -> PositiveImbalanceOf<T> { | ||
| T::Currency::burn(amount) | ||
| } |
There was a problem hiding this comment.
This file is like a shim that makes the usage of LockableCurrency and Hold overlap, I can kind of see where you are going with this and it is good :)
This is a no-op refactor of staking pallet to move all
T::Currencyapi calls under one module.A followup PR (#5501) will implement the Currency <> Fungible migration for the pallet.
Introduces the new
assetmodule that centralizes all interaction withT::Currency. This is an attempt to try minimising staking logic changes to minimal parts of the codebase.Things of note
T::Currency::free_balancein current implementation includes both staked (locked) and liquid tokens (kinda sounds wrong to call it free then). This PR renames it tostakeable_balance(any better name suggestions?). With [Staking] Currency <> Fungible migration #5501, this will becomefree balance that can be held/staked+already held/staked balance.