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::{schedule::{LookupError, LOWEST_PRIORITY}, PreimageProvider},201 };202 use frame_system::pallet_prelude::*;203204 205 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);206207 #[pallet::pallet]208 #[pallet::generate_store(pub(super) trait Store)]209 #[pallet::storage_version(STORAGE_VERSION)]210 #[pallet::without_storage_info]211 pub struct Pallet<T>(_);212213 214 #[pallet::config]215 pub trait Config: frame_system::Config {216 217 type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;218219 220 type RuntimeOrigin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>221 + From<Self::PalletsOrigin>222 + IsType<<Self as system::Config>::RuntimeOrigin>;223224 225 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;226227 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;228229 230 type RuntimeCall: Parameter231 + Dispatchable<Origin = <Self as Config>::RuntimeOrigin, PostInfo = PostDispatchInfo>232 + UnfilteredDispatchable<Origin = <Self as system::Config>::RuntimeOrigin>233 + GetDispatchInfo234 + From<system::RuntimeCall<Self>>;235236 237 238 #[pallet::constant]239 type MaximumWeight: Get<Weight>;240241 242 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::RuntimeOrigin, Success = ScheduledEnsureOriginSuccess<Self::AccountId>>;243244 245 type PrioritySetOrigin: EnsureOrigin<<Self as system::Config>::RuntimeOrigin>;246247 248 249 250 251 252 253 254 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;255256 257 258 #[pallet::constant]259 type MaxScheduledPerBlock: Get<u32>;260261 262 type WeightInfo: WeightInfo;263264 265 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;266267 268 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;269270 271 272273 274 type CallExecutor: DispatchCall<Self, H160>;275 }276277 278 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {279 280 fn reserve_balance(281 id: ScheduledId,282 sponsor: <T as frame_system::Config>::AccountId,283 call: <T as Config>::RuntimeCall,284 count: u32,285 ) -> Result<(), DispatchError>;286287 288 fn pay_for_call(289 id: ScheduledId,290 sponsor: <T as frame_system::Config>::AccountId,291 call: <T as Config>::RuntimeCall,292 ) -> Result<u128, DispatchError>;293294 295 fn dispatch_call(296 signer: Option<T::AccountId>,297 function: <T as Config>::RuntimeCall,298 ) -> Result<299 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,300 TransactionValidityError,301 >;302303 304 fn cancel_reserve(305 id: ScheduledId,306 sponsor: <T as frame_system::Config>::AccountId,307 ) -> Result<u128, DispatchError>;308 }309310 311 #[pallet::storage]312 pub type Agenda<T: Config> =313 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;314315 316 #[pallet::storage]317 pub(crate) type Lookup<T: Config> =318 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;319320 321 #[pallet::event]322 #[pallet::generate_deposit(pub(super) fn deposit_event)]323 pub enum Event<T: Config> {324 325 Scheduled { when: T::BlockNumber, index: u32 },326 327 Canceled { when: T::BlockNumber, index: u32 },328 329 PriorityChanged { 330 when: T::BlockNumber,331 index: u32,332 priority: schedule::Priority,333 },334 335 Dispatched {336 task: TaskAddress<T::BlockNumber>,337 id: Option<ScheduledId>,338 result: DispatchResult,339 },340 341 CallLookupFailed {342 task: TaskAddress<T::BlockNumber>,343 id: Option<ScheduledId>,344 error: LookupError,345 },346 }347348 #[pallet::error]349 pub enum Error<T> {350 351 FailedToSchedule,352 353 NotFound,354 355 TargetBlockNumberInPast,356 357 RescheduleNoChange,358 }359360 #[pallet::hooks]361 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {362 363 fn on_initialize(now: T::BlockNumber) -> Weight {364 let limit = T::MaximumWeight::get();365366 let mut queued = Agenda::<T>::take(now)367 .into_iter()368 .enumerate()369 .filter_map(|(index, s)| Some((index as u32, s?)))370 .collect::<Vec<_>>();371372 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {373 log::warn!(374 target: "runtime::scheduler",375 "Warning: This block has more items queued in Scheduler than \376 expected from the runtime configuration. An update might be needed."377 );378 }379380 queued.sort_by_key(|(_, s)| s.priority);381382 let next = now + One::one();383384 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);385 for (order, (index, mut s)) in queued.into_iter().enumerate() {386 let named = s.maybe_id.is_some();387388 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();389 s.call = call;390391 let resolved = if let Some(completed) = maybe_completed {392 T::PreimageProvider::unrequest_preimage(&completed);393 true394 } else {395 false396 };397 let call = match s.call.as_value().cloned() {398 Some(c) => c,399 None => {400 401 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));402 if let Some(delay) = T::NoPreimagePostponement::get() {403 let until = now.saturating_add(delay);404 if let Some(ref id) = s.maybe_id {405 let index = Agenda::<T>::decode_len(until).unwrap_or(0);406 Lookup::<T>::insert(id, (until, index as u32));407 }408 Agenda::<T>::append(until, Some(s));409 }410 continue;411 }412 };413414 let periodic = s.maybe_periodic.is_some();415 let call_weight = call.get_dispatch_info().weight;416 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));417 let origin = <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(418 s.origin.clone(),419 )420 .into();421 if ensure_signed(origin).is_ok() {422 423 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));424 }425426 427 428 429 430 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;431 let test_weight = total_weight432 .saturating_add(call_weight)433 .saturating_add(item_weight);434 if !hard_deadline && order > 0 && test_weight.all_gt(limit) {435 436 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));437 if let Some(ref id) = s.maybe_id {438 439 440 441 442 let index = Agenda::<T>::decode_len(next).unwrap_or(0);443 Lookup::<T>::insert(id, (next, index as u32));444 }445 Agenda::<T>::append(next, Some(s));446 continue;447 }448449 let scheduled_origin = <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(s.origin.clone());450 let ensured_origin = T::ScheduleOrigin::ensure_origin(scheduled_origin.into()).unwrap();451452 let r;453 match ensured_origin {454 ScheduledEnsureOriginSuccess::Root => {455 r = Ok(call.dispatch_bypass_filter(frame_system::RawOrigin::Root.into()));456 },457 ScheduledEnsureOriginSuccess::Signed(sender) => {458 459 460 r = T::CallExecutor::dispatch_call(Some(sender), call.clone());461 },462 ScheduledEnsureOriginSuccess::Unsigned => {463 464 r = T::CallExecutor::dispatch_call(None, call.clone());465 }466 }467468 let mut actual_call_weight: Weight = item_weight;469 let result: Result<_, DispatchError> = match r {470 Ok(o) => match o {471 Ok(di) => {472 actual_call_weight = di.actual_weight.unwrap_or(item_weight);473 Ok(())474 }475 Err(err) => Err(err.error),476 },477 Err(_) => {478 log::error!(479 target: "runtime::scheduler",480 "Warning: Scheduler has failed to execute a post-dispatch transaction. \481 This block might have become invalid.");482 Err(DispatchError::CannotLookup)483 } 484 };485486 total_weight.saturating_accrue(item_weight);487 total_weight.saturating_accrue(actual_call_weight);488489 Self::deposit_event(Event::Dispatched {490 task: (now, index),491 id: s.maybe_id.clone(),492 result,493 });494495 if let &Some((period, count)) = &s.maybe_periodic {496 if count > 1 {497 s.maybe_periodic = Some((period, count - 1));498 } else {499 s.maybe_periodic = None;500 }501 let wake = now + period;502 let is_canceled;503504 505 if let Some(ref id) = s.maybe_id {506 is_canceled = Lookup::<T>::get(id).is_none();507 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);508509 if !is_canceled {510 Lookup::<T>::insert(id, (wake, wake_index as u32));511 }512 } else {513 is_canceled = false;514 }515516 if !is_canceled {517 Agenda::<T>::append(wake, Some(s));518 }519 } else if let Some(ref id) = s.maybe_id {520 Lookup::<T>::remove(id);521 }522 }523 total_weight524 }525 }526527 #[pallet::call]528 impl<T: Config> Pallet<T> {529 530 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]531 pub fn schedule_named(532 origin: OriginFor<T>,533 id: ScheduledId,534 when: T::BlockNumber,535 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,536 priority: Option<schedule::Priority>,537 call: Box<CallOrHashOf<T>>,538 ) -> DispatchResult {539 T::ScheduleOrigin::ensure_origin(origin.clone())?;540541 if priority.is_some() {542 T::PrioritySetOrigin::ensure_origin(origin.clone())?;543 }544545 let origin = <T as Config>::RuntimeOrigin::from(origin);546 Self::do_schedule_named(547 id,548 DispatchTime::At(when),549 maybe_periodic,550 priority.unwrap_or(LOWEST_PRIORITY),551 origin.caller().clone(),552 *call,553 )?;554 Ok(())555 }556557 558 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]559 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {560 T::ScheduleOrigin::ensure_origin(origin.clone())?;561 let origin = <T as Config>::RuntimeOrigin::from(origin);562 Self::do_cancel_named(Some(origin.caller().clone()), id)?;563 Ok(())564 }565566 567 568 569 570 571 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]572 pub fn schedule_named_after(573 origin: OriginFor<T>,574 id: ScheduledId,575 after: T::BlockNumber,576 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,577 priority: Option<schedule::Priority>,578 call: Box<CallOrHashOf<T>>,579 ) -> DispatchResult {580 T::ScheduleOrigin::ensure_origin(origin.clone())?;581582 if priority.is_some() {583 T::PrioritySetOrigin::ensure_origin(origin.clone())?;584 }585586 let origin = <T as Config>::RuntimeOrigin::from(origin);587 Self::do_schedule_named(588 id,589 DispatchTime::After(after),590 maybe_periodic,591 priority.unwrap_or(LOWEST_PRIORITY),592 origin.caller().clone(),593 *call,594 )?;595 Ok(())596 }597598 #[pallet::weight(<T as Config>::WeightInfo::change_named_priority(T::MaxScheduledPerBlock::get()))]599 pub fn change_named_priority(600 origin: OriginFor<T>,601 id: ScheduledId,602 priority: schedule::Priority,603 ) -> DispatchResult {604 T::PrioritySetOrigin::ensure_origin(origin.clone())?;605 let origin = <T as Config>::Origin::from(origin);606 Self::do_change_named_priority(origin.caller().clone(), id, priority)607 }608 }609}610611impl<T: Config> Pallet<T> {612 #[cfg(feature = "try-runtime")]613 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {614 Ok(())615 }616617 #[cfg(feature = "try-runtime")]618 pub fn post_migrate_to_v3() -> Result<(), &'static str> {619 use frame_support::dispatch::GetStorageVersion;620621 assert!(Self::current_storage_version() == 3);622 for k in Agenda::<T>::iter_keys() {623 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;624 }625 Ok(())626 }627628 629 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {630 Agenda::<T>::translate::<631 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,632 _,633 >(|_, agenda| {634 Some(635 agenda636 .into_iter()637 .map(|schedule| {638 schedule.map(|schedule| Scheduled {639 maybe_id: schedule.maybe_id,640 priority: schedule.priority,641 call: schedule.call,642 maybe_periodic: schedule.maybe_periodic,643 origin: schedule.origin.into(),644 _phantom: Default::default(),645 })646 })647 .collect::<Vec<_>>(),648 )649 });650 }651652 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {653 let now = frame_system::Pallet::<T>::block_number();654655 let when = match when {656 DispatchTime::At(x) => x,657 658 659 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),660 };661662 if when <= now {663 return Err(Error::<T>::TargetBlockNumberInPast.into());664 }665666 Ok(when)667 }668669 fn do_schedule_named(670 id: ScheduledId,671 when: DispatchTime<T::BlockNumber>,672 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,673 priority: schedule::Priority,674 origin: T::PalletsOrigin,675 call: CallOrHashOf<T>,676 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {677 678 if Lookup::<T>::contains_key(&id) {679 return Err(Error::<T>::FailedToSchedule)?;680 }681682 let when = Self::resolve_time(when)?;683684 call.ensure_requested::<T::PreimageProvider>();685686 687 let maybe_periodic = maybe_periodic688 .filter(|p| p.1 > 1 && !p.0.is_zero())689 690 .map(|(p, c)| (p, c - 1));691692 let s = Scheduled {693 maybe_id: Some(id.clone()),694 priority,695 call: call.clone(),696 maybe_periodic,697 origin: origin.clone(),698 _phantom: Default::default(),699 };700701 702 703 704 705 706 707 708 709 710 711 712 713 714715 Agenda::<T>::append(when, Some(s));716 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;717 let address = (when, index);718 Lookup::<T>::insert(&id, &address);719 Self::deposit_event(Event::Scheduled { when, index });720721 Ok(address)722 }723724 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {725 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {726 if let Some((when, index)) = lookup.take() {727 let i = index as usize;728 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {729 if let Some(s) = agenda.get_mut(i) {730 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {731 if matches!(732 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),733 Some(Ordering::Less) | None734 ) {735 return Err(BadOrigin.into());736 }737 738 739 740 741 742 743 744 745746 s.call.ensure_unrequested::<T::PreimageProvider>();747 }748 *s = None;749 }750 Ok(())751 })?;752753 Self::deposit_event(Event::Canceled { when, index });754 Ok(())755 } else {756 Err(Error::<T>::NotFound)?757 }758 })759 }760761 fn do_change_named_priority(762 origin: T::PalletsOrigin,763 id: ScheduledId,764 priority: schedule::Priority,765 ) -> DispatchResult {766 match Lookup::<T>::get(id) {767 Some((when, index)) => {768 let i = index as usize;769 Agenda::<T>::try_mutate(when, |agenda| {770 if let Some(Some(s)) = agenda.get_mut(i) {771 if matches!(772 T::OriginPrivilegeCmp::cmp_privilege(&origin, &s.origin),773 Some(Ordering::Less) | None774 ) {775 return Err(BadOrigin.into());776 }777778 s.priority = priority;779 Self::deposit_event(Event::PriorityChanged { when, index, priority });780 }781 Ok(())782 })783 },784 None => Err(Error::<T>::NotFound.into())785 }786 }787}