12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788#![cfg_attr(not(feature = "std"), no_std)]8990#[cfg(feature = "runtime-benchmarks")]91mod benchmarking;9293pub mod weights;9495use sp_core::H160;96use codec::{Codec, Decode, Encode};97use frame_system::{self as system, ensure_signed};98pub use pallet::*;99use scale_info::TypeInfo;100use sp_runtime::{101 traits::{BadOrigin, One, Saturating, Zero},102 RuntimeDebug, DispatchErrorWithPostInfo,103};104use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};105106use frame_support::{107 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},108 traits::{109 schedule::{self, DispatchTime, MaybeHashed},110 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,111 StorageVersion,112 },113 weights::{GetDispatchInfo, Weight},114};115116pub use weights::WeightInfo;117118119pub type PeriodicIndex = u32;120121pub type TaskAddress<BlockNumber> = (BlockNumber, u32);122pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;123124type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];125pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;126127128#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]129#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]130pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {131 132 maybe_id: Option<ScheduledId>,133 134 priority: schedule::Priority,135 136 call: Call,137 138 maybe_periodic: Option<schedule::Period<BlockNumber>>,139 140 origin: PalletsOrigin,141 _phantom: PhantomData<AccountId>,142}143144pub type ScheduledV3Of<T> = ScheduledV3<145 CallOrHashOf<T>,146 <T as frame_system::Config>::BlockNumber,147 <T as Config>::PalletsOrigin,148 <T as frame_system::Config>::AccountId,149>;150151pub type ScheduledOf<T> = ScheduledV3Of<T>;152153154pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =155 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;156157#[cfg(feature = "runtime-benchmarks")]158mod preimage_provider {159 use frame_support::traits::PreimageRecipient;160 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}161 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}162}163164#[cfg(not(feature = "runtime-benchmarks"))]165mod preimage_provider {166 use frame_support::traits::PreimageProvider;167 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}168 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}169}170171pub use preimage_provider::PreimageProviderAndMaybeRecipient;172173174pub(crate) trait MarginalWeightInfo: WeightInfo {175 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {176 match (periodic, named, resolved) {177 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),178 (_, true, None) => {179 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)180 }181 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),182 (false, true, Some(false)) => {183 Self::on_initialize_named(2) - Self::on_initialize_named(1)184 }185 (true, false, Some(false)) => {186 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)187 }188 (true, true, Some(false)) => {189 Self::on_initialize_periodic_named_resolved(2)190 - Self::on_initialize_periodic_named_resolved(1)191 }192 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),193 (false, true, Some(true)) => {194 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)195 }196 (true, false, Some(true)) => {197 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)198 }199 (true, true, Some(true)) => {200 Self::on_initialize_periodic_named_resolved(2)201 - Self::on_initialize_periodic_named_resolved(1)202 }203 }204 }205}206impl<T: WeightInfo> MarginalWeightInfo for T {}207208#[frame_support::pallet]209pub mod pallet {210 use super::*;211 use frame_support::{212 dispatch::PostDispatchInfo,213 pallet_prelude::*,214 traits::{schedule::LookupError, PreimageProvider},215 };216 use frame_system::pallet_prelude::*;217218 219 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);220221 #[pallet::pallet]222 #[pallet::generate_store(pub(super) trait Store)]223 #[pallet::storage_version(STORAGE_VERSION)]224 #[pallet::without_storage_info]225 pub struct Pallet<T>(_);226227 228 #[pallet::config]229 pub trait Config: frame_system::Config {230 231 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;232233 234 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>235 + From<Self::PalletsOrigin>236 + IsType<<Self as system::Config>::Origin>;237238 239 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;240241 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;242243 244 type Call: Parameter245 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>246 + GetDispatchInfo247 + From<system::Call<Self>>;248249 250 251 #[pallet::constant]252 type MaximumWeight: Get<Weight>;253254 255 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;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>::Call,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>::Call,302 ) -> Result<u128, DispatchError>;303304 305 fn dispatch_call(306 signer: T::AccountId,307 function: <T as Config>::Call,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 Dispatched {340 task: TaskAddress<T::BlockNumber>,341 id: Option<ScheduledId>,342 result: DispatchResult,343 },344 345 CallLookupFailed {346 task: TaskAddress<T::BlockNumber>,347 id: Option<ScheduledId>,348 error: LookupError,349 },350 }351352 #[pallet::error]353 pub enum Error<T> {354 355 FailedToSchedule,356 357 NotFound,358 359 TargetBlockNumberInPast,360 361 RescheduleNoChange,362 }363364 #[pallet::hooks]365 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {366 367 fn on_initialize(now: T::BlockNumber) -> Weight {368 let limit = T::MaximumWeight::get();369370 let mut queued = Agenda::<T>::take(now)371 .into_iter()372 .enumerate()373 .filter_map(|(index, s)| Some((index as u32, s?)))374 .collect::<Vec<_>>();375376 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {377 log::warn!(378 target: "runtime::scheduler",379 "Warning: This block has more items queued in Scheduler than \380 expected from the runtime configuration. An update might be needed."381 );382 }383384 queued.sort_by_key(|(_, s)| s.priority);385386 let next = now + One::one();387388 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);389 for (order, (index, mut s)) in queued.into_iter().enumerate() {390 let named = if let Some(ref id) = s.maybe_id {391 Lookup::<T>::remove(id);392 true393 } else {394 false395 };396397 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();398 s.call = call;399400 let resolved = if let Some(completed) = maybe_completed {401 T::PreimageProvider::unrequest_preimage(&completed);402 true403 } else {404 false405 };406 let call = match s.call.as_value().cloned() {407 Some(c) => c,408 None => {409 410 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));411 if let Some(delay) = T::NoPreimagePostponement::get() {412 let until = now.saturating_add(delay);413 if let Some(ref id) = s.maybe_id {414 let index = Agenda::<T>::decode_len(until).unwrap_or(0);415 Lookup::<T>::insert(id, (until, index as u32));416 }417 Agenda::<T>::append(until, Some(s));418 }419 continue;420 }421 };422423 let periodic = s.maybe_periodic.is_some();424 let call_weight = call.get_dispatch_info().weight;425 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));426 let origin =427 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())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 > 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 458 let sender = ensure_signed(459 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())460 .into(),461 )462 .unwrap();463464 465 466 467 468 469 470 471 472473 474 let r = T::CallExecutor::dispatch_call(sender, call.clone());475476 let mut actual_call_weight: Weight = item_weight;477 let result: Result<_, DispatchError> = match r {478 Ok(o) => match o {479 Ok(di) => {480 actual_call_weight = di.actual_weight.unwrap_or(item_weight);481 Ok(())482 }483 Err(err) => Err(err.error),484 },485 Err(_) => {486 log::error!(487 target: "runtime::scheduler",488 "Warning: Scheduler has failed to execute a post-dispatch transaction. \489 This block might have become invalid.");490 Err(DispatchError::CannotLookup)491 } 492 };493494 total_weight.saturating_accrue(item_weight);495 total_weight.saturating_accrue(actual_call_weight);496497 Self::deposit_event(Event::Dispatched {498 task: (now, index),499 id: s.maybe_id.clone(),500 result,501 });502503 if let &Some((period, count)) = &s.maybe_periodic {504 if count > 1 {505 s.maybe_periodic = Some((period, count - 1));506 } else {507 s.maybe_periodic = None;508 }509 let wake = now + period;510 511 if let Some(ref id) = s.maybe_id {512 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);513 Lookup::<T>::insert(id, (wake, wake_index as u32));514 }515 Agenda::<T>::append(wake, Some(s));516 }517 }518 519 0520 }521 }522523 #[pallet::call]524 impl<T: Config> Pallet<T> {525 526 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]527 pub fn schedule_named(528 origin: OriginFor<T>,529 id: ScheduledId,530 when: T::BlockNumber,531 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,532 priority: schedule::Priority,533 call: Box<CallOrHashOf<T>>,534 ) -> DispatchResult {535 T::ScheduleOrigin::ensure_origin(origin.clone())?;536 let origin = <T as Config>::Origin::from(origin);537 Self::do_schedule_named(538 id,539 DispatchTime::At(when),540 maybe_periodic,541 priority,542 origin.caller().clone(),543 *call,544 )?;545 Ok(())546 }547548 549 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]550 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {551 T::ScheduleOrigin::ensure_origin(origin.clone())?;552 let origin = <T as Config>::Origin::from(origin);553 Self::do_cancel_named(Some(origin.caller().clone()), id)?;554 Ok(())555 }556557 558 559 560 561 562 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]563 pub fn schedule_named_after(564 origin: OriginFor<T>,565 id: ScheduledId,566 after: T::BlockNumber,567 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,568 priority: schedule::Priority,569 call: Box<CallOrHashOf<T>>,570 ) -> DispatchResult {571 T::ScheduleOrigin::ensure_origin(origin.clone())?;572 let origin = <T as Config>::Origin::from(origin);573 Self::do_schedule_named(574 id,575 DispatchTime::After(after),576 maybe_periodic,577 priority,578 origin.caller().clone(),579 *call,580 )?;581 Ok(())582 }583 }584}585586impl<T: Config> Pallet<T> {587 #[cfg(feature = "try-runtime")]588 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {589 Ok(())590 }591592 #[cfg(feature = "try-runtime")]593 pub fn post_migrate_to_v3() -> Result<(), &'static str> {594 use frame_support::dispatch::GetStorageVersion;595596 assert!(Self::current_storage_version() == 3);597 for k in Agenda::<T>::iter_keys() {598 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;599 }600 Ok(())601 }602603 604 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {605 Agenda::<T>::translate::<606 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,607 _,608 >(|_, agenda| {609 Some(610 agenda611 .into_iter()612 .map(|schedule| {613 schedule.map(|schedule| Scheduled {614 maybe_id: schedule.maybe_id,615 priority: schedule.priority,616 call: schedule.call,617 maybe_periodic: schedule.maybe_periodic,618 origin: schedule.origin.into(),619 _phantom: Default::default(),620 })621 })622 .collect::<Vec<_>>(),623 )624 });625 }626627 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {628 let now = frame_system::Pallet::<T>::block_number();629630 let when = match when {631 DispatchTime::At(x) => x,632 633 634 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),635 };636637 if when <= now {638 return Err(Error::<T>::TargetBlockNumberInPast.into());639 }640641 Ok(when)642 }643644 fn do_schedule_named(645 id: ScheduledId,646 when: DispatchTime<T::BlockNumber>,647 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,648 priority: schedule::Priority,649 origin: T::PalletsOrigin,650 call: CallOrHashOf<T>,651 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {652 653 if Lookup::<T>::contains_key(&id) {654 return Err(Error::<T>::FailedToSchedule)?;655 }656657 let when = Self::resolve_time(when)?;658659 call.ensure_requested::<T::PreimageProvider>();660661 662 let maybe_periodic = maybe_periodic663 .filter(|p| p.1 > 1 && !p.0.is_zero())664 665 .map(|(p, c)| (p, c - 1));666667 let s = Scheduled {668 maybe_id: Some(id.clone()),669 priority,670 call: call.clone(),671 maybe_periodic,672 origin: origin.clone(),673 _phantom: Default::default(),674 };675676 677 678 679 680 681 682 683 684 685 686 687 688 689690 Agenda::<T>::append(when, Some(s));691 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;692 let address = (when, index);693 Lookup::<T>::insert(&id, &address);694 Self::deposit_event(Event::Scheduled { when, index });695696 Ok(address)697 }698699 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {700 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {701 if let Some((when, index)) = lookup.take() {702 let i = index as usize;703 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {704 if let Some(s) = agenda.get_mut(i) {705 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {706 if matches!(707 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),708 Some(Ordering::Less) | None709 ) {710 return Err(BadOrigin.into());711 }712 713 714 715 716 717 718 719 720721 s.call.ensure_unrequested::<T::PreimageProvider>();722 }723 *s = None;724 }725 Ok(())726 })?;727728 Self::deposit_event(Event::Canceled { when, index });729 Ok(())730 } else {731 Err(Error::<T>::NotFound)?732 }733 })734 }735}