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::{90 DispatchError, DispatchResult, Dispatchable, UnfilteredDispatchable, Parameter,91 GetDispatchInfo,92 },93 traits::{94 schedule::{self, DispatchTime, MaybeHashed},95 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,96 StorageVersion,97 },98 weights::{Weight},99};100101pub use weights::WeightInfo;102103104pub type TaskAddress<BlockNumber> = (BlockNumber, u32);105pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;106107pub type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];108pub type CallOrHashOf<T> =109 MaybeHashed<<T as Config>::RuntimeCall, <T as frame_system::Config>::Hash>;110111112#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]113#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]114pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {115 116 maybe_id: Option<ScheduledId>,117 118 priority: schedule::Priority,119 120 call: Call,121 122 maybe_periodic: Option<schedule::Period<BlockNumber>>,123 124 origin: PalletsOrigin,125 _phantom: PhantomData<AccountId>,126}127128pub type ScheduledV3Of<T> = ScheduledV3<129 CallOrHashOf<T>,130 <T as frame_system::Config>::BlockNumber,131 <T as Config>::PalletsOrigin,132 <T as frame_system::Config>::AccountId,133>;134135pub type ScheduledOf<T> = ScheduledV3Of<T>;136137138pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =139 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;140141pub enum ScheduledEnsureOriginSuccess<AccountId> {142 Root,143 Signed(AccountId),144}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;161162pub(crate) trait MarginalWeightInfo: WeightInfo {163 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {164 match (periodic, named, resolved) {165 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),166 (_, true, None) => {167 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)168 }169 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),170 (false, true, Some(false)) => {171 Self::on_initialize_named(2) - Self::on_initialize_named(1)172 }173 (true, false, Some(false)) => {174 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)175 }176 (true, true, Some(false)) => {177 Self::on_initialize_periodic_named_resolved(2)178 - Self::on_initialize_periodic_named_resolved(1)179 }180 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),181 (false, true, Some(true)) => {182 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)183 }184 (true, false, Some(true)) => {185 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)186 }187 (true, true, Some(true)) => {188 Self::on_initialize_periodic_named_resolved(2)189 - Self::on_initialize_periodic_named_resolved(1)190 }191 }192 }193}194impl<T: WeightInfo> MarginalWeightInfo for T {}195196#[frame_support::pallet]197pub mod pallet {198 use super::*;199 use frame_support::{200 dispatch::PostDispatchInfo,201 pallet_prelude::*,202 traits::{203 schedule::{LookupError, LOWEST_PRIORITY},204 PreimageProvider,205 },206 };207 use frame_system::pallet_prelude::*;208209 210 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);211212 #[pallet::pallet]213 #[pallet::generate_store(pub(super) trait Store)]214 #[pallet::storage_version(STORAGE_VERSION)]215 #[pallet::without_storage_info]216 pub struct Pallet<T>(_);217218 219 #[pallet::config]220 pub trait Config: frame_system::Config {221 222 type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;223224 225 type RuntimeOrigin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>226 + From<Self::PalletsOrigin>227 + IsType<<Self as system::Config>::RuntimeOrigin>;228229 230 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;231232 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;233234 235 type RuntimeCall: Parameter236 + Dispatchable<237 RuntimeOrigin = <Self as Config>::RuntimeOrigin,238 PostInfo = PostDispatchInfo,239 > + UnfilteredDispatchable<RuntimeOrigin = <Self as system::Config>::RuntimeOrigin>240 + GetDispatchInfo241 + From<system::Call<Self>>;242243 244 245 #[pallet::constant]246 type MaximumWeight: Get<Weight>;247248 249 type ScheduleOrigin: EnsureOrigin<250 <Self as system::Config>::RuntimeOrigin,251 Success = ScheduledEnsureOriginSuccess<Self::AccountId>,252 >;253254 255 type PrioritySetOrigin: EnsureOrigin<<Self as system::Config>::RuntimeOrigin>;256257 258 259 260 261 262 263 264 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;265266 267 268 #[pallet::constant]269 type MaxScheduledPerBlock: Get<u32>;270271 272 type WeightInfo: WeightInfo;273274 275 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;276277 278 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;279280 281 282283 284 type CallExecutor: DispatchCall<Self, H160>;285 }286287 288 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {289 290 fn reserve_balance(291 id: ScheduledId,292 sponsor: <T as frame_system::Config>::AccountId,293 call: <T as Config>::RuntimeCall,294 count: u32,295 ) -> Result<(), DispatchError>;296297 298 fn pay_for_call(299 id: ScheduledId,300 sponsor: <T as frame_system::Config>::AccountId,301 call: <T as Config>::RuntimeCall,302 ) -> Result<u128, DispatchError>;303304 305 fn dispatch_call(306 signer: Option<T::AccountId>,307 function: <T as Config>::RuntimeCall,308 ) -> Result<309 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,310 TransactionValidityError,311 >;312313 314 fn cancel_reserve(315 id: ScheduledId,316 sponsor: <T as frame_system::Config>::AccountId,317 ) -> Result<u128, DispatchError>;318 }319320 321 #[pallet::storage]322 pub type Agenda<T: Config> =323 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;324325 326 #[pallet::storage]327 pub(crate) type Lookup<T: Config> =328 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;329330 331 #[pallet::event]332 #[pallet::generate_deposit(pub(super) fn deposit_event)]333 pub enum Event<T: Config> {334 335 Scheduled { when: T::BlockNumber, index: u32 },336 337 Canceled { when: T::BlockNumber, index: u32 },338 339 PriorityChanged {340 when: T::BlockNumber,341 index: u32,342 priority: schedule::Priority,343 },344 345 Dispatched {346 task: TaskAddress<T::BlockNumber>,347 id: Option<ScheduledId>,348 result: DispatchResult,349 },350 351 CallLookupFailed {352 task: TaskAddress<T::BlockNumber>,353 id: Option<ScheduledId>,354 error: LookupError,355 },356 }357358 #[pallet::error]359 pub enum Error<T> {360 361 FailedToSchedule,362 363 NotFound,364 365 TargetBlockNumberInPast,366 367 RescheduleNoChange,368 }369370 #[pallet::hooks]371 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {372 373 fn on_initialize(now: T::BlockNumber) -> Weight {374 let limit = T::MaximumWeight::get();375376 let mut queued = Agenda::<T>::take(now)377 .into_iter()378 .enumerate()379 .filter_map(|(index, s)| Some((index as u32, s?)))380 .collect::<Vec<_>>();381382 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {383 log::warn!(384 target: "runtime::scheduler",385 "Warning: This block has more items queued in Scheduler than \386 expected from the runtime configuration. An update might be needed."387 );388 }389390 queued.sort_by_key(|(_, s)| s.priority);391392 let next = now + One::one();393394 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);395 for (order, (index, mut s)) in queued.into_iter().enumerate() {396 let named = s.maybe_id.is_some();397398 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();399 s.call = call;400401 let resolved = if let Some(completed) = maybe_completed {402 T::PreimageProvider::unrequest_preimage(&completed);403 true404 } else {405 false406 };407 let call = match s.call.as_value().cloned() {408 Some(c) => c,409 None => {410 411 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));412 if let Some(delay) = T::NoPreimagePostponement::get() {413 let until = now.saturating_add(delay);414 if let Some(ref id) = s.maybe_id {415 let index = Agenda::<T>::decode_len(until).unwrap_or(0);416 Lookup::<T>::insert(id, (until, index as u32));417 }418 Agenda::<T>::append(until, Some(s));419 } else if let Some(ref id) = s.maybe_id {420 Lookup::<T>::remove(id);421 }422 continue;423 }424 };425426 let periodic = s.maybe_periodic.is_some();427 let call_weight = call.get_dispatch_info().weight;428 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));429 let origin = <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(430 s.origin.clone(),431 )432 .into();433 if ensure_signed(origin).is_ok() {434 435 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));436 }437438 439 440 441 442 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;443 let test_weight = total_weight444 .saturating_add(call_weight)445 .saturating_add(item_weight);446 if !hard_deadline && order > 0 && test_weight.all_gt(limit) {447 448 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));449 if let Some(ref id) = s.maybe_id {450 451 452 453 454 let index = Agenda::<T>::decode_len(next).unwrap_or(0);455 Lookup::<T>::insert(id, (next, index as u32));456 }457 Agenda::<T>::append(next, Some(s));458 continue;459 }460461 let scheduled_origin =462 <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(463 s.origin.clone(),464 );465 let ensured_origin = T::ScheduleOrigin::ensure_origin(scheduled_origin.into());466467 let r = match ensured_origin {468 Ok(ScheduledEnsureOriginSuccess::Root) => {469 Ok(call.dispatch_bypass_filter(frame_system::RawOrigin::Root.into()))470 }471 Ok(ScheduledEnsureOriginSuccess::Signed(sender)) => {472 473 474 T::CallExecutor::dispatch_call(Some(sender), call.clone())475 }476 Err(e) => Ok(Err(e.into())),477 };478479 let mut actual_call_weight: Weight = item_weight;480 let result: Result<_, DispatchError> = match r {481 Ok(o) => match o {482 Ok(di) => {483 actual_call_weight = di.actual_weight.unwrap_or(item_weight);484 Ok(())485 }486 Err(err) => Err(err.error),487 },488 Err(_) => {489 log::error!(490 target: "runtime::scheduler",491 "Warning: Scheduler has failed to execute a post-dispatch transaction. \492 This block might have become invalid.");493 Err(DispatchError::CannotLookup)494 } 495 };496497 total_weight.saturating_accrue(item_weight);498 total_weight.saturating_accrue(actual_call_weight);499500 Self::deposit_event(Event::Dispatched {501 task: (now, index),502 id: s.maybe_id.clone(),503 result,504 });505506 if let &Some((period, count)) = &s.maybe_periodic {507 if count > 1 {508 s.maybe_periodic = Some((period, count - 1));509 } else {510 s.maybe_periodic = None;511 }512 let wake = now + period;513 let is_canceled;514515 516 if let Some(ref id) = s.maybe_id {517 is_canceled = Lookup::<T>::get(id).is_none();518 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);519520 if !is_canceled {521 Lookup::<T>::insert(id, (wake, wake_index as u32));522 }523 } else {524 is_canceled = false;525 }526527 if !is_canceled {528 Agenda::<T>::append(wake, Some(s));529 }530 } else if let Some(ref id) = s.maybe_id {531 Lookup::<T>::remove(id);532 }533 }534 total_weight535 }536 }537538 #[pallet::call]539 impl<T: Config> Pallet<T> {540 541 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]542 pub fn schedule_named(543 origin: OriginFor<T>,544 id: ScheduledId,545 when: T::BlockNumber,546 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,547 priority: Option<schedule::Priority>,548 call: Box<CallOrHashOf<T>>,549 ) -> DispatchResult {550 T::ScheduleOrigin::ensure_origin(origin.clone())?;551552 if priority.is_some() {553 T::PrioritySetOrigin::ensure_origin(origin.clone())?;554 }555556 let origin = <T as Config>::RuntimeOrigin::from(origin);557 Self::do_schedule_named(558 id,559 DispatchTime::At(when),560 maybe_periodic,561 priority.unwrap_or(LOWEST_PRIORITY),562 origin.caller().clone(),563 *call,564 )?;565 Ok(())566 }567568 569 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]570 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {571 T::ScheduleOrigin::ensure_origin(origin.clone())?;572 let origin = <T as Config>::RuntimeOrigin::from(origin);573 Self::do_cancel_named(Some(origin.caller().clone()), id)?;574 Ok(())575 }576577 578 579 580 581 582 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]583 pub fn schedule_named_after(584 origin: OriginFor<T>,585 id: ScheduledId,586 after: T::BlockNumber,587 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,588 priority: Option<schedule::Priority>,589 call: Box<CallOrHashOf<T>>,590 ) -> DispatchResult {591 T::ScheduleOrigin::ensure_origin(origin.clone())?;592593 if priority.is_some() {594 T::PrioritySetOrigin::ensure_origin(origin.clone())?;595 }596597 let origin = <T as Config>::RuntimeOrigin::from(origin);598 Self::do_schedule_named(599 id,600 DispatchTime::After(after),601 maybe_periodic,602 priority.unwrap_or(LOWEST_PRIORITY),603 origin.caller().clone(),604 *call,605 )?;606 Ok(())607 }608609 #[pallet::weight(<T as Config>::WeightInfo::change_named_priority(T::MaxScheduledPerBlock::get()))]610 pub fn change_named_priority(611 origin: OriginFor<T>,612 id: ScheduledId,613 priority: schedule::Priority,614 ) -> DispatchResult {615 T::PrioritySetOrigin::ensure_origin(origin.clone())?;616 let origin = <T as Config>::RuntimeOrigin::from(origin);617 Self::do_change_named_priority(origin.caller().clone(), id, priority)618 }619 }620}621622impl<T: Config> Pallet<T> {623 #[cfg(feature = "try-runtime")]624 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {625 Ok(())626 }627628 #[cfg(feature = "try-runtime")]629 pub fn post_migrate_to_v3() -> Result<(), &'static str> {630 use frame_support::dispatch::GetStorageVersion;631632 assert!(Self::current_storage_version() == 3);633 for k in Agenda::<T>::iter_keys() {634 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;635 }636 Ok(())637 }638639 640 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {641 Agenda::<T>::translate::<642 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,643 _,644 >(|_, agenda| {645 Some(646 agenda647 .into_iter()648 .map(|schedule| {649 schedule.map(|schedule| Scheduled {650 maybe_id: schedule.maybe_id,651 priority: schedule.priority,652 call: schedule.call,653 maybe_periodic: schedule.maybe_periodic,654 origin: schedule.origin.into(),655 _phantom: Default::default(),656 })657 })658 .collect::<Vec<_>>(),659 )660 });661 }662663 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {664 let now = frame_system::Pallet::<T>::block_number();665666 let when = match when {667 DispatchTime::At(x) => x,668 669 670 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),671 };672673 if when <= now {674 return Err(Error::<T>::TargetBlockNumberInPast.into());675 }676677 Ok(when)678 }679680 fn do_schedule_named(681 id: ScheduledId,682 when: DispatchTime<T::BlockNumber>,683 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,684 priority: schedule::Priority,685 origin: T::PalletsOrigin,686 call: CallOrHashOf<T>,687 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {688 689 if Lookup::<T>::contains_key(&id) {690 return Err(Error::<T>::FailedToSchedule)?;691 }692693 let when = Self::resolve_time(when)?;694695 call.ensure_requested::<T::PreimageProvider>();696697 698 let maybe_periodic = maybe_periodic699 .filter(|p| p.1 > 1 && !p.0.is_zero())700 701 .map(|(p, c)| (p, c - 1));702703 let s = Scheduled {704 maybe_id: Some(id.clone()),705 priority,706 call: call.clone(),707 maybe_periodic,708 origin: origin.clone(),709 _phantom: Default::default(),710 };711712 713 714 715 716 717 718 719 720 721 722 723 724 725726 Agenda::<T>::append(when, Some(s));727 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;728 let address = (when, index);729 Lookup::<T>::insert(&id, &address);730 Self::deposit_event(Event::Scheduled { when, index });731732 Ok(address)733 }734735 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {736 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {737 if let Some((when, index)) = lookup.take() {738 let i = index as usize;739 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {740 if let Some(s) = agenda.get_mut(i) {741 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {742 if matches!(743 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),744 Some(Ordering::Less) | None745 ) {746 return Err(BadOrigin.into());747 }748 749 750 751 752 753 754 755 756757 s.call.ensure_unrequested::<T::PreimageProvider>();758 }759 *s = None;760 }761 Ok(())762 })?;763764 Self::deposit_event(Event::Canceled { when, index });765 Ok(())766 } else {767 Err(Error::<T>::NotFound)?768 }769 })770 }771772 fn do_change_named_priority(773 origin: T::PalletsOrigin,774 id: ScheduledId,775 priority: schedule::Priority,776 ) -> DispatchResult {777 match Lookup::<T>::get(id) {778 Some((when, index)) => {779 let i = index as usize;780 Agenda::<T>::try_mutate(when, |agenda| {781 if let Some(Some(s)) = agenda.get_mut(i) {782 if matches!(783 T::OriginPrivilegeCmp::cmp_privilege(&origin, &s.origin),784 Some(Ordering::Less) | None785 ) {786 return Err(BadOrigin.into());787 }788789 s.priority = priority;790 Self::deposit_event(Event::PriorityChanged {791 when,792 index,793 priority,794 });795 }796 Ok(())797 })798 }799 None => Err(Error::<T>::NotFound.into()),800 }801 }802}