12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970#![cfg_attr(not(feature = "std"), no_std)]7172#[cfg(feature = "runtime-benchmarks")]73mod benchmarking;7475pub mod weights;7677use sp_core::H160;78use codec::{Codec, Decode, Encode};79use frame_system::{self as system, ensure_signed};80pub use pallet::*;81use scale_info::TypeInfo;82use sp_runtime::{83 traits::{BadOrigin, One, Saturating, Zero},84 RuntimeDebug, DispatchErrorWithPostInfo,85};86use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};8788use frame_support::{89 dispatch::{DispatchError, DispatchResult, Dispatchable, UnfilteredDispatchable, Parameter},90 traits::{91 schedule::{self, DispatchTime, MaybeHashed},92 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,93 StorageVersion,94 },95 weights::{Weight},96};9798pub use weights::WeightInfo;99100101pub type TaskAddress<BlockNumber> = (BlockNumber, u32);102pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;103104type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];105pub type CallOrHashOf<T> =106 MaybeHashed<<T as Config>::RuntimeCall, <T as frame_system::Config>::Hash>;107108109#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]110#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]111pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {112 113 maybe_id: Option<ScheduledId>,114 115 priority: schedule::Priority,116 117 call: Call,118 119 maybe_periodic: Option<schedule::Period<BlockNumber>>,120 121 origin: PalletsOrigin,122 _phantom: PhantomData<AccountId>,123}124125pub type ScheduledV3Of<T> = ScheduledV3<126 CallOrHashOf<T>,127 <T as frame_system::Config>::BlockNumber,128 <T as Config>::PalletsOrigin,129 <T as frame_system::Config>::AccountId,130>;131132pub type ScheduledOf<T> = ScheduledV3Of<T>;133134135pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =136 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;137138pub enum ScheduledEnsureOriginSuccess<AccountId> {139 Root,140 Signed(AccountId),141 Unsigned,142}143144#[cfg(feature = "runtime-benchmarks")]145mod preimage_provider {146 use frame_support::traits::PreimageRecipient;147 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}148 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}149}150151#[cfg(not(feature = "runtime-benchmarks"))]152mod preimage_provider {153 use frame_support::traits::PreimageProvider;154 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}155 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}156}157158pub use preimage_provider::PreimageProviderAndMaybeRecipient;159160pub(crate) trait MarginalWeightInfo: WeightInfo {161 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {162 match (periodic, named, resolved) {163 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),164 (_, true, None) => {165 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)166 }167 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),168 (false, true, Some(false)) => {169 Self::on_initialize_named(2) - Self::on_initialize_named(1)170 }171 (true, false, Some(false)) => {172 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)173 }174 (true, true, Some(false)) => {175 Self::on_initialize_periodic_named_resolved(2)176 - Self::on_initialize_periodic_named_resolved(1)177 }178 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),179 (false, true, Some(true)) => {180 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)181 }182 (true, false, Some(true)) => {183 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)184 }185 (true, true, Some(true)) => {186 Self::on_initialize_periodic_named_resolved(2)187 - Self::on_initialize_periodic_named_resolved(1)188 }189 }190 }191}192impl<T: WeightInfo> MarginalWeightInfo for T {}193194#[frame_support::pallet]195pub mod pallet {196 use super::*;197 use frame_support::{198 dispatch::PostDispatchInfo,199 pallet_prelude::*,200 traits::{201 schedule::{LookupError, LOWEST_PRIORITY},202 PreimageProvider,203 },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 RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;221222 223 type RuntimeOrigin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>224 + From<Self::PalletsOrigin>225 + IsType<<Self as system::Config>::RuntimeOrigin>;226227 228 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;229230 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;231232 233 type RuntimeCall: Parameter234 + Dispatchable<Origin = <Self as Config>::RuntimeOrigin, PostInfo = PostDispatchInfo>235 + UnfilteredDispatchable<Origin = <Self as system::Config>::RuntimeOrigin>236 + GetDispatchInfo237 + From<system::RuntimeCall<Self>>;238239 240 241 #[pallet::constant]242 type MaximumWeight: Get<Weight>;243244 245 type ScheduleOrigin: EnsureOrigin<246 <Self as system::Config>::RuntimeOrigin,247 Success = ScheduledEnsureOriginSuccess<Self::AccountId>,248 >;249250 251 type PrioritySetOrigin: EnsureOrigin<<Self as system::Config>::RuntimeOrigin>;252253 254 255 256 257 258 259 260 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;261262 263 264 #[pallet::constant]265 type MaxScheduledPerBlock: Get<u32>;266267 268 type WeightInfo: WeightInfo;269270 271 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;272273 274 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;275276 277 278279 280 type CallExecutor: DispatchCall<Self, H160>;281 }282283 284 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {285 286 fn reserve_balance(287 id: ScheduledId,288 sponsor: <T as frame_system::Config>::AccountId,289 call: <T as Config>::RuntimeCall,290 count: u32,291 ) -> Result<(), DispatchError>;292293 294 fn pay_for_call(295 id: ScheduledId,296 sponsor: <T as frame_system::Config>::AccountId,297 call: <T as Config>::RuntimeCall,298 ) -> Result<u128, DispatchError>;299300 301 fn dispatch_call(302 signer: Option<T::AccountId>,303 function: <T as Config>::RuntimeCall,304 ) -> Result<305 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,306 TransactionValidityError,307 >;308309 310 fn cancel_reserve(311 id: ScheduledId,312 sponsor: <T as frame_system::Config>::AccountId,313 ) -> Result<u128, DispatchError>;314 }315316 317 #[pallet::storage]318 pub type Agenda<T: Config> =319 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;320321 322 #[pallet::storage]323 pub(crate) type Lookup<T: Config> =324 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;325326 327 #[pallet::event]328 #[pallet::generate_deposit(pub(super) fn deposit_event)]329 pub enum Event<T: Config> {330 331 Scheduled { when: T::BlockNumber, index: u32 },332 333 Canceled { when: T::BlockNumber, index: u32 },334 335 PriorityChanged {336 when: T::BlockNumber,337 index: u32,338 priority: schedule::Priority,339 },340 341 Dispatched {342 task: TaskAddress<T::BlockNumber>,343 id: Option<ScheduledId>,344 result: DispatchResult,345 },346 347 CallLookupFailed {348 task: TaskAddress<T::BlockNumber>,349 id: Option<ScheduledId>,350 error: LookupError,351 },352 }353354 #[pallet::error]355 pub enum Error<T> {356 357 FailedToSchedule,358 359 NotFound,360 361 TargetBlockNumberInPast,362 363 RescheduleNoChange,364 }365366 #[pallet::hooks]367 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {368 369 fn on_initialize(now: T::BlockNumber) -> Weight {370 let limit = T::MaximumWeight::get();371372 let mut queued = Agenda::<T>::take(now)373 .into_iter()374 .enumerate()375 .filter_map(|(index, s)| Some((index as u32, s?)))376 .collect::<Vec<_>>();377378 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {379 log::warn!(380 target: "runtime::scheduler",381 "Warning: This block has more items queued in Scheduler than \382 expected from the runtime configuration. An update might be needed."383 );384 }385386 queued.sort_by_key(|(_, s)| s.priority);387388 let next = now + One::one();389390 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);391 for (order, (index, mut s)) in queued.into_iter().enumerate() {392 let named = s.maybe_id.is_some();393394 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();395 s.call = call;396397 let resolved = if let Some(completed) = maybe_completed {398 T::PreimageProvider::unrequest_preimage(&completed);399 true400 } else {401 false402 };403 let call = match s.call.as_value().cloned() {404 Some(c) => c,405 None => {406 407 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));408 if let Some(delay) = T::NoPreimagePostponement::get() {409 let until = now.saturating_add(delay);410 if let Some(ref id) = s.maybe_id {411 let index = Agenda::<T>::decode_len(until).unwrap_or(0);412 Lookup::<T>::insert(id, (until, index as u32));413 }414 Agenda::<T>::append(until, Some(s));415 } else if let Some(ref id) = s.maybe_id {416 Lookup::<T>::remove(id);417 }418 continue;419 }420 };421422 let periodic = s.maybe_periodic.is_some();423 let call_weight = call.get_dispatch_info().weight;424 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));425 let origin = <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(426 s.origin.clone(),427 )428 .into();429 if ensure_signed(origin).is_ok() {430 431 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));432 }433434 435 436 437 438 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;439 let test_weight = total_weight440 .saturating_add(call_weight)441 .saturating_add(item_weight);442 if !hard_deadline && order > 0 && test_weight.all_gt(limit) {443 444 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));445 if let Some(ref id) = s.maybe_id {446 447 448 449 450 let index = Agenda::<T>::decode_len(next).unwrap_or(0);451 Lookup::<T>::insert(id, (next, index as u32));452 }453 Agenda::<T>::append(next, Some(s));454 continue;455 }456457 let scheduled_origin =458 <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(s.origin.clone());459 let ensured_origin = T::ScheduleOrigin::ensure_origin(scheduled_origin.into());460461 let r = match ensured_origin {462 Ok(ScheduledEnsureOriginSuccess::Root) => {463 Ok(call.dispatch_bypass_filter(frame_system::RawOrigin::Root.into()))464 }465 Ok(ScheduledEnsureOriginSuccess::Signed(sender)) => {466 467 468 T::CallExecutor::dispatch_call(Some(sender), call.clone())469 }470 Ok(ScheduledEnsureOriginSuccess::Unsigned) => {471 472 T::CallExecutor::dispatch_call(None, call.clone())473 }474 Err(e) => Ok(Err(e.into())),475 };476477 let mut actual_call_weight: Weight = item_weight;478 let result: Result<_, DispatchError> = match r {479 Ok(o) => match o {480 Ok(di) => {481 actual_call_weight = di.actual_weight.unwrap_or(item_weight);482 Ok(())483 }484 Err(err) => Err(err.error),485 },486 Err(_) => {487 log::error!(488 target: "runtime::scheduler",489 "Warning: Scheduler has failed to execute a post-dispatch transaction. \490 This block might have become invalid.");491 Err(DispatchError::CannotLookup)492 } 493 };494495 total_weight.saturating_accrue(item_weight);496 total_weight.saturating_accrue(actual_call_weight);497498 Self::deposit_event(Event::Dispatched {499 task: (now, index),500 id: s.maybe_id.clone(),501 result,502 });503504 if let &Some((period, count)) = &s.maybe_periodic {505 if count > 1 {506 s.maybe_periodic = Some((period, count - 1));507 } else {508 s.maybe_periodic = None;509 }510 let wake = now + period;511 let is_canceled;512513 514 if let Some(ref id) = s.maybe_id {515 is_canceled = Lookup::<T>::get(id).is_none();516 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);517518 if !is_canceled {519 Lookup::<T>::insert(id, (wake, wake_index as u32));520 }521 } else {522 is_canceled = false;523 }524525 if !is_canceled {526 Agenda::<T>::append(wake, Some(s));527 }528 } else if let Some(ref id) = s.maybe_id {529 Lookup::<T>::remove(id);530 }531 }532 total_weight533 }534 }535536 #[pallet::call]537 impl<T: Config> Pallet<T> {538 539 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]540 pub fn schedule_named(541 origin: OriginFor<T>,542 id: ScheduledId,543 when: T::BlockNumber,544 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,545 priority: Option<schedule::Priority>,546 call: Box<CallOrHashOf<T>>,547 ) -> DispatchResult {548 T::ScheduleOrigin::ensure_origin(origin.clone())?;549550 if priority.is_some() {551 T::PrioritySetOrigin::ensure_origin(origin.clone())?;552 }553554 let origin = <T as Config>::RuntimeOrigin::from(origin);555 Self::do_schedule_named(556 id,557 DispatchTime::At(when),558 maybe_periodic,559 priority.unwrap_or(LOWEST_PRIORITY),560 origin.caller().clone(),561 *call,562 )?;563 Ok(())564 }565566 567 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]568 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {569 T::ScheduleOrigin::ensure_origin(origin.clone())?;570 let origin = <T as Config>::RuntimeOrigin::from(origin);571 Self::do_cancel_named(Some(origin.caller().clone()), id)?;572 Ok(())573 }574575 576 577 578 579 580 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]581 pub fn schedule_named_after(582 origin: OriginFor<T>,583 id: ScheduledId,584 after: T::BlockNumber,585 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,586 priority: Option<schedule::Priority>,587 call: Box<CallOrHashOf<T>>,588 ) -> DispatchResult {589 T::ScheduleOrigin::ensure_origin(origin.clone())?;590591 if priority.is_some() {592 T::PrioritySetOrigin::ensure_origin(origin.clone())?;593 }594595 let origin = <T as Config>::RuntimeOrigin::from(origin);596 Self::do_schedule_named(597 id,598 DispatchTime::After(after),599 maybe_periodic,600 priority.unwrap_or(LOWEST_PRIORITY),601 origin.caller().clone(),602 *call,603 )?;604 Ok(())605 }606607 #[pallet::weight(<T as Config>::WeightInfo::change_named_priority(T::MaxScheduledPerBlock::get()))]608 pub fn change_named_priority(609 origin: OriginFor<T>,610 id: ScheduledId,611 priority: schedule::Priority,612 ) -> DispatchResult {613 T::PrioritySetOrigin::ensure_origin(origin.clone())?;614 let origin = <T as Config>::Origin::from(origin);615 Self::do_change_named_priority(origin.caller().clone(), id, priority)616 }617 }618}619620impl<T: Config> Pallet<T> {621 #[cfg(feature = "try-runtime")]622 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {623 Ok(())624 }625626 #[cfg(feature = "try-runtime")]627 pub fn post_migrate_to_v3() -> Result<(), &'static str> {628 use frame_support::dispatch::GetStorageVersion;629630 assert!(Self::current_storage_version() == 3);631 for k in Agenda::<T>::iter_keys() {632 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;633 }634 Ok(())635 }636637 638 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {639 Agenda::<T>::translate::<640 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,641 _,642 >(|_, agenda| {643 Some(644 agenda645 .into_iter()646 .map(|schedule| {647 schedule.map(|schedule| Scheduled {648 maybe_id: schedule.maybe_id,649 priority: schedule.priority,650 call: schedule.call,651 maybe_periodic: schedule.maybe_periodic,652 origin: schedule.origin.into(),653 _phantom: Default::default(),654 })655 })656 .collect::<Vec<_>>(),657 )658 });659 }660661 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {662 let now = frame_system::Pallet::<T>::block_number();663664 let when = match when {665 DispatchTime::At(x) => x,666 667 668 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),669 };670671 if when <= now {672 return Err(Error::<T>::TargetBlockNumberInPast.into());673 }674675 Ok(when)676 }677678 fn do_schedule_named(679 id: ScheduledId,680 when: DispatchTime<T::BlockNumber>,681 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,682 priority: schedule::Priority,683 origin: T::PalletsOrigin,684 call: CallOrHashOf<T>,685 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {686 687 if Lookup::<T>::contains_key(&id) {688 return Err(Error::<T>::FailedToSchedule)?;689 }690691 let when = Self::resolve_time(when)?;692693 call.ensure_requested::<T::PreimageProvider>();694695 696 let maybe_periodic = maybe_periodic697 .filter(|p| p.1 > 1 && !p.0.is_zero())698 699 .map(|(p, c)| (p, c - 1));700701 let s = Scheduled {702 maybe_id: Some(id.clone()),703 priority,704 call: call.clone(),705 maybe_periodic,706 origin: origin.clone(),707 _phantom: Default::default(),708 };709710 711 712 713 714 715 716 717 718 719 720 721 722 723724 Agenda::<T>::append(when, Some(s));725 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;726 let address = (when, index);727 Lookup::<T>::insert(&id, &address);728 Self::deposit_event(Event::Scheduled { when, index });729730 Ok(address)731 }732733 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {734 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {735 if let Some((when, index)) = lookup.take() {736 let i = index as usize;737 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {738 if let Some(s) = agenda.get_mut(i) {739 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {740 if matches!(741 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),742 Some(Ordering::Less) | None743 ) {744 return Err(BadOrigin.into());745 }746 747 748 749 750 751 752 753 754755 s.call.ensure_unrequested::<T::PreimageProvider>();756 }757 *s = None;758 }759 Ok(())760 })?;761762 Self::deposit_event(Event::Canceled { when, index });763 Ok(())764 } else {765 Err(Error::<T>::NotFound)?766 }767 })768 }769770 fn do_change_named_priority(771 origin: T::PalletsOrigin,772 id: ScheduledId,773 priority: schedule::Priority,774 ) -> DispatchResult {775 match Lookup::<T>::get(id) {776 Some((when, index)) => {777 let i = index as usize;778 Agenda::<T>::try_mutate(when, |agenda| {779 if let Some(Some(s)) = agenda.get_mut(i) {780 if matches!(781 T::OriginPrivilegeCmp::cmp_privilege(&origin, &s.origin),782 Some(Ordering::Less) | None783 ) {784 return Err(BadOrigin.into());785 }786787 s.priority = priority;788 Self::deposit_event(Event::PriorityChanged {789 when,790 index,791 priority,792 });793 }794 Ok(())795 })796 }797 None => Err(Error::<T>::NotFound.into()),798 }799 }800}