difftreelog
Doc style fix
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//! # Schedulerdo_reschedule36//!37//! This Pallet exposes capabilities for scheduling dispatches to occur at a38//! specified block number or at a specified period. These scheduled dispatches39//! may be named or anonymous and may be canceled.40//!41//! **NOTE:** The scheduled calls will be dispatched with the default filter42//! for the origin: namely `frame_system::Config::BaseCallFilter` for all origin43//! except root which will get no filter. And not the filter contained in origin44//! use to call `fn schedule`.45//!46//! If a call is scheduled using proxy or whatever mecanism which adds filter,47//! then those filter will not be used when dispatching the schedule call.48//!49//! The scheduler is designed for deferred transaction calls by block number.50//! Any user can book a call of a certain transaction to a specific block number.51//! Also possible to book a call with a certain frequency.52//! Key differences from original pallet:53//! Id restricted by 16 bytes54//! Priority limited by HARD DEADLINE (<= 63). Calls over maximum weight don't include to block55//! Maybe_periodic limit is 100 calls56//! Any account allowed to schedule any calls. Account withdraw implemented through default transaction logic.57//!58//! ## Interface59//!60//! ### Dispatchable Functions61//!62//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and63//! with a specified priority.64//! * `cancel` - cancel a scheduled dispatch, specified by block number and index.65//! * `schedule_named` - augments the `schedule` interface with an additional `Vec<u8>` parameter66//! that can be used for identification.67//! * `cancel_named` - the named complement to the cancel function.6869// Ensure we're `no_std` when compiling for Wasm.70#![cfg_attr(not(feature = "std"), no_std)]7172#[cfg(feature = "runtime-benchmarks")]73mod benchmarking;7475pub mod weights;7677use sp_core::H160;78use codec::{Codec, Decode, Encode};79use frame_system::{self as system, ensure_signed};80pub use pallet::*;81use scale_info::TypeInfo;82use sp_runtime::{83 traits::{BadOrigin, One, Saturating, Zero},84 RuntimeDebug, DispatchErrorWithPostInfo,85};86use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};8788use frame_support::{89 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},90 traits::{91 schedule::{self, DispatchTime, MaybeHashed},92 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,93 StorageVersion,94 },95 weights::{GetDispatchInfo, Weight},96};9798pub use weights::WeightInfo;99100/// Just a simple index for naming period tasks.101pub type PeriodicIndex = u32;102/// The location of a scheduled task that can be used to remove it.103pub type TaskAddress<BlockNumber> = (BlockNumber, u32);104pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;105106type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];107pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;108109/// Information regarding an item to be executed in the future.110#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]111#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]112pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {113 /// The unique identity for this task, if there is one.114 maybe_id: Option<ScheduledId>,115 /// This task's priority.116 priority: schedule::Priority,117 /// The call to be dispatched.118 call: Call,119 /// If the call is periodic, then this points to the information concerning that.120 maybe_periodic: Option<schedule::Period<BlockNumber>>,121 /// The origin to dispatch the call.122 origin: PalletsOrigin,123 _phantom: PhantomData<AccountId>,124}125126pub type ScheduledV3Of<T> = ScheduledV3<127 CallOrHashOf<T>,128 <T as frame_system::Config>::BlockNumber,129 <T as Config>::PalletsOrigin,130 <T as frame_system::Config>::AccountId,131>;132133pub type ScheduledOf<T> = ScheduledV3Of<T>;134135/// The current version of Scheduled struct.136pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =137 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;138139#[cfg(feature = "runtime-benchmarks")]140mod preimage_provider {141 use frame_support::traits::PreimageRecipient;142 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}143 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}144}145146#[cfg(not(feature = "runtime-benchmarks"))]147mod preimage_provider {148 use frame_support::traits::PreimageProvider;149 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}150 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}151}152153pub use preimage_provider::PreimageProviderAndMaybeRecipient;154155/// Weight templates for calculating actual fees156pub(crate) trait MarginalWeightInfo: WeightInfo {157 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {158 match (periodic, named, resolved) {159 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),160 (_, true, None) => {161 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)162 }163 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),164 (false, true, Some(false)) => {165 Self::on_initialize_named(2) - Self::on_initialize_named(1)166 }167 (true, false, Some(false)) => {168 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)169 }170 (true, true, Some(false)) => {171 Self::on_initialize_periodic_named_resolved(2)172 - Self::on_initialize_periodic_named_resolved(1)173 }174 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),175 (false, true, Some(true)) => {176 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)177 }178 (true, false, Some(true)) => {179 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)180 }181 (true, true, Some(true)) => {182 Self::on_initialize_periodic_named_resolved(2)183 - Self::on_initialize_periodic_named_resolved(1)184 }185 }186 }187}188impl<T: WeightInfo> MarginalWeightInfo for T {}189190#[frame_support::pallet]191pub mod pallet {192 use super::*;193 use frame_support::{194 dispatch::PostDispatchInfo,195 pallet_prelude::*,196 traits::{schedule::LookupError, PreimageProvider},197 };198 use frame_system::pallet_prelude::*;199200 /// The current storage version.201 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);202203 #[pallet::pallet]204 #[pallet::generate_store(pub(super) trait Store)]205 #[pallet::storage_version(STORAGE_VERSION)]206 #[pallet::without_storage_info]207 pub struct Pallet<T>(_);208209 /// `system::Config` should always be included in our implied traits.210 #[pallet::config]211 pub trait Config: frame_system::Config {212 /// The overarching event type.213 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;214215 /// The aggregated origin which the dispatch will take.216 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>217 + From<Self::PalletsOrigin>218 + IsType<<Self as system::Config>::Origin>;219220 /// The caller origin, overarching type of all pallets origins.221 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;222223 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;224225 /// The aggregated call type.226 type Call: Parameter227 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>228 + GetDispatchInfo229 + From<system::Call<Self>>;230231 /// The maximum weight that may be scheduled per block for any dispatchables of less232 /// priority than `schedule::HARD_DEADLINE`.233 #[pallet::constant]234 type MaximumWeight: Get<Weight>;235236 /// Required origin to schedule or cancel calls.237 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;238239 /// Compare the privileges of origins.240 ///241 /// This will be used when canceling a task, to ensure that the origin that tries242 /// to cancel has greater or equal privileges as the origin that created the scheduled task.243 ///244 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can245 /// be used. This will only check if two given origins are equal.246 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;247248 /// The maximum number of scheduled calls in the queue for a single block.249 /// Not strictly enforced, but used for weight estimation.250 #[pallet::constant]251 type MaxScheduledPerBlock: Get<u32>;252253 /// Weight information for extrinsics in this pallet.254 type WeightInfo: WeightInfo;255256 /// The preimage provider with which we look up call hashes to get the call.257 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;258259 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.260 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;261262 /// Sponsoring function. In this version sposorship is disabled263 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;264265 /// The helper type used for custom transaction fee logic.266 type CallExecutor: DispatchCall<Self, H160>;267 }268269 /// A Scheduler-Runtime interface for finer payment handling.270 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {271 /// Lock balance required for transaction payment272 fn reserve_balance(273 id: ScheduledId,274 sponsor: <T as frame_system::Config>::AccountId,275 call: <T as Config>::Call,276 count: u32,277 ) -> Result<(), DispatchError>;278279 /// Unlock centain amount from payer280 fn pay_for_call(281 id: ScheduledId,282 sponsor: <T as frame_system::Config>::AccountId,283 call: <T as Config>::Call,284 ) -> Result<u128, DispatchError>;285286 /// Resolve the call dispatch, including any post-dispatch operations.287 fn dispatch_call(288 signer: T::AccountId,289 function: <T as Config>::Call,290 ) -> Result<291 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,292 TransactionValidityError,293 >;294295 /// Cancel schedule reservation and unlock balance296 fn cancel_reserve(297 id: ScheduledId,298 sponsor: <T as frame_system::Config>::AccountId,299 ) -> Result<u128, DispatchError>;300 }301302 /// Items to be executed, indexed by the block number that they should be executed on.303 #[pallet::storage]304 pub type Agenda<T: Config> =305 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;306307 /// Lookup from identity to the block number and index of the task.308 #[pallet::storage]309 pub(crate) type Lookup<T: Config> =310 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;311312 /// Events type.313 #[pallet::event]314 #[pallet::generate_deposit(pub(super) fn deposit_event)]315 pub enum Event<T: Config> {316 /// Scheduled some task.317 Scheduled { when: T::BlockNumber, index: u32 },318 /// Canceled some task.319 Canceled { when: T::BlockNumber, index: u32 },320 /// Dispatched some task.321 Dispatched {322 task: TaskAddress<T::BlockNumber>,323 id: Option<ScheduledId>,324 result: DispatchResult,325 },326 /// The call for the provided hash was not found so the task has been aborted.327 CallLookupFailed {328 task: TaskAddress<T::BlockNumber>,329 id: Option<ScheduledId>,330 error: LookupError,331 },332 }333334 #[pallet::error]335 pub enum Error<T> {336 /// Failed to schedule a call337 FailedToSchedule,338 /// Cannot find the scheduled call.339 NotFound,340 /// Given target block number is in the past.341 TargetBlockNumberInPast,342 /// Reschedule failed because it does not change scheduled time.343 RescheduleNoChange,344 }345346 #[pallet::hooks]347 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {348 /// Execute the scheduled calls349 fn on_initialize(now: T::BlockNumber) -> Weight {350 let limit = T::MaximumWeight::get();351352 let mut queued = Agenda::<T>::take(now)353 .into_iter()354 .enumerate()355 .filter_map(|(index, s)| Some((index as u32, s?)))356 .collect::<Vec<_>>();357358 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {359 log::warn!(360 target: "runtime::scheduler",361 "Warning: This block has more items queued in Scheduler than \362 expected from the runtime configuration. An update might be needed."363 );364 }365366 queued.sort_by_key(|(_, s)| s.priority);367368 let next = now + One::one();369370 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);371 for (order, (index, mut s)) in queued.into_iter().enumerate() {372 let named = if let Some(ref id) = s.maybe_id {373 Lookup::<T>::remove(id);374 true375 } else {376 false377 };378379 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();380 s.call = call;381382 let resolved = if let Some(completed) = maybe_completed {383 T::PreimageProvider::unrequest_preimage(&completed);384 true385 } else {386 false387 };388 let call = match s.call.as_value().cloned() {389 Some(c) => c,390 None => {391 // Preimage not available - postpone until some block.392 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));393 if let Some(delay) = T::NoPreimagePostponement::get() {394 let until = now.saturating_add(delay);395 if let Some(ref id) = s.maybe_id {396 let index = Agenda::<T>::decode_len(until).unwrap_or(0);397 Lookup::<T>::insert(id, (until, index as u32));398 }399 Agenda::<T>::append(until, Some(s));400 }401 continue;402 }403 };404405 let periodic = s.maybe_periodic.is_some();406 let call_weight = call.get_dispatch_info().weight;407 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));408 let origin =409 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())410 .into();411 if ensure_signed(origin).is_ok() {412 // Weights of Signed dispatches expect their signing account to be whitelisted.413 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));414 }415416 // We allow a scheduled call if any is true:417 // - It's priority is `HARD_DEADLINE`418 // - It does not push the weight past the limit.419 // - It is the first item in the schedule420 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;421 let test_weight = total_weight422 .saturating_add(call_weight)423 .saturating_add(item_weight);424 if !hard_deadline && order > 0 && test_weight > limit {425 // Cannot be scheduled this block - postpone until next.426 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));427 if let Some(ref id) = s.maybe_id {428 // NOTE: We could reasonably not do this (in which case there would be one429 // block where the named and delayed item could not be referenced by name),430 // but we will do it anyway since it should be mostly free in terms of431 // weight and it is slightly cleaner.432 let index = Agenda::<T>::decode_len(next).unwrap_or(0);433 Lookup::<T>::insert(id, (next, index as u32));434 }435 Agenda::<T>::append(next, Some(s));436 continue;437 }438439 // Sender is the account who signed transaction440 let sender = ensure_signed(441 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())442 .into(),443 )444 .unwrap();445446 // // if call have id it was be reserved447 // if s.maybe_id.is_some() {448 // let _ = T::CallExecutor::pay_for_call(449 // s.maybe_id.unwrap(),450 // sender.clone(),451 // call.clone(),452 // );453 // }454455 // Execute transaction via chain default pipeline456 let r = T::CallExecutor::dispatch_call(sender, call.clone());457458 let mut actual_call_weight: Weight = item_weight;459 let result: Result<_, DispatchError> = match r {460 Ok(o) => match o {461 Ok(di) => {462 actual_call_weight = di.actual_weight.unwrap_or(item_weight);463 Ok(())464 }465 Err(err) => Err(err.error),466 },467 Err(_) => {468 log::error!(469 target: "runtime::scheduler",470 "Warning: Scheduler has failed to execute a post-dispatch transaction. \471 This block might have become invalid.");472 Err(DispatchError::CannotLookup)473 } // todo possibly force a skip/return here, do something with the error474 };475476 total_weight.saturating_accrue(item_weight);477 total_weight.saturating_accrue(actual_call_weight);478479 Self::deposit_event(Event::Dispatched {480 task: (now, index),481 id: s.maybe_id.clone(),482 result,483 });484485 if let &Some((period, count)) = &s.maybe_periodic {486 if count > 1 {487 s.maybe_periodic = Some((period, count - 1));488 } else {489 s.maybe_periodic = None;490 }491 let wake = now + period;492 // If scheduled is named, place its information in `Lookup`493 if let Some(ref id) = s.maybe_id {494 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);495 Lookup::<T>::insert(id, (wake, wake_index as u32));496 }497 Agenda::<T>::append(wake, Some(s));498 }499 }500 /// Weight should be 0, because transaction already paid501 0502 }503 }504505 #[pallet::call]506 impl<T: Config> Pallet<T> {507 /// Schedule a named task.508 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]509 pub fn schedule_named(510 origin: OriginFor<T>,511 id: ScheduledId,512 when: T::BlockNumber,513 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,514 priority: schedule::Priority,515 call: Box<CallOrHashOf<T>>,516 ) -> DispatchResult {517 T::ScheduleOrigin::ensure_origin(origin.clone())?;518 let origin = <T as Config>::Origin::from(origin);519 Self::do_schedule_named(520 id,521 DispatchTime::At(when),522 maybe_periodic,523 priority,524 origin.caller().clone(),525 *call,526 )?;527 Ok(())528 }529530 /// Cancel a named scheduled task.531 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]532 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {533 T::ScheduleOrigin::ensure_origin(origin.clone())?;534 let origin = <T as Config>::Origin::from(origin);535 Self::do_cancel_named(Some(origin.caller().clone()), id)?;536 Ok(())537 }538539 /// Schedule a named task after a delay.540 ///541 /// # <weight>542 /// Same as [`schedule_named`](Self::schedule_named).543 /// # </weight>544 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]545 pub fn schedule_named_after(546 origin: OriginFor<T>,547 id: ScheduledId,548 after: T::BlockNumber,549 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,550 priority: schedule::Priority,551 call: Box<CallOrHashOf<T>>,552 ) -> DispatchResult {553 T::ScheduleOrigin::ensure_origin(origin.clone())?;554 let origin = <T as Config>::Origin::from(origin);555 Self::do_schedule_named(556 id,557 DispatchTime::After(after),558 maybe_periodic,559 priority,560 origin.caller().clone(),561 *call,562 )?;563 Ok(())564 }565 }566}567568impl<T: Config> Pallet<T> {569 #[cfg(feature = "try-runtime")]570 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {571 Ok(())572 }573574 #[cfg(feature = "try-runtime")]575 pub fn post_migrate_to_v3() -> Result<(), &'static str> {576 use frame_support::dispatch::GetStorageVersion;577578 assert!(Self::current_storage_version() == 3);579 for k in Agenda::<T>::iter_keys() {580 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;581 }582 Ok(())583 }584585 /// Helper to migrate scheduler when the pallet origin type has changed.586 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {587 Agenda::<T>::translate::<588 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,589 _,590 >(|_, agenda| {591 Some(592 agenda593 .into_iter()594 .map(|schedule| {595 schedule.map(|schedule| Scheduled {596 maybe_id: schedule.maybe_id,597 priority: schedule.priority,598 call: schedule.call,599 maybe_periodic: schedule.maybe_periodic,600 origin: schedule.origin.into(),601 _phantom: Default::default(),602 })603 })604 .collect::<Vec<_>>(),605 )606 });607 }608609 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {610 let now = frame_system::Pallet::<T>::block_number();611612 let when = match when {613 DispatchTime::At(x) => x,614 // The current block has already completed it's scheduled tasks, so615 // Schedule the task at lest one block after this current block.616 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),617 };618619 if when <= now {620 return Err(Error::<T>::TargetBlockNumberInPast.into());621 }622623 Ok(when)624 }625626 fn do_schedule_named(627 id: ScheduledId,628 when: DispatchTime<T::BlockNumber>,629 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,630 priority: schedule::Priority,631 origin: T::PalletsOrigin,632 call: CallOrHashOf<T>,633 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {634 // ensure id it is unique635 if Lookup::<T>::contains_key(&id) {636 return Err(Error::<T>::FailedToSchedule)?;637 }638639 let when = Self::resolve_time(when)?;640641 call.ensure_requested::<T::PreimageProvider>();642643 // sanitize maybe_periodic644 let maybe_periodic = maybe_periodic645 .filter(|p| p.1 > 1 && !p.0.is_zero())646 // Remove one from the number of repetitions since we will schedule one now.647 .map(|(p, c)| (p, c - 1));648649 let s = Scheduled {650 maybe_id: Some(id.clone()),651 priority,652 call: call.clone(),653 maybe_periodic,654 origin: origin.clone(),655 _phantom: Default::default(),656 };657658 // reserve balance for periodic execution659 // let sender =660 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;661 // let repeats = match maybe_periodic {662 // Some(p) => p.1,663 // None => 1,664 // };665 // let _ = T::CallExecutor::reserve_balance(666 // id.clone(),667 // sender,668 // call.as_value().unwrap().clone(),669 // repeats,670 // );671672 Agenda::<T>::append(when, Some(s));673 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;674 let address = (when, index);675 Lookup::<T>::insert(&id, &address);676 Self::deposit_event(Event::Scheduled { when, index });677678 Ok(address)679 }680681 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {682 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {683 if let Some((when, index)) = lookup.take() {684 let i = index as usize;685 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {686 if let Some(s) = agenda.get_mut(i) {687 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {688 if matches!(689 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),690 Some(Ordering::Less) | None691 ) {692 return Err(BadOrigin.into());693 }694 // release balance reserve695 // let sender = ensure_signed(696 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(697 // origin.unwrap(),698 // )699 // .into(),700 // )?;701 // let _ = T::CallExecutor::cancel_reserve(id, sender);702703 s.call.ensure_unrequested::<T::PreimageProvider>();704 }705 *s = None;706 }707 Ok(())708 })?;709710 Self::deposit_event(Event::Canceled { when, index });711 Ok(())712 } else {713 Err(Error::<T>::NotFound)?714 }715 })716 }717}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//! 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.75//!76//! ## Interface77//!78//! ### Dispatchable Functions79//!80//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and81//! with a specified priority.82//! * `cancel` - cancel a scheduled dispatch, specified by block number and index.83//! * `schedule_named` - augments the `schedule` interface with an additional `Vec<u8>` parameter84//! that can be used for identification.85//! * `cancel_named` - the named complement to the cancel function.8687// Ensure we're `no_std` when compiling for Wasm.88#![cfg_attr(not(feature = "std"), no_std)]8990#[cfg(feature = "runtime-benchmarks")]91mod benchmarking;9293pub mod weights;9495use sp_core::H160;96use codec::{Codec, Decode, Encode};97use frame_system::{self as system, ensure_signed};98pub use pallet::*;99use scale_info::TypeInfo;100use sp_runtime::{101 traits::{BadOrigin, One, Saturating, Zero},102 RuntimeDebug, DispatchErrorWithPostInfo,103};104use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};105106use frame_support::{107 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},108 traits::{109 schedule::{self, DispatchTime, MaybeHashed},110 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,111 StorageVersion,112 },113 weights::{GetDispatchInfo, Weight},114};115116pub use weights::WeightInfo;117118/// Just a simple index for naming period tasks.119pub type PeriodicIndex = u32;120/// The location of a scheduled task that can be used to remove it.121pub type TaskAddress<BlockNumber> = (BlockNumber, u32);122pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;123124type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];125pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;126127/// Information regarding an item to be executed in the future.128#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]129#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]130pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {131 /// The unique identity for this task, if there is one.132 maybe_id: Option<ScheduledId>,133 /// This task's priority.134 priority: schedule::Priority,135 /// The call to be dispatched.136 call: Call,137 /// If the call is periodic, then this points to the information concerning that.138 maybe_periodic: Option<schedule::Period<BlockNumber>>,139 /// The origin to dispatch the call.140 origin: PalletsOrigin,141 _phantom: PhantomData<AccountId>,142}143144pub type ScheduledV3Of<T> = ScheduledV3<145 CallOrHashOf<T>,146 <T as frame_system::Config>::BlockNumber,147 <T as Config>::PalletsOrigin,148 <T as frame_system::Config>::AccountId,149>;150151pub type ScheduledOf<T> = ScheduledV3Of<T>;152153/// The current version of Scheduled struct.154pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =155 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;156157#[cfg(feature = "runtime-benchmarks")]158mod preimage_provider {159 use frame_support::traits::PreimageRecipient;160 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}161 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}162}163164#[cfg(not(feature = "runtime-benchmarks"))]165mod preimage_provider {166 use frame_support::traits::PreimageProvider;167 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}168 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}169}170171pub use preimage_provider::PreimageProviderAndMaybeRecipient;172173/// Weight templates for calculating actual fees174pub(crate) trait MarginalWeightInfo: WeightInfo {175 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {176 match (periodic, named, resolved) {177 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),178 (_, true, None) => {179 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)180 }181 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),182 (false, true, Some(false)) => {183 Self::on_initialize_named(2) - Self::on_initialize_named(1)184 }185 (true, false, Some(false)) => {186 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)187 }188 (true, true, Some(false)) => {189 Self::on_initialize_periodic_named_resolved(2)190 - Self::on_initialize_periodic_named_resolved(1)191 }192 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),193 (false, true, Some(true)) => {194 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)195 }196 (true, false, Some(true)) => {197 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)198 }199 (true, true, Some(true)) => {200 Self::on_initialize_periodic_named_resolved(2)201 - Self::on_initialize_periodic_named_resolved(1)202 }203 }204 }205}206impl<T: WeightInfo> MarginalWeightInfo for T {}207208#[frame_support::pallet]209pub mod pallet {210 use super::*;211 use frame_support::{212 dispatch::PostDispatchInfo,213 pallet_prelude::*,214 traits::{schedule::LookupError, PreimageProvider},215 };216 use frame_system::pallet_prelude::*;217218 /// The current storage version.219 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);220221 #[pallet::pallet]222 #[pallet::generate_store(pub(super) trait Store)]223 #[pallet::storage_version(STORAGE_VERSION)]224 #[pallet::without_storage_info]225 pub struct Pallet<T>(_);226227 /// `system::Config` should always be included in our implied traits.228 #[pallet::config]229 pub trait Config: frame_system::Config {230 /// The overarching event type.231 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;232233 /// The aggregated origin which the dispatch will take.234 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>235 + From<Self::PalletsOrigin>236 + IsType<<Self as system::Config>::Origin>;237238 /// The caller origin, overarching type of all pallets origins.239 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;240241 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;242243 /// The aggregated call type.244 type Call: Parameter245 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>246 + GetDispatchInfo247 + From<system::Call<Self>>;248249 /// The maximum weight that may be scheduled per block for any dispatchables of less250 /// priority than `schedule::HARD_DEADLINE`.251 #[pallet::constant]252 type MaximumWeight: Get<Weight>;253254 /// Required origin to schedule or cancel calls.255 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;256257 /// Compare the privileges of origins.258 ///259 /// This will be used when canceling a task, to ensure that the origin that tries260 /// to cancel has greater or equal privileges as the origin that created the scheduled task.261 ///262 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can263 /// be used. This will only check if two given origins are equal.264 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;265266 /// The maximum number of scheduled calls in the queue for a single block.267 /// Not strictly enforced, but used for weight estimation.268 #[pallet::constant]269 type MaxScheduledPerBlock: Get<u32>;270271 /// Weight information for extrinsics in this pallet.272 type WeightInfo: WeightInfo;273274 /// The preimage provider with which we look up call hashes to get the call.275 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;276277 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.278 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;279280 /// Sponsoring function. In this version sposorship is disabled281 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;282283 /// The helper type used for custom transaction fee logic.284 type CallExecutor: DispatchCall<Self, H160>;285 }286287 /// A Scheduler-Runtime interface for finer payment handling.288 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {289 /// Lock balance required for transaction payment290 fn reserve_balance(291 id: ScheduledId,292 sponsor: <T as frame_system::Config>::AccountId,293 call: <T as Config>::Call,294 count: u32,295 ) -> Result<(), DispatchError>;296297 /// Unlock centain amount from payer298 fn pay_for_call(299 id: ScheduledId,300 sponsor: <T as frame_system::Config>::AccountId,301 call: <T as Config>::Call,302 ) -> Result<u128, DispatchError>;303304 /// Resolve the call dispatch, including any post-dispatch operations.305 fn dispatch_call(306 signer: T::AccountId,307 function: <T as Config>::Call,308 ) -> Result<309 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,310 TransactionValidityError,311 >;312313 /// Cancel schedule reservation and unlock balance314 fn cancel_reserve(315 id: ScheduledId,316 sponsor: <T as frame_system::Config>::AccountId,317 ) -> Result<u128, DispatchError>;318 }319320 /// Items to be executed, indexed by the block number that they should be executed on.321 #[pallet::storage]322 pub type Agenda<T: Config> =323 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;324325 /// Lookup from identity to the block number and index of the task.326 #[pallet::storage]327 pub(crate) type Lookup<T: Config> =328 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;329330 /// Events type.331 #[pallet::event]332 #[pallet::generate_deposit(pub(super) fn deposit_event)]333 pub enum Event<T: Config> {334 /// Scheduled some task.335 Scheduled { when: T::BlockNumber, index: u32 },336 /// Canceled some task.337 Canceled { when: T::BlockNumber, index: u32 },338 /// Dispatched some task.339 Dispatched {340 task: TaskAddress<T::BlockNumber>,341 id: Option<ScheduledId>,342 result: DispatchResult,343 },344 /// The call for the provided hash was not found so the task has been aborted.345 CallLookupFailed {346 task: TaskAddress<T::BlockNumber>,347 id: Option<ScheduledId>,348 error: LookupError,349 },350 }351352 #[pallet::error]353 pub enum Error<T> {354 /// Failed to schedule a call355 FailedToSchedule,356 /// Cannot find the scheduled call.357 NotFound,358 /// Given target block number is in the past.359 TargetBlockNumberInPast,360 /// Reschedule failed because it does not change scheduled time.361 RescheduleNoChange,362 }363364 #[pallet::hooks]365 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {366 /// Execute the scheduled calls367 fn on_initialize(now: T::BlockNumber) -> Weight {368 let limit = T::MaximumWeight::get();369370 let mut queued = Agenda::<T>::take(now)371 .into_iter()372 .enumerate()373 .filter_map(|(index, s)| Some((index as u32, s?)))374 .collect::<Vec<_>>();375376 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {377 log::warn!(378 target: "runtime::scheduler",379 "Warning: This block has more items queued in Scheduler than \380 expected from the runtime configuration. An update might be needed."381 );382 }383384 queued.sort_by_key(|(_, s)| s.priority);385386 let next = now + One::one();387388 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);389 for (order, (index, mut s)) in queued.into_iter().enumerate() {390 let named = if let Some(ref id) = s.maybe_id {391 Lookup::<T>::remove(id);392 true393 } else {394 false395 };396397 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();398 s.call = call;399400 let resolved = if let Some(completed) = maybe_completed {401 T::PreimageProvider::unrequest_preimage(&completed);402 true403 } else {404 false405 };406 let call = match s.call.as_value().cloned() {407 Some(c) => c,408 None => {409 // Preimage not available - postpone until some block.410 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));411 if let Some(delay) = T::NoPreimagePostponement::get() {412 let until = now.saturating_add(delay);413 if let Some(ref id) = s.maybe_id {414 let index = Agenda::<T>::decode_len(until).unwrap_or(0);415 Lookup::<T>::insert(id, (until, index as u32));416 }417 Agenda::<T>::append(until, Some(s));418 }419 continue;420 }421 };422423 let periodic = s.maybe_periodic.is_some();424 let call_weight = call.get_dispatch_info().weight;425 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));426 let origin =427 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())428 .into();429 if ensure_signed(origin).is_ok() {430 // Weights of Signed dispatches expect their signing account to be whitelisted.431 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));432 }433434 // We allow a scheduled call if any is true:435 // - It's priority is `HARD_DEADLINE`436 // - It does not push the weight past the limit.437 // - It is the first item in the schedule438 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;439 let test_weight = total_weight440 .saturating_add(call_weight)441 .saturating_add(item_weight);442 if !hard_deadline && order > 0 && test_weight > limit {443 // Cannot be scheduled this block - postpone until next.444 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));445 if let Some(ref id) = s.maybe_id {446 // NOTE: We could reasonably not do this (in which case there would be one447 // block where the named and delayed item could not be referenced by name),448 // but we will do it anyway since it should be mostly free in terms of449 // weight and it is slightly cleaner.450 let index = Agenda::<T>::decode_len(next).unwrap_or(0);451 Lookup::<T>::insert(id, (next, index as u32));452 }453 Agenda::<T>::append(next, Some(s));454 continue;455 }456457 // Sender is the account who signed transaction458 let sender = ensure_signed(459 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())460 .into(),461 )462 .unwrap();463464 // // if call have id it was be reserved465 // if s.maybe_id.is_some() {466 // let _ = T::CallExecutor::pay_for_call(467 // s.maybe_id.unwrap(),468 // sender.clone(),469 // call.clone(),470 // );471 // }472473 // Execute transaction via chain default pipeline474 let r = T::CallExecutor::dispatch_call(sender, call.clone());475476 let mut actual_call_weight: Weight = item_weight;477 let result: Result<_, DispatchError> = match r {478 Ok(o) => match o {479 Ok(di) => {480 actual_call_weight = di.actual_weight.unwrap_or(item_weight);481 Ok(())482 }483 Err(err) => Err(err.error),484 },485 Err(_) => {486 log::error!(487 target: "runtime::scheduler",488 "Warning: Scheduler has failed to execute a post-dispatch transaction. \489 This block might have become invalid.");490 Err(DispatchError::CannotLookup)491 } // todo possibly force a skip/return here, do something with the error492 };493494 total_weight.saturating_accrue(item_weight);495 total_weight.saturating_accrue(actual_call_weight);496497 Self::deposit_event(Event::Dispatched {498 task: (now, index),499 id: s.maybe_id.clone(),500 result,501 });502503 if let &Some((period, count)) = &s.maybe_periodic {504 if count > 1 {505 s.maybe_periodic = Some((period, count - 1));506 } else {507 s.maybe_periodic = None;508 }509 let wake = now + period;510 // If scheduled is named, place its information in `Lookup`511 if let Some(ref id) = s.maybe_id {512 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);513 Lookup::<T>::insert(id, (wake, wake_index as u32));514 }515 Agenda::<T>::append(wake, Some(s));516 }517 }518 /// Weight should be 0, because transaction already paid519 0520 }521 }522523 #[pallet::call]524 impl<T: Config> Pallet<T> {525 /// Schedule a named task.526 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]527 pub fn schedule_named(528 origin: OriginFor<T>,529 id: ScheduledId,530 when: T::BlockNumber,531 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,532 priority: schedule::Priority,533 call: Box<CallOrHashOf<T>>,534 ) -> DispatchResult {535 T::ScheduleOrigin::ensure_origin(origin.clone())?;536 let origin = <T as Config>::Origin::from(origin);537 Self::do_schedule_named(538 id,539 DispatchTime::At(when),540 maybe_periodic,541 priority,542 origin.caller().clone(),543 *call,544 )?;545 Ok(())546 }547548 /// Cancel a named scheduled task.549 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]550 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {551 T::ScheduleOrigin::ensure_origin(origin.clone())?;552 let origin = <T as Config>::Origin::from(origin);553 Self::do_cancel_named(Some(origin.caller().clone()), id)?;554 Ok(())555 }556557 /// Schedule a named task after a delay.558 ///559 /// # <weight>560 /// Same as [`schedule_named`](Self::schedule_named).561 /// # </weight>562 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]563 pub fn schedule_named_after(564 origin: OriginFor<T>,565 id: ScheduledId,566 after: T::BlockNumber,567 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,568 priority: schedule::Priority,569 call: Box<CallOrHashOf<T>>,570 ) -> DispatchResult {571 T::ScheduleOrigin::ensure_origin(origin.clone())?;572 let origin = <T as Config>::Origin::from(origin);573 Self::do_schedule_named(574 id,575 DispatchTime::After(after),576 maybe_periodic,577 priority,578 origin.caller().clone(),579 *call,580 )?;581 Ok(())582 }583 }584}585586impl<T: Config> Pallet<T> {587 #[cfg(feature = "try-runtime")]588 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {589 Ok(())590 }591592 #[cfg(feature = "try-runtime")]593 pub fn post_migrate_to_v3() -> Result<(), &'static str> {594 use frame_support::dispatch::GetStorageVersion;595596 assert!(Self::current_storage_version() == 3);597 for k in Agenda::<T>::iter_keys() {598 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;599 }600 Ok(())601 }602603 /// Helper to migrate scheduler when the pallet origin type has changed.604 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {605 Agenda::<T>::translate::<606 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,607 _,608 >(|_, agenda| {609 Some(610 agenda611 .into_iter()612 .map(|schedule| {613 schedule.map(|schedule| Scheduled {614 maybe_id: schedule.maybe_id,615 priority: schedule.priority,616 call: schedule.call,617 maybe_periodic: schedule.maybe_periodic,618 origin: schedule.origin.into(),619 _phantom: Default::default(),620 })621 })622 .collect::<Vec<_>>(),623 )624 });625 }626627 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {628 let now = frame_system::Pallet::<T>::block_number();629630 let when = match when {631 DispatchTime::At(x) => x,632 // The current block has already completed it's scheduled tasks, so633 // Schedule the task at lest one block after this current block.634 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),635 };636637 if when <= now {638 return Err(Error::<T>::TargetBlockNumberInPast.into());639 }640641 Ok(when)642 }643644 fn do_schedule_named(645 id: ScheduledId,646 when: DispatchTime<T::BlockNumber>,647 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,648 priority: schedule::Priority,649 origin: T::PalletsOrigin,650 call: CallOrHashOf<T>,651 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {652 // ensure id it is unique653 if Lookup::<T>::contains_key(&id) {654 return Err(Error::<T>::FailedToSchedule)?;655 }656657 let when = Self::resolve_time(when)?;658659 call.ensure_requested::<T::PreimageProvider>();660661 // sanitize maybe_periodic662 let maybe_periodic = maybe_periodic663 .filter(|p| p.1 > 1 && !p.0.is_zero())664 // Remove one from the number of repetitions since we will schedule one now.665 .map(|(p, c)| (p, c - 1));666667 let s = Scheduled {668 maybe_id: Some(id.clone()),669 priority,670 call: call.clone(),671 maybe_periodic,672 origin: origin.clone(),673 _phantom: Default::default(),674 };675676 // reserve balance for periodic execution677 // let sender =678 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;679 // let repeats = match maybe_periodic {680 // Some(p) => p.1,681 // None => 1,682 // };683 // let _ = T::CallExecutor::reserve_balance(684 // id.clone(),685 // sender,686 // call.as_value().unwrap().clone(),687 // repeats,688 // );689690 Agenda::<T>::append(when, Some(s));691 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;692 let address = (when, index);693 Lookup::<T>::insert(&id, &address);694 Self::deposit_event(Event::Scheduled { when, index });695696 Ok(address)697 }698699 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {700 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {701 if let Some((when, index)) = lookup.take() {702 let i = index as usize;703 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {704 if let Some(s) = agenda.get_mut(i) {705 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {706 if matches!(707 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),708 Some(Ordering::Less) | None709 ) {710 return Err(BadOrigin.into());711 }712 // release balance reserve713 // let sender = ensure_signed(714 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(715 // origin.unwrap(),716 // )717 // .into(),718 // )?;719 // let _ = T::CallExecutor::cancel_reserve(id, sender);720721 s.call.ensure_unrequested::<T::PreimageProvider>();722 }723 *s = None;724 }725 Ok(())726 })?;727728 Self::deposit_event(Event::Canceled { when, index });729 Ok(())730 } else {731 Err(Error::<T>::NotFound)?732 }733 })734 }735}