Skip to content

Commit

Permalink
add rustdoc for migrate
Browse files Browse the repository at this point in the history
  • Loading branch information
Ank4n committed Oct 26, 2024
1 parent d2b1084 commit 3e48265
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions substrate/frame/staking/src/pallet/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2181,6 +2181,13 @@ pub mod pallet {
Ok(())
}

/// Migrates permissionlessly a stash from locks to holds.
///
/// This removes the old lock on the stake and creates a hold on it atomically. If all
/// stake cannot be held, the best effort is made to hold as much as possible. The remaining
/// stake is removed from the ledger.
///
/// The fee is waived if the migration is successful.
#[pallet::call_index(30)]
#[pallet::weight(T::WeightInfo::migrate_currency())]
pub fn migrate_currency(
Expand Down

0 comments on commit 3e48265

Please sign in to comment.