difftreelog
fix cargo fmt
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.0>28//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//! should be named and may be canceled.47//!48//! **NOTE:** The unique scheduler is designed for deferred transaction calls by block number.49//! Any user can book a call of a certain transaction to a specific block number.50//! Also possible to book a call with a certain frequency.51//!52//! Key differences from the original pallet:53//! <https://crates.io/crates/pallet-scheduler>54//! Schedule Id restricted by 16 bytes. Identificator for booked call.55//! Priority limited by HARD DEADLINE (<= 63). Calls over maximum weight don't include to block.56//! The maximum weight that may be scheduled per block for any dispatchables of less priority than `schedule::HARD_DEADLINE`.57//! Maybe_periodic limit is 100 calls. Reserved for future sponsored transaction support.58//! At 100 calls reserved amount is not so much and this is avoid potential problems with balance locks.59//! Any account allowed to schedule any calls. Account withdraw implemented through default transaction logic.60//!61//! ## Interface62//!63//! ### Dispatchable Functions64//!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, UnfilteredDispatchable, Parameter, GetDispatchInfo},90 traits::{91 schedule::{self, DispatchTime, MaybeHashed},92 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,93 StorageVersion,94 },95 weights::{Weight},96};9798pub use weights::WeightInfo;99100/// The location of a scheduled task that can be used to remove it.101pub type TaskAddress<BlockNumber> = (BlockNumber, u32);102pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;103104pub type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];105pub type CallOrHashOf<T> =106 MaybeHashed<<T as Config>::RuntimeCall, <T as frame_system::Config>::Hash>;107108/// Information regarding an item to be executed in the future.109#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]110#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]111pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {112 /// The unique identity for this task, if there is one.113 maybe_id: Option<ScheduledId>,114 /// This task's priority.115 priority: schedule::Priority,116 /// The call to be dispatched.117 call: Call,118 /// If the call is periodic, then this points to the information concerning that.119 maybe_periodic: Option<schedule::Period<BlockNumber>>,120 /// The origin to dispatch the call.121 origin: PalletsOrigin,122 _phantom: PhantomData<AccountId>,123}124125pub type ScheduledV3Of<T> = ScheduledV3<126 CallOrHashOf<T>,127 <T as frame_system::Config>::BlockNumber,128 <T as Config>::PalletsOrigin,129 <T as frame_system::Config>::AccountId,130>;131132pub type ScheduledOf<T> = ScheduledV3Of<T>;133134/// The current version of Scheduled struct.135pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =136 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;137138pub enum ScheduledEnsureOriginSuccess<AccountId> {139 Root,140 Signed(AccountId),141 Unsigned,142}143144#[cfg(feature = "runtime-benchmarks")]145mod preimage_provider {146 use frame_support::traits::PreimageRecipient;147 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}148 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}149}150151#[cfg(not(feature = "runtime-benchmarks"))]152mod preimage_provider {153 use frame_support::traits::PreimageProvider;154 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}155 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}156}157158pub use preimage_provider::PreimageProviderAndMaybeRecipient;159160pub(crate) trait MarginalWeightInfo: WeightInfo {161 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {162 match (periodic, named, resolved) {163 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),164 (_, true, None) => {165 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)166 }167 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),168 (false, true, Some(false)) => {169 Self::on_initialize_named(2) - Self::on_initialize_named(1)170 }171 (true, false, Some(false)) => {172 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)173 }174 (true, true, Some(false)) => {175 Self::on_initialize_periodic_named_resolved(2)176 - Self::on_initialize_periodic_named_resolved(1)177 }178 (false, false, Some(true)) => Self::on_initialize(2) - Self::on_initialize(1),179 (false, true, Some(true)) => {180 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)181 }182 (true, false, Some(true)) => {183 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)184 }185 (true, true, Some(true)) => {186 Self::on_initialize_periodic_named_resolved(2)187 - Self::on_initialize_periodic_named_resolved(1)188 }189 }190 }191}192impl<T: WeightInfo> MarginalWeightInfo for T {}193194#[frame_support::pallet]195pub mod pallet {196 use super::*;197 use frame_support::{198 dispatch::PostDispatchInfo,199 pallet_prelude::*,200 traits::{201 schedule::{LookupError, LOWEST_PRIORITY},202 PreimageProvider,203 },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 RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;221222 /// The aggregated origin which the dispatch will take.223 type RuntimeOrigin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>224 + From<Self::PalletsOrigin>225 + IsType<<Self as system::Config>::RuntimeOrigin>;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 RuntimeCall: Parameter234 + Dispatchable<RuntimeOrigin = <Self as Config>::RuntimeOrigin, PostInfo = PostDispatchInfo>235 + UnfilteredDispatchable<RuntimeOrigin = <Self as system::Config>::RuntimeOrigin>236 + GetDispatchInfo237 + From<system::Call<Self>>;238239 /// The maximum weight that may be scheduled per block for any dispatchables of less240 /// priority than `schedule::HARD_DEADLINE`.241 #[pallet::constant]242 type MaximumWeight: Get<Weight>;243244 /// Required origin to schedule or cancel calls.245 type ScheduleOrigin: EnsureOrigin<246 <Self as system::Config>::RuntimeOrigin,247 Success = ScheduledEnsureOriginSuccess<Self::AccountId>,248 >;249250 /// Required origin to set/change calls' priority.251 type PrioritySetOrigin: EnsureOrigin<<Self as system::Config>::RuntimeOrigin>;252253 /// Compare the privileges of origins.254 ///255 /// This will be used when canceling a task, to ensure that the origin that tries256 /// to cancel has greater or equal privileges as the origin that created the scheduled task.257 ///258 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can259 /// be used. This will only check if two given origins are equal.260 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;261262 /// The maximum number of scheduled calls in the queue for a single block.263 /// Not strictly enforced, but used for weight estimation.264 #[pallet::constant]265 type MaxScheduledPerBlock: Get<u32>;266267 /// Weight information for extrinsics in this pallet.268 type WeightInfo: WeightInfo;269270 /// The preimage provider with which we look up call hashes to get the call.271 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;272273 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.274 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;275276 /// Sponsoring function.277 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;278279 /// The helper type used for custom transaction fee logic.280 type CallExecutor: DispatchCall<Self, H160>;281 }282283 /// A Scheduler-Runtime interface for finer payment handling.284 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {285 /// Reserve (lock) the maximum spendings on a call, calculated from its weight and the repetition count.286 fn reserve_balance(287 id: ScheduledId,288 sponsor: <T as frame_system::Config>::AccountId,289 call: <T as Config>::RuntimeCall,290 count: u32,291 ) -> Result<(), DispatchError>;292293 /// Unreserve (unlock) a certain amount from the payer's reserved funds, returning the change.294 fn pay_for_call(295 id: ScheduledId,296 sponsor: <T as frame_system::Config>::AccountId,297 call: <T as Config>::RuntimeCall,298 ) -> Result<u128, DispatchError>;299300 /// Resolve the call dispatch, including any post-dispatch operations.301 fn dispatch_call(302 signer: Option<T::AccountId>,303 function: <T as Config>::RuntimeCall,304 ) -> Result<305 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,306 TransactionValidityError,307 >;308309 /// Release unspent reserved funds in case of a schedule cancel.310 fn cancel_reserve(311 id: ScheduledId,312 sponsor: <T as frame_system::Config>::AccountId,313 ) -> Result<u128, DispatchError>;314 }315316 /// Items to be executed, indexed by the block number that they should be executed on.317 #[pallet::storage]318 pub type Agenda<T: Config> =319 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;320321 /// Lookup from identity to the block number and index of the task.322 #[pallet::storage]323 pub(crate) type Lookup<T: Config> =324 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;325326 /// Events type.327 #[pallet::event]328 #[pallet::generate_deposit(pub(super) fn deposit_event)]329 pub enum Event<T: Config> {330 /// Scheduled some task.331 Scheduled { when: T::BlockNumber, index: u32 },332 /// Canceled some task.333 Canceled { when: T::BlockNumber, index: u32 },334 /// Scheduled task's priority has changed335 PriorityChanged {336 when: T::BlockNumber,337 index: u32,338 priority: schedule::Priority,339 },340 /// Dispatched some task.341 Dispatched {342 task: TaskAddress<T::BlockNumber>,343 id: Option<ScheduledId>,344 result: DispatchResult,345 },346 /// The call for the provided hash was not found so the task has been aborted.347 CallLookupFailed {348 task: TaskAddress<T::BlockNumber>,349 id: Option<ScheduledId>,350 error: LookupError,351 },352 }353354 #[pallet::error]355 pub enum Error<T> {356 /// Failed to schedule a call357 FailedToSchedule,358 /// Cannot find the scheduled call.359 NotFound,360 /// Given target block number is in the past.361 TargetBlockNumberInPast,362 /// Reschedule failed because it does not change scheduled time.363 RescheduleNoChange,364 }365366 #[pallet::hooks]367 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {368 /// Execute the scheduled calls369 fn on_initialize(now: T::BlockNumber) -> Weight {370 let limit = T::MaximumWeight::get();371372 let mut queued = Agenda::<T>::take(now)373 .into_iter()374 .enumerate()375 .filter_map(|(index, s)| Some((index as u32, s?)))376 .collect::<Vec<_>>();377378 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {379 log::warn!(380 target: "runtime::scheduler",381 "Warning: This block has more items queued in Scheduler than \382 expected from the runtime configuration. An update might be needed."383 );384 }385386 queued.sort_by_key(|(_, s)| s.priority);387388 let next = now + One::one();389390 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);391 for (order, (index, mut s)) in queued.into_iter().enumerate() {392 let named = s.maybe_id.is_some();393394 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();395 s.call = call;396397 let resolved = if let Some(completed) = maybe_completed {398 T::PreimageProvider::unrequest_preimage(&completed);399 true400 } else {401 false402 };403 let call = match s.call.as_value().cloned() {404 Some(c) => c,405 None => {406 // Preimage not available - postpone until some block.407 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));408 if let Some(delay) = T::NoPreimagePostponement::get() {409 let until = now.saturating_add(delay);410 if let Some(ref id) = s.maybe_id {411 let index = Agenda::<T>::decode_len(until).unwrap_or(0);412 Lookup::<T>::insert(id, (until, index as u32));413 }414 Agenda::<T>::append(until, Some(s));415 } else if let Some(ref id) = s.maybe_id {416 Lookup::<T>::remove(id);417 }418 continue;419 }420 };421422 let periodic = s.maybe_periodic.is_some();423 let call_weight = call.get_dispatch_info().weight;424 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));425 let origin = <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(426 s.origin.clone(),427 )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.all_gt(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 let scheduled_origin =458 <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(s.origin.clone());459 let ensured_origin = T::ScheduleOrigin::ensure_origin(scheduled_origin.into());460461 let r = match ensured_origin {462 Ok(ScheduledEnsureOriginSuccess::Root) => {463 Ok(call.dispatch_bypass_filter(frame_system::RawOrigin::Root.into()))464 }465 Ok(ScheduledEnsureOriginSuccess::Signed(sender)) => {466 // Execute transaction via chain default pipeline467 // That means dispatch will be processed like any user's extrinsic e.g. transaction fees will be taken468 T::CallExecutor::dispatch_call(Some(sender), call.clone())469 }470 Ok(ScheduledEnsureOriginSuccess::Unsigned) => {471 // Unsigned version of the above472 T::CallExecutor::dispatch_call(None, call.clone())473 }474 Err(e) => Ok(Err(e.into())),475 };476477 let mut actual_call_weight: Weight = item_weight;478 let result: Result<_, DispatchError> = match r {479 Ok(o) => match o {480 Ok(di) => {481 actual_call_weight = di.actual_weight.unwrap_or(item_weight);482 Ok(())483 }484 Err(err) => Err(err.error),485 },486 Err(_) => {487 log::error!(488 target: "runtime::scheduler",489 "Warning: Scheduler has failed to execute a post-dispatch transaction. \490 This block might have become invalid.");491 Err(DispatchError::CannotLookup)492 } // todo possibly force a skip/return here, do something with the error493 };494495 total_weight.saturating_accrue(item_weight);496 total_weight.saturating_accrue(actual_call_weight);497498 Self::deposit_event(Event::Dispatched {499 task: (now, index),500 id: s.maybe_id.clone(),501 result,502 });503504 if let &Some((period, count)) = &s.maybe_periodic {505 if count > 1 {506 s.maybe_periodic = Some((period, count - 1));507 } else {508 s.maybe_periodic = None;509 }510 let wake = now + period;511 let is_canceled;512513 // If scheduled is named, place its information in `Lookup`514 if let Some(ref id) = s.maybe_id {515 is_canceled = Lookup::<T>::get(id).is_none();516 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);517518 if !is_canceled {519 Lookup::<T>::insert(id, (wake, wake_index as u32));520 }521 } else {522 is_canceled = false;523 }524525 if !is_canceled {526 Agenda::<T>::append(wake, Some(s));527 }528 } else if let Some(ref id) = s.maybe_id {529 Lookup::<T>::remove(id);530 }531 }532 total_weight533 }534 }535536 #[pallet::call]537 impl<T: Config> Pallet<T> {538 /// Schedule a named task.539 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]540 pub fn schedule_named(541 origin: OriginFor<T>,542 id: ScheduledId,543 when: T::BlockNumber,544 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,545 priority: Option<schedule::Priority>,546 call: Box<CallOrHashOf<T>>,547 ) -> DispatchResult {548 T::ScheduleOrigin::ensure_origin(origin.clone())?;549550 if priority.is_some() {551 T::PrioritySetOrigin::ensure_origin(origin.clone())?;552 }553554 let origin = <T as Config>::RuntimeOrigin::from(origin);555 Self::do_schedule_named(556 id,557 DispatchTime::At(when),558 maybe_periodic,559 priority.unwrap_or(LOWEST_PRIORITY),560 origin.caller().clone(),561 *call,562 )?;563 Ok(())564 }565566 /// Cancel a named scheduled task.567 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]568 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {569 T::ScheduleOrigin::ensure_origin(origin.clone())?;570 let origin = <T as Config>::RuntimeOrigin::from(origin);571 Self::do_cancel_named(Some(origin.caller().clone()), id)?;572 Ok(())573 }574575 /// Schedule a named task after a delay.576 ///577 /// # <weight>578 /// Same as [`schedule_named`](Self::schedule_named).579 /// # </weight>580 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]581 pub fn schedule_named_after(582 origin: OriginFor<T>,583 id: ScheduledId,584 after: T::BlockNumber,585 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,586 priority: Option<schedule::Priority>,587 call: Box<CallOrHashOf<T>>,588 ) -> DispatchResult {589 T::ScheduleOrigin::ensure_origin(origin.clone())?;590591 if priority.is_some() {592 T::PrioritySetOrigin::ensure_origin(origin.clone())?;593 }594595 let origin = <T as Config>::RuntimeOrigin::from(origin);596 Self::do_schedule_named(597 id,598 DispatchTime::After(after),599 maybe_periodic,600 priority.unwrap_or(LOWEST_PRIORITY),601 origin.caller().clone(),602 *call,603 )?;604 Ok(())605 }606607 #[pallet::weight(<T as Config>::WeightInfo::change_named_priority(T::MaxScheduledPerBlock::get()))]608 pub fn change_named_priority(609 origin: OriginFor<T>,610 id: ScheduledId,611 priority: schedule::Priority,612 ) -> DispatchResult {613 T::PrioritySetOrigin::ensure_origin(origin.clone())?;614 let origin = <T as Config>::RuntimeOrigin::from(origin);615 Self::do_change_named_priority(origin.caller().clone(), id, priority)616 }617 }618}619620impl<T: Config> Pallet<T> {621 #[cfg(feature = "try-runtime")]622 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {623 Ok(())624 }625626 #[cfg(feature = "try-runtime")]627 pub fn post_migrate_to_v3() -> Result<(), &'static str> {628 use frame_support::dispatch::GetStorageVersion;629630 assert!(Self::current_storage_version() == 3);631 for k in Agenda::<T>::iter_keys() {632 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;633 }634 Ok(())635 }636637 /// Helper to migrate scheduler when the pallet origin type has changed.638 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {639 Agenda::<T>::translate::<640 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,641 _,642 >(|_, agenda| {643 Some(644 agenda645 .into_iter()646 .map(|schedule| {647 schedule.map(|schedule| Scheduled {648 maybe_id: schedule.maybe_id,649 priority: schedule.priority,650 call: schedule.call,651 maybe_periodic: schedule.maybe_periodic,652 origin: schedule.origin.into(),653 _phantom: Default::default(),654 })655 })656 .collect::<Vec<_>>(),657 )658 });659 }660661 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {662 let now = frame_system::Pallet::<T>::block_number();663664 let when = match when {665 DispatchTime::At(x) => x,666 // The current block has already completed it's scheduled tasks, so667 // Schedule the task at lest one block after this current block.668 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),669 };670671 if when <= now {672 return Err(Error::<T>::TargetBlockNumberInPast.into());673 }674675 Ok(when)676 }677678 fn do_schedule_named(679 id: ScheduledId,680 when: DispatchTime<T::BlockNumber>,681 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,682 priority: schedule::Priority,683 origin: T::PalletsOrigin,684 call: CallOrHashOf<T>,685 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {686 // ensure id it is unique687 if Lookup::<T>::contains_key(&id) {688 return Err(Error::<T>::FailedToSchedule)?;689 }690691 let when = Self::resolve_time(when)?;692693 call.ensure_requested::<T::PreimageProvider>();694695 // sanitize maybe_periodic696 let maybe_periodic = maybe_periodic697 .filter(|p| p.1 > 1 && !p.0.is_zero())698 // Remove one from the number of repetitions since we will schedule one now.699 .map(|(p, c)| (p, c - 1));700701 let s = Scheduled {702 maybe_id: Some(id.clone()),703 priority,704 call: call.clone(),705 maybe_periodic,706 origin: origin.clone(),707 _phantom: Default::default(),708 };709710 // reserve balance for periodic execution711 // let sender =712 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;713 // let repeats = match maybe_periodic {714 // Some(p) => p.1,715 // None => 1,716 // };717 // let _ = T::CallExecutor::reserve_balance(718 // id.clone(),719 // sender,720 // call.as_value().unwrap().clone(),721 // repeats,722 // );723724 Agenda::<T>::append(when, Some(s));725 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;726 let address = (when, index);727 Lookup::<T>::insert(&id, &address);728 Self::deposit_event(Event::Scheduled { when, index });729730 Ok(address)731 }732733 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {734 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {735 if let Some((when, index)) = lookup.take() {736 let i = index as usize;737 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {738 if let Some(s) = agenda.get_mut(i) {739 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {740 if matches!(741 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),742 Some(Ordering::Less) | None743 ) {744 return Err(BadOrigin.into());745 }746 // release balance reserve747 // let sender = ensure_signed(748 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(749 // origin.unwrap(),750 // )751 // .into(),752 // )?;753 // let _ = T::CallExecutor::cancel_reserve(id, sender);754755 s.call.ensure_unrequested::<T::PreimageProvider>();756 }757 *s = None;758 }759 Ok(())760 })?;761762 Self::deposit_event(Event::Canceled { when, index });763 Ok(())764 } else {765 Err(Error::<T>::NotFound)?766 }767 })768 }769770 fn do_change_named_priority(771 origin: T::PalletsOrigin,772 id: ScheduledId,773 priority: schedule::Priority,774 ) -> DispatchResult {775 match Lookup::<T>::get(id) {776 Some((when, index)) => {777 let i = index as usize;778 Agenda::<T>::try_mutate(when, |agenda| {779 if let Some(Some(s)) = agenda.get_mut(i) {780 if matches!(781 T::OriginPrivilegeCmp::cmp_privilege(&origin, &s.origin),782 Some(Ordering::Less) | None783 ) {784 return Err(BadOrigin.into());785 }786787 s.priority = priority;788 Self::deposit_event(Event::PriorityChanged {789 when,790 index,791 priority,792 });793 }794 Ok(())795 })796 }797 None => Err(Error::<T>::NotFound.into()),798 }799 }800}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.0>28//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//! should be named and may be canceled.47//!48//! **NOTE:** The unique scheduler is designed for deferred transaction calls by block number.49//! Any user can book a call of a certain transaction to a specific block number.50//! Also possible to book a call with a certain frequency.51//!52//! Key differences from the original pallet:53//! <https://crates.io/crates/pallet-scheduler>54//! Schedule Id restricted by 16 bytes. Identificator for booked call.55//! Priority limited by HARD DEADLINE (<= 63). Calls over maximum weight don't include to block.56//! The maximum weight that may be scheduled per block for any dispatchables of less priority than `schedule::HARD_DEADLINE`.57//! Maybe_periodic limit is 100 calls. Reserved for future sponsored transaction support.58//! At 100 calls reserved amount is not so much and this is avoid potential problems with balance locks.59//! Any account allowed to schedule any calls. Account withdraw implemented through default transaction logic.60//!61//! ## Interface62//!63//! ### Dispatchable Functions64//!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::{90 DispatchError, DispatchResult, Dispatchable, UnfilteredDispatchable, Parameter,91 GetDispatchInfo,92 },93 traits::{94 schedule::{self, DispatchTime, MaybeHashed},95 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,96 StorageVersion,97 },98 weights::{Weight},99};100101pub use weights::WeightInfo;102103/// The location of a scheduled task that can be used to remove it.104pub type TaskAddress<BlockNumber> = (BlockNumber, u32);105pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;106107pub type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];108pub type CallOrHashOf<T> =109 MaybeHashed<<T as Config>::RuntimeCall, <T as frame_system::Config>::Hash>;110111/// Information regarding an item to be executed in the future.112#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]113#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]114pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {115 /// The unique identity for this task, if there is one.116 maybe_id: Option<ScheduledId>,117 /// This task's priority.118 priority: schedule::Priority,119 /// The call to be dispatched.120 call: Call,121 /// If the call is periodic, then this points to the information concerning that.122 maybe_periodic: Option<schedule::Period<BlockNumber>>,123 /// The origin to dispatch the call.124 origin: PalletsOrigin,125 _phantom: PhantomData<AccountId>,126}127128pub type ScheduledV3Of<T> = ScheduledV3<129 CallOrHashOf<T>,130 <T as frame_system::Config>::BlockNumber,131 <T as Config>::PalletsOrigin,132 <T as frame_system::Config>::AccountId,133>;134135pub type ScheduledOf<T> = ScheduledV3Of<T>;136137/// The current version of Scheduled struct.138pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =139 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;140141pub enum ScheduledEnsureOriginSuccess<AccountId> {142 Root,143 Signed(AccountId),144 Unsigned,145}146147#[cfg(feature = "runtime-benchmarks")]148mod preimage_provider {149 use frame_support::traits::PreimageRecipient;150 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}151 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}152}153154#[cfg(not(feature = "runtime-benchmarks"))]155mod preimage_provider {156 use frame_support::traits::PreimageProvider;157 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}158 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}159}160161pub use preimage_provider::PreimageProviderAndMaybeRecipient;162163pub(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::{204 schedule::{LookupError, LOWEST_PRIORITY},205 PreimageProvider,206 },207 };208 use frame_system::pallet_prelude::*;209210 /// The current storage version.211 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);212213 #[pallet::pallet]214 #[pallet::generate_store(pub(super) trait Store)]215 #[pallet::storage_version(STORAGE_VERSION)]216 #[pallet::without_storage_info]217 pub struct Pallet<T>(_);218219 /// `system::Config` should always be included in our implied traits.220 #[pallet::config]221 pub trait Config: frame_system::Config {222 /// The overarching event type.223 type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;224225 /// The aggregated origin which the dispatch will take.226 type RuntimeOrigin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>227 + From<Self::PalletsOrigin>228 + IsType<<Self as system::Config>::RuntimeOrigin>;229230 /// The caller origin, overarching type of all pallets origins.231 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;232233 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;234235 /// The aggregated call type.236 type RuntimeCall: Parameter237 + Dispatchable<238 RuntimeOrigin = <Self as Config>::RuntimeOrigin,239 PostInfo = PostDispatchInfo,240 > + UnfilteredDispatchable<RuntimeOrigin = <Self as system::Config>::RuntimeOrigin>241 + GetDispatchInfo242 + From<system::Call<Self>>;243244 /// The maximum weight that may be scheduled per block for any dispatchables of less245 /// priority than `schedule::HARD_DEADLINE`.246 #[pallet::constant]247 type MaximumWeight: Get<Weight>;248249 /// Required origin to schedule or cancel calls.250 type ScheduleOrigin: EnsureOrigin<251 <Self as system::Config>::RuntimeOrigin,252 Success = ScheduledEnsureOriginSuccess<Self::AccountId>,253 >;254255 /// Required origin to set/change calls' priority.256 type PrioritySetOrigin: EnsureOrigin<<Self as system::Config>::RuntimeOrigin>;257258 /// Compare the privileges of origins.259 ///260 /// This will be used when canceling a task, to ensure that the origin that tries261 /// to cancel has greater or equal privileges as the origin that created the scheduled task.262 ///263 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can264 /// be used. This will only check if two given origins are equal.265 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;266267 /// The maximum number of scheduled calls in the queue for a single block.268 /// Not strictly enforced, but used for weight estimation.269 #[pallet::constant]270 type MaxScheduledPerBlock: Get<u32>;271272 /// Weight information for extrinsics in this pallet.273 type WeightInfo: WeightInfo;274275 /// The preimage provider with which we look up call hashes to get the call.276 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;277278 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.279 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;280281 /// Sponsoring function.282 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;283284 /// The helper type used for custom transaction fee logic.285 type CallExecutor: DispatchCall<Self, H160>;286 }287288 /// A Scheduler-Runtime interface for finer payment handling.289 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {290 /// Reserve (lock) the maximum spendings on a call, calculated from its weight and the repetition count.291 fn reserve_balance(292 id: ScheduledId,293 sponsor: <T as frame_system::Config>::AccountId,294 call: <T as Config>::RuntimeCall,295 count: u32,296 ) -> Result<(), DispatchError>;297298 /// Unreserve (unlock) a certain amount from the payer's reserved funds, returning the change.299 fn pay_for_call(300 id: ScheduledId,301 sponsor: <T as frame_system::Config>::AccountId,302 call: <T as Config>::RuntimeCall,303 ) -> Result<u128, DispatchError>;304305 /// Resolve the call dispatch, including any post-dispatch operations.306 fn dispatch_call(307 signer: Option<T::AccountId>,308 function: <T as Config>::RuntimeCall,309 ) -> Result<310 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,311 TransactionValidityError,312 >;313314 /// Release unspent reserved funds in case of a schedule cancel.315 fn cancel_reserve(316 id: ScheduledId,317 sponsor: <T as frame_system::Config>::AccountId,318 ) -> Result<u128, DispatchError>;319 }320321 /// Items to be executed, indexed by the block number that they should be executed on.322 #[pallet::storage]323 pub type Agenda<T: Config> =324 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;325326 /// Lookup from identity to the block number and index of the task.327 #[pallet::storage]328 pub(crate) type Lookup<T: Config> =329 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;330331 /// Events type.332 #[pallet::event]333 #[pallet::generate_deposit(pub(super) fn deposit_event)]334 pub enum Event<T: Config> {335 /// Scheduled some task.336 Scheduled { when: T::BlockNumber, index: u32 },337 /// Canceled some task.338 Canceled { when: T::BlockNumber, index: u32 },339 /// Scheduled task's priority has changed340 PriorityChanged {341 when: T::BlockNumber,342 index: u32,343 priority: schedule::Priority,344 },345 /// Dispatched some task.346 Dispatched {347 task: TaskAddress<T::BlockNumber>,348 id: Option<ScheduledId>,349 result: DispatchResult,350 },351 /// The call for the provided hash was not found so the task has been aborted.352 CallLookupFailed {353 task: TaskAddress<T::BlockNumber>,354 id: Option<ScheduledId>,355 error: LookupError,356 },357 }358359 #[pallet::error]360 pub enum Error<T> {361 /// Failed to schedule a call362 FailedToSchedule,363 /// Cannot find the scheduled call.364 NotFound,365 /// Given target block number is in the past.366 TargetBlockNumberInPast,367 /// Reschedule failed because it does not change scheduled time.368 RescheduleNoChange,369 }370371 #[pallet::hooks]372 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {373 /// Execute the scheduled calls374 fn on_initialize(now: T::BlockNumber) -> Weight {375 let limit = T::MaximumWeight::get();376377 let mut queued = Agenda::<T>::take(now)378 .into_iter()379 .enumerate()380 .filter_map(|(index, s)| Some((index as u32, s?)))381 .collect::<Vec<_>>();382383 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {384 log::warn!(385 target: "runtime::scheduler",386 "Warning: This block has more items queued in Scheduler than \387 expected from the runtime configuration. An update might be needed."388 );389 }390391 queued.sort_by_key(|(_, s)| s.priority);392393 let next = now + One::one();394395 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);396 for (order, (index, mut s)) in queued.into_iter().enumerate() {397 let named = s.maybe_id.is_some();398399 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();400 s.call = call;401402 let resolved = if let Some(completed) = maybe_completed {403 T::PreimageProvider::unrequest_preimage(&completed);404 true405 } else {406 false407 };408 let call = match s.call.as_value().cloned() {409 Some(c) => c,410 None => {411 // Preimage not available - postpone until some block.412 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));413 if let Some(delay) = T::NoPreimagePostponement::get() {414 let until = now.saturating_add(delay);415 if let Some(ref id) = s.maybe_id {416 let index = Agenda::<T>::decode_len(until).unwrap_or(0);417 Lookup::<T>::insert(id, (until, index as u32));418 }419 Agenda::<T>::append(until, Some(s));420 } else if let Some(ref id) = s.maybe_id {421 Lookup::<T>::remove(id);422 }423 continue;424 }425 };426427 let periodic = s.maybe_periodic.is_some();428 let call_weight = call.get_dispatch_info().weight;429 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));430 let origin = <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(431 s.origin.clone(),432 )433 .into();434 if ensure_signed(origin).is_ok() {435 // Weights of Signed dispatches expect their signing account to be whitelisted.436 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));437 }438439 // We allow a scheduled call if any is true:440 // - It's priority is `HARD_DEADLINE`441 // - It does not push the weight past the limit.442 // - It is the first item in the schedule443 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;444 let test_weight = total_weight445 .saturating_add(call_weight)446 .saturating_add(item_weight);447 if !hard_deadline && order > 0 && test_weight.all_gt(limit) {448 // Cannot be scheduled this block - postpone until next.449 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));450 if let Some(ref id) = s.maybe_id {451 // NOTE: We could reasonably not do this (in which case there would be one452 // block where the named and delayed item could not be referenced by name),453 // but we will do it anyway since it should be mostly free in terms of454 // weight and it is slightly cleaner.455 let index = Agenda::<T>::decode_len(next).unwrap_or(0);456 Lookup::<T>::insert(id, (next, index as u32));457 }458 Agenda::<T>::append(next, Some(s));459 continue;460 }461462 let scheduled_origin =463 <<T as Config>::RuntimeOrigin as From<T::PalletsOrigin>>::from(464 s.origin.clone(),465 );466 let ensured_origin = T::ScheduleOrigin::ensure_origin(scheduled_origin.into());467468 let r = match ensured_origin {469 Ok(ScheduledEnsureOriginSuccess::Root) => {470 Ok(call.dispatch_bypass_filter(frame_system::RawOrigin::Root.into()))471 }472 Ok(ScheduledEnsureOriginSuccess::Signed(sender)) => {473 // Execute transaction via chain default pipeline474 // That means dispatch will be processed like any user's extrinsic e.g. transaction fees will be taken475 T::CallExecutor::dispatch_call(Some(sender), call.clone())476 }477 Ok(ScheduledEnsureOriginSuccess::Unsigned) => {478 // Unsigned version of the above479 T::CallExecutor::dispatch_call(None, call.clone())480 }481 Err(e) => Ok(Err(e.into())),482 };483484 let mut actual_call_weight: Weight = item_weight;485 let result: Result<_, DispatchError> = match r {486 Ok(o) => match o {487 Ok(di) => {488 actual_call_weight = di.actual_weight.unwrap_or(item_weight);489 Ok(())490 }491 Err(err) => Err(err.error),492 },493 Err(_) => {494 log::error!(495 target: "runtime::scheduler",496 "Warning: Scheduler has failed to execute a post-dispatch transaction. \497 This block might have become invalid.");498 Err(DispatchError::CannotLookup)499 } // todo possibly force a skip/return here, do something with the error500 };501502 total_weight.saturating_accrue(item_weight);503 total_weight.saturating_accrue(actual_call_weight);504505 Self::deposit_event(Event::Dispatched {506 task: (now, index),507 id: s.maybe_id.clone(),508 result,509 });510511 if let &Some((period, count)) = &s.maybe_periodic {512 if count > 1 {513 s.maybe_periodic = Some((period, count - 1));514 } else {515 s.maybe_periodic = None;516 }517 let wake = now + period;518 let is_canceled;519520 // If scheduled is named, place its information in `Lookup`521 if let Some(ref id) = s.maybe_id {522 is_canceled = Lookup::<T>::get(id).is_none();523 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);524525 if !is_canceled {526 Lookup::<T>::insert(id, (wake, wake_index as u32));527 }528 } else {529 is_canceled = false;530 }531532 if !is_canceled {533 Agenda::<T>::append(wake, Some(s));534 }535 } else if let Some(ref id) = s.maybe_id {536 Lookup::<T>::remove(id);537 }538 }539 total_weight540 }541 }542543 #[pallet::call]544 impl<T: Config> Pallet<T> {545 /// Schedule a named task.546 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]547 pub fn schedule_named(548 origin: OriginFor<T>,549 id: ScheduledId,550 when: T::BlockNumber,551 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,552 priority: Option<schedule::Priority>,553 call: Box<CallOrHashOf<T>>,554 ) -> DispatchResult {555 T::ScheduleOrigin::ensure_origin(origin.clone())?;556557 if priority.is_some() {558 T::PrioritySetOrigin::ensure_origin(origin.clone())?;559 }560561 let origin = <T as Config>::RuntimeOrigin::from(origin);562 Self::do_schedule_named(563 id,564 DispatchTime::At(when),565 maybe_periodic,566 priority.unwrap_or(LOWEST_PRIORITY),567 origin.caller().clone(),568 *call,569 )?;570 Ok(())571 }572573 /// Cancel a named scheduled task.574 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]575 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {576 T::ScheduleOrigin::ensure_origin(origin.clone())?;577 let origin = <T as Config>::RuntimeOrigin::from(origin);578 Self::do_cancel_named(Some(origin.caller().clone()), id)?;579 Ok(())580 }581582 /// Schedule a named task after a delay.583 ///584 /// # <weight>585 /// Same as [`schedule_named`](Self::schedule_named).586 /// # </weight>587 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]588 pub fn schedule_named_after(589 origin: OriginFor<T>,590 id: ScheduledId,591 after: T::BlockNumber,592 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,593 priority: Option<schedule::Priority>,594 call: Box<CallOrHashOf<T>>,595 ) -> DispatchResult {596 T::ScheduleOrigin::ensure_origin(origin.clone())?;597598 if priority.is_some() {599 T::PrioritySetOrigin::ensure_origin(origin.clone())?;600 }601602 let origin = <T as Config>::RuntimeOrigin::from(origin);603 Self::do_schedule_named(604 id,605 DispatchTime::After(after),606 maybe_periodic,607 priority.unwrap_or(LOWEST_PRIORITY),608 origin.caller().clone(),609 *call,610 )?;611 Ok(())612 }613614 #[pallet::weight(<T as Config>::WeightInfo::change_named_priority(T::MaxScheduledPerBlock::get()))]615 pub fn change_named_priority(616 origin: OriginFor<T>,617 id: ScheduledId,618 priority: schedule::Priority,619 ) -> DispatchResult {620 T::PrioritySetOrigin::ensure_origin(origin.clone())?;621 let origin = <T as Config>::RuntimeOrigin::from(origin);622 Self::do_change_named_priority(origin.caller().clone(), id, priority)623 }624 }625}626627impl<T: Config> Pallet<T> {628 #[cfg(feature = "try-runtime")]629 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {630 Ok(())631 }632633 #[cfg(feature = "try-runtime")]634 pub fn post_migrate_to_v3() -> Result<(), &'static str> {635 use frame_support::dispatch::GetStorageVersion;636637 assert!(Self::current_storage_version() == 3);638 for k in Agenda::<T>::iter_keys() {639 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;640 }641 Ok(())642 }643644 /// Helper to migrate scheduler when the pallet origin type has changed.645 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {646 Agenda::<T>::translate::<647 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,648 _,649 >(|_, agenda| {650 Some(651 agenda652 .into_iter()653 .map(|schedule| {654 schedule.map(|schedule| Scheduled {655 maybe_id: schedule.maybe_id,656 priority: schedule.priority,657 call: schedule.call,658 maybe_periodic: schedule.maybe_periodic,659 origin: schedule.origin.into(),660 _phantom: Default::default(),661 })662 })663 .collect::<Vec<_>>(),664 )665 });666 }667668 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {669 let now = frame_system::Pallet::<T>::block_number();670671 let when = match when {672 DispatchTime::At(x) => x,673 // The current block has already completed it's scheduled tasks, so674 // Schedule the task at lest one block after this current block.675 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),676 };677678 if when <= now {679 return Err(Error::<T>::TargetBlockNumberInPast.into());680 }681682 Ok(when)683 }684685 fn do_schedule_named(686 id: ScheduledId,687 when: DispatchTime<T::BlockNumber>,688 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,689 priority: schedule::Priority,690 origin: T::PalletsOrigin,691 call: CallOrHashOf<T>,692 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {693 // ensure id it is unique694 if Lookup::<T>::contains_key(&id) {695 return Err(Error::<T>::FailedToSchedule)?;696 }697698 let when = Self::resolve_time(when)?;699700 call.ensure_requested::<T::PreimageProvider>();701702 // sanitize maybe_periodic703 let maybe_periodic = maybe_periodic704 .filter(|p| p.1 > 1 && !p.0.is_zero())705 // Remove one from the number of repetitions since we will schedule one now.706 .map(|(p, c)| (p, c - 1));707708 let s = Scheduled {709 maybe_id: Some(id.clone()),710 priority,711 call: call.clone(),712 maybe_periodic,713 origin: origin.clone(),714 _phantom: Default::default(),715 };716717 // reserve balance for periodic execution718 // let sender =719 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;720 // let repeats = match maybe_periodic {721 // Some(p) => p.1,722 // None => 1,723 // };724 // let _ = T::CallExecutor::reserve_balance(725 // id.clone(),726 // sender,727 // call.as_value().unwrap().clone(),728 // repeats,729 // );730731 Agenda::<T>::append(when, Some(s));732 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;733 let address = (when, index);734 Lookup::<T>::insert(&id, &address);735 Self::deposit_event(Event::Scheduled { when, index });736737 Ok(address)738 }739740 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {741 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {742 if let Some((when, index)) = lookup.take() {743 let i = index as usize;744 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {745 if let Some(s) = agenda.get_mut(i) {746 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {747 if matches!(748 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),749 Some(Ordering::Less) | None750 ) {751 return Err(BadOrigin.into());752 }753 // release balance reserve754 // let sender = ensure_signed(755 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(756 // origin.unwrap(),757 // )758 // .into(),759 // )?;760 // let _ = T::CallExecutor::cancel_reserve(id, sender);761762 s.call.ensure_unrequested::<T::PreimageProvider>();763 }764 *s = None;765 }766 Ok(())767 })?;768769 Self::deposit_event(Event::Canceled { when, index });770 Ok(())771 } else {772 Err(Error::<T>::NotFound)?773 }774 })775 }776777 fn do_change_named_priority(778 origin: T::PalletsOrigin,779 id: ScheduledId,780 priority: schedule::Priority,781 ) -> DispatchResult {782 match Lookup::<T>::get(id) {783 Some((when, index)) => {784 let i = index as usize;785 Agenda::<T>::try_mutate(when, |agenda| {786 if let Some(Some(s)) = agenda.get_mut(i) {787 if matches!(788 T::OriginPrivilegeCmp::cmp_privilege(&origin, &s.origin),789 Some(Ordering::Less) | None790 ) {791 return Err(BadOrigin.into());792 }793794 s.priority = priority;795 Self::deposit_event(Event::PriorityChanged {796 when,797 index,798 priority,799 });800 }801 Ok(())802 })803 }804 None => Err(Error::<T>::NotFound.into()),805 }806 }807}