difftreelog
Call executor added to scheduler pallet
in: master
3 files changed
pallets/scheduler/Cargo.tomldiffbeforeafterboth--- a/pallets/scheduler/Cargo.toml
+++ b/pallets/scheduler/Cargo.toml
@@ -20,11 +20,11 @@
sp-io = { default-features = false, git = 'https://github.com/paritytech/substrate.git', branch = 'polkadot-v0.9.14' }
frame-benchmarking = { default-features = false, optional = true, git = 'https://github.com/paritytech/substrate.git', branch = 'polkadot-v0.9.14' }
+sp-core = { default-features = false, git = 'https://github.com/paritytech/substrate.git', branch = 'polkadot-v0.9.14' }
up-sponsorship = { version = "0.1.0", default-features = false, git = "https://github.com/UniqueNetwork/pallet-sponsoring", branch = 'polkadot-v0.9.14' }
log = { version = "0.4.14", default-features = false }
[dev-dependencies]
-sp-core = { default-features = false, git = 'https://github.com/paritytech/substrate.git', branch = 'polkadot-v0.9.14' }
substrate-test-utils = { git = 'https://github.com/paritytech/substrate.git', branch = 'polkadot-v0.9.14' }
[features]
@@ -38,6 +38,7 @@
"up-sponsorship/std",
"sp-io/std",
"sp-std/std",
+ "sp-core/std",
"log/std",
]
runtime-benchmarks = [
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};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};80use sp_core::{H160};8182pub trait ApplyCall<C: Dispatchable, SelfContainedSignedInfo> {83 fn apply_call(signer: Address, function: C);84}8586/// The address format for describing accounts.87pub type Signature = MultiSignature;88pub type Address = sp_runtime::MultiAddress<AccountId, ()>;89pub type AccountId = <<Signature as Verify>::Signer as IdentifyAccount>::AccountId;9091/// Our pallet's configuration trait. All our types and constants go in here. If the92/// pallet is dependent on specific other pallets, then their configuration traits93/// should be added to our implied traits list.94///95/// `system::Config` should always be included in our implied traits.96/// //97pub trait Config: system::Config {98 /// The overarching event type.99 type Event: From<Event<Self>> + Into<<Self as system::Config>::Event>;100101 /// The aggregated origin which the dispatch will take.102 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>103 + From<Self::PalletsOrigin>104 + IsType<<Self as system::Config>::Origin>;105106 /// The caller origin, overarching type of all pallets origins.107 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + TypeInfo + Clone + Eq;108109 /// The aggregated call type.110 type Call: Parameter111 + Dispatchable<Origin = <Self as Config>::Origin>112 + GetDispatchInfo113 + From<system::Call<Self>>;114115 /// The maximum weight that may be scheduled per block for any dispatchables of less priority116 /// than `schedule::HARD_DEADLINE`.117 type MaximumWeight: Get<Weight>;118119 /// Required origin to schedule or cancel calls.120 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;121122 /// The maximum number of scheduled calls in the queue for a single block.123 /// Not strictly enforced, but used for weight estimation.124 type MaxScheduledPerBlock: Get<u32>;125126 /// Weight information for extrinsics in this pallet.127 type WeightInfo: WeightInfo;128129 /// A type that allows you to use SignedExtra additional logic when dispatching call130 type Executor: ApplyCall<<Self as system::Config>::Call, H160>;131}132133pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;134135pub const PERIODIC_CALLS_LIMIT: u32 = 100;136137// pub type SelfWeightInfo<T> = <T as system::Config>::WeightInfo;138139/// Just a simple index for naming period tasks.140pub type PeriodicIndex = u32;141/// The location of a scheduled task that can be used to remove it.142pub type TaskAddress<BlockNumber> = (BlockNumber, u32);143144#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]145#[derive(Clone, RuntimeDebug, Encode, Decode)]146struct ScheduledV1<Call, BlockNumber> {147 maybe_id: Option<Vec<u8>>,148 priority: schedule::Priority,149 call: Call,150 maybe_periodic: Option<schedule::Period<BlockNumber>>,151}152153/// Information regarding an item to be executed in the future.154#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]155#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]156pub struct ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId> {157 /// The unique identity for this task, if there is one.158 maybe_id: Option<Vec<u8>>,159 /// This task's priority.160 priority: schedule::Priority,161 /// The call to be dispatched.162 call: Call,163 /// If the call is periodic, then this points to the information concerning that.164 maybe_periodic: Option<schedule::Period<BlockNumber>>,165 /// The origin to dispatch the call.166 origin: PalletsOrigin,167 _phantom: PhantomData<AccountId>,168}169170/// The current version of Scheduled struct.171pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =172 ScheduledV2<Call, BlockNumber, PalletsOrigin, AccountId>;173174// A value placed in storage that represents the current version of the Scheduler storage.175// This value is used by the `on_runtime_upgrade` logic to determine whether we run176// storage migration logic.177#[derive(Encode, Decode, Clone, Copy, PartialEq, Eq, RuntimeDebug, TypeInfo)]178enum Releases {179 V1,180 V2,181}182183impl Default for Releases {184 fn default() -> Self {185 Releases::V1186 }187}188189#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo)]190pub struct CallSpec {191 module: u32,192 method: u32,193}194195decl_storage! {196 trait Store for Module<T: Config> as Scheduler {197 /// Items to be executed, indexed by the block number that they should be executed on.198 pub Agenda: map hasher(twox_64_concat) T::BlockNumber199 => Vec<Option<Scheduled<<T as Config>::Call, T::BlockNumber, T::PalletsOrigin, T::AccountId>>>;200201 pub SpecAgenda: map hasher(twox_64_concat) T::BlockNumber202 => Vec<Option<CallSpec>>;203204 /// Lookup from identity to the block number and index of the task.205 Lookup: map hasher(twox_64_concat) Vec<u8> => Option<TaskAddress<T::BlockNumber>>;206207 /// Storage version of the pallet.208 ///209 /// New networks start with last version.210 StorageVersion build(|_| Releases::V2): Releases;211 }212}213214decl_event!(215 pub enum Event<T> where <T as system::Config>::BlockNumber {216 /// Scheduled some task. \[when, index\]217 Scheduled(BlockNumber, u32),218 /// Canceled some task. \[when, index\]219 Canceled(BlockNumber, u32),220 /// Dispatched some task. \[task, id, result\]221 Dispatched(TaskAddress<BlockNumber>, Option<Vec<u8>>, DispatchResult),222 }223);224225decl_error! {226 pub enum Error for Module<T: Config> {227 /// Failed to schedule a call228 FailedToSchedule,229 /// Cannot find the scheduled call.230 NotFound,231 /// Given target block number is in the past.232 TargetBlockNumberInPast,233 /// Reschedule failed because it does not change scheduled time.234 RescheduleNoChange,235 }236}237238decl_module! {239 /// Scheduler module declaration.240 pub struct Module<T: Config> for enum Call241 where242 origin: <T as system::Config>::Origin243 {244 type Error = Error<T>;245 fn deposit_event() = default;246247248 /// Anonymously schedule a task.249 ///250 /// # <weight>251 /// - S = Number of already scheduled calls252 /// - Base Weight: 22.29 + .126 * S µs253 /// - DB Weight:254 /// - Read: Agenda255 /// - Write: Agenda256 /// - Will use base weight of 25 which should be good for up to 30 scheduled calls257 /// # </weight>258 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]259 fn schedule(origin,260 when: T::BlockNumber,261 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,262 priority: schedule::Priority,263 call: Box<<T as Config>::Call>,264 )265 {266 let origin = <T as Config>::Origin::from(origin);267 Self::do_schedule_nameless(DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call)?;268 }269270 /// Cancel an anonymously scheduled task.271 ///272 /// # <weight>273 /// - S = Number of already scheduled calls274 /// - Base Weight: 22.15 + 2.869 * S µs275 /// - DB Weight:276 /// - Read: Agenda277 /// - Write: Agenda, Lookup278 /// - Will use base weight of 100 which should be good for up to 30 scheduled calls279 /// # </weight>280 #[weight = <T as Config>::WeightInfo::cancel(T::MaxScheduledPerBlock::get())]281 fn cancel(origin, when: T::BlockNumber, index: u32) {282 T::ScheduleOrigin::ensure_origin(origin.clone())?;283 let origin = <T as Config>::Origin::from(origin);284 Self::do_cancel(Some(origin.caller().clone()), (when, index))?;285 }286287 /// Schedule a named task.288 ///289 /// # <weight>290 /// - S = Number of already scheduled calls291 /// - Base Weight: 29.6 + .159 * S µs292 /// - DB Weight:293 /// - Read: Agenda, Lookup294 /// - Write: Agenda, Lookup295 /// - Will use base weight of 35 which should be good for more than 30 scheduled calls296 /// # </weight>297 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]298 fn schedule_named(origin,299 id: Vec<u8>,300 when: T::BlockNumber,301 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,302 priority: schedule::Priority,303 call: Box<<T as Config>::Call>,304 ) {305 T::ScheduleOrigin::ensure_origin(origin.clone())?;306 let origin = <T as Config>::Origin::from(origin);307 Self::do_schedule_named(308 id, DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call309 )?;310 }311312 /// Cancel a named scheduled task.313 ///314 /// # <weight>315 /// - S = Number of already scheduled calls316 /// - Base Weight: 24.91 + 2.907 * S µs317 /// - DB Weight:318 /// - Read: Agenda, Lookup319 /// - Write: Agenda, Lookup320 /// - Will use base weight of 100 which should be good for up to 30 scheduled calls321 /// # </weight>322 #[weight = <T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get())]323 fn cancel_named(origin, id: Vec<u8>) {324 T::ScheduleOrigin::ensure_origin(origin.clone())?;325 let origin = <T as Config>::Origin::from(origin);326 Self::do_cancel_named(Some(origin.caller().clone()), id)?;327 }328329 /// Anonymously schedule a task after a delay.330 ///331 /// # <weight>332 /// Same as [`schedule`].333 /// # </weight>334 #[weight = <T as Config>::WeightInfo::schedule(T::MaxScheduledPerBlock::get())]335 fn schedule_after(origin,336 after: T::BlockNumber,337 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,338 priority: schedule::Priority,339 call: Box<<T as Config>::Call>,340 ) {341 T::ScheduleOrigin::ensure_origin(origin.clone())?;342 let origin = <T as Config>::Origin::from(origin);343 Self::do_schedule_nameless(344 DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call345 )?;346 }347348 /// Schedule a named task after a delay.349 ///350 /// # <weight>351 /// Same as [`schedule_named`].352 /// # </weight>353 #[weight = <T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get())]354 fn schedule_named_after(origin,355 id: Vec<u8>,356 after: T::BlockNumber,357 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,358 priority: schedule::Priority,359 call: Box<<T as Config>::Call>,360 ) {361 T::ScheduleOrigin::ensure_origin(origin.clone())?;362 let origin = <T as Config>::Origin::from(origin);363 Self::do_schedule_named(364 id, DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call365 )?;366 }367368 /// Execute the scheduled calls369 ///370 /// # <weight>371 /// - S = Number of already scheduled calls372 /// - N = Named scheduled calls373 /// - P = Periodic Calls374 /// - Base Weight: 9.243 + 23.45 * S µs375 /// - DB Weight:376 /// - Read: Agenda + Lookup * N + Agenda(Future) * P377 /// - Write: Agenda + Lookup * N + Agenda(future) * P378 /// # </weight>379 fn on_initialize(now: T::BlockNumber) -> Weight {380 let limit = T::MaximumWeight::get();381 let mut queued = Agenda::<T>::take(now)382 .into_iter()383 .enumerate()384 .filter_map(|(index, s)| s.map(|inner| (index as u32, inner)))385 .collect::<Vec<_>>();386 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {387 log::warn!(388 target: "runtime::scheduler",389 "Warning: This block has more items queued in Scheduler than \390 expected from the runtime configuration. An update might be needed."391 );392 }393 queued.sort_by_key(|(_, s)| s.priority);394 let base_weight: Weight = T::DbWeight::get().reads_writes(1, 2); // Agenda + Agenda(next)395 let mut total_weight: Weight = 0; // T::WeightInfo::on_initialize(0)396 queued.into_iter()397 .enumerate()398 .scan(base_weight, |cumulative_weight, (order, (index, s))| {399 *cumulative_weight = cumulative_weight400 .saturating_add(s.call.get_dispatch_info().weight);401402 let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(403 s.origin.clone()404 ).into();405406 if ensure_signed(origin).is_ok() {407 // AccountData for inner call origin accountdata.408 *cumulative_weight = cumulative_weight409 .saturating_add(T::DbWeight::get().reads_writes(1, 1));410 }411412 if s.maybe_id.is_some() {413 // Remove/Modify Lookup414 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().writes(1));415 }416 if s.maybe_periodic.is_some() {417 // Read/Write Agenda for future block418 *cumulative_weight = cumulative_weight.saturating_add(T::DbWeight::get().reads_writes(1, 1));419 }420421 Some((order, index, *cumulative_weight, s))422 })423 .filter_map(|(order, index, cumulative_weight, mut s)| {424 // We allow a scheduled call if any is true:425 // - It's priority is `HARD_DEADLINE`426 // - It does not push the weight past the limit.427 // - It is the first item in the schedule428 if s.priority <= schedule::HARD_DEADLINE || cumulative_weight <= limit || order == 0 {429430 let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(431 s.origin.clone()432 ).into();433 // let sender = ensure_signed(origin).unwrap_or_default();434 // let who_will_pay = T::SponsorshipHandler::get_sponsor(&sender, &s.call).unwrap_or(sender);435 // let sponsor = T::PalletsOrigin::from(system::RawOrigin::Signed(who_will_pay));436 // let r = s.call.clone().dispatch(sponsor.into());437438439 let sender = ensure_signed(origin).unwrap_or_default();440 T::Executor::apply_call(sender.clone(), s.call.clone());441442 let maybe_id = s.maybe_id.clone();443 if let Some((period, count)) = s.maybe_periodic {444 if count > 1 {445 s.maybe_periodic = Some((period, count - 1));446 } else {447 s.maybe_periodic = None;448 }449 let next = now + period;450 // If scheduled is named, place it's information in `Lookup`451 if let Some(ref id) = s.maybe_id {452 let next_index = Agenda::<T>::decode_len(now + period).unwrap_or(0);453 Lookup::<T>::insert(id, (next, next_index as u32));454 }455 Agenda::<T>::append(next, Some(s));456 } else if let Some(ref id) = s.maybe_id {457 Lookup::<T>::remove(id);458 }459 Self::deposit_event(RawEvent::Dispatched(460 (now, index),461 maybe_id,462 Ok(())// r.map(|_| ()).map_err(|e| e.error)463 ));464 total_weight = cumulative_weight;465 None466 } else {467 Some(Some(s))468 }469 })470 .for_each(|unused| {471 let next = now + One::one();472 Agenda::<T>::append(next, unused);473 });474475 total_weight476 }477 }478}479480impl<T: Config> Module<T> {481 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {482 let now = frame_system::Pallet::<T>::block_number();483484 let when = match when {485 DispatchTime::At(x) => x,486 // The current block has already completed it's scheduled tasks, so487 // Schedule the task at lest one block after this current block.488 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),489 };490491 if when <= now {492 return Err(Error::<T>::TargetBlockNumberInPast.into());493 }494495 Ok(when)496 }497498 fn do_schedule(499 maybe_id: Option<Vec<u8>>,500 when: DispatchTime<T::BlockNumber>,501 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,502 priority: schedule::Priority,503 origin: T::PalletsOrigin,504 call: <T as Config>::Call,505 ) -> Result<(T::BlockNumber, u32), DispatchError> {506 let when = Self::resolve_time(when)?;507508 let sender = ensure_signed(509 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin.clone()).into(),510 )511 .unwrap_or_default();512 let who_will_pay = sender; // T::SponsorshipHandler::get_sponsor(&sender, &call).unwrap_or(sender);513 let sponsor = T::PalletsOrigin::from(system::RawOrigin::Signed(who_will_pay));514 let r = call.clone().dispatch(sponsor.into());515516 //T::PaymentHandler::validate(sponsor.into(), call.clone(), ); todo dispatch call517518 // sanitize maybe_periodic519 let maybe_periodic = None;520 // let maybe_periodic = maybe_periodic521 // .filter(|p| p.1 > 1 && !p.0.is_zero())522 // // Limit the repetitions to 100 calls and remove one from the number of repetitions since we will schedule one now.523 // .map(|(p, c)| (p, std::cmp::min(c, PERIODIC_CALLS_LIMIT) - 1));524525 let s = Some(Scheduled {526 maybe_id,527 priority,528 call,529 maybe_periodic,530 origin,531 _phantom: PhantomData::<T::AccountId>::default(),532 });533 Agenda::<T>::append(when, s);534 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;535 if index > T::MaxScheduledPerBlock::get() {536 log::warn!(537 target: "runtime::scheduler",538 "Warning: There are more items queued in the Scheduler than \539 expected from the runtime configuration. An update might be needed.",540 );541 }542543 Ok((when, index))544 }545546 fn do_schedule_nameless(547 when: DispatchTime<T::BlockNumber>,548 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,549 priority: schedule::Priority,550 origin: T::PalletsOrigin,551 call: <T as Config>::Call,552 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {553 let address = Self::do_schedule(None, when, maybe_periodic, priority, origin, call)?;554 let (when, index) = address;555556 Self::deposit_event(RawEvent::Scheduled(when, index));557558 Ok(address)559 }560561 fn do_cancel(562 origin: Option<T::PalletsOrigin>,563 (when, index): TaskAddress<T::BlockNumber>,564 ) -> Result<(), DispatchError> {565 let scheduled = Agenda::<T>::try_mutate(when, |agenda| {566 agenda.get_mut(index as usize).map_or(567 Ok(None),568 |s| -> Result<Option<Scheduled<_, _, _, _>>, DispatchError> {569 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {570 if *o != s.origin {571 return Err(BadOrigin.into());572 }573 };574 Ok(s.take())575 },576 )577 })?;578 if let Some(s) = scheduled {579 if let Some(id) = s.maybe_id {580 Lookup::<T>::remove(id);581 }582 Self::deposit_event(RawEvent::Canceled(when, index));583 Ok(())584 } else {585 Err(Error::<T>::NotFound.into())586 }587 }588589 fn do_reschedule(590 (when, index): TaskAddress<T::BlockNumber>,591 new_time: DispatchTime<T::BlockNumber>,592 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {593 let new_time = Self::resolve_time(new_time)?;594595 if new_time == when {596 return Err(Error::<T>::RescheduleNoChange.into());597 }598599 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {600 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;601 let task = task.take().ok_or(Error::<T>::NotFound)?;602 Agenda::<T>::append(new_time, Some(task));603 Ok(())604 })?;605606 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;607 Self::deposit_event(RawEvent::Canceled(when, index));608 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));609610 Ok((new_time, new_index))611 }612613 fn do_schedule_named(614 id: Vec<u8>,615 when: DispatchTime<T::BlockNumber>,616 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,617 priority: schedule::Priority,618 origin: T::PalletsOrigin,619 call: <T as Config>::Call,620 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {621 // ensure id length does not exceed expectations & is unique622 if id.len() > MAX_TASK_ID_LENGTH_IN_BYTES.try_into().unwrap()623 || Lookup::<T>::contains_key(&id)624 {625 return Err(Error::<T>::FailedToSchedule.into());626 }627628 let address = Self::do_schedule(629 Some(id.clone()),630 when,631 maybe_periodic,632 priority,633 origin,634 call,635 )?;636 let (when, index) = address;637638 Lookup::<T>::insert(&id, &address);639 Self::deposit_event(RawEvent::Scheduled(when, index));640 Ok(address)641 }642643 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: Vec<u8>) -> DispatchResult {644 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {645 if let Some((when, index)) = lookup.take() {646 let i = index as usize;647 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {648 if let Some(s) = agenda.get_mut(i) {649 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {650 if *o != s.origin {651 return Err(BadOrigin.into());652 }653 }654 *s = None;655 }656 Ok(())657 })?;658 Self::deposit_event(RawEvent::Canceled(when, index));659 Ok(())660 } else {661 Err(Error::<T>::NotFound.into())662 }663 })664 }665666 fn do_reschedule_named(667 id: Vec<u8>,668 new_time: DispatchTime<T::BlockNumber>,669 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {670 let new_time = Self::resolve_time(new_time)?;671672 Lookup::<T>::try_mutate_exists(673 id,674 |lookup| -> Result<TaskAddress<T::BlockNumber>, DispatchError> {675 let (when, index) = lookup.ok_or(Error::<T>::NotFound)?;676677 if new_time == when {678 return Err(Error::<T>::RescheduleNoChange.into());679 }680681 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {682 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;683 let task = task.take().ok_or(Error::<T>::NotFound)?;684 Agenda::<T>::append(new_time, Some(task));685686 Ok(())687 })?;688689 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;690 Self::deposit_event(RawEvent::Canceled(when, index));691 Self::deposit_event(RawEvent::Scheduled(new_time, new_index));692693 *lookup = Some((new_time, new_index));694695 Ok((new_time, new_index))696 },697 )698 }699}700701impl<T: Config> schedule::Anon<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>702 for Module<T>703{704 type Address = TaskAddress<T::BlockNumber>;705706 fn schedule(707 when: DispatchTime<T::BlockNumber>,708 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,709 priority: schedule::Priority,710 origin: T::PalletsOrigin,711 call: <T as Config>::Call,712 ) -> Result<Self::Address, DispatchError> {713 Self::do_schedule_nameless(when, maybe_periodic, priority, origin, call)714 }715716 fn cancel((when, index): Self::Address) -> Result<(), ()> {717 Self::do_cancel(None, (when, index)).map_err(|_| ())718 }719720 fn reschedule(721 address: Self::Address,722 when: DispatchTime<T::BlockNumber>,723 ) -> Result<Self::Address, DispatchError> {724 Self::do_reschedule(address, when)725 }726727 fn next_dispatch_time((when, index): Self::Address) -> Result<T::BlockNumber, ()> {728 Agenda::<T>::get(when)729 .get(index as usize)730 .ok_or(())731 .map(|_| when)732 }733}734735impl<T: Config> schedule::Named<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>736 for Module<T>737{738 type Address = TaskAddress<T::BlockNumber>;739740 fn schedule_named(741 id: Vec<u8>,742 when: DispatchTime<T::BlockNumber>,743 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,744 priority: schedule::Priority,745 origin: T::PalletsOrigin,746 call: <T as Config>::Call,747 ) -> Result<Self::Address, ()> {748 Self::do_schedule_named(id, when, maybe_periodic, priority, origin, call).map_err(|_| ())749 }750751 fn cancel_named(id: Vec<u8>) -> Result<(), ()> {752 Self::do_cancel_named(None, id).map_err(|_| ())753 }754755 fn reschedule_named(756 id: Vec<u8>,757 when: DispatchTime<T::BlockNumber>,758 ) -> Result<Self::Address, DispatchError> {759 Self::do_reschedule_named(id, when)760 }761762 fn next_dispatch_time(id: Vec<u8>) -> Result<T::BlockNumber, ()> {763 Lookup::<T>::get(id)764 .and_then(|(when, index)| Agenda::<T>::get(when).get(index as usize).map(|_| when))765 .ok_or(())766 }767}768769#[cfg(test)]770#[allow(clippy::from_over_into)]771mod tests {772 use super::*;773774 use frame_support::{775 ord_parameter_types, parameter_types, traits::Contains, weights::constants::RocksDbWeight,776 };777 use sp_core::H256;778 use sp_runtime::{779 Perbill,780 testing::Header,781 traits::{BlakeTwo256, IdentityLookup},782 };783 use frame_system::{EnsureOneOf, EnsureRoot, EnsureSignedBy};784 use crate as scheduler;785786 mod logger {787 use super::*;788 use std::cell::RefCell;789790 thread_local! {791 static LOG: RefCell<Vec<(OriginCaller, u32)>> = RefCell::new(Vec::new());792 }793 pub trait Config: system::Config {794 type Event: From<Event> + Into<<Self as system::Config>::Event>;795 }796 decl_event! {797 pub enum Event {798 Logged(u32, Weight),799 }800 }801 decl_module! {802 pub struct Module<T: Config> for enum Call803 where804 origin: <T as system::Config>::Origin,805 <T as system::Config>::Origin: OriginTrait<PalletsOrigin = OriginCaller>806 {807 fn deposit_event() = default;808809 #[weight = *weight]810 fn log(origin, i: u32, weight: Weight) {811 Self::deposit_event(Event::Logged(i, weight));812 LOG.with(|log| {813 log.borrow_mut().push((origin.caller().clone(), i));814 })815 }816817 #[weight = *weight]818 fn log_without_filter(origin, i: u32, weight: Weight) {819 Self::deposit_event(Event::Logged(i, weight));820 LOG.with(|log| {821 log.borrow_mut().push((origin.caller().clone(), i));822 })823 }824 }825 }826 }827828 type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;829 type Block = frame_system::mocking::MockBlock<Test>;830831 frame_support::construct_runtime!(832 pub enum Test where833 Block = Block,834 NodeBlock = Block,835 UncheckedExtrinsic = UncheckedExtrinsic,836 {837 System: frame_system::{Pallet, Call, Config, Storage, Event<T>},838 Logger: logger::{Pallet, Call, Event},839 Scheduler: scheduler::{Pallet, Call, Storage, Event<T>},840 }841 );842843 // Scheduler must dispatch with root and no filter, this tests base filter is indeed not used.844 pub struct BaseFilter;845 impl Contains<Call> for BaseFilter {846 fn contains(call: &Call) -> bool {847 !matches!(call, Call::Logger(logger::Call::log { .. }))848 }849 }850851 parameter_types! {852 pub const BlockHashCount: u64 = 250;853 pub BlockWeights: frame_system::limits::BlockWeights =854 frame_system::limits::BlockWeights::simple_max(2_000_000_000_000);855 }856 impl system::Config for Test {857 type BaseCallFilter = BaseFilter;858 type BlockWeights = ();859 type BlockLength = ();860 type DbWeight = RocksDbWeight;861 type Origin = Origin;862 type Call = Call;863 type Index = u64;864 type BlockNumber = u64;865 type Hash = H256;866 type Hashing = BlakeTwo256;867 type AccountId = u64;868 type Lookup = IdentityLookup<Self::AccountId>;869 type Header = Header;870 type Event = Event;871 type BlockHashCount = BlockHashCount;872 type Version = ();873 type PalletInfo = PalletInfo;874 type AccountData = ();875 type OnNewAccount = ();876 type OnKilledAccount = ();877 type SystemWeightInfo = ();878 type SS58Prefix = ();879 type OnSetCode = ();880 }881 impl logger::Config for Test {882 type Event = Event;883 }884 parameter_types! {885 pub MaximumSchedulerWeight: Weight = Perbill::from_percent(80) * BlockWeights::get().max_block;886 pub const MaxScheduledPerBlock: u32 = 10;887 }888 ord_parameter_types! {889 pub const One: u64 = 1;890 }891892 impl Config for Test {893 type Event = Event;894 type Origin = Origin;895 type PalletsOrigin = OriginCaller;896 type Call = Call;897 type MaximumWeight = MaximumSchedulerWeight;898 type ScheduleOrigin = EnsureOneOf<u64, EnsureRoot<u64>, EnsureSignedBy<One, u64>>;899 type MaxScheduledPerBlock = MaxScheduledPerBlock;900 type WeightInfo = ();901 type SponsorshipHandler = ();902 type PaymentHandler = ();903 }904}runtime/src/lib.rsdiffbeforeafterboth--- a/runtime/src/lib.rs
+++ b/runtime/src/lib.rs
@@ -17,6 +17,8 @@
use sp_api::impl_runtime_apis;
use sp_core::{crypto::KeyTypeId, OpaqueMetadata, H256, U256, H160};
use sp_runtime::DispatchError;
+use fp_self_contained::*;
+use sp_runtime::traits::{Applyable, Member};
// #[cfg(any(feature = "std", test))]
// pub use sp_runtime::BuildStorage;
@@ -824,22 +826,33 @@
type ScheduleOrigin = EnsureSigned<AccountId>;
type MaxScheduledPerBlock = MaxScheduledPerBlock;
type WeightInfo = ();
- type Executor = Ex;
+ type Executor = Executor;
}
-// 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 {
- fn apply_extrinsic(signer: Address, function: C) -> ApplyExtrinsicResult {
- let extrinsic = sign(fp_self_contained::CheckedExtrinsic {
- signed: fp_self_contained::CheckedSignature::SelfContained(None),
- function: function,
- });
+pub struct Executor;
+impl<C, SelfContainedSignedInfo> ApplyExtrinsic<C, SelfContainedSignedInfo> for Executor
+where
+ C: Member
+ + Dispatchable<Origin = Origin, Info = DispatchInfo>
+ + SelfContainedCall<SignedInfo = SelfContainedSignedInfo>
+ + GetDispatchInfo
+ + From<frame_system::Call<Runtime>>,
+ SelfContainedSignedInfo: Send + Sync + 'static,
+ Call: From<C> + SelfContainedCall<SignedInfo = SelfContainedSignedInfo>,
+{
+ fn apply_call(signer: Address, call: C) {
+ let dispatch_info = call.get_dispatch_info();
+ let extrinsic = fp_self_contained::CheckedExtrinsic::<
+ AccountId,
+ Call,
+ SignedExtra,
+ SelfContainedSignedInfo,
+ > {
+ signed: CheckedSignature::<AccountId, SignedExtra, SelfContainedSignedInfo>::Unsigned, // change to signer
+ function: call.into(),
+ };
- Executive::apply_extrinsic(extrinsic)
+ extrinsic.apply::<Runtime>(&dispatch_info, 0);
}
}