difftreelog
feat(Scheduler) scheduler-runtime interface [WIP]
in: master
3 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -6272,6 +6272,7 @@
"parity-scale-codec",
"scale-info",
"serde",
+ "sp-api",
"sp-core",
"sp-io",
"sp-runtime",
pallets/scheduler/src/lib.rsdiffbeforeafterboth1// This file is part of Substrate.23// Copyright (C) 2017-2021 Parity Technologies (UK) Ltd.4// SPDX-License-Identifier: Apache-2.056// Licensed under the Apache License, Version 2.0 (the "License");7// you may not use this file except in compliance with the License.8// You may obtain a copy of the License at9//10// http://www.apache.org/licenses/LICENSE-2.011//12// Unless required by applicable law or agreed to in writing, software13// distributed under the License is distributed on an "AS IS" BASIS,14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.15// See the License for the specific language governing permissions and16// limitations under the License.1718//! # Scheduler19//! A module for scheduling dispatches.20//!21//! - [`Config`]22//! - [`Call`]23//! - [`Module`]24//!25//! ## Overview26//!27//! This module exposes capabilities for scheduling dispatches to occur at a28//! specified block number or at a specified period. These scheduled dispatches29//! may be named or anonymous and may be canceled.30//!31//! **NOTE:** The scheduled calls will be dispatched with the default filter32//! for the origin: namely `frame_system::Config::BaseCallFilter` for all origin33//! except root which will get no filter. And not the filter contained in origin34//! use to call `fn schedule`.35//!36//! If a call is scheduled using proxy or whatever mecanism which adds filter,37//! then those filter will not be used when dispatching the schedule call.38//!39//! ## Interface40//!41//! ### Dispatchable Functions42//!43//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a44//! specified block and with a specified priority.45//! * `cancel` - cancel a scheduled dispatch, specified by block number and46//! index.47//! * `schedule_named` - augments the `schedule` interface with an additional48//! `Vec<u8>` parameter that can be used for identification.49//! * `cancel_named` - the named complement to the cancel function.5051// Ensure we're `no_std` when compiling for Wasm.52#![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::{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 scale_info::TypeInfo;77use sp_runtime::ApplyExtrinsicResult;78use sp_runtime::traits::{IdentifyAccount, Verify};79use sp_runtime::{MultiSignature};8081pub trait ApplyExtrinsic<C: Dispatchable> {82 fn apply_extrinsic(signer: Address, function: C) -> ApplyExtrinsicResult;83}8485/// The address format for describing accounts.86pub type Signature = MultiSignature;87pub type Address = sp_runtime::MultiAddress<AccountId, ()>;88pub type AccountId = <<Signature as Verify>::Signer as IdentifyAccount>::AccountId;8990/// Our pallet's configuration trait. All our types and constants go in here. If the91/// pallet is dependent on specific other pallets, then their configuration traits92/// should be added to our implied traits list.93///94/// `system::Config` should always be included in our implied traits.95/// //96pub trait Config: system::Config {97 /// The overarching event type.98 type Event: From<Event<Self>> + Into<<Self as system::Config>::Event>;99100 /// The aggregated origin which the dispatch will take.101 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>102 + From<Self::PalletsOrigin>103 + IsType<<Self as system::Config>::Origin>;104105 /// The caller origin, overarching type of all pallets origins.106 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + TypeInfo + Clone + Eq;107108 /// The aggregated call type.109 type Call: Parameter110 + Dispatchable<Origin = <Self as Config>::Origin>111 + GetDispatchInfo112 + From<system::Call<Self>>;113114 /// The maximum weight that may be scheduled per block for any dispatchables of less priority115 /// than `schedule::HARD_DEADLINE`.116 type MaximumWeight: Get<Weight>;117118 /// Required origin to schedule or cancel calls.119 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;120121 /// The maximum number of scheduled calls in the queue for a single block.122 /// Not strictly enforced, but used for weight estimation.123 type MaxScheduledPerBlock: Get<u32>;124125 /// Weight information for extrinsics in this pallet.126 type WeightInfo: WeightInfo;127128 type Executor: ApplyExtrinsic<<Self as Config>::Call>;129}130131pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;132133pub const PERIODIC_CALLS_LIMIT: u32 = 100;134135// pub type SelfWeightInfo<T> = <T as system::Config>::WeightInfo;136137/// Just a simple index for naming period tasks.138pub type PeriodicIndex = u32;139/// The location of a scheduled task that can be used to remove it.140pub type TaskAddress<BlockNumber> = (BlockNumber, u32);141142#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]143#[derive(Clone, RuntimeDebug, Encode, Decode)]144struct ScheduledV1<Call, BlockNumber> {145 maybe_id: Option<Vec<u8>>,146 priority: schedule::Priority,147 call: Call,148 maybe_periodic: Option<schedule::Period<BlockNumber>>,149}150151/// Information regarding an item to be executed in the future.152#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]153#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]154pub struct ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId> {155 /// The unique identity for this task, if there is one.156 maybe_id: Option<Vec<u8>>,157 /// This task's priority.158 priority: schedule::Priority,159 /// The call to be dispatched.160 call: Call,161 /// If the call is periodic, then this points to the information concerning that.162 maybe_periodic: Option<schedule::Period<BlockNumber>>,163 /// The origin to dispatch the call.164 origin: PalletsOrigin,165 _phantom: PhantomData<AccountId>,166}167168/// The current version of Scheduled struct.169pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =170 ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId>;171172// A value placed in storage that represents the current version of the Scheduler storage.173// This value is used by the `on_runtime_upgrade` logic to determine whether we run174// storage migration logic.175#[derive(Encode, Decode, Clone, Copy, PartialEq, Eq, RuntimeDebug, TypeInfo)]176enum Releases {177 V1,178 V2,179}180181impl Default for Releases {182 fn default() -> Self {183 Releases::V1184 }185}186187#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo)]188pub struct CallSpec {189 module: u32,190 method: u32,191}192193decl_storage! {194 trait Store for Module<T: Config> as Scheduler {195 /// Items to be executed, indexed by the block number that they should be executed on.196 pub Agenda: map hasher(twox_64_concat) T::BlockNumber197 => Vec<Option<Scheduled<<T as Config>::Call, T::BlockNumber, T::PalletsOrigin, T::AccountId>>>;198199 pub SpecAgenda: map hasher(twox_64_concat) T::BlockNumber200 => Vec<Option<CallSpec>>;201202 /// Lookup from identity to the block number and index of the task.203 Lookup: map hasher(twox_64_concat) Vec<u8> => Option<TaskAddress<T::BlockNumber>>;204205 /// Storage version of the pallet.206 ///207 /// New networks start with last version.208 StorageVersion build(|_| Releases::V2): Releases;209 }210}211212decl_event!(213 pub enum Event<T> where <T as system::Config>::BlockNumber {214 /// Scheduled some task. \[when, index\]215 Scheduled(BlockNumber, u32),216 /// Canceled some task. \[when, index\]217 Canceled(BlockNumber, u32),218 /// Dispatched some task. \[task, id, result\]219 Dispatched(TaskAddress<BlockNumber>, Option<Vec<u8>>, DispatchResult),220 }221);222223decl_error! {224 pub enum Error for Module<T: Config> {225 /// Failed to schedule a call226 FailedToSchedule,227 /// Cannot find the scheduled call.228 NotFound,229 /// Given target block number is in the past.230 TargetBlockNumberInPast,231 /// Reschedule failed because it does not change scheduled time.232 RescheduleNoChange,233 }234}235236decl_module! {237 /// Scheduler module declaration.238 pub struct Module<T: Config> for enum Call239 where240 origin: <T as system::Config>::Origin241 {242 type Error = Error<T>;243 fn deposit_event() = default;244245246 /// Anonymously schedule a task.247 ///248 /// # <weight>249 /// - S = Number of already scheduled calls250 /// - Base Weight: 22.29 + .126 * S µs251 /// - DB Weight:252 /// - Read: Agenda253 /// - Write: Agenda254 /// - Will use base weight of 25 which should be good for up to 30 scheduled calls255 /// # </weight>256 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]257 fn schedule(origin,258 when: T::BlockNumber,259 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,260 priority: schedule::Priority,261 call: Box<<T as Config>::Call>,262 )263 {264 let origin = <T as Config>::Origin::from(origin);265 Self::do_schedule_nameless(DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call)?;266 }267268 /// Cancel an anonymously scheduled task.269 ///270 /// # <weight>271 /// - S = Number of already scheduled calls272 /// - Base Weight: 22.15 + 2.869 * S µs273 /// - DB Weight:274 /// - Read: Agenda275 /// - Write: Agenda, Lookup276 /// - Will use base weight of 100 which should be good for up to 30 scheduled calls277 /// # </weight>278 #[weight = <T as Config>::WeightInfo::cancel(T::MaxScheduledPerBlock::get())]279 fn cancel(origin, when: T::BlockNumber, index: u32) {280 T::ScheduleOrigin::ensure_origin(origin.clone())?;281 let origin = <T as Config>::Origin::from(origin);282 Self::do_cancel(Some(origin.caller().clone()), (when, index))?;283 }284285 /// Schedule a named task.286 ///287 /// # <weight>288 /// - S = Number of already scheduled calls289 /// - Base Weight: 29.6 + .159 * S µs290 /// - DB Weight:291 /// - Read: Agenda, Lookup292 /// - Write: Agenda, Lookup293 /// - Will use base weight of 35 which should be good for more than 30 scheduled calls294 /// # </weight>295 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]296 fn schedule_named(origin,297 id: Vec<u8>,298 when: T::BlockNumber,299 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,300 priority: schedule::Priority,301 call: Box<<T as Config>::Call>,302 ) {303 T::ScheduleOrigin::ensure_origin(origin.clone())?;304 let origin = <T as Config>::Origin::from(origin);305 Self::do_schedule_named(306 id, DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call307 )?;308 }309310 /// Cancel a named scheduled task.311 ///312 /// # <weight>313 /// - S = Number of already scheduled calls314 /// - Base Weight: 24.91 + 2.907 * S µs315 /// - DB Weight:316 /// - Read: Agenda, Lookup317 /// - Write: Agenda, Lookup318 /// - Will use base weight of 100 which should be good for up to 30 scheduled calls319 /// # </weight>320 #[weight = <T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get())]321 fn cancel_named(origin, id: Vec<u8>) {322 T::ScheduleOrigin::ensure_origin(origin.clone())?;323 let origin = <T as Config>::Origin::from(origin);324 Self::do_cancel_named(Some(origin.caller().clone()), id)?;325 }326327 /// Anonymously schedule a task after a delay.328 ///329 /// # <weight>330 /// Same as [`schedule`].331 /// # </weight>332 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]333 fn schedule_after(origin,334 after: T::BlockNumber,335 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,336 priority: schedule::Priority,337 call: Box<<T as Config>::Call>,338 ) {339 T::ScheduleOrigin::ensure_origin(origin.clone())?;340 let origin = <T as Config>::Origin::from(origin);341 Self::do_schedule_nameless(342 DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call343 )?;344 }345346 /// Schedule a named task after a delay.347 ///348 /// # <weight>349 /// Same as [`schedule_named`].350 /// # </weight>351 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]352 fn schedule_named_after(origin,353 id: Vec<u8>,354 after: T::BlockNumber,355 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,356 priority: schedule::Priority,357 call: Box<<T as Config>::Call>,358 ) {359 T::ScheduleOrigin::ensure_origin(origin.clone())?;360 let origin = <T as Config>::Origin::from(origin);361 Self::do_schedule_named(362 id, DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call363 )?;364 }365366 /// Execute the scheduled calls367 ///368 /// # <weight>369 /// - S = Number of already scheduled calls370 /// - N = Named scheduled calls371 /// - P = Periodic Calls372 /// - Base Weight: 9.243 + 23.45 * S µs373 /// - DB Weight:374 /// - Read: Agenda + Lookup * N + Agenda(Future) * P375 /// - Write: Agenda + Lookup * N + Agenda(future) * P376 /// # </weight>377 fn on_initialize(now: T::BlockNumber) -> Weight {378 let limit = T::MaximumWeight::get();379 let mut queued = Agenda::<T>::take(now)380 .into_iter()381 .enumerate()382 .filter_map(|(index, s)| s.map(|inner| (index as u32, inner)))383 .collect::<Vec<_>>();384 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {385 log::warn!(386 target: "runtime::scheduler",387 "Warning: This block has more items queued in Scheduler than \388 expected from the runtime configuration. An update might be needed."389 );390 }391 queued.sort_by_key(|(_, s)| s.priority);392 let base_weight: Weight = T::DbWeight::get().reads_writes(1, 2); // Agenda + Agenda(next)393 let mut total_weight: Weight = 0; // T::WeightInfo::on_initialize(0)394 queued.into_iter()395 .enumerate()396 .scan(base_weight, |cumulative_weight, (order, (index, s))| {397 *cumulative_weight = cumulative_weight398 .saturating_add(s.call.get_dispatch_info().weight);399400 let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(401 s.origin.clone()402 ).into();403404 if ensure_signed(origin).is_ok() {405 // AccountData for inner call origin accountdata.406 *cumulative_weight = cumulative_weight407 .saturating_add(T::DbWeight::get().reads_writes(1, 1));408 }409410 if s.maybe_id.is_some() {411 // Remove/Modify Lookup412 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().writes(1));413 }414 if s.maybe_periodic.is_some() {415 // Read/Write Agenda for future block416 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().reads_writes(1, 1));417 }418419 Some((order, index, *cumulative_weight, s))420 })421 .filter_map(|(order, index, cumulative_weight, mut s)| {422 // We allow a scheduled call if any is true:423 // - It's priority is `HARD_DEADLINE`424 // - It does not push the weight past the limit.425 // - It is the first item in the schedule426 if s.priority <= schedule::HARD_DEADLINE || cumulative_weight <= limit || order == 0 {427428 // let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(429 // s.origin.clone()430 // ).into();431 // let sender = ensure_signed(origin).unwrap_or_default();432 // let who_will_pay = T::SponsorshipHandler::get_sponsor(&sender, &s.call).unwrap_or(sender);433 // let sponsor = T::PalletsOrigin::from(system::RawOrigin::Signed(who_will_pay));434 // let r = s.call.clone().dispatch(sponsor.into());435 let maybe_id = s.maybe_id.clone();436 if let Some((period, count)) = s.maybe_periodic {437 if count > 1 {438 s.maybe_periodic = Some((period, count - 1));439 } else {440 s.maybe_periodic = None;441 }442 let next = now + period;443 // If scheduled is named, place it's information in `Lookup`444 if let Some(ref id) = s.maybe_id {445 let next_index = Agenda::<T>::decode_len(now + period).unwrap_or(0);446 Lookup::<T>::insert(id, (next, next_index as u32));447 }448 Agenda::<T>::append(next, Some(s));449 } else if let Some(ref id) = s.maybe_id {450 Lookup::<T>::remove(id);451 }452 Self::deposit_event(RawEvent::Dispatched(453 (now, index),454 maybe_id,455 Ok(())// r.map(|_| ()).map_err(|e| e.error)456 ));457 total_weight = cumulative_weight;458 None459 } else {460 Some(Some(s))461 }462 })463 .for_each(|unused| {464 let next = now + One::one();465 Agenda::<T>::append(next, unused);466 });467468 total_weight469 }470 }471}472473impl<T: Config> Module<T> {474 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {475 let now = frame_system::Pallet::<T>::block_number();476477 let when = match when {478 DispatchTime::At(x) => x,479 // The current block has already completed it's scheduled tasks, so480 // Schedule the task at lest one block after this current block.481 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),482 };483484 if when <= now {485 return Err(Error::<T>::TargetBlockNumberInPast.into());486 }487488 Ok(when)489 }490491 fn do_schedule(492 maybe_id: Option<Vec<u8>>,493 when: DispatchTime<T::BlockNumber>,494 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,495 priority: schedule::Priority,496 origin: T::PalletsOrigin,497 call: <T as Config>::Call,498 ) -> Result<(T::BlockNumber, u32), DispatchError> {499 let when = Self::resolve_time(when)?;500501 let sender = ensure_signed(502 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin.clone()).into(),503 )504 .unwrap_or_default();505 let who_will_pay = sender; // T::SponsorshipHandler::get_sponsor(&sender, &call).unwrap_or(sender);506 let sponsor = T::PalletsOrigin::from(system::RawOrigin::Signed(who_will_pay));507 let r = call.clone().dispatch(sponsor.into());508509 //T::PaymentHandler::validate(sponsor.into(), call.clone(), ); todo dispatch call510511 // sanitize maybe_periodic512 let maybe_periodic = None;513 // let maybe_periodic = maybe_periodic514 // .filter(|p| p.1 > 1 && !p.0.is_zero())515 // // Limit the repetitions to 100 calls and remove one from the number of repetitions since we will schedule one now.516 // .map(|(p, c)| (p, std::cmp::min(c, PERIODIC_CALLS_LIMIT) - 1));517518 let s = Some(Scheduled {519 maybe_id,520 priority,521 call,522 maybe_periodic,523 origin,524 _phantom: PhantomData::<T::AccountId>::default(),525 });526 Agenda::<T>::append(when, s);527 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;528 if index > T::MaxScheduledPerBlock::get() {529 log::warn!(530 target: "runtime::scheduler",531 "Warning: There are more items queued in the Scheduler than \532 expected from the runtime configuration. An update might be needed.",533 );534 }535536 Ok((when, index))537 }538539 fn do_schedule_nameless(540 when: DispatchTime<T::BlockNumber>,541 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,542 priority: schedule::Priority,543 origin: T::PalletsOrigin,544 call: <T as Config>::Call,545 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {546 let address = Self::do_schedule(None, when, maybe_periodic, priority, origin, call)?;547 let (when, index) = address;548549 Self::deposit_event(RawEvent::Scheduled(when, index));550551 Ok(address)552 }553554 fn do_cancel(555 origin: Option<T::PalletsOrigin>,556 (when, index): TaskAddress<T::BlockNumber>,557 ) -> Result<(), DispatchError> {558 let scheduled = Agenda::<T>::try_mutate(when, |agenda| {559 agenda.get_mut(index as usize).map_or(560 Ok(None),561 |s| -> Result<Option<Scheduled<_, _, _, _>>, DispatchError> {562 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {563 if *o != s.origin {564 return Err(BadOrigin.into());565 }566 };567 Ok(s.take())568 },569 )570 })?;571 if let Some(s) = scheduled {572 if let Some(id) = s.maybe_id {573 Lookup::<T>::remove(id);574 }575 Self::deposit_event(RawEvent::Canceled(when, index));576 Ok(())577 } else {578 Err(Error::<T>::NotFound.into())579 }580 }581582 fn do_reschedule(583 (when, index): TaskAddress<T::BlockNumber>,584 new_time: DispatchTime<T::BlockNumber>,585 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {586 let new_time = Self::resolve_time(new_time)?;587588 if new_time == when {589 return Err(Error::<T>::RescheduleNoChange.into());590 }591592 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {593 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;594 let task = task.take().ok_or(Error::<T>::NotFound)?;595 Agenda::<T>::append(new_time, Some(task));596 Ok(())597 })?;598599 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;600 Self::deposit_event(RawEvent::Canceled(when, index));601 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));602603 Ok((new_time, new_index))604 }605606 fn do_schedule_named(607 id: Vec<u8>,608 when: DispatchTime<T::BlockNumber>,609 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,610 priority: schedule::Priority,611 origin: T::PalletsOrigin,612 call: <T as Config>::Call,613 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {614 // ensure id length does not exceed expectations & is unique615 if id.len() > MAX_TASK_ID_LENGTH_IN_BYTES.try_into().unwrap()616 || Lookup::<T>::contains_key(&id)617 {618 return Err(Error::<T>::FailedToSchedule.into());619 }620621 let address = Self::do_schedule(622 Some(id.clone()),623 when,624 maybe_periodic,625 priority,626 origin,627 call,628 )?;629 let (when, index) = address;630631 Lookup::<T>::insert(&id, &address);632 Self::deposit_event(RawEvent::Scheduled(when, index));633 Ok(address)634 }635636 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: Vec<u8>) -> DispatchResult {637 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {638 if let Some((when, index)) = lookup.take() {639 let i = index as usize;640 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {641 if let Some(s) = agenda.get_mut(i) {642 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {643 if *o != s.origin {644 return Err(BadOrigin.into());645 }646 }647 *s = None;648 }649 Ok(())650 })?;651 Self::deposit_event(RawEvent::Canceled(when, index));652 Ok(())653 } else {654 Err(Error::<T>::NotFound.into())655 }656 })657 }658659 fn do_reschedule_named(660 id: Vec<u8>,661 new_time: DispatchTime<T::BlockNumber>,662 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {663 let new_time = Self::resolve_time(new_time)?;664665 Lookup::<T>::try_mutate_exists(666 id,667 |lookup| -> Result<TaskAddress<T::BlockNumber>, DispatchError> {668 let (when, index) = lookup.ok_or(Error::<T>::NotFound)?;669670 if new_time == when {671 return Err(Error::<T>::RescheduleNoChange.into());672 }673674 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {675 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;676 let task = task.take().ok_or(Error::<T>::NotFound)?;677 Agenda::<T>::append(new_time, Some(task));678679 Ok(())680 })?;681682 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;683 Self::deposit_event(RawEvent::Canceled(when, index));684 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));685686 *lookup = Some((new_time, new_index));687688 Ok((new_time, new_index))689 },690 )691 }692}693694impl<T: Config> schedule::Anon<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>695 for Module<T>696{697 type Address = TaskAddress<T::BlockNumber>;698699 fn schedule(700 when: DispatchTime<T::BlockNumber>,701 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,702 priority: schedule::Priority,703 origin: T::PalletsOrigin,704 call: <T as Config>::Call,705 ) -> Result<Self::Address, DispatchError> {706 Self::do_schedule_nameless(when, maybe_periodic, priority, origin, call)707 }708709 fn cancel((when, index): Self::Address) -> Result<(), ()> {710 Self::do_cancel(None, (when, index)).map_err(|_| ())711 }712713 fn reschedule(714 address: Self::Address,715 when: DispatchTime<T::BlockNumber>,716 ) -> Result<Self::Address, DispatchError> {717 Self::do_reschedule(address, when)718 }719720 fn next_dispatch_time((when, index): Self::Address) -> Result<T::BlockNumber, ()> {721 Agenda::<T>::get(when)722 .get(index as usize)723 .ok_or(())724 .map(|_| when)725 }726}727728impl<T: Config> schedule::Named<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>729 for Module<T>730{731 type Address = TaskAddress<T::BlockNumber>;732733 fn schedule_named(734 id: Vec<u8>,735 when: DispatchTime<T::BlockNumber>,736 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,737 priority: schedule::Priority,738 origin: T::PalletsOrigin,739 call: <T as Config>::Call,740 ) -> Result<Self::Address, ()> {741 Self::do_schedule_named(id, when, maybe_periodic, priority, origin, call).map_err(|_| ())742 }743744 fn cancel_named(id: Vec<u8>) -> Result<(), ()> {745 Self::do_cancel_named(None, id).map_err(|_| ())746 }747748 fn reschedule_named(749 id: Vec<u8>,750 when: DispatchTime<T::BlockNumber>,751 ) -> Result<Self::Address, DispatchError> {752 Self::do_reschedule_named(id, when)753 }754755 fn next_dispatch_time(id: Vec<u8>) -> Result<T::BlockNumber, ()> {756 Lookup::<T>::get(id)757 .and_then(|(when, index)| Agenda::<T>::get(when).get(index as usize).map(|_| when))758 .ok_or(())759 }760}761762#[cfg(test)]763#[allow(clippy::from_over_into)]764mod tests {765 use super::*;766767 use frame_support::{768 ord_parameter_types, parameter_types, traits::Contains, weights::constants::RocksDbWeight,769 };770 use sp_core::H256;771 use sp_runtime::{772 Perbill,773 testing::Header,774 traits::{BlakeTwo256, IdentityLookup},775 };776 use frame_system::{EnsureOneOf, EnsureRoot, EnsureSignedBy};777 use crate as scheduler;778779 mod logger {780 use super::*;781 use std::cell::RefCell;782783 thread_local! {784 static LOG: RefCell<Vec<(OriginCaller, u32)>> = RefCell::new(Vec::new());785 }786 pub trait Config: system::Config {787 type Event: From<Event> + Into<<Self as system::Config>::Event>;788 }789 decl_event! {790 pub enum Event {791 Logged(u32, Weight),792 }793 }794 decl_module! {795 pub struct Module<T: Config> for enum Call796 where797 origin: <T as system::Config>::Origin,798 <T as system::Config>::Origin: OriginTrait<PalletsOrigin = OriginCaller>799 {800 fn deposit_event() = default;801802 #[weight = *weight]803 fn log(origin, i: u32, weight: Weight) {804 Self::deposit_event(Event::Logged(i, weight));805 LOG.with(|log| {806 log.borrow_mut().push((origin.caller().clone(), i));807 })808 }809810 #[weight = *weight]811 fn log_without_filter(origin, i: u32, weight: Weight) {812 Self::deposit_event(Event::Logged(i, weight));813 LOG.with(|log| {814 log.borrow_mut().push((origin.caller().clone(), i));815 })816 }817 }818 }819 }820821 type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;822 type Block = frame_system::mocking::MockBlock<Test>;823824 frame_support::construct_runtime!(825 pub enum Test where826 Block = Block,827 NodeBlock = Block,828 UncheckedExtrinsic = UncheckedExtrinsic,829 {830 System: frame_system::{Pallet, Call, Config, Storage, Event<T>},831 Logger: logger::{Pallet, Call, Event},832 Scheduler: scheduler::{Pallet, Call, Storage, Event<T>},833 }834 );835836 // Scheduler must dispatch with root and no filter, this tests base filter is indeed not used.837 pub struct BaseFilter;838 impl Contains<Call> for BaseFilter {839 fn contains(call: &Call) -> bool {840 !matches!(call, Call::Logger(logger::Call::log { .. }))841 }842 }843844 parameter_types! {845 pub const BlockHashCount: u64 = 250;846 pub BlockWeights: frame_system::limits::BlockWeights =847 frame_system::limits::BlockWeights::simple_max(2_000_000_000_000);848 }849 impl system::Config for Test {850 type BaseCallFilter = BaseFilter;851 type BlockWeights = ();852 type BlockLength = ();853 type DbWeight = RocksDbWeight;854 type Origin = Origin;855 type Call = Call;856 type Index = u64;857 type BlockNumber = u64;858 type Hash = H256;859 type Hashing = BlakeTwo256;860 type AccountId = u64;861 type Lookup = IdentityLookup<Self::AccountId>;862 type Header = Header;863 type Event = Event;864 type BlockHashCount = BlockHashCount;865 type Version = ();866 type PalletInfo = PalletInfo;867 type AccountData = ();868 type OnNewAccount = ();869 type OnKilledAccount = ();870 type SystemWeightInfo = ();871 type SS58Prefix = ();872 type OnSetCode = ();873 }874 impl logger::Config for Test {875 type Event = Event;876 }877 parameter_types! {878 pub MaximumSchedulerWeight: Weight = Perbill::from_percent(80) * BlockWeights::get().max_block;879 pub const MaxScheduledPerBlock: u32 = 10;880 }881 ord_parameter_types! {882 pub const One: u64 = 1;883 }884885 impl Config for Test {886 type Event = Event;887 type Origin = Origin;888 type PalletsOrigin = OriginCaller;889 type Call = Call;890 type MaximumWeight = MaximumSchedulerWeight;891 type ScheduleOrigin = EnsureOneOf<u64, EnsureRoot<u64>, EnsureSignedBy<One, u64>>;892 type MaxScheduledPerBlock = MaxScheduledPerBlock;893 type WeightInfo = ();894 type SponsorshipHandler = ();895 type PaymentHandler = ();896 }897}1// This file is part of Substrate.23// Copyright (C) 2017-2021 Parity Technologies (UK) Ltd.4// SPDX-License-Identifier: Apache-2.056// Licensed under the Apache License, Version 2.0 (the "License");7// you may not use this file except in compliance with the License.8// You may obtain a copy of the License at9//10// http://www.apache.org/licenses/LICENSE-2.011//12// Unless required by applicable law or agreed to in writing, software13// distributed under the License is distributed on an "AS IS" BASIS,14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.15// See the License for the specific language governing permissions and16// limitations under the License.1718//! # Scheduler19//! A module for scheduling dispatches.20//!21//! - [`Config`]22//! - [`Call`]23//! - [`Module`]24//!25//! ## Overview26//!27//! This module exposes capabilities for scheduling dispatches to occur at a28//! specified block number or at a specified period. These scheduled dispatches29//! may be named or anonymous and may be canceled.30//!31//! **NOTE:** The scheduled calls will be dispatched with the default filter32//! for the origin: namely `frame_system::Config::BaseCallFilter` for all origin33//! except root which will get no filter. And not the filter contained in origin34//! use to call `fn schedule`.35//!36//! If a call is scheduled using proxy or whatever mecanism which adds filter,37//! then those filter will not be used when dispatching the schedule call.38//!39//! ## Interface40//!41//! ### Dispatchable Functions42//!43//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a44//! specified block and with a specified priority.45//! * `cancel` - cancel a scheduled dispatch, specified by block number and46//! index.47//! * `schedule_named` - augments the `schedule` interface with an additional48//! `Vec<u8>` parameter that can be used for identification.49//! * `cancel_named` - the named complement to the cancel function.5051// Ensure we're `no_std` when compiling for Wasm.52#![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, cmp};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 scale_info::TypeInfo;77use sp_runtime::ApplyExtrinsicResult;78use sp_runtime::traits::{IdentifyAccount, Verify};79use sp_runtime::{MultiSignature};8081pub trait ApplyExtrinsic<C: Dispatchable> {82 fn apply_extrinsic(signer: Address, function: C) -> ApplyExtrinsicResult;83}8485/// The address format for describing accounts.86pub type Signature = MultiSignature;87pub type Address = sp_runtime::MultiAddress<AccountId, ()>;88pub type AccountId = <<Signature as Verify>::Signer as IdentifyAccount>::AccountId;8990/// Our pallet's configuration trait. All our types and constants go in here. If the91/// pallet is dependent on specific other pallets, then their configuration traits92/// should be added to our implied traits list.93///94/// `system::Config` should always be included in our implied traits.95/// //96pub trait Config: system::Config {97 /// The overarching event type.98 type Event: From<Event<Self>> + Into<<Self as system::Config>::Event>;99100 /// The aggregated origin which the dispatch will take.101 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>102 + From<Self::PalletsOrigin>103 + IsType<<Self as system::Config>::Origin>;104105 /// The caller origin, overarching type of all pallets origins.106 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + TypeInfo + Clone + Eq;107108 /// The aggregated call type.109 type Call: Parameter110 + Dispatchable<Origin = <Self as Config>::Origin>111 + GetDispatchInfo112 + From<system::Call<Self>>;113114 /// The maximum weight that may be scheduled per block for any dispatchables of less priority115 /// than `schedule::HARD_DEADLINE`.116 type MaximumWeight: Get<Weight>;117118 /// Required origin to schedule or cancel calls.119 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;120121 /// The maximum number of scheduled calls in the queue for a single block.122 /// Not strictly enforced, but used for weight estimation.123 type MaxScheduledPerBlock: Get<u32>;124125 /// Weight information for extrinsics in this pallet.126 type WeightInfo: WeightInfo;127128 type Executor: ApplyExtrinsic<<Self as Config>::Call>;129}130131pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;132133pub const PERIODIC_CALLS_LIMIT: u32 = 100;134135// pub type SelfWeightInfo<T> = <T as system::Config>::WeightInfo;136137/// Just a simple index for naming period tasks.138pub type PeriodicIndex = u32;139/// The location of a scheduled task that can be used to remove it.140pub type TaskAddress<BlockNumber> = (BlockNumber, u32);141142#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]143#[derive(Clone, RuntimeDebug, Encode, Decode)]144struct ScheduledV1<Call, BlockNumber> {145 maybe_id: Option<Vec<u8>>,146 priority: schedule::Priority,147 call: Call,148 maybe_periodic: Option<schedule::Period<BlockNumber>>,149}150151/// Information regarding an item to be executed in the future.152#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]153#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]154pub struct ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId> {155 /// The unique identity for this task, if there is one.156 maybe_id: Option<Vec<u8>>,157 /// This task's priority.158 priority: schedule::Priority,159 /// The call to be dispatched.160 call: Call,161 /// If the call is periodic, then this points to the information concerning that.162 maybe_periodic: Option<schedule::Period<BlockNumber>>,163 /// The origin to dispatch the call.164 origin: PalletsOrigin,165 _phantom: PhantomData<AccountId>,166}167168/// The current version of Scheduled struct.169pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =170 ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId>;171172// A value placed in storage that represents the current version of the Scheduler storage.173// This value is used by the `on_runtime_upgrade` logic to determine whether we run174// storage migration logic.175#[derive(Encode, Decode, Clone, Copy, PartialEq, Eq, RuntimeDebug, TypeInfo)]176enum Releases {177 V1,178 V2,179}180181impl Default for Releases {182 fn default() -> Self {183 Releases::V1184 }185}186187#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo)]188pub struct CallSpec {189 module: u32,190 method: u32,191}192193decl_storage! {194 trait Store for Module<T: Config> as Scheduler {195 /// Items to be executed, indexed by the block number that they should be executed on.196 pub Agenda: map hasher(twox_64_concat) T::BlockNumber197 => Vec<Option<Scheduled<<T as Config>::Call, T::BlockNumber, T::PalletsOrigin, T::AccountId>>>;198199 pub SpecAgenda: map hasher(twox_64_concat) T::BlockNumber200 => Vec<Option<CallSpec>>;201202 /// Lookup from identity to the block number and index of the task.203 Lookup: map hasher(twox_64_concat) Vec<u8> => Option<TaskAddress<T::BlockNumber>>;204205 /// Storage version of the pallet.206 ///207 /// New networks start with last version.208 StorageVersion build(|_| Releases::V2): Releases;209 }210}211212decl_event!(213 pub enum Event<T> where <T as system::Config>::BlockNumber {214 /// Scheduled some task. \[when, index\]215 Scheduled(BlockNumber, u32),216 /// Canceled some task. \[when, index\]217 Canceled(BlockNumber, u32),218 /// Dispatched some task. \[task, id, result\]219 Dispatched(TaskAddress<BlockNumber>, Option<Vec<u8>>, DispatchResult),220 }221);222223decl_error! {224 pub enum Error for Module<T: Config> {225 /// Failed to schedule a call226 FailedToSchedule,227 /// Cannot find the scheduled call.228 NotFound,229 /// Given target block number is in the past.230 TargetBlockNumberInPast,231 /// Reschedule failed because it does not change scheduled time.232 RescheduleNoChange,233 }234}235236decl_module! {237 /// Scheduler module declaration.238 pub struct Module<T: Config> for enum Call239 where240 origin: <T as system::Config>::Origin241 {242 type Error = Error<T>;243 fn deposit_event() = default;244245 /// Anonymously schedule a task.246 ///247 /// # <weight>248 /// - S = Number of already scheduled calls249 /// - Base Weight: 22.29 + .126 * S µs250 /// - DB Weight:251 /// - Read: Agenda252 /// - Write: Agenda253 /// - Will use base weight of 25 which should be good for up to 30 scheduled calls254 /// # </weight>255 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]256 fn schedule(origin,257 when: T::BlockNumber,258 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,259 priority: schedule::Priority,260 call: Box<<T as Config>::Call>,261 )262 {263 let origin = <T as Config>::Origin::from(origin);264 Self::do_schedule_nameless(DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call)?;265 }266267 /// Cancel an anonymously scheduled task.268 ///269 /// # <weight>270 /// - S = Number of already scheduled calls271 /// - Base Weight: 22.15 + 2.869 * S µs272 /// - DB Weight:273 /// - Read: Agenda274 /// - Write: Agenda, Lookup275 /// - Will use base weight of 100 which should be good for up to 30 scheduled calls276 /// # </weight>277 #[weight = <T as Config>::WeightInfo::cancel(T::MaxScheduledPerBlock::get())]278 fn cancel(origin, when: T::BlockNumber, index: u32) {279 T::ScheduleOrigin::ensure_origin(origin.clone())?;280 let origin = <T as Config>::Origin::from(origin);281 Self::do_cancel(Some(origin.caller().clone()), (when, index))?;282 }283284 /// Schedule a named task.285 ///286 /// # <weight>287 /// - S = Number of already scheduled calls288 /// - Base Weight: 29.6 + .159 * S µs289 /// - DB Weight:290 /// - Read: Agenda, Lookup291 /// - Write: Agenda, Lookup292 /// - Will use base weight of 35 which should be good for more than 30 scheduled calls293 /// # </weight>294 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]295 fn schedule_named(origin,296 id: Vec<u8>,297 when: T::BlockNumber,298 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,299 priority: schedule::Priority,300 call: Box<<T as Config>::Call>,301 ) {302 T::ScheduleOrigin::ensure_origin(origin.clone())?;303 let origin = <T as Config>::Origin::from(origin);304 Self::do_schedule_named(305 id, DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call306 )?;307 }308309 /// Cancel a named scheduled task.310 ///311 /// # <weight>312 /// - S = Number of already scheduled calls313 /// - Base Weight: 24.91 + 2.907 * S µs314 /// - DB Weight:315 /// - Read: Agenda, Lookup316 /// - Write: Agenda, Lookup317 /// - Will use base weight of 100 which should be good for up to 30 scheduled calls318 /// # </weight>319 #[weight = <T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get())]320 fn cancel_named(origin, id: Vec<u8>) {321 T::ScheduleOrigin::ensure_origin(origin.clone())?;322 let origin = <T as Config>::Origin::from(origin);323 Self::do_cancel_named(Some(origin.caller().clone()), id)?;324 }325326 /// Anonymously schedule a task after a delay.327 ///328 /// # <weight>329 /// Same as [`schedule`].330 /// # </weight>331 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]332 fn schedule_after(origin,333 after: T::BlockNumber,334 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,335 priority: schedule::Priority,336 call: Box<<T as Config>::Call>,337 ) {338 T::ScheduleOrigin::ensure_origin(origin.clone())?;339 let origin = <T as Config>::Origin::from(origin);340 Self::do_schedule_nameless(341 DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call342 )?;343 }344345 /// Schedule a named task after a delay.346 ///347 /// # <weight>348 /// Same as [`schedule_named`].349 /// # </weight>350 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]351 fn schedule_named_after(origin,352 id: Vec<u8>,353 after: T::BlockNumber,354 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,355 priority: schedule::Priority,356 call: Box<<T as Config>::Call>,357 ) {358 T::ScheduleOrigin::ensure_origin(origin.clone())?;359 let origin = <T as Config>::Origin::from(origin);360 Self::do_schedule_named(361 id, DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call362 )?;363 }364365 /// Execute the scheduled calls366 ///367 /// # <weight>368 /// - S = Number of already scheduled calls369 /// - N = Named scheduled calls370 /// - P = Periodic Calls371 /// - Base Weight: 9.243 + 23.45 * S µs372 /// - DB Weight:373 /// - Read: Agenda + Lookup * N + Agenda(Future) * P374 /// - Write: Agenda + Lookup * N + Agenda(future) * P375 /// # </weight>376 fn on_initialize(now: T::BlockNumber) -> Weight {377 let limit = T::MaximumWeight::get();378 let mut queued = Agenda::<T>::take(now)379 .into_iter()380 .enumerate()381 .filter_map(|(index, s)| s.map(|inner| (index as u32, inner)))382 .collect::<Vec<_>>();383 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {384 log::warn!(385 target: "runtime::scheduler",386 "Warning: This block has more items queued in Scheduler than \387 expected from the runtime configuration. An update might be needed."388 );389 }390 queued.sort_by_key(|(_, s)| s.priority);391 let base_weight: Weight = T::DbWeight::get().reads_writes(1, 2); // Agenda + Agenda(next)392 let mut total_weight: Weight = 0; // T::WeightInfo::on_initialize(0)393 queued.into_iter()394 .enumerate()395 .scan(base_weight, |cumulative_weight, (order, (index, s))| {396 *cumulative_weight = cumulative_weight397 .saturating_add(s.call.get_dispatch_info().weight);398399 let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(400 s.origin.clone()401 ).into();402403 if ensure_signed(origin).is_ok() {404 // AccountData for inner call origin accountdata.405 *cumulative_weight = cumulative_weight406 .saturating_add(T::DbWeight::get().reads_writes(1, 1));407 }408409 if s.maybe_id.is_some() {410 // Remove/Modify Lookup411 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().writes(1));412 }413 if s.maybe_periodic.is_some() {414 // Read/Write Agenda for future block415 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().reads_writes(1, 1));416 }417418 Some((order, index, *cumulative_weight, s))419 })420 .filter_map(|(order, index, cumulative_weight, mut s)| {421 // We allow a scheduled call if any is true:422 // - It's priority is `HARD_DEADLINE`423 // - It does not push the weight past the limit.424 // - It is the first item in the schedule425 if s.priority <= schedule::HARD_DEADLINE || cumulative_weight <= limit || order == 0 {426427 // let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(428 // s.origin.clone()429 // ).into();430 // let sender = ensure_signed(origin).unwrap_or_default();431 // let who_will_pay = T::SponsorshipHandler::get_sponsor(&sender, &s.call).unwrap_or(sender);432 // let sponsor = T::PalletsOrigin::from(system::RawOrigin::Signed(who_will_pay));433 // let r = s.call.clone().dispatch(sponsor.into());434 let maybe_id = s.maybe_id.clone();435 if let Some((period, count)) = s.maybe_periodic {436 if count > 1 {437 s.maybe_periodic = Some((period, count - 1));438 } else {439 s.maybe_periodic = None;440 }441 let next = now + period;442 // If scheduled is named, place it's information in `Lookup`443 if let Some(ref id) = s.maybe_id {444 let next_index = Agenda::<T>::decode_len(now + period).unwrap_or(0);445 Lookup::<T>::insert(id, (next, next_index as u32));446 }447 Agenda::<T>::append(next, Some(s));448 } else if let Some(ref id) = s.maybe_id {449 Lookup::<T>::remove(id);450 }451 Self::deposit_event(RawEvent::Dispatched(452 (now, index),453 maybe_id,454 Ok(())// r.map(|_| ()).map_err(|e| e.error)455 ));456 total_weight = cumulative_weight;457 None458 } else {459 Some(Some(s))460 }461 })462 .for_each(|unused| {463 let next = now + One::one();464 Agenda::<T>::append(next, unused);465 });466467 total_weight468 }469 }470}471472impl<T: Config> Module<T> {473 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {474 let now = frame_system::Pallet::<T>::block_number();475476 let when = match when {477 DispatchTime::At(x) => x,478 // The current block has already completed it's scheduled tasks, so479 // Schedule the task at lest one block after this current block.480 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),481 };482483 if when <= now {484 return Err(Error::<T>::TargetBlockNumberInPast.into());485 }486487 Ok(when)488 }489490 fn do_schedule(491 maybe_id: Option<Vec<u8>>,492 when: DispatchTime<T::BlockNumber>,493 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,494 priority: schedule::Priority,495 origin: T::PalletsOrigin,496 call: <T as Config>::Call,497 ) -> Result<(T::BlockNumber, u32), DispatchError> {498 let when = Self::resolve_time(when)?;499500 let sender = ensure_signed(501 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin.clone()).into(),502 )503 .unwrap_or_default();504 let who_will_pay = sender; // T::SponsorshipHandler::get_sponsor(&sender, &call).unwrap_or(sender);505 let sponsor = T::PalletsOrigin::from(system::RawOrigin::Signed(who_will_pay));506 let r = call.clone().dispatch(sponsor.into());507508 //T::PaymentHandler::apply();509 //T::PaymentHandler::validate(sponsor.into(), call.clone(), ); todo dispatch extrinsic here510511 // sanitize maybe_periodic512 let maybe_periodic = maybe_periodic513 .filter(|p| p.1 > 1 && !p.0.is_zero())514 // Limit the repetitions to 100 calls and remove one from the number of repetitions since we will schedule one now.515 .map(|(p, c)| (p, cmp::min(c, PERIODIC_CALLS_LIMIT) - 1));516517 let s = Some(Scheduled {518 maybe_id,519 priority,520 call,521 maybe_periodic,522 origin,523 _phantom: PhantomData::<T::AccountId>::default(),524 });525 Agenda::<T>::append(when, s);526 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;527 if index > T::MaxScheduledPerBlock::get() {528 log::warn!(529 target: "runtime::scheduler",530 "Warning: There are more items queued in the Scheduler than \531 expected from the runtime configuration. An update might be needed.",532 );533 }534535 Ok((when, index))536 }537538 fn do_schedule_nameless(539 when: DispatchTime<T::BlockNumber>,540 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,541 priority: schedule::Priority,542 origin: T::PalletsOrigin,543 call: <T as Config>::Call,544 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {545 let address = Self::do_schedule(None, when, maybe_periodic, priority, origin, call)?;546 let (when, index) = address;547548 Self::deposit_event(RawEvent::Scheduled(when, index));549550 Ok(address)551 }552553 fn do_cancel(554 origin: Option<T::PalletsOrigin>,555 (when, index): TaskAddress<T::BlockNumber>,556 ) -> Result<(), DispatchError> {557 let scheduled = Agenda::<T>::try_mutate(when, |agenda| {558 agenda.get_mut(index as usize).map_or(559 Ok(None),560 |s| -> Result<Option<Scheduled<_, _, _, _>>, DispatchError> {561 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {562 if *o != s.origin {563 return Err(BadOrigin.into());564 }565 };566 Ok(s.take())567 },568 )569 })?;570 if let Some(s) = scheduled {571 if let Some(id) = s.maybe_id {572 Lookup::<T>::remove(id);573 // todo add back money / displace to another function for consistency574 }575 Self::deposit_event(RawEvent::Canceled(when, index));576 Ok(())577 } else {578 Err(Error::<T>::NotFound.into())579 }580 }581582 fn do_reschedule(583 (when, index): TaskAddress<T::BlockNumber>,584 new_time: DispatchTime<T::BlockNumber>,585 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {586 let new_time = Self::resolve_time(new_time)?;587588 if new_time == when {589 return Err(Error::<T>::RescheduleNoChange.into());590 }591592 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {593 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;594 let task = task.take().ok_or(Error::<T>::NotFound)?;595 Agenda::<T>::append(new_time, Some(task));596 Ok(())597 })?;598599 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;600 Self::deposit_event(RawEvent::Canceled(when, index));601 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));602603 Ok((new_time, new_index))604 }605606 fn do_schedule_named(607 id: Vec<u8>,608 when: DispatchTime<T::BlockNumber>,609 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,610 priority: schedule::Priority,611 origin: T::PalletsOrigin,612 call: <T as Config>::Call,613 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {614 // ensure id length does not exceed expectations & is unique615 if id.len() > MAX_TASK_ID_LENGTH_IN_BYTES.try_into().unwrap()616 || Lookup::<T>::contains_key(&id)617 {618 return Err(Error::<T>::FailedToSchedule.into());619 }620621 let address = Self::do_schedule(622 Some(id.clone()),623 when,624 maybe_periodic,625 priority,626 origin,627 call,628 )?;629 let (when, index) = address;630631 Lookup::<T>::insert(&id, &address);632 Self::deposit_event(RawEvent::Scheduled(when, index));633 Ok(address)634 }635636 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: Vec<u8>) -> DispatchResult {637 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {638 if let Some((when, index)) = lookup.take() {639 let i = index as usize;640 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {641 if let Some(s) = agenda.get_mut(i) {642 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {643 if *o != s.origin {644 return Err(BadOrigin.into());645 }646 }647 *s = None;648 }649 Ok(())650 })?;651 // todo add money back / displace to another function652 Self::deposit_event(RawEvent::Canceled(when, index));653 Ok(())654 } else {655 Err(Error::<T>::NotFound.into())656 }657 })658 }659660 fn do_reschedule_named(661 id: Vec<u8>,662 new_time: DispatchTime<T::BlockNumber>,663 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {664 let new_time = Self::resolve_time(new_time)?;665666 Lookup::<T>::try_mutate_exists(667 id,668 |lookup| -> Result<TaskAddress<T::BlockNumber>, DispatchError> {669 let (when, index) = lookup.ok_or(Error::<T>::NotFound)?;670671 if new_time == when {672 return Err(Error::<T>::RescheduleNoChange.into());673 }674675 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {676 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;677 let task = task.take().ok_or(Error::<T>::NotFound)?;678 Agenda::<T>::append(new_time, Some(task));679680 Ok(())681 })?;682683 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;684 Self::deposit_event(RawEvent::Canceled(when, index));685 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));686687 *lookup = Some((new_time, new_index));688689 Ok((new_time, new_index))690 },691 )692 }693}694695impl<T: Config> schedule::Anon<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>696 for Module<T>697{698 type Address = TaskAddress<T::BlockNumber>;699700 fn schedule(701 when: DispatchTime<T::BlockNumber>,702 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,703 priority: schedule::Priority,704 origin: T::PalletsOrigin,705 call: <T as Config>::Call,706 ) -> Result<Self::Address, DispatchError> {707 Self::do_schedule_nameless(when, maybe_periodic, priority, origin, call)708 }709710 fn cancel((when, index): Self::Address) -> Result<(), ()> {711 Self::do_cancel(None, (when, index)).map_err(|_| ())712 }713714 fn reschedule(715 address: Self::Address,716 when: DispatchTime<T::BlockNumber>,717 ) -> Result<Self::Address, DispatchError> {718 Self::do_reschedule(address, when)719 }720721 fn next_dispatch_time((when, index): Self::Address) -> Result<T::BlockNumber, ()> {722 Agenda::<T>::get(when)723 .get(index as usize)724 .ok_or(())725 .map(|_| when)726 }727}728729impl<T: Config> schedule::Named<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>730 for Module<T>731{732 type Address = TaskAddress<T::BlockNumber>;733734 fn schedule_named(735 id: Vec<u8>,736 when: DispatchTime<T::BlockNumber>,737 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,738 priority: schedule::Priority,739 origin: T::PalletsOrigin,740 call: <T as Config>::Call,741 ) -> Result<Self::Address, ()> {742 Self::do_schedule_named(id, when, maybe_periodic, priority, origin, call).map_err(|_| ())743 }744745 fn cancel_named(id: Vec<u8>) -> Result<(), ()> {746 Self::do_cancel_named(None, id).map_err(|_| ())747 }748749 fn reschedule_named(750 id: Vec<u8>,751 when: DispatchTime<T::BlockNumber>,752 ) -> Result<Self::Address, DispatchError> {753 Self::do_reschedule_named(id, when)754 }755756 fn next_dispatch_time(id: Vec<u8>) -> Result<T::BlockNumber, ()> {757 Lookup::<T>::get(id)758 .and_then(|(when, index)| Agenda::<T>::get(when).get(index as usize).map(|_| when))759 .ok_or(())760 }761}762763#[cfg(test)]764#[allow(clippy::from_over_into)]765mod tests {766 use super::*;767768 use frame_support::{769 ord_parameter_types, parameter_types, traits::Contains, weights::constants::RocksDbWeight,770 };771 use sp_core::H256;772 use sp_runtime::{773 Perbill,774 testing::Header,775 traits::{BlakeTwo256, IdentityLookup},776 };777 use frame_system::{EnsureOneOf, EnsureRoot, EnsureSignedBy};778 use crate as scheduler;779780 mod logger {781 use super::*;782 use std::cell::RefCell;783784 thread_local! {785 static LOG: RefCell<Vec<(OriginCaller, u32)>> = RefCell::new(Vec::new());786 }787 pub trait Config: system::Config {788 type Event: From<Event> + Into<<Self as system::Config>::Event>;789 }790 decl_event! {791 pub enum Event {792 Logged(u32, Weight),793 }794 }795 decl_module! {796 pub struct Module<T: Config> for enum Call797 where798 origin: <T as system::Config>::Origin,799 <T as system::Config>::Origin: OriginTrait<PalletsOrigin = OriginCaller>800 {801 fn deposit_event() = default;802803 #[weight = *weight]804 fn log(origin, i: u32, weight: Weight) {805 Self::deposit_event(Event::Logged(i, weight));806 LOG.with(|log| {807 log.borrow_mut().push((origin.caller().clone(), i));808 })809 }810811 #[weight = *weight]812 fn log_without_filter(origin, i: u32, weight: Weight) {813 Self::deposit_event(Event::Logged(i, weight));814 LOG.with(|log| {815 log.borrow_mut().push((origin.caller().clone(), i));816 })817 }818 }819 }820 }821822 type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;823 type Block = frame_system::mocking::MockBlock<Test>;824825 frame_support::construct_runtime!(826 pub enum Test where827 Block = Block,828 NodeBlock = Block,829 UncheckedExtrinsic = UncheckedExtrinsic,830 {831 System: frame_system::{Pallet, Call, Config, Storage, Event<T>},832 Logger: logger::{Pallet, Call, Event},833 Scheduler: scheduler::{Pallet, Call, Storage, Event<T>},834 }835 );836837 // Scheduler must dispatch with root and no filter, this tests base filter is indeed not used.838 pub struct BaseFilter;839 impl Contains<Call> for BaseFilter {840 fn contains(call: &Call) -> bool {841 !matches!(call, Call::Logger(logger::Call::log { .. }))842 }843 }844845 pub struct DummyExecutor; // todo do something with naming and function body846 impl<C: Dispatchable> ApplyExtrinsic<C> for DummyExecutor {847 fn apply_extrinsic(_signer: Address, _function: C) -> ApplyExtrinsicResult {848 todo!()849 }850 }851852 parameter_types! {853 pub const BlockHashCount: u64 = 250;854 pub BlockWeights: frame_system::limits::BlockWeights =855 frame_system::limits::BlockWeights::simple_max(2_000_000_000_000);856 }857 impl system::Config for Test {858 type BaseCallFilter = BaseFilter;859 type BlockWeights = ();860 type BlockLength = ();861 type DbWeight = RocksDbWeight;862 type Origin = Origin;863 type Call = Call;864 type Index = u64;865 type BlockNumber = u64;866 type Hash = H256;867 type Hashing = BlakeTwo256;868 type AccountId = u64;869 type Lookup = IdentityLookup<Self::AccountId>;870 type Header = Header;871 type Event = Event;872 type BlockHashCount = BlockHashCount;873 type Version = ();874 type PalletInfo = PalletInfo;875 type AccountData = ();876 type OnNewAccount = ();877 type OnKilledAccount = ();878 type SystemWeightInfo = ();879 type SS58Prefix = ();880 type OnSetCode = ();881 }882 impl logger::Config for Test {883 type Event = Event;884 }885 parameter_types! {886 pub MaximumSchedulerWeight: Weight = Perbill::from_percent(80) * BlockWeights::get().max_block;887 pub const MaxScheduledPerBlock: u32 = 10;888 }889 ord_parameter_types! {890 pub const One: u64 = 1;891 }892893 impl Config for Test {894 type Event = Event;895 type Origin = Origin;896 type PalletsOrigin = OriginCaller;897 type Call = Call;898 type MaximumWeight = MaximumSchedulerWeight;899 type ScheduleOrigin = EnsureOneOf<u64, EnsureRoot<u64>, EnsureSignedBy<One, u64>>;900 type MaxScheduledPerBlock = MaxScheduledPerBlock;901 type WeightInfo = ();902 type Executor = DummyExecutor;903 }904}runtime/src/lib.rsdiffbeforeafterboth--- a/runtime/src/lib.rs
+++ b/runtime/src/lib.rs
@@ -815,34 +815,35 @@
pallet_evm_transaction_payment::BridgeSponsorshipHandler<Runtime>,
);
-impl pallet_unq_scheduler::Config for Runtime {
- type Event = Event;
- type Origin = Origin;
- type PalletsOrigin = OriginCaller;
- type Call = Call;
- type MaximumWeight = MaximumSchedulerWeight;
- type ScheduleOrigin = EnsureSigned<AccountId>;
- type MaxScheduledPerBlock = MaxScheduledPerBlock;
- type WeightInfo = ();
- type Executor = Ex;
-}
-
// pub fn sign(xt: CheckedExtrinsic) -> UncheckedExtrinsic {
// node_testing::keyring::sign(xt, SPEC_VERSION, TRANSACTION_VERSION, GENESIS_HASH)
// }
-struct Ex;
-impl<C: Dispatchable> ApplyExtrinsic<C> for Ex {
+pub struct SchedulerPaymentExecutor;
+impl<C: Dispatchable> ApplyExtrinsic<C> for SchedulerPaymentExecutor {
fn apply_extrinsic(signer: Address, function: C) -> ApplyExtrinsicResult {
- let extrinsic = sign(fp_self_contained::CheckedExtrinsic {
+ /*let extrinsic = sign(fp_self_contained::CheckedExtrinsic {
signed: fp_self_contained::CheckedSignature::SelfContained(None),
- function: function,
+ function,
});
- Executive::apply_extrinsic(extrinsic)
+ Executive::apply_extrinsic(extrinsic)*/
+ todo!()
}
}
+impl pallet_unq_scheduler::Config for Runtime {
+ type Event = Event;
+ type Origin = Origin;
+ type PalletsOrigin = OriginCaller;
+ type Call = Call;
+ type MaximumWeight = MaximumSchedulerWeight;
+ type ScheduleOrigin = EnsureSigned<AccountId>;
+ type MaxScheduledPerBlock = MaxScheduledPerBlock;
+ type WeightInfo = ();
+ type Executor = SchedulerPaymentExecutor;
+}
+
impl pallet_evm_transaction_payment::Config for Runtime {
type EvmSponsorshipHandler = EvmSponsorshipHandler;
type Currency = Balances;