12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061#![cfg_attr(not(feature = "std"), no_std)]6263#[cfg(feature = "runtime-benchmarks")]64mod benchmarking;6566pub mod weights;6768use sp_core::H160;69use codec::{Codec, Decode, Encode};70use frame_system::{self as system, ensure_signed};71pub use pallet::*;72use scale_info::TypeInfo;73use sp_runtime::{74 traits::{BadOrigin, One, Saturating, Zero},75 RuntimeDebug, DispatchErrorWithPostInfo,76};77use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};7879use frame_support::{80 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},81 traits::{82 schedule::{self, DispatchTime, MaybeHashed},83 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,84 StorageVersion,85 },86 weights::{GetDispatchInfo, Weight},87};8889pub use weights::WeightInfo;909192pub type PeriodicIndex = u32;9394pub type TaskAddress<BlockNumber> = (BlockNumber, u32);95pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;9697type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];98pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;99100101#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]102#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]103pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {104 105 maybe_id: Option<ScheduledId>,106 107 priority: schedule::Priority,108 109 call: Call,110 111 maybe_periodic: Option<schedule::Period<BlockNumber>>,112 113 origin: PalletsOrigin,114 _phantom: PhantomData<AccountId>,115}116117pub type ScheduledV3Of<T> = ScheduledV3<118 CallOrHashOf<T>,119 <T as frame_system::Config>::BlockNumber,120 <T as Config>::PalletsOrigin,121 <T as frame_system::Config>::AccountId,122>;123124pub type ScheduledOf<T> = ScheduledV3Of<T>;125126127pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =128 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;129130#[cfg(feature = "runtime-benchmarks")]131mod preimage_provider {132 use frame_support::traits::PreimageRecipient;133 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}134 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}135}136137#[cfg(not(feature = "runtime-benchmarks"))]138mod preimage_provider {139 use frame_support::traits::PreimageProvider;140 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}141 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}142}143144pub use preimage_provider::PreimageProviderAndMaybeRecipient;145146pub(crate) trait MarginalWeightInfo: WeightInfo {147 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {148 match (periodic, named, resolved) {149 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),150 (_, true, None) => {151 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)152 }153 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),154 (false, true, Some(false)) => {155 Self::on_initialize_named(2) - Self::on_initialize_named(1)156 }157 (true, false, Some(false)) => {158 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)159 }160 (true, true, Some(false)) => {161 Self::on_initialize_periodic_named_resolved(2)162 - Self::on_initialize_periodic_named_resolved(1)163 }164 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),165 (false, true, Some(true)) => {166 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)167 }168 (true, false, Some(true)) => {169 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)170 }171 (true, true, Some(true)) => {172 Self::on_initialize_periodic_named_resolved(2)173 - Self::on_initialize_periodic_named_resolved(1)174 }175 }176 }177}178impl<T: WeightInfo> MarginalWeightInfo for T {}179180#[frame_support::pallet]181pub mod pallet {182 use super::*;183 use frame_support::{184 dispatch::PostDispatchInfo,185 pallet_prelude::*,186 traits::{schedule::LookupError, PreimageProvider},187 };188 use frame_system::pallet_prelude::*;189190 191 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);192193 #[pallet::pallet]194 #[pallet::generate_store(pub(super) trait Store)]195 #[pallet::storage_version(STORAGE_VERSION)]196 #[pallet::without_storage_info]197 pub struct Pallet<T>(_);198199 200 #[pallet::config]201 pub trait Config: frame_system::Config {202 203 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;204205 206 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>207 + From<Self::PalletsOrigin>208 + IsType<<Self as system::Config>::Origin>;209210 211 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;212213 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;214215 216 type Call: Parameter217 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>218 + GetDispatchInfo219 + From<system::Call<Self>>;220221 222 223 #[pallet::constant]224 type MaximumWeight: Get<Weight>;225226 227 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;228229 230 231 232 233 234 235 236 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;237238 239 240 #[pallet::constant]241 type MaxScheduledPerBlock: Get<u32>;242243 244 type WeightInfo: WeightInfo;245246 247 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;248249 250 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;251252 253 254255 256 type CallExecutor: DispatchCall<Self, H160>;257 }258259 260 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {261 fn reserve_balance(262 id: ScheduledId,263 sponsor: <T as frame_system::Config>::AccountId,264 call: <T as Config>::Call,265 count: u32,266 ) -> Result<(), DispatchError>;267268 fn pay_for_call(269 id: ScheduledId,270 sponsor: <T as frame_system::Config>::AccountId,271 call: <T as Config>::Call,272 ) -> Result<u128, DispatchError>;273274 275 fn dispatch_call(276 signer: T::AccountId,277 function: <T as Config>::Call,278 ) -> Result<279 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,280 TransactionValidityError,281 >;282283 fn cancel_reserve(284 id: ScheduledId,285 sponsor: <T as frame_system::Config>::AccountId,286 ) -> Result<u128, DispatchError>;287 }288289 290 #[pallet::storage]291 pub type Agenda<T: Config> =292 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;293294 295 #[pallet::storage]296 pub(crate) type Lookup<T: Config> =297 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;298299 300 #[pallet::event]301 #[pallet::generate_deposit(pub(super) fn deposit_event)]302 pub enum Event<T: Config> {303 304 Scheduled { when: T::BlockNumber, index: u32 },305 306 Canceled { when: T::BlockNumber, index: u32 },307 308 Dispatched {309 task: TaskAddress<T::BlockNumber>,310 id: Option<ScheduledId>,311 result: DispatchResult,312 },313 314 CallLookupFailed {315 task: TaskAddress<T::BlockNumber>,316 id: Option<ScheduledId>,317 error: LookupError,318 },319 }320321 #[pallet::error]322 pub enum Error<T> {323 324 FailedToSchedule,325 326 NotFound,327 328 TargetBlockNumberInPast,329 330 RescheduleNoChange,331 }332333 #[pallet::hooks]334 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {335 336 fn on_initialize(now: T::BlockNumber) -> Weight {337 let limit = T::MaximumWeight::get();338339 let mut queued = Agenda::<T>::take(now)340 .into_iter()341 .enumerate()342 .filter_map(|(index, s)| Some((index as u32, s?)))343 .collect::<Vec<_>>();344345 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {346 log::warn!(347 target: "runtime::scheduler",348 "Warning: This block has more items queued in Scheduler than \349 expected from the runtime configuration. An update might be needed."350 );351 }352353 queued.sort_by_key(|(_, s)| s.priority);354355 let next = now + One::one();356357 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);358 for (order, (index, mut s)) in queued.into_iter().enumerate() {359 let named = if let Some(ref id) = s.maybe_id {360 Lookup::<T>::remove(id);361 true362 } else {363 false364 };365366 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();367 s.call = call;368369 let resolved = if let Some(completed) = maybe_completed {370 T::PreimageProvider::unrequest_preimage(&completed);371 true372 } else {373 false374 };375 let call = match s.call.as_value().cloned() {376 Some(c) => c,377 None => {378 379 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));380 if let Some(delay) = T::NoPreimagePostponement::get() {381 let until = now.saturating_add(delay);382 if let Some(ref id) = s.maybe_id {383 let index = Agenda::<T>::decode_len(until).unwrap_or(0);384 Lookup::<T>::insert(id, (until, index as u32));385 }386 Agenda::<T>::append(until, Some(s));387 }388 continue;389 }390 };391392 let periodic = s.maybe_periodic.is_some();393 let call_weight = call.get_dispatch_info().weight;394 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));395 let origin =396 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())397 .into();398 if ensure_signed(origin).is_ok() {399 400 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));401 }402403 404 405 406 407 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;408 let test_weight = total_weight409 .saturating_add(call_weight)410 .saturating_add(item_weight);411 if !hard_deadline && order > 0 && test_weight > limit {412 413 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));414 if let Some(ref id) = s.maybe_id {415 416 417 418 419 let index = Agenda::<T>::decode_len(next).unwrap_or(0);420 Lookup::<T>::insert(id, (next, index as u32));421 }422 Agenda::<T>::append(next, Some(s));423 continue;424 }425426 let sender = ensure_signed(427 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())428 .into(),429 )430 .unwrap();431432 433 434 435 436 437 438 439 440441 let r = T::CallExecutor::dispatch_call(sender, call.clone());442443 let mut actual_call_weight: Weight = item_weight;444 let result: Result<_, DispatchError> = match r {445 Ok(o) => match o {446 Ok(di) => {447 actual_call_weight = di.actual_weight.unwrap_or(item_weight);448 Ok(())449 }450 Err(err) => Err(err.error),451 },452 Err(_) => {453 log::error!(454 target: "runtime::scheduler",455 "Warning: Scheduler has failed to execute a post-dispatch transaction. \456 This block might have become invalid.");457 Err(DispatchError::CannotLookup)458 } 459 };460461 total_weight.saturating_accrue(item_weight);462 total_weight.saturating_accrue(actual_call_weight);463464 Self::deposit_event(Event::Dispatched {465 task: (now, index),466 id: s.maybe_id.clone(),467 result,468 });469470 if let &Some((period, count)) = &s.maybe_periodic {471 if count > 1 {472 s.maybe_periodic = Some((period, count - 1));473 } else {474 s.maybe_periodic = None;475 }476 let wake = now + period;477 478 if let Some(ref id) = s.maybe_id {479 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);480 Lookup::<T>::insert(id, (wake, wake_index as u32));481 }482 Agenda::<T>::append(wake, Some(s));483 }484 }485 0486 487 }488 }489490 #[pallet::call]491 impl<T: Config> Pallet<T> {492 493 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]494 pub fn schedule_named(495 origin: OriginFor<T>,496 id: ScheduledId,497 when: T::BlockNumber,498 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,499 priority: schedule::Priority,500 call: Box<CallOrHashOf<T>>,501 ) -> DispatchResult {502 T::ScheduleOrigin::ensure_origin(origin.clone())?;503 let origin = <T as Config>::Origin::from(origin);504 Self::do_schedule_named(505 id,506 DispatchTime::At(when),507 maybe_periodic,508 priority,509 origin.caller().clone(),510 *call,511 )?;512 Ok(())513 }514515 516 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]517 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {518 T::ScheduleOrigin::ensure_origin(origin.clone())?;519 let origin = <T as Config>::Origin::from(origin);520 Self::do_cancel_named(Some(origin.caller().clone()), id)?;521 Ok(())522 }523524 525 526 527 528 529 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]530 pub fn schedule_named_after(531 origin: OriginFor<T>,532 id: ScheduledId,533 after: T::BlockNumber,534 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,535 priority: schedule::Priority,536 call: Box<CallOrHashOf<T>>,537 ) -> DispatchResult {538 T::ScheduleOrigin::ensure_origin(origin.clone())?;539 let origin = <T as Config>::Origin::from(origin);540 Self::do_schedule_named(541 id,542 DispatchTime::After(after),543 maybe_periodic,544 priority,545 origin.caller().clone(),546 *call,547 )?;548 Ok(())549 }550 }551}552553impl<T: Config> Pallet<T> {554 #[cfg(feature = "try-runtime")]555 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {556 Ok(())557 }558559 #[cfg(feature = "try-runtime")]560 pub fn post_migrate_to_v3() -> Result<(), &'static str> {561 use frame_support::dispatch::GetStorageVersion;562563 assert!(Self::current_storage_version() == 3);564 for k in Agenda::<T>::iter_keys() {565 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;566 }567 Ok(())568 }569570 571 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {572 Agenda::<T>::translate::<573 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,574 _,575 >(|_, agenda| {576 Some(577 agenda578 .into_iter()579 .map(|schedule| {580 schedule.map(|schedule| Scheduled {581 maybe_id: schedule.maybe_id,582 priority: schedule.priority,583 call: schedule.call,584 maybe_periodic: schedule.maybe_periodic,585 origin: schedule.origin.into(),586 _phantom: Default::default(),587 })588 })589 .collect::<Vec<_>>(),590 )591 });592 }593594 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {595 let now = frame_system::Pallet::<T>::block_number();596597 let when = match when {598 DispatchTime::At(x) => x,599 600 601 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),602 };603604 if when <= now {605 return Err(Error::<T>::TargetBlockNumberInPast.into());606 }607608 Ok(when)609 }610611 fn do_schedule_named(612 id: ScheduledId,613 when: DispatchTime<T::BlockNumber>,614 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,615 priority: schedule::Priority,616 origin: T::PalletsOrigin,617 call: CallOrHashOf<T>,618 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {619 620 if Lookup::<T>::contains_key(&id) {621 return Err(Error::<T>::FailedToSchedule)?;622 }623624 let when = Self::resolve_time(when)?;625626 call.ensure_requested::<T::PreimageProvider>();627628 629 let maybe_periodic = maybe_periodic630 .filter(|p| p.1 > 1 && !p.0.is_zero())631 632 .map(|(p, c)| (p, c - 1));633634 let s = Scheduled {635 maybe_id: Some(id.clone()),636 priority,637 call: call.clone(),638 maybe_periodic,639 origin: origin.clone(),640 _phantom: Default::default(),641 };642643 644 645 646 647 648 649 650 651 652 653 654 655 656657 Agenda::<T>::append(when, Some(s));658 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;659 let address = (when, index);660 Lookup::<T>::insert(&id, &address);661 Self::deposit_event(Event::Scheduled { when, index });662663 Ok(address)664 }665666 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {667 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {668 if let Some((when, index)) = lookup.take() {669 let i = index as usize;670 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {671 if let Some(s) = agenda.get_mut(i) {672 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {673 if matches!(674 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),675 Some(Ordering::Less) | None676 ) {677 return Err(BadOrigin.into());678 }679 680 681 682 683 684 685 686 687688 s.call.ensure_unrequested::<T::PreimageProvider>();689 }690 *s = None;691 }692 Ok(())693 })?;694695 Self::deposit_event(Event::Canceled { when, index });696 Ok(())697 } else {698 Err(Error::<T>::NotFound)?699 }700 })701 }702}