|
| 1 | +//! # Pool Withdrawal Fix Pallet |
| 2 | +//! |
| 3 | +//! A pallet for handling pool withdrawal operations through delegation pallet connector. |
| 4 | +//! This pallet provides withdrawal functionality that can be called by root or governance. |
| 5 | +
|
| 6 | +#![cfg_attr(not(feature = "std"), no_std)] |
| 7 | + |
| 8 | +use frame_support::pallet_prelude::Weight; |
| 9 | +pub use pallet::*; |
| 10 | + |
| 11 | +#[frame_support::pallet] |
| 12 | +pub mod pallet { |
| 13 | + use frame_support::{ |
| 14 | + pallet_prelude::*, |
| 15 | + traits::{Currency, EnsureOrigin, LockableCurrency}, |
| 16 | + }; |
| 17 | + use frame_system::pallet_prelude::*; |
| 18 | + use sp_staking::OnStakingUpdate; |
| 19 | + |
| 20 | + use crate::WeightInfo; |
| 21 | + |
| 22 | + pub type BalanceOf<T> = |
| 23 | + <<T as Config>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance; |
| 24 | + |
| 25 | + #[pallet::pallet] |
| 26 | + pub struct Pallet<T>(_); |
| 27 | + |
| 28 | + /// Configure the pallet by specifying the parameters and types on which it depends. |
| 29 | + #[pallet::config] |
| 30 | + pub trait Config: frame_system::Config { |
| 31 | + /// Because this pallet emits events, it depends on the runtime's definition of an event. |
| 32 | + type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>; |
| 33 | + type Currency: LockableCurrency<Self::AccountId, Moment = BlockNumberFor<Self>>; |
| 34 | + /// Integrate Delegated Pallet |
| 35 | + type DelegationPalletConnector: OnStakingUpdate<Self::AccountId, BalanceOf<Self>>; |
| 36 | + /// Governance origin for withdrawal calls |
| 37 | + type GovernanceOrigin: EnsureOrigin<Self::RuntimeOrigin>; |
| 38 | + /// Type representing the weight of this pallet |
| 39 | + type WeightInfo: WeightInfo; |
| 40 | + } |
| 41 | + |
| 42 | + /// Pallets use events to inform users when important changes are made. |
| 43 | + /// https://docs.substrate.io/main-docs/build/events-errors/ |
| 44 | + #[pallet::event] |
| 45 | + #[pallet::generate_deposit(pub(super) fn deposit_event)] |
| 46 | + pub enum Event<T: Config> { |
| 47 | + /// Withdrawal was called for a stash account. [stash_account, amount] |
| 48 | + WithdrawCalled { stash_account: T::AccountId, amount: BalanceOf<T> }, |
| 49 | + } |
| 50 | + |
| 51 | + #[pallet::error] |
| 52 | + pub enum Error<T> { |
| 53 | + /// Withdrawal failed due to insufficient balance or other staking constraints. |
| 54 | + WithdrawalFailed, |
| 55 | + } |
| 56 | + |
| 57 | + /// Dispatchable functions allows users to interact with the pallet and invoke state changes. |
| 58 | + /// These functions materialize as "extrinsics", which are often compared to transactions. |
| 59 | + /// Dispatchable functions must be annotated with a weight and must return a DispatchResult. |
| 60 | + #[pallet::call] |
| 61 | + impl<T: Config> Pallet<T> { |
| 62 | + /// Call withdrawal for a stash account through the delegation pallet connector. |
| 63 | + /// This function can be called by root or governance. |
| 64 | + #[pallet::call_index(0)] |
| 65 | + #[pallet::weight(T::WeightInfo::call_withdraw())] |
| 66 | + pub fn call_withdraw( |
| 67 | + origin: OriginFor<T>, |
| 68 | + stash_account: T::AccountId, |
| 69 | + amount: BalanceOf<T>, |
| 70 | + ) -> DispatchResult { |
| 71 | + T::GovernanceOrigin::ensure_origin(origin)?; |
| 72 | + |
| 73 | + // Call the delegation pallet connector to handle withdrawal |
| 74 | + T::DelegationPalletConnector::on_withdraw(&stash_account, amount); |
| 75 | + |
| 76 | + // Emit an event. |
| 77 | + Self::deposit_event(Event::WithdrawCalled { stash_account, amount }); |
| 78 | + |
| 79 | + Ok(()) |
| 80 | + } |
| 81 | + } |
| 82 | +} |
| 83 | + |
| 84 | +/// Weight functions needed for pallet_pool_withdrawal_fix. |
| 85 | +pub trait WeightInfo { |
| 86 | + fn call_withdraw() -> Weight; |
| 87 | +} |
| 88 | + |
| 89 | +/// Default weight implementation for the pallet. |
| 90 | +impl WeightInfo for () { |
| 91 | + fn call_withdraw() -> Weight { |
| 92 | + Weight::from_parts(10_000, 0) |
| 93 | + } |
| 94 | +} |
0 commit comments