1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677#![cfg_attr(not(feature = "std"), no_std)]7879#[cfg(feature = "runtime-benchmarks")]80mod benchmarking;8182pub mod weights;8384use sp_core::H160;85use codec::{Codec, Decode, Encode};86use frame_system::{self as system, ensure_signed};87pub use pallet::*;88use scale_info::TypeInfo;89use sp_runtime::{90 traits::{BadOrigin, One, Saturating, Zero},91 RuntimeDebug, DispatchErrorWithPostInfo,92};93use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};9495use frame_support::{96 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},97 traits::{98 schedule::{self, DispatchTime, MaybeHashed},99 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,100 StorageVersion,101 },102 weights::{GetDispatchInfo, Weight},103};104105pub use weights::WeightInfo;106107108pub type PeriodicIndex = u32;109110pub type TaskAddress<BlockNumber> = (BlockNumber, u32);111pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;112113type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];114pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;115116117#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]118#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]119pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {120 121 maybe_id: Option<ScheduledId>,122 123 priority: schedule::Priority,124 125 call: Call,126 127 maybe_periodic: Option<schedule::Period<BlockNumber>>,128 129 origin: PalletsOrigin,130 _phantom: PhantomData<AccountId>,131}132133pub type ScheduledV3Of<T> = ScheduledV3<134 CallOrHashOf<T>,135 <T as frame_system::Config>::BlockNumber,136 <T as Config>::PalletsOrigin,137 <T as frame_system::Config>::AccountId,138>;139140pub type ScheduledOf<T> = ScheduledV3Of<T>;141142143pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =144 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;145146#[cfg(feature = "runtime-benchmarks")]147mod preimage_provider {148 use frame_support::traits::PreimageRecipient;149 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}150 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}151}152153#[cfg(not(feature = "runtime-benchmarks"))]154mod preimage_provider {155 use frame_support::traits::PreimageProvider;156 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}157 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}158}159160pub use preimage_provider::PreimageProviderAndMaybeRecipient;161162163pub(crate) trait MarginalWeightInfo: WeightInfo {164 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {165 match (periodic, named, resolved) {166 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),167 (_, true, None) => {168 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)169 }170 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),171 (false, true, Some(false)) => {172 Self::on_initialize_named(2) - Self::on_initialize_named(1)173 }174 (true, false, Some(false)) => {175 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)176 }177 (true, true, Some(false)) => {178 Self::on_initialize_periodic_named_resolved(2)179 - Self::on_initialize_periodic_named_resolved(1)180 }181 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),182 (false, true, Some(true)) => {183 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)184 }185 (true, false, Some(true)) => {186 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)187 }188 (true, true, Some(true)) => {189 Self::on_initialize_periodic_named_resolved(2)190 - Self::on_initialize_periodic_named_resolved(1)191 }192 }193 }194}195impl<T: WeightInfo> MarginalWeightInfo for T {}196197#[frame_support::pallet]198pub mod pallet {199 use super::*;200 use frame_support::{201 dispatch::PostDispatchInfo,202 pallet_prelude::*,203 traits::{schedule::LookupError, PreimageProvider},204 };205 use frame_system::pallet_prelude::*;206207 208 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);209210 #[pallet::pallet]211 #[pallet::generate_store(pub(super) trait Store)]212 #[pallet::storage_version(STORAGE_VERSION)]213 #[pallet::without_storage_info]214 pub struct Pallet<T>(_);215216 217 #[pallet::config]218 pub trait Config: frame_system::Config {219 220 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;221222 223 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>224 + From<Self::PalletsOrigin>225 + IsType<<Self as system::Config>::Origin>;226227 228 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;229230 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;231232 233 type Call: Parameter234 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>235 + GetDispatchInfo236 + From<system::Call<Self>>;237238 239 240 #[pallet::constant]241 type MaximumWeight: Get<Weight>;242243 244 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;245246 247 248 249 250 251 252 253 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;254255 256 257 #[pallet::constant]258 type MaxScheduledPerBlock: Get<u32>;259260 261 type WeightInfo: WeightInfo;262263 264 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;265266 267 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;268269 270 271272 273 type CallExecutor: DispatchCall<Self, H160>;274 }275276 277 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {278 279 fn reserve_balance(280 id: ScheduledId,281 sponsor: <T as frame_system::Config>::AccountId,282 call: <T as Config>::Call,283 count: u32,284 ) -> Result<(), DispatchError>;285286 287 fn pay_for_call(288 id: ScheduledId,289 sponsor: <T as frame_system::Config>::AccountId,290 call: <T as Config>::Call,291 ) -> Result<u128, DispatchError>;292293 294 fn dispatch_call(295 signer: T::AccountId,296 function: <T as Config>::Call,297 ) -> Result<298 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,299 TransactionValidityError,300 >;301302 303 fn cancel_reserve(304 id: ScheduledId,305 sponsor: <T as frame_system::Config>::AccountId,306 ) -> Result<u128, DispatchError>;307 }308309 310 #[pallet::storage]311 pub type Agenda<T: Config> =312 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;313314 315 #[pallet::storage]316 pub(crate) type Lookup<T: Config> =317 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;318319 320 #[pallet::event]321 #[pallet::generate_deposit(pub(super) fn deposit_event)]322 pub enum Event<T: Config> {323 324 Scheduled { when: T::BlockNumber, index: u32 },325 326 Canceled { when: T::BlockNumber, index: u32 },327 328 Dispatched {329 task: TaskAddress<T::BlockNumber>,330 id: Option<ScheduledId>,331 result: DispatchResult,332 },333 334 CallLookupFailed {335 task: TaskAddress<T::BlockNumber>,336 id: Option<ScheduledId>,337 error: LookupError,338 },339 }340341 #[pallet::error]342 pub enum Error<T> {343 344 FailedToSchedule,345 346 NotFound,347 348 TargetBlockNumberInPast,349 350 RescheduleNoChange,351 }352353 #[pallet::hooks]354 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {355 356 fn on_initialize(now: T::BlockNumber) -> Weight {357 let limit = T::MaximumWeight::get();358359 let mut queued = Agenda::<T>::take(now)360 .into_iter()361 .enumerate()362 .filter_map(|(index, s)| Some((index as u32, s?)))363 .collect::<Vec<_>>();364365 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {366 log::warn!(367 target: "runtime::scheduler",368 "Warning: This block has more items queued in Scheduler than \369 expected from the runtime configuration. An update might be needed."370 );371 }372373 queued.sort_by_key(|(_, s)| s.priority);374375 let next = now + One::one();376377 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);378 for (order, (index, mut s)) in queued.into_iter().enumerate() {379 let named = if let Some(ref id) = s.maybe_id {380 Lookup::<T>::remove(id);381 true382 } else {383 false384 };385386 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();387 s.call = call;388389 let resolved = if let Some(completed) = maybe_completed {390 T::PreimageProvider::unrequest_preimage(&completed);391 true392 } else {393 false394 };395 let call = match s.call.as_value().cloned() {396 Some(c) => c,397 None => {398 399 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));400 if let Some(delay) = T::NoPreimagePostponement::get() {401 let until = now.saturating_add(delay);402 if let Some(ref id) = s.maybe_id {403 let index = Agenda::<T>::decode_len(until).unwrap_or(0);404 Lookup::<T>::insert(id, (until, index as u32));405 }406 Agenda::<T>::append(until, Some(s));407 }408 continue;409 }410 };411412 let periodic = s.maybe_periodic.is_some();413 let call_weight = call.get_dispatch_info().weight;414 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));415 let origin =416 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())417 .into();418 if ensure_signed(origin).is_ok() {419 420 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));421 }422423 424 425 426 427 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;428 let test_weight = total_weight429 .saturating_add(call_weight)430 .saturating_add(item_weight);431 if !hard_deadline && order > 0 && test_weight > limit {432 433 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));434 if let Some(ref id) = s.maybe_id {435 436 437 438 439 let index = Agenda::<T>::decode_len(next).unwrap_or(0);440 Lookup::<T>::insert(id, (next, index as u32));441 }442 Agenda::<T>::append(next, Some(s));443 continue;444 }445446 447 let sender = ensure_signed(448 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())449 .into(),450 )451 .unwrap();452453 454 455 456 457 458 459 460 461462 463 let r = T::CallExecutor::dispatch_call(sender, call.clone());464465 let mut actual_call_weight: Weight = item_weight;466 let result: Result<_, DispatchError> = match r {467 Ok(o) => match o {468 Ok(di) => {469 actual_call_weight = di.actual_weight.unwrap_or(item_weight);470 Ok(())471 }472 Err(err) => Err(err.error),473 },474 Err(_) => {475 log::error!(476 target: "runtime::scheduler",477 "Warning: Scheduler has failed to execute a post-dispatch transaction. \478 This block might have become invalid.");479 Err(DispatchError::CannotLookup)480 } 481 };482483 total_weight.saturating_accrue(item_weight);484 total_weight.saturating_accrue(actual_call_weight);485486 Self::deposit_event(Event::Dispatched {487 task: (now, index),488 id: s.maybe_id.clone(),489 result,490 });491492 if let &Some((period, count)) = &s.maybe_periodic {493 if count > 1 {494 s.maybe_periodic = Some((period, count - 1));495 } else {496 s.maybe_periodic = None;497 }498 let wake = now + period;499 500 if let Some(ref id) = s.maybe_id {501 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);502 Lookup::<T>::insert(id, (wake, wake_index as u32));503 }504 Agenda::<T>::append(wake, Some(s));505 }506 }507 508 0509 }510 }511512 #[pallet::call]513 impl<T: Config> Pallet<T> {514 515 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]516 pub fn schedule_named(517 origin: OriginFor<T>,518 id: ScheduledId,519 when: T::BlockNumber,520 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,521 priority: schedule::Priority,522 call: Box<CallOrHashOf<T>>,523 ) -> DispatchResult {524 T::ScheduleOrigin::ensure_origin(origin.clone())?;525 let origin = <T as Config>::Origin::from(origin);526 Self::do_schedule_named(527 id,528 DispatchTime::At(when),529 maybe_periodic,530 priority,531 origin.caller().clone(),532 *call,533 )?;534 Ok(())535 }536537 538 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]539 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {540 T::ScheduleOrigin::ensure_origin(origin.clone())?;541 let origin = <T as Config>::Origin::from(origin);542 Self::do_cancel_named(Some(origin.caller().clone()), id)?;543 Ok(())544 }545546 547 548 549 550 551 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]552 pub fn schedule_named_after(553 origin: OriginFor<T>,554 id: ScheduledId,555 after: T::BlockNumber,556 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,557 priority: schedule::Priority,558 call: Box<CallOrHashOf<T>>,559 ) -> DispatchResult {560 T::ScheduleOrigin::ensure_origin(origin.clone())?;561 let origin = <T as Config>::Origin::from(origin);562 Self::do_schedule_named(563 id,564 DispatchTime::After(after),565 maybe_periodic,566 priority,567 origin.caller().clone(),568 *call,569 )?;570 Ok(())571 }572 }573}574575impl<T: Config> Pallet<T> {576 #[cfg(feature = "try-runtime")]577 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {578 Ok(())579 }580581 #[cfg(feature = "try-runtime")]582 pub fn post_migrate_to_v3() -> Result<(), &'static str> {583 use frame_support::dispatch::GetStorageVersion;584585 assert!(Self::current_storage_version() == 3);586 for k in Agenda::<T>::iter_keys() {587 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;588 }589 Ok(())590 }591592 593 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {594 Agenda::<T>::translate::<595 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,596 _,597 >(|_, agenda| {598 Some(599 agenda600 .into_iter()601 .map(|schedule| {602 schedule.map(|schedule| Scheduled {603 maybe_id: schedule.maybe_id,604 priority: schedule.priority,605 call: schedule.call,606 maybe_periodic: schedule.maybe_periodic,607 origin: schedule.origin.into(),608 _phantom: Default::default(),609 })610 })611 .collect::<Vec<_>>(),612 )613 });614 }615616 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {617 let now = frame_system::Pallet::<T>::block_number();618619 let when = match when {620 DispatchTime::At(x) => x,621 622 623 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),624 };625626 if when <= now {627 return Err(Error::<T>::TargetBlockNumberInPast.into());628 }629630 Ok(when)631 }632633 fn do_schedule_named(634 id: ScheduledId,635 when: DispatchTime<T::BlockNumber>,636 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,637 priority: schedule::Priority,638 origin: T::PalletsOrigin,639 call: CallOrHashOf<T>,640 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {641 642 if Lookup::<T>::contains_key(&id) {643 return Err(Error::<T>::FailedToSchedule)?;644 }645646 let when = Self::resolve_time(when)?;647648 call.ensure_requested::<T::PreimageProvider>();649650 651 let maybe_periodic = maybe_periodic652 .filter(|p| p.1 > 1 && !p.0.is_zero())653 654 .map(|(p, c)| (p, c - 1));655656 let s = Scheduled {657 maybe_id: Some(id.clone()),658 priority,659 call: call.clone(),660 maybe_periodic,661 origin: origin.clone(),662 _phantom: Default::default(),663 };664665 666 667 668 669 670 671 672 673 674 675 676 677 678679 Agenda::<T>::append(when, Some(s));680 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;681 let address = (when, index);682 Lookup::<T>::insert(&id, &address);683 Self::deposit_event(Event::Scheduled { when, index });684685 Ok(address)686 }687688 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {689 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {690 if let Some((when, index)) = lookup.take() {691 let i = index as usize;692 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {693 if let Some(s) = agenda.get_mut(i) {694 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {695 if matches!(696 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),697 Some(Ordering::Less) | None698 ) {699 return Err(BadOrigin.into());700 }701 702 703 704 705 706 707 708 709710 s.call.ensure_unrequested::<T::PreimageProvider>();711 }712 *s = None;713 }714 Ok(())715 })?;716717 Self::deposit_event(Event::Canceled { when, index });718 Ok(())719 } else {720 Err(Error::<T>::NotFound)?721 }722 })723 }724}