12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152#![cfg_attr(not(feature = "std"), no_std)]53#![allow(clippy::type_complexity, clippy::boxed_local, clippy::unused_unit)]5455mod benchmarking;56pub mod weights;5758use sp_std::{prelude::*, marker::PhantomData, borrow::Borrow};59use codec::{Encode, Decode, Codec};60use sp_runtime::{61 RuntimeDebug,62 traits::{Zero, One, BadOrigin, Saturating},63};64use frame_support::{65 decl_module, decl_storage, decl_event, decl_error,66 dispatch::{Dispatchable, DispatchError, DispatchResult, Parameter},67 traits::{68 Get,69 schedule::{self, DispatchTime},70 OriginTrait, EnsureOrigin, IsType,71 },72 weights::{GetDispatchInfo, Weight},73};74use frame_system::{self as system, ensure_signed};75pub use weights::WeightInfo;76use up_sponsorship::SponsorshipHandler;77use scale_info::TypeInfo;7879808182838485pub trait Config: system::Config {86 87 type Event: From<Event<Self>> + Into<<Self as system::Config>::Event>;8889 90 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>91 + From<Self::PalletsOrigin>92 + IsType<<Self as system::Config>::Origin>;9394 95 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + TypeInfo + Clone + Eq;9697 98 type Call: Parameter99 + Dispatchable<Origin = <Self as Config>::Origin>100 + GetDispatchInfo101 + From<system::Call<Self>>;102103 104 105 type MaximumWeight: Get<Weight>;106107 108 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;109110 111 112 type MaxScheduledPerBlock: Get<u32>;113114 115 type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;116117 118 type WeightInfo: WeightInfo;119}120121122123124pub type PeriodicIndex = u32;125126pub type TaskAddress<BlockNumber> = (BlockNumber, u32);127128#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]129#[derive(Clone, RuntimeDebug, Encode, Decode)]130struct ScheduledV1<Call, BlockNumber> {131 maybe_id: Option<Vec<u8>>,132 priority: schedule::Priority,133 call: Call,134 maybe_periodic: Option<schedule::Period<BlockNumber>>,135}136137138#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]139#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]140pub struct ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId> {141 142 maybe_id: Option<Vec<u8>>,143 144 priority: schedule::Priority,145 146 call: Call,147 148 maybe_periodic: Option<schedule::Period<BlockNumber>>,149 150 origin: PalletsOrigin,151 _phantom: PhantomData<AccountId>,152}153154155pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =156 ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId>;157158159160161#[derive(Encode, Decode, Clone, Copy, PartialEq, Eq, RuntimeDebug, TypeInfo)]162enum Releases {163 V1,164 V2,165}166167impl Default for Releases {168 fn default() -> Self {169 Releases::V1170 }171}172173#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo)]174pub struct CallSpec {175 module: u32,176 method: u32,177}178179decl_storage! {180 trait Store for Module<T: Config> as Scheduler {181 182 pub Agenda: map hasher(twox_64_concat) T::BlockNumber183 => Vec<Option<Scheduled<<T as Config>::Call, T::BlockNumber, T::PalletsOrigin, T::AccountId>>>;184185 pub SpecAgenda: map hasher(twox_64_concat) T::BlockNumber186 => Vec<Option<CallSpec>>;187188 189 Lookup: map hasher(twox_64_concat) Vec<u8> => Option<TaskAddress<T::BlockNumber>>;190191 192 193 194 StorageVersion build(|_| Releases::V2): Releases;195 }196}197198decl_event!(199 pub enum Event<T> where <T as system::Config>::BlockNumber {200 201 Scheduled(BlockNumber, u32),202 203 Canceled(BlockNumber, u32),204 205 Dispatched(TaskAddress<BlockNumber>, Option<Vec<u8>>, DispatchResult),206 }207);208209decl_error! {210 pub enum Error for Module<T: Config> {211 212 FailedToSchedule,213 214 NotFound,215 216 TargetBlockNumberInPast,217 218 RescheduleNoChange,219 }220}221222decl_module! {223 224 pub struct Module<T: Config> for enum Call225 where226 origin: <T as system::Config>::Origin227 {228 type Error = Error<T>;229 fn deposit_event() = default;230231232 233 234 235 236 237 238 239 240 241 242 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]243 fn schedule(origin,244 when: T::BlockNumber,245 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,246 priority: schedule::Priority,247 call: Box<<T as Config>::Call>,248 )249 {250 let origin = <T as Config>::Origin::from(origin);251 Self::do_schedule(DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call)?;252 }253254 255 256 257 258 259 260 261 262 263 264 #[weight = <T as Config>::WeightInfo::cancel(T::MaxScheduledPerBlock::get())]265 fn cancel(origin, when: T::BlockNumber, index: u32) {266 T::ScheduleOrigin::ensure_origin(origin.clone())?;267 let origin = <T as Config>::Origin::from(origin);268 Self::do_cancel(Some(origin.caller().clone()), (when, index))?;269 }270271 272 273 274 275 276 277 278 279 280 281 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]282 fn schedule_named(origin,283 id: Vec<u8>,284 when: T::BlockNumber,285 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,286 priority: schedule::Priority,287 call: Box<<T as Config>::Call>,288 ) {289 T::ScheduleOrigin::ensure_origin(origin.clone())?;290 let origin = <T as Config>::Origin::from(origin);291 Self::do_schedule_named(292 id, DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call293 )?;294 }295296 297 298 299 300 301 302 303 304 305 306 #[weight = <T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get())]307 fn cancel_named(origin, id: Vec<u8>) {308 T::ScheduleOrigin::ensure_origin(origin.clone())?;309 let origin = <T as Config>::Origin::from(origin);310 Self::do_cancel_named(Some(origin.caller().clone()), id)?;311 }312313 314 315 316 317 318 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]319 fn schedule_after(origin,320 after: T::BlockNumber,321 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,322 priority: schedule::Priority,323 call: Box<<T as Config>::Call>,324 ) {325 T::ScheduleOrigin::ensure_origin(origin.clone())?;326 let origin = <T as Config>::Origin::from(origin);327 Self::do_schedule(328 DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call329 )?;330 }331332 333 334 335 336 337 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]338 fn schedule_named_after(origin,339 id: Vec<u8>,340 after: T::BlockNumber,341 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,342 priority: schedule::Priority,343 call: Box<<T as Config>::Call>,344 ) {345 T::ScheduleOrigin::ensure_origin(origin.clone())?;346 let origin = <T as Config>::Origin::from(origin);347 Self::do_schedule_named(348 id, DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call349 )?;350 }351352 353 354 355 356 357 358 359 360 361 362 363 fn on_initialize(now: T::BlockNumber) -> Weight {364 let limit = T::MaximumWeight::get();365 let mut queued = Agenda::<T>::take(now).into_iter()366 .enumerate()367 .filter_map(|(index, s)| s.map(|inner| (index as u32, inner)))368 .collect::<Vec<_>>();369 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {370 log::warn!(371 target: "runtime::scheduler",372 "Warning: This block has more items queued in Scheduler than \373 expected from the runtime configuration. An update might be needed."374 );375 }376 queued.sort_by_key(|(_, s)| s.priority);377 let base_weight: Weight = T::DbWeight::get().reads_writes(1, 2); 378 let mut total_weight: Weight = 0;379 queued.into_iter()380 .enumerate()381 .scan(base_weight, |cumulative_weight, (order, (index, s))| {382 *cumulative_weight = cumulative_weight383 .saturating_add(s.call.get_dispatch_info().weight);384385 let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(386 s.origin.clone()387 ).into();388389 if ensure_signed(origin).is_ok() {390 391 *cumulative_weight = cumulative_weight392 .saturating_add(T::DbWeight::get().reads_writes(1, 1));393 }394395 if s.maybe_id.is_some() {396 397 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().writes(1));398 }399 if s.maybe_periodic.is_some() {400 401 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().reads_writes(1, 1));402 }403404 Some((order, index, *cumulative_weight, s))405 })406 .filter_map(|(order, index, cumulative_weight, mut s)| {407 408 409 410 411 if s.priority <= schedule::HARD_DEADLINE || cumulative_weight <= limit || order == 0 {412413 let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(414 s.origin.clone()415 ).into();416 let sender = match ensure_signed(origin) {417 Ok(v) => v,418 419 Err(_) => return Some(Some(s))420 };421 let who_will_pay = T::SponsorshipHandler::get_sponsor(&sender, &s.call).unwrap_or(sender);422 let sponsor = T::PalletsOrigin::from(system::RawOrigin::Signed(who_will_pay));423 let r = s.call.clone().dispatch(sponsor.into());424 let maybe_id = s.maybe_id.clone();425 if let Some((period, count)) = s.maybe_periodic {426 if count > 1 {427 s.maybe_periodic = Some((period, count - 1));428 } else {429 s.maybe_periodic = None;430 }431 let next = now + period;432 433 if let Some(ref id) = s.maybe_id {434 let next_index = Agenda::<T>::decode_len(now + period).unwrap_or(0);435 Lookup::<T>::insert(id, (next, next_index as u32));436 }437 Agenda::<T>::append(next, Some(s));438 } else if let Some(ref id) = s.maybe_id {439 Lookup::<T>::remove(id);440 }441 Self::deposit_event(RawEvent::Dispatched(442 (now, index),443 maybe_id,444 r.map(|_| ()).map_err(|e| e.error)445 ));446 total_weight = cumulative_weight;447 None448 } else {449 Some(Some(s))450 }451 })452 .for_each(|unused| {453 let next = now + One::one();454 Agenda::<T>::append(next, unused);455 });456457 total_weight458 }459 }460}461462impl<T: Config> Module<T> {463 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {464 let now = frame_system::Pallet::<T>::block_number();465466 let when = match when {467 DispatchTime::At(x) => x,468 469 470 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),471 };472473 if when <= now {474 return Err(Error::<T>::TargetBlockNumberInPast.into());475 }476477 Ok(when)478 }479480 fn do_schedule(481 when: DispatchTime<T::BlockNumber>,482 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,483 priority: schedule::Priority,484 origin: T::PalletsOrigin,485 call: <T as Config>::Call,486 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {487 let when = Self::resolve_time(when)?;488489 490 let maybe_periodic = maybe_periodic491 .filter(|p| p.1 > 1 && !p.0.is_zero())492 493 .map(|(p, c)| (p, c - 1));494 let s = Some(Scheduled {495 maybe_id: None,496 priority,497 call,498 maybe_periodic,499 origin,500 _phantom: PhantomData::<T::AccountId>::default(),501 });502 Agenda::<T>::append(when, s);503 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;504 if index > T::MaxScheduledPerBlock::get() {505 log::warn!(506 target: "runtime::scheduler",507 "Warning: There are more items queued in the Scheduler than \508 expected from the runtime configuration. An update might be needed.",509 );510 }511 Self::deposit_event(RawEvent::Scheduled(when, index));512513 Ok((when, index))514 }515516 fn do_cancel(517 origin: Option<T::PalletsOrigin>,518 (when, index): TaskAddress<T::BlockNumber>,519 ) -> Result<(), DispatchError> {520 let scheduled = Agenda::<T>::try_mutate(when, |agenda| {521 agenda.get_mut(index as usize).map_or(522 Ok(None),523 |s| -> Result<Option<Scheduled<_, _, _, _>>, DispatchError> {524 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {525 if *o != s.origin {526 return Err(BadOrigin.into());527 }528 };529 Ok(s.take())530 },531 )532 })?;533 if let Some(s) = scheduled {534 if let Some(id) = s.maybe_id {535 Lookup::<T>::remove(id);536 }537 Self::deposit_event(RawEvent::Canceled(when, index));538 Ok(())539 } else {540 Err(Error::<T>::NotFound.into())541 }542 }543544 fn do_reschedule(545 (when, index): TaskAddress<T::BlockNumber>,546 new_time: DispatchTime<T::BlockNumber>,547 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {548 let new_time = Self::resolve_time(new_time)?;549550 if new_time == when {551 return Err(Error::<T>::RescheduleNoChange.into());552 }553554 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {555 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;556 let task = task.take().ok_or(Error::<T>::NotFound)?;557 Agenda::<T>::append(new_time, Some(task));558 Ok(())559 })?;560561 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;562 Self::deposit_event(RawEvent::Canceled(when, index));563 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));564565 Ok((new_time, new_index))566 }567568 fn do_schedule_named(569 id: Vec<u8>,570 when: DispatchTime<T::BlockNumber>,571 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,572 priority: schedule::Priority,573 origin: T::PalletsOrigin,574 call: <T as Config>::Call,575 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {576 577 if Lookup::<T>::contains_key(&id) {578 return Err(Error::<T>::FailedToSchedule.into());579 }580581 let when = Self::resolve_time(when)?;582583 584 let maybe_periodic = maybe_periodic585 .filter(|p| p.1 > 1 && !p.0.is_zero())586 587 .map(|(p, c)| (p, c - 1));588589 let s = Scheduled {590 maybe_id: Some(id.clone()),591 priority,592 call,593 maybe_periodic,594 origin,595 _phantom: Default::default(),596 };597 Agenda::<T>::append(when, Some(s));598 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;599 if index > T::MaxScheduledPerBlock::get() {600 log::warn!(601 target: "runtime::scheduler",602 "Warning: There are more items queued in the Scheduler than \603 expected from the runtime configuration. An update might be needed.",604 );605 }606 let address = (when, index);607 Lookup::<T>::insert(&id, &address);608 Self::deposit_event(RawEvent::Scheduled(when, index));609610 Ok(address)611 }612613 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: Vec<u8>) -> DispatchResult {614 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {615 if let Some((when, index)) = lookup.take() {616 let i = index as usize;617 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {618 if let Some(s) = agenda.get_mut(i) {619 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {620 if *o != s.origin {621 return Err(BadOrigin.into());622 }623 }624 *s = None;625 }626 Ok(())627 })?;628 Self::deposit_event(RawEvent::Canceled(when, index));629 Ok(())630 } else {631 Err(Error::<T>::NotFound.into())632 }633 })634 }635636 fn do_reschedule_named(637 id: Vec<u8>,638 new_time: DispatchTime<T::BlockNumber>,639 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {640 let new_time = Self::resolve_time(new_time)?;641642 Lookup::<T>::try_mutate_exists(643 id,644 |lookup| -> Result<TaskAddress<T::BlockNumber>, DispatchError> {645 let (when, index) = lookup.ok_or(Error::<T>::NotFound)?;646647 if new_time == when {648 return Err(Error::<T>::RescheduleNoChange.into());649 }650651 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {652 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;653 let task = task.take().ok_or(Error::<T>::NotFound)?;654 Agenda::<T>::append(new_time, Some(task));655656 Ok(())657 })?;658659 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;660 Self::deposit_event(RawEvent::Canceled(when, index));661 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));662663 *lookup = Some((new_time, new_index));664665 Ok((new_time, new_index))666 },667 )668 }669}670671#[cfg(test)]672#[allow(clippy::from_over_into)]673mod tests {674 use super::*;675676 use frame_support::{677 ord_parameter_types, parameter_types,678 traits::{Contains, ConstU32, EnsureOneOf},679 weights::constants::RocksDbWeight,680 };681 use sp_core::H256;682 use sp_runtime::{683 Perbill,684 testing::Header,685 traits::{BlakeTwo256, IdentityLookup},686 };687 use frame_system::{EnsureRoot, EnsureSignedBy};688 use crate as scheduler;689690 mod logger {691 use super::*;692 use std::cell::RefCell;693694 thread_local! {695 static LOG: RefCell<Vec<(OriginCaller, u32)>> = RefCell::new(Vec::new());696 }697 pub trait Config: system::Config {698 type Event: From<Event> + Into<<Self as system::Config>::Event>;699 }700 decl_event! {701 pub enum Event {702 Logged(u32, Weight),703 }704 }705 decl_module! {706 pub struct Module<T: Config> for enum Call707 where708 origin: <T as system::Config>::Origin,709 <T as system::Config>::Origin: OriginTrait<PalletsOrigin = OriginCaller>710 {711 fn deposit_event() = default;712713 #[weight = *weight]714 fn log(origin, i: u32, weight: Weight) {715 Self::deposit_event(Event::Logged(i, weight));716 LOG.with(|log| {717 log.borrow_mut().push((origin.caller().clone(), i));718 })719 }720721 #[weight = *weight]722 fn log_without_filter(origin, i: u32, weight: Weight) {723 Self::deposit_event(Event::Logged(i, weight));724 LOG.with(|log| {725 log.borrow_mut().push((origin.caller().clone(), i));726 })727 }728 }729 }730 }731732 type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;733 type Block = frame_system::mocking::MockBlock<Test>;734735 frame_support::construct_runtime!(736 pub enum Test where737 Block = Block,738 NodeBlock = Block,739 UncheckedExtrinsic = UncheckedExtrinsic,740 {741 System: frame_system::{Pallet, Call, Config, Storage, Event<T>},742 Logger: logger::{Pallet, Call, Event},743 Scheduler: scheduler::{Pallet, Call, Storage, Event<T>},744 }745 );746747 748 pub struct BaseFilter;749 impl Contains<Call> for BaseFilter {750 fn contains(call: &Call) -> bool {751 !matches!(call, Call::Logger(logger::Call::log { .. }))752 }753 }754755 parameter_types! {756 pub const BlockHashCount: u64 = 250;757 pub BlockWeights: frame_system::limits::BlockWeights =758 frame_system::limits::BlockWeights::simple_max(2_000_000_000_000);759 }760 impl system::Config for Test {761 type BaseCallFilter = BaseFilter;762 type BlockWeights = ();763 type BlockLength = ();764 type DbWeight = RocksDbWeight;765 type Origin = Origin;766 type Call = Call;767 type Index = u64;768 type BlockNumber = u64;769 type Hash = H256;770 type Hashing = BlakeTwo256;771 type AccountId = u64;772 type Lookup = IdentityLookup<Self::AccountId>;773 type Header = Header;774 type Event = Event;775 type BlockHashCount = BlockHashCount;776 type Version = ();777 type PalletInfo = PalletInfo;778 type AccountData = ();779 type OnNewAccount = ();780 type OnKilledAccount = ();781 type SystemWeightInfo = ();782 type SS58Prefix = ();783 type OnSetCode = ();784 type MaxConsumers = ConstU32<16>;785 }786 impl logger::Config for Test {787 type Event = Event;788 }789 parameter_types! {790 pub MaximumSchedulerWeight: Weight = Perbill::from_percent(80) * BlockWeights::get().max_block;791 pub const MaxScheduledPerBlock: u32 = 10;792 }793 ord_parameter_types! {794 pub const One: u64 = 1;795 }796797 impl Config for Test {798 type Event = Event;799 type Origin = Origin;800 type PalletsOrigin = OriginCaller;801 type Call = Call;802 type MaximumWeight = MaximumSchedulerWeight;803 type ScheduleOrigin = EnsureOneOf<EnsureRoot<u64>, EnsureSignedBy<One, u64>>;804 type MaxScheduledPerBlock = MaxScheduledPerBlock;805 type WeightInfo = ();806 type SponsorshipHandler = ();807 }808}