difftreelog
Documentation extended
in: master
1 file changed
pallets/scheduler/src/lib.rsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617// Original license:18// This file is part of Substrate.1920// Copyright (C) 2017-2022 Parity Technologies (UK) Ltd.21// SPDX-License-Identifier: Apache-2.02223// Licensed under the Apache License, Version 2.0 (the "License");24// you may not use this file except in compliance with the License.25// You may obtain a copy of the License at26//27// http://www.apache.org/licenses/LICENSE-2.028//29// Unless required by applicable law or agreed to in writing, software30// distributed under the License is distributed on an "AS IS" BASIS,31// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.32// See the License for the specific language governing permissions and33// limitations under the License.3435//! # Unique scheduler36//! A Pallet for scheduling dispatches.37//!38//! - [`Config`]39//! - [`Call`]40//! - [`Pallet`]41//!42//! ## Overview43//!44//! This Pallet exposes capabilities for scheduling dispatches to occur at a45//! specified block number or at a specified period. These scheduled dispatches46//! may be named or anonymous and may be canceled.47//!48//! **NOTE:** The scheduled calls will be dispatched with the default filter49//! for the origin: namely `frame_system::Config::BaseCallFilter` for all origin50//! except root which will get no filter. And not the filter contained in origin51//! use to call `fn schedule`.52//!53//! If a call is scheduled using proxy or whatever mecanism which adds filter,54//! then those filter will not be used when dispatching the schedule call.55//!56//! **NOTE:** The unique scheduler is designed for deferred transaction calls by block number.57//! Any user can book a call of a certain transaction to a specific block number.58//! Also possible to book a call with a certain frequency.59//! Key differences from original pallet:60//! Id restricted by 16 bytes61//! Priority limited by HARD DEADLINE (<= 63). Calls over maximum weight don't include to block62//! Maybe_periodic limit is 100 calls63//! Any account allowed to schedule any calls. Account withdraw implemented through default transaction logic.64//!65//! ## Interface66//!67//! ### Dispatchable Functions68//!69//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and70//! with a specified priority.71//! * `cancel` - cancel a scheduled dispatch, specified by block number and index.72//! * `schedule_named` - augments the `schedule` interface with an additional `Vec<u8>` parameter73//! that can be used for identification.74//! * `cancel_named` - the named complement to the cancel function.7576// Ensure we're `no_std` when compiling for Wasm.77#![cfg_attr(not(feature = "std"), no_std)]7879#[cfg(feature = "runtime-benchmarks")]80mod benchmarking;8182pub mod weights;8384use sp_core::H160;85use codec::{Codec, Decode, Encode};86use frame_system::{self as system, ensure_signed};87pub use pallet::*;88use scale_info::TypeInfo;89use sp_runtime::{90 traits::{BadOrigin, One, Saturating, Zero},91 RuntimeDebug, DispatchErrorWithPostInfo,92};93use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};9495use frame_support::{96 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},97 traits::{98 schedule::{self, DispatchTime, MaybeHashed},99 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,100 StorageVersion,101 },102 weights::{GetDispatchInfo, Weight},103};104105pub use weights::WeightInfo;106107/// Just a simple index for naming period tasks.108pub type PeriodicIndex = u32;109/// The location of a scheduled task that can be used to remove it.110pub type TaskAddress<BlockNumber> = (BlockNumber, u32);111pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;112113type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];114pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;115116/// Information regarding an item to be executed in the future.117#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]118#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]119pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {120 /// The unique identity for this task, if there is one.121 maybe_id: Option<ScheduledId>,122 /// This task's priority.123 priority: schedule::Priority,124 /// The call to be dispatched.125 call: Call,126 /// If the call is periodic, then this points to the information concerning that.127 maybe_periodic: Option<schedule::Period<BlockNumber>>,128 /// The origin to dispatch the call.129 origin: PalletsOrigin,130 _phantom: PhantomData<AccountId>,131}132133pub type ScheduledV3Of<T> = ScheduledV3<134 CallOrHashOf<T>,135 <T as frame_system::Config>::BlockNumber,136 <T as Config>::PalletsOrigin,137 <T as frame_system::Config>::AccountId,138>;139140pub type ScheduledOf<T> = ScheduledV3Of<T>;141142/// The current version of Scheduled struct.143pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =144 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;145146#[cfg(feature = "runtime-benchmarks")]147mod preimage_provider {148 use frame_support::traits::PreimageRecipient;149 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}150 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}151}152153#[cfg(not(feature = "runtime-benchmarks"))]154mod preimage_provider {155 use frame_support::traits::PreimageProvider;156 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}157 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}158}159160pub use preimage_provider::PreimageProviderAndMaybeRecipient;161162/// Weight templates for calculating actual fees163pub(crate) trait MarginalWeightInfo: WeightInfo {164 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {165 match (periodic, named, resolved) {166 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),167 (_, true, None) => {168 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)169 }170 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),171 (false, true, Some(false)) => {172 Self::on_initialize_named(2) - Self::on_initialize_named(1)173 }174 (true, false, Some(false)) => {175 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)176 }177 (true, true, Some(false)) => {178 Self::on_initialize_periodic_named_resolved(2)179 - Self::on_initialize_periodic_named_resolved(1)180 }181 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),182 (false, true, Some(true)) => {183 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)184 }185 (true, false, Some(true)) => {186 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)187 }188 (true, true, Some(true)) => {189 Self::on_initialize_periodic_named_resolved(2)190 - Self::on_initialize_periodic_named_resolved(1)191 }192 }193 }194}195impl<T: WeightInfo> MarginalWeightInfo for T {}196197#[frame_support::pallet]198pub mod pallet {199 use super::*;200 use frame_support::{201 dispatch::PostDispatchInfo,202 pallet_prelude::*,203 traits::{schedule::LookupError, PreimageProvider},204 };205 use frame_system::pallet_prelude::*;206207 /// The current storage version.208 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);209210 #[pallet::pallet]211 #[pallet::generate_store(pub(super) trait Store)]212 #[pallet::storage_version(STORAGE_VERSION)]213 #[pallet::without_storage_info]214 pub struct Pallet<T>(_);215216 /// `system::Config` should always be included in our implied traits.217 #[pallet::config]218 pub trait Config: frame_system::Config {219 /// The overarching event type.220 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;221222 /// The aggregated origin which the dispatch will take.223 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>224 + From<Self::PalletsOrigin>225 + IsType<<Self as system::Config>::Origin>;226227 /// The caller origin, overarching type of all pallets origins.228 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;229230 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;231232 /// The aggregated call type.233 type Call: Parameter234 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>235 + GetDispatchInfo236 + From<system::Call<Self>>;237238 /// The maximum weight that may be scheduled per block for any dispatchables of less239 /// priority than `schedule::HARD_DEADLINE`.240 #[pallet::constant]241 type MaximumWeight: Get<Weight>;242243 /// Required origin to schedule or cancel calls.244 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;245246 /// Compare the privileges of origins.247 ///248 /// This will be used when canceling a task, to ensure that the origin that tries249 /// to cancel has greater or equal privileges as the origin that created the scheduled task.250 ///251 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can252 /// be used. This will only check if two given origins are equal.253 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;254255 /// The maximum number of scheduled calls in the queue for a single block.256 /// Not strictly enforced, but used for weight estimation.257 #[pallet::constant]258 type MaxScheduledPerBlock: Get<u32>;259260 /// Weight information for extrinsics in this pallet.261 type WeightInfo: WeightInfo;262263 /// The preimage provider with which we look up call hashes to get the call.264 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;265266 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.267 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;268269 /// Sponsoring function. In this version sposorship is disabled270 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;271272 /// The helper type used for custom transaction fee logic.273 type CallExecutor: DispatchCall<Self, H160>;274 }275276 /// A Scheduler-Runtime interface for finer payment handling.277 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {278 /// Lock balance required for transaction payment279 fn reserve_balance(280 id: ScheduledId,281 sponsor: <T as frame_system::Config>::AccountId,282 call: <T as Config>::Call,283 count: u32,284 ) -> Result<(), DispatchError>;285286 /// Unlock centain amount from payer287 fn pay_for_call(288 id: ScheduledId,289 sponsor: <T as frame_system::Config>::AccountId,290 call: <T as Config>::Call,291 ) -> Result<u128, DispatchError>;292293 /// Resolve the call dispatch, including any post-dispatch operations.294 fn dispatch_call(295 signer: T::AccountId,296 function: <T as Config>::Call,297 ) -> Result<298 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,299 TransactionValidityError,300 >;301302 /// Cancel schedule reservation and unlock balance303 fn cancel_reserve(304 id: ScheduledId,305 sponsor: <T as frame_system::Config>::AccountId,306 ) -> Result<u128, DispatchError>;307 }308309 /// Items to be executed, indexed by the block number that they should be executed on.310 #[pallet::storage]311 pub type Agenda<T: Config> =312 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;313314 /// Lookup from identity to the block number and index of the task.315 #[pallet::storage]316 pub(crate) type Lookup<T: Config> =317 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;318319 /// Events type.320 #[pallet::event]321 #[pallet::generate_deposit(pub(super) fn deposit_event)]322 pub enum Event<T: Config> {323 /// Scheduled some task.324 Scheduled { when: T::BlockNumber, index: u32 },325 /// Canceled some task.326 Canceled { when: T::BlockNumber, index: u32 },327 /// Dispatched some task.328 Dispatched {329 task: TaskAddress<T::BlockNumber>,330 id: Option<ScheduledId>,331 result: DispatchResult,332 },333 /// The call for the provided hash was not found so the task has been aborted.334 CallLookupFailed {335 task: TaskAddress<T::BlockNumber>,336 id: Option<ScheduledId>,337 error: LookupError,338 },339 }340341 #[pallet::error]342 pub enum Error<T> {343 /// Failed to schedule a call344 FailedToSchedule,345 /// Cannot find the scheduled call.346 NotFound,347 /// Given target block number is in the past.348 TargetBlockNumberInPast,349 /// Reschedule failed because it does not change scheduled time.350 RescheduleNoChange,351 }352353 #[pallet::hooks]354 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {355 /// Execute the scheduled calls356 fn on_initialize(now: T::BlockNumber) -> Weight {357 let limit = T::MaximumWeight::get();358359 let mut queued = Agenda::<T>::take(now)360 .into_iter()361 .enumerate()362 .filter_map(|(index, s)| Some((index as u32, s?)))363 .collect::<Vec<_>>();364365 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {366 log::warn!(367 target: "runtime::scheduler",368 "Warning: This block has more items queued in Scheduler than \369 expected from the runtime configuration. An update might be needed."370 );371 }372373 queued.sort_by_key(|(_, s)| s.priority);374375 let next = now + One::one();376377 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);378 for (order, (index, mut s)) in queued.into_iter().enumerate() {379 let named = if let Some(ref id) = s.maybe_id {380 Lookup::<T>::remove(id);381 true382 } else {383 false384 };385386 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();387 s.call = call;388389 let resolved = if let Some(completed) = maybe_completed {390 T::PreimageProvider::unrequest_preimage(&completed);391 true392 } else {393 false394 };395 let call = match s.call.as_value().cloned() {396 Some(c) => c,397 None => {398 // Preimage not available - postpone until some block.399 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));400 if let Some(delay) = T::NoPreimagePostponement::get() {401 let until = now.saturating_add(delay);402 if let Some(ref id) = s.maybe_id {403 let index = Agenda::<T>::decode_len(until).unwrap_or(0);404 Lookup::<T>::insert(id, (until, index as u32));405 }406 Agenda::<T>::append(until, Some(s));407 }408 continue;409 }410 };411412 let periodic = s.maybe_periodic.is_some();413 let call_weight = call.get_dispatch_info().weight;414 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));415 let origin =416 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())417 .into();418 if ensure_signed(origin).is_ok() {419 // Weights of Signed dispatches expect their signing account to be whitelisted.420 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));421 }422423 // We allow a scheduled call if any is true:424 // - It's priority is `HARD_DEADLINE`425 // - It does not push the weight past the limit.426 // - It is the first item in the schedule427 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;428 let test_weight = total_weight429 .saturating_add(call_weight)430 .saturating_add(item_weight);431 if !hard_deadline && order > 0 && test_weight > limit {432 // Cannot be scheduled this block - postpone until next.433 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));434 if let Some(ref id) = s.maybe_id {435 // NOTE: We could reasonably not do this (in which case there would be one436 // block where the named and delayed item could not be referenced by name),437 // but we will do it anyway since it should be mostly free in terms of438 // weight and it is slightly cleaner.439 let index = Agenda::<T>::decode_len(next).unwrap_or(0);440 Lookup::<T>::insert(id, (next, index as u32));441 }442 Agenda::<T>::append(next, Some(s));443 continue;444 }445446 // Sender is the account who signed transaction447 let sender = ensure_signed(448 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())449 .into(),450 )451 .unwrap();452453 // // if call have id it was be reserved454 // if s.maybe_id.is_some() {455 // let _ = T::CallExecutor::pay_for_call(456 // s.maybe_id.unwrap(),457 // sender.clone(),458 // call.clone(),459 // );460 // }461462 // Execute transaction via chain default pipeline463 let r = T::CallExecutor::dispatch_call(sender, call.clone());464465 let mut actual_call_weight: Weight = item_weight;466 let result: Result<_, DispatchError> = match r {467 Ok(o) => match o {468 Ok(di) => {469 actual_call_weight = di.actual_weight.unwrap_or(item_weight);470 Ok(())471 }472 Err(err) => Err(err.error),473 },474 Err(_) => {475 log::error!(476 target: "runtime::scheduler",477 "Warning: Scheduler has failed to execute a post-dispatch transaction. \478 This block might have become invalid.");479 Err(DispatchError::CannotLookup)480 } // todo possibly force a skip/return here, do something with the error481 };482483 total_weight.saturating_accrue(item_weight);484 total_weight.saturating_accrue(actual_call_weight);485486 Self::deposit_event(Event::Dispatched {487 task: (now, index),488 id: s.maybe_id.clone(),489 result,490 });491492 if let &Some((period, count)) = &s.maybe_periodic {493 if count > 1 {494 s.maybe_periodic = Some((period, count - 1));495 } else {496 s.maybe_periodic = None;497 }498 let wake = now + period;499 // If scheduled is named, place its information in `Lookup`500 if let Some(ref id) = s.maybe_id {501 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);502 Lookup::<T>::insert(id, (wake, wake_index as u32));503 }504 Agenda::<T>::append(wake, Some(s));505 }506 }507 /// Weight should be 0, because transaction already paid508 0509 }510 }511512 #[pallet::call]513 impl<T: Config> Pallet<T> {514 /// Schedule a named task.515 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]516 pub fn schedule_named(517 origin: OriginFor<T>,518 id: ScheduledId,519 when: T::BlockNumber,520 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,521 priority: schedule::Priority,522 call: Box<CallOrHashOf<T>>,523 ) -> DispatchResult {524 T::ScheduleOrigin::ensure_origin(origin.clone())?;525 let origin = <T as Config>::Origin::from(origin);526 Self::do_schedule_named(527 id,528 DispatchTime::At(when),529 maybe_periodic,530 priority,531 origin.caller().clone(),532 *call,533 )?;534 Ok(())535 }536537 /// Cancel a named scheduled task.538 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]539 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {540 T::ScheduleOrigin::ensure_origin(origin.clone())?;541 let origin = <T as Config>::Origin::from(origin);542 Self::do_cancel_named(Some(origin.caller().clone()), id)?;543 Ok(())544 }545546 /// Schedule a named task after a delay.547 ///548 /// # <weight>549 /// Same as [`schedule_named`](Self::schedule_named).550 /// # </weight>551 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]552 pub fn schedule_named_after(553 origin: OriginFor<T>,554 id: ScheduledId,555 after: T::BlockNumber,556 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,557 priority: schedule::Priority,558 call: Box<CallOrHashOf<T>>,559 ) -> DispatchResult {560 T::ScheduleOrigin::ensure_origin(origin.clone())?;561 let origin = <T as Config>::Origin::from(origin);562 Self::do_schedule_named(563 id,564 DispatchTime::After(after),565 maybe_periodic,566 priority,567 origin.caller().clone(),568 *call,569 )?;570 Ok(())571 }572 }573}574575impl<T: Config> Pallet<T> {576 #[cfg(feature = "try-runtime")]577 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {578 Ok(())579 }580581 #[cfg(feature = "try-runtime")]582 pub fn post_migrate_to_v3() -> Result<(), &'static str> {583 use frame_support::dispatch::GetStorageVersion;584585 assert!(Self::current_storage_version() == 3);586 for k in Agenda::<T>::iter_keys() {587 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;588 }589 Ok(())590 }591592 /// Helper to migrate scheduler when the pallet origin type has changed.593 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {594 Agenda::<T>::translate::<595 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,596 _,597 >(|_, agenda| {598 Some(599 agenda600 .into_iter()601 .map(|schedule| {602 schedule.map(|schedule| Scheduled {603 maybe_id: schedule.maybe_id,604 priority: schedule.priority,605 call: schedule.call,606 maybe_periodic: schedule.maybe_periodic,607 origin: schedule.origin.into(),608 _phantom: Default::default(),609 })610 })611 .collect::<Vec<_>>(),612 )613 });614 }615616 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {617 let now = frame_system::Pallet::<T>::block_number();618619 let when = match when {620 DispatchTime::At(x) => x,621 // The current block has already completed it's scheduled tasks, so622 // Schedule the task at lest one block after this current block.623 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),624 };625626 if when <= now {627 return Err(Error::<T>::TargetBlockNumberInPast.into());628 }629630 Ok(when)631 }632633 fn do_schedule_named(634 id: ScheduledId,635 when: DispatchTime<T::BlockNumber>,636 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,637 priority: schedule::Priority,638 origin: T::PalletsOrigin,639 call: CallOrHashOf<T>,640 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {641 // ensure id it is unique642 if Lookup::<T>::contains_key(&id) {643 return Err(Error::<T>::FailedToSchedule)?;644 }645646 let when = Self::resolve_time(when)?;647648 call.ensure_requested::<T::PreimageProvider>();649650 // sanitize maybe_periodic651 let maybe_periodic = maybe_periodic652 .filter(|p| p.1 > 1 && !p.0.is_zero())653 // Remove one from the number of repetitions since we will schedule one now.654 .map(|(p, c)| (p, c - 1));655656 let s = Scheduled {657 maybe_id: Some(id.clone()),658 priority,659 call: call.clone(),660 maybe_periodic,661 origin: origin.clone(),662 _phantom: Default::default(),663 };664665 // reserve balance for periodic execution666 // let sender =667 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;668 // let repeats = match maybe_periodic {669 // Some(p) => p.1,670 // None => 1,671 // };672 // let _ = T::CallExecutor::reserve_balance(673 // id.clone(),674 // sender,675 // call.as_value().unwrap().clone(),676 // repeats,677 // );678679 Agenda::<T>::append(when, Some(s));680 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;681 let address = (when, index);682 Lookup::<T>::insert(&id, &address);683 Self::deposit_event(Event::Scheduled { when, index });684685 Ok(address)686 }687688 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {689 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {690 if let Some((when, index)) = lookup.take() {691 let i = index as usize;692 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {693 if let Some(s) = agenda.get_mut(i) {694 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {695 if matches!(696 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),697 Some(Ordering::Less) | None698 ) {699 return Err(BadOrigin.into());700 }701 // release balance reserve702 // let sender = ensure_signed(703 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(704 // origin.unwrap(),705 // )706 // .into(),707 // )?;708 // let _ = T::CallExecutor::cancel_reserve(id, sender);709710 s.call.ensure_unrequested::<T::PreimageProvider>();711 }712 *s = None;713 }714 Ok(())715 })?;716717 Self::deposit_event(Event::Canceled { when, index });718 Ok(())719 } else {720 Err(Error::<T>::NotFound)?721 }722 })723 }724}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617// Original license:18// This file is part of Substrate.1920// Copyright (C) 2017-2022 Parity Technologies (UK) Ltd.21// SPDX-License-Identifier: Apache-2.02223// Licensed under the Apache License, Version 2.0 (the "License");24// you may not use this file except in compliance with the License.25// You may obtain a copy of the License at26//27// http://www.apache.org/licenses/LICENSE-2.028//29// Unless required by applicable law or agreed to in writing, software30// distributed under the License is distributed on an "AS IS" BASIS,31// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.32// See the License for the specific language governing permissions and33// limitations under the License.3435//! # Unique scheduler36//! A Pallet for scheduling dispatches.37//!38//! - [`Config`]39//! - [`Call`]40//! - [`Pallet`]41//!42//! ## Overview43//!44//! This Pallet exposes capabilities for scheduling dispatches to occur at a45//! specified block number or at a specified period. These scheduled dispatches46//! may be named or anonymous and may be canceled.47//!48//! **NOTE:** The scheduled calls will be dispatched with the default filter49//! for the origin: namely `frame_system::Config::BaseCallFilter` for all origin50//! except root which will get no filter. And not the filter contained in origin51//! use to call `fn schedule`.52//!53//! If a call is scheduled using proxy or whatever mecanism which adds filter,54//! then those filter will not be used when dispatching the schedule call.55//!56//! **NOTE:** The unique scheduler is designed for deferred transaction calls by block number.57//! Any user can book a call of a certain transaction to a specific block number.58//! Also possible to book a call with a certain frequency.59//!60//! Key differences from original pallet:61//! https://crates.io/crates/pallet-scheduler62//! Schedule Id restricted by 16 bytes63//! Priority limited by HARD DEADLINE (<= 63). Calls over maximum weight don't include to block64//! Maybe_periodic limit is 100 calls65//! Any account allowed to schedule any calls. Account withdraw implemented through default transaction logic.66//!67//! ## Interface68//!69//! ### Dispatchable Functions70//!71//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and72//! with a specified priority.73//! * `cancel` - cancel a scheduled dispatch, specified by block number and index.74//! * `schedule_named` - augments the `schedule` interface with an additional `Vec<u8>` parameter75//! that can be used for identification.76//! * `cancel_named` - the named complement to the cancel function.7778// Ensure we're `no_std` when compiling for Wasm.79#![cfg_attr(not(feature = "std"), no_std)]8081#[cfg(feature = "runtime-benchmarks")]82mod benchmarking;8384pub mod weights;8586use sp_core::H160;87use codec::{Codec, Decode, Encode};88use frame_system::{self as system, ensure_signed};89pub use pallet::*;90use scale_info::TypeInfo;91use sp_runtime::{92 traits::{BadOrigin, One, Saturating, Zero},93 RuntimeDebug, DispatchErrorWithPostInfo,94};95use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};9697use frame_support::{98 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},99 traits::{100 schedule::{self, DispatchTime, MaybeHashed},101 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,102 StorageVersion,103 },104 weights::{GetDispatchInfo, Weight},105};106107pub use weights::WeightInfo;108109/// Just a simple index for naming period tasks.110pub type PeriodicIndex = u32;111/// The location of a scheduled task that can be used to remove it.112pub type TaskAddress<BlockNumber> = (BlockNumber, u32);113pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;114115type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];116pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;117118/// Information regarding an item to be executed in the future.119#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]120#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]121pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {122 /// The unique identity for this task, if there is one.123 maybe_id: Option<ScheduledId>,124 /// This task's priority.125 priority: schedule::Priority,126 /// The call to be dispatched.127 call: Call,128 /// If the call is periodic, then this points to the information concerning that.129 maybe_periodic: Option<schedule::Period<BlockNumber>>,130 /// The origin to dispatch the call.131 origin: PalletsOrigin,132 _phantom: PhantomData<AccountId>,133}134135pub type ScheduledV3Of<T> = ScheduledV3<136 CallOrHashOf<T>,137 <T as frame_system::Config>::BlockNumber,138 <T as Config>::PalletsOrigin,139 <T as frame_system::Config>::AccountId,140>;141142pub type ScheduledOf<T> = ScheduledV3Of<T>;143144/// The current version of Scheduled struct.145pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =146 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;147148#[cfg(feature = "runtime-benchmarks")]149mod preimage_provider {150 use frame_support::traits::PreimageRecipient;151 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}152 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}153}154155#[cfg(not(feature = "runtime-benchmarks"))]156mod preimage_provider {157 use frame_support::traits::PreimageProvider;158 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}159 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}160}161162pub use preimage_provider::PreimageProviderAndMaybeRecipient;163164/// Weight templates for calculating actual fees165pub(crate) trait MarginalWeightInfo: WeightInfo {166 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {167 match (periodic, named, resolved) {168 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),169 (_, true, None) => {170 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)171 }172 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),173 (false, true, Some(false)) => {174 Self::on_initialize_named(2) - Self::on_initialize_named(1)175 }176 (true, false, Some(false)) => {177 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)178 }179 (true, true, Some(false)) => {180 Self::on_initialize_periodic_named_resolved(2)181 - Self::on_initialize_periodic_named_resolved(1)182 }183 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),184 (false, true, Some(true)) => {185 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)186 }187 (true, false, Some(true)) => {188 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)189 }190 (true, true, Some(true)) => {191 Self::on_initialize_periodic_named_resolved(2)192 - Self::on_initialize_periodic_named_resolved(1)193 }194 }195 }196}197impl<T: WeightInfo> MarginalWeightInfo for T {}198199#[frame_support::pallet]200pub mod pallet {201 use super::*;202 use frame_support::{203 dispatch::PostDispatchInfo,204 pallet_prelude::*,205 traits::{schedule::LookupError, PreimageProvider},206 };207 use frame_system::pallet_prelude::*;208209 /// The current storage version.210 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);211212 #[pallet::pallet]213 #[pallet::generate_store(pub(super) trait Store)]214 #[pallet::storage_version(STORAGE_VERSION)]215 #[pallet::without_storage_info]216 pub struct Pallet<T>(_);217218 /// `system::Config` should always be included in our implied traits.219 #[pallet::config]220 pub trait Config: frame_system::Config {221 /// The overarching event type.222 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;223224 /// The aggregated origin which the dispatch will take.225 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>226 + From<Self::PalletsOrigin>227 + IsType<<Self as system::Config>::Origin>;228229 /// The caller origin, overarching type of all pallets origins.230 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;231232 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;233234 /// The aggregated call type.235 type Call: Parameter236 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>237 + GetDispatchInfo238 + From<system::Call<Self>>;239240 /// The maximum weight that may be scheduled per block for any dispatchables of less241 /// priority than `schedule::HARD_DEADLINE`.242 #[pallet::constant]243 type MaximumWeight: Get<Weight>;244245 /// Required origin to schedule or cancel calls.246 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;247248 /// Compare the privileges of origins.249 ///250 /// This will be used when canceling a task, to ensure that the origin that tries251 /// to cancel has greater or equal privileges as the origin that created the scheduled task.252 ///253 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can254 /// be used. This will only check if two given origins are equal.255 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;256257 /// The maximum number of scheduled calls in the queue for a single block.258 /// Not strictly enforced, but used for weight estimation.259 #[pallet::constant]260 type MaxScheduledPerBlock: Get<u32>;261262 /// Weight information for extrinsics in this pallet.263 type WeightInfo: WeightInfo;264265 /// The preimage provider with which we look up call hashes to get the call.266 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;267268 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.269 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;270271 /// Sponsoring function. In this version sposorship is disabled272 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;273274 /// The helper type used for custom transaction fee logic.275 type CallExecutor: DispatchCall<Self, H160>;276 }277278 /// A Scheduler-Runtime interface for finer payment handling.279 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {280 /// Lock balance required for transaction payment281 fn reserve_balance(282 id: ScheduledId,283 sponsor: <T as frame_system::Config>::AccountId,284 call: <T as Config>::Call,285 count: u32,286 ) -> Result<(), DispatchError>;287288 /// Unlock centain amount from payer289 fn pay_for_call(290 id: ScheduledId,291 sponsor: <T as frame_system::Config>::AccountId,292 call: <T as Config>::Call,293 ) -> Result<u128, DispatchError>;294295 /// Resolve the call dispatch, including any post-dispatch operations.296 fn dispatch_call(297 signer: T::AccountId,298 function: <T as Config>::Call,299 ) -> Result<300 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,301 TransactionValidityError,302 >;303304 /// Cancel schedule reservation and unlock balance305 fn cancel_reserve(306 id: ScheduledId,307 sponsor: <T as frame_system::Config>::AccountId,308 ) -> Result<u128, DispatchError>;309 }310311 /// Items to be executed, indexed by the block number that they should be executed on.312 #[pallet::storage]313 pub type Agenda<T: Config> =314 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;315316 /// Lookup from identity to the block number and index of the task.317 #[pallet::storage]318 pub(crate) type Lookup<T: Config> =319 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;320321 /// Events type.322 #[pallet::event]323 #[pallet::generate_deposit(pub(super) fn deposit_event)]324 pub enum Event<T: Config> {325 /// Scheduled some task.326 Scheduled { when: T::BlockNumber, index: u32 },327 /// Canceled some task.328 Canceled { when: T::BlockNumber, index: u32 },329 /// Dispatched some task.330 Dispatched {331 task: TaskAddress<T::BlockNumber>,332 id: Option<ScheduledId>,333 result: DispatchResult,334 },335 /// The call for the provided hash was not found so the task has been aborted.336 CallLookupFailed {337 task: TaskAddress<T::BlockNumber>,338 id: Option<ScheduledId>,339 error: LookupError,340 },341 }342343 #[pallet::error]344 pub enum Error<T> {345 /// Failed to schedule a call346 FailedToSchedule,347 /// Cannot find the scheduled call.348 NotFound,349 /// Given target block number is in the past.350 TargetBlockNumberInPast,351 /// Reschedule failed because it does not change scheduled time.352 RescheduleNoChange,353 }354355 #[pallet::hooks]356 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {357 /// Execute the scheduled calls358 fn on_initialize(now: T::BlockNumber) -> Weight {359 let limit = T::MaximumWeight::get();360361 let mut queued = Agenda::<T>::take(now)362 .into_iter()363 .enumerate()364 .filter_map(|(index, s)| Some((index as u32, s?)))365 .collect::<Vec<_>>();366367 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {368 log::warn!(369 target: "runtime::scheduler",370 "Warning: This block has more items queued in Scheduler than \371 expected from the runtime configuration. An update might be needed."372 );373 }374375 queued.sort_by_key(|(_, s)| s.priority);376377 let next = now + One::one();378379 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);380 for (order, (index, mut s)) in queued.into_iter().enumerate() {381 let named = if let Some(ref id) = s.maybe_id {382 Lookup::<T>::remove(id);383 true384 } else {385 false386 };387388 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();389 s.call = call;390391 let resolved = if let Some(completed) = maybe_completed {392 T::PreimageProvider::unrequest_preimage(&completed);393 true394 } else {395 false396 };397 let call = match s.call.as_value().cloned() {398 Some(c) => c,399 None => {400 // Preimage not available - postpone until some block.401 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));402 if let Some(delay) = T::NoPreimagePostponement::get() {403 let until = now.saturating_add(delay);404 if let Some(ref id) = s.maybe_id {405 let index = Agenda::<T>::decode_len(until).unwrap_or(0);406 Lookup::<T>::insert(id, (until, index as u32));407 }408 Agenda::<T>::append(until, Some(s));409 }410 continue;411 }412 };413414 let periodic = s.maybe_periodic.is_some();415 let call_weight = call.get_dispatch_info().weight;416 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));417 let origin =418 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())419 .into();420 if ensure_signed(origin).is_ok() {421 // Weights of Signed dispatches expect their signing account to be whitelisted.422 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));423 }424425 // We allow a scheduled call if any is true:426 // - It's priority is `HARD_DEADLINE`427 // - It does not push the weight past the limit.428 // - It is the first item in the schedule429 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;430 let test_weight = total_weight431 .saturating_add(call_weight)432 .saturating_add(item_weight);433 if !hard_deadline && order > 0 && test_weight > limit {434 // Cannot be scheduled this block - postpone until next.435 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));436 if let Some(ref id) = s.maybe_id {437 // NOTE: We could reasonably not do this (in which case there would be one438 // block where the named and delayed item could not be referenced by name),439 // but we will do it anyway since it should be mostly free in terms of440 // weight and it is slightly cleaner.441 let index = Agenda::<T>::decode_len(next).unwrap_or(0);442 Lookup::<T>::insert(id, (next, index as u32));443 }444 Agenda::<T>::append(next, Some(s));445 continue;446 }447448 // Sender is the account who signed transaction449 let sender = ensure_signed(450 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())451 .into(),452 )453 .unwrap();454455 // // if call have id it was be reserved456 // if s.maybe_id.is_some() {457 // let _ = T::CallExecutor::pay_for_call(458 // s.maybe_id.unwrap(),459 // sender.clone(),460 // call.clone(),461 // );462 // }463464 // Execute transaction via chain default pipeline465 // That means dispatch will be processed like any user's extrinsic e.g. transaction fees will be taken466 let r = T::CallExecutor::dispatch_call(sender, call.clone());467468 let mut actual_call_weight: Weight = item_weight;469 let result: Result<_, DispatchError> = match r {470 Ok(o) => match o {471 Ok(di) => {472 actual_call_weight = di.actual_weight.unwrap_or(item_weight);473 Ok(())474 }475 Err(err) => Err(err.error),476 },477 Err(_) => {478 log::error!(479 target: "runtime::scheduler",480 "Warning: Scheduler has failed to execute a post-dispatch transaction. \481 This block might have become invalid.");482 Err(DispatchError::CannotLookup)483 } // todo possibly force a skip/return here, do something with the error484 };485486 total_weight.saturating_accrue(item_weight);487 total_weight.saturating_accrue(actual_call_weight);488489 Self::deposit_event(Event::Dispatched {490 task: (now, index),491 id: s.maybe_id.clone(),492 result,493 });494495 if let &Some((period, count)) = &s.maybe_periodic {496 if count > 1 {497 s.maybe_periodic = Some((period, count - 1));498 } else {499 s.maybe_periodic = None;500 }501 let wake = now + period;502 // If scheduled is named, place its information in `Lookup`503 if let Some(ref id) = s.maybe_id {504 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);505 Lookup::<T>::insert(id, (wake, wake_index as u32));506 }507 Agenda::<T>::append(wake, Some(s));508 }509 }510 /// Weight should be 0, because transaction already paid511 0512 }513 }514515 #[pallet::call]516 impl<T: Config> Pallet<T> {517 /// Schedule a named task.518 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]519 pub fn schedule_named(520 origin: OriginFor<T>,521 id: ScheduledId,522 when: T::BlockNumber,523 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,524 priority: schedule::Priority,525 call: Box<CallOrHashOf<T>>,526 ) -> DispatchResult {527 T::ScheduleOrigin::ensure_origin(origin.clone())?;528 let origin = <T as Config>::Origin::from(origin);529 Self::do_schedule_named(530 id,531 DispatchTime::At(when),532 maybe_periodic,533 priority,534 origin.caller().clone(),535 *call,536 )?;537 Ok(())538 }539540 /// Cancel a named scheduled task.541 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]542 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {543 T::ScheduleOrigin::ensure_origin(origin.clone())?;544 let origin = <T as Config>::Origin::from(origin);545 Self::do_cancel_named(Some(origin.caller().clone()), id)?;546 Ok(())547 }548549 /// Schedule a named task after a delay.550 ///551 /// # <weight>552 /// Same as [`schedule_named`](Self::schedule_named).553 /// # </weight>554 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]555 pub fn schedule_named_after(556 origin: OriginFor<T>,557 id: ScheduledId,558 after: T::BlockNumber,559 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,560 priority: schedule::Priority,561 call: Box<CallOrHashOf<T>>,562 ) -> DispatchResult {563 T::ScheduleOrigin::ensure_origin(origin.clone())?;564 let origin = <T as Config>::Origin::from(origin);565 Self::do_schedule_named(566 id,567 DispatchTime::After(after),568 maybe_periodic,569 priority,570 origin.caller().clone(),571 *call,572 )?;573 Ok(())574 }575 }576}577578impl<T: Config> Pallet<T> {579 #[cfg(feature = "try-runtime")]580 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {581 Ok(())582 }583584 #[cfg(feature = "try-runtime")]585 pub fn post_migrate_to_v3() -> Result<(), &'static str> {586 use frame_support::dispatch::GetStorageVersion;587588 assert!(Self::current_storage_version() == 3);589 for k in Agenda::<T>::iter_keys() {590 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;591 }592 Ok(())593 }594595 /// Helper to migrate scheduler when the pallet origin type has changed.596 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {597 Agenda::<T>::translate::<598 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,599 _,600 >(|_, agenda| {601 Some(602 agenda603 .into_iter()604 .map(|schedule| {605 schedule.map(|schedule| Scheduled {606 maybe_id: schedule.maybe_id,607 priority: schedule.priority,608 call: schedule.call,609 maybe_periodic: schedule.maybe_periodic,610 origin: schedule.origin.into(),611 _phantom: Default::default(),612 })613 })614 .collect::<Vec<_>>(),615 )616 });617 }618619 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {620 let now = frame_system::Pallet::<T>::block_number();621622 let when = match when {623 DispatchTime::At(x) => x,624 // The current block has already completed it's scheduled tasks, so625 // Schedule the task at lest one block after this current block.626 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),627 };628629 if when <= now {630 return Err(Error::<T>::TargetBlockNumberInPast.into());631 }632633 Ok(when)634 }635636 fn do_schedule_named(637 id: ScheduledId,638 when: DispatchTime<T::BlockNumber>,639 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,640 priority: schedule::Priority,641 origin: T::PalletsOrigin,642 call: CallOrHashOf<T>,643 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {644 // ensure id it is unique645 if Lookup::<T>::contains_key(&id) {646 return Err(Error::<T>::FailedToSchedule)?;647 }648649 let when = Self::resolve_time(when)?;650651 call.ensure_requested::<T::PreimageProvider>();652653 // sanitize maybe_periodic654 let maybe_periodic = maybe_periodic655 .filter(|p| p.1 > 1 && !p.0.is_zero())656 // Remove one from the number of repetitions since we will schedule one now.657 .map(|(p, c)| (p, c - 1));658659 let s = Scheduled {660 maybe_id: Some(id.clone()),661 priority,662 call: call.clone(),663 maybe_periodic,664 origin: origin.clone(),665 _phantom: Default::default(),666 };667668 // reserve balance for periodic execution669 // let sender =670 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;671 // let repeats = match maybe_periodic {672 // Some(p) => p.1,673 // None => 1,674 // };675 // let _ = T::CallExecutor::reserve_balance(676 // id.clone(),677 // sender,678 // call.as_value().unwrap().clone(),679 // repeats,680 // );681682 Agenda::<T>::append(when, Some(s));683 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;684 let address = (when, index);685 Lookup::<T>::insert(&id, &address);686 Self::deposit_event(Event::Scheduled { when, index });687688 Ok(address)689 }690691 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {692 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {693 if let Some((when, index)) = lookup.take() {694 let i = index as usize;695 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {696 if let Some(s) = agenda.get_mut(i) {697 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {698 if matches!(699 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),700 Some(Ordering::Less) | None701 ) {702 return Err(BadOrigin.into());703 }704 // release balance reserve705 // let sender = ensure_signed(706 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(707 // origin.unwrap(),708 // )709 // .into(),710 // )?;711 // let _ = T::CallExecutor::cancel_reserve(id, sender);712713 s.call.ensure_unrequested::<T::PreimageProvider>();714 }715 *s = None;716 }717 Ok(())718 })?;719720 Self::deposit_event(Event::Canceled { when, index });721 Ok(())722 } else {723 Err(Error::<T>::NotFound)?724 }725 })726 }727}