difftreelog
Merge branch 'develop' into feature/CORE-302-ss58Format
in: master
17 files changed
pallets/common/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/common/src/benchmarking.rs
+++ b/pallets/common/src/benchmarking.rs
@@ -20,8 +20,8 @@
use frame_benchmarking::{benchmarks, account};
use up_data_structs::{
CollectionMode, CreateCollectionData, CollectionId, Property, PropertyKey, PropertyValue,
- MAX_COLLECTION_NAME_LENGTH, MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH,
- OFFCHAIN_SCHEMA_LIMIT, CONST_ON_CHAIN_SCHEMA_LIMIT, MAX_PROPERTIES_PER_ITEM,
+ CollectionPermissions, NestingRule, MAX_COLLECTION_NAME_LENGTH,
+ MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH, MAX_PROPERTIES_PER_ITEM,
};
use frame_support::{
traits::{Currency, Get},
@@ -74,15 +74,15 @@
}
pub fn create_collection_raw<T: Config, R>(
- owner: T::AccountId,
+ owner: T::CrossAccountId,
mode: CollectionMode,
handler: impl FnOnce(
- T::AccountId,
+ T::CrossAccountId,
CreateCollectionData<T::AccountId>,
) -> Result<CollectionId, DispatchError>,
cast: impl FnOnce(CollectionHandle<T>) -> R,
) -> Result<R, DispatchError> {
- T::Currency::deposit_creating(&owner, T::CollectionCreationPrice::get());
+ <T as Config>::Currency::deposit_creating(&owner.as_sub(), T::CollectionCreationPrice::get());
let name = create_u16_data::<MAX_COLLECTION_NAME_LENGTH>();
let description = create_u16_data::<MAX_COLLECTION_DESCRIPTION_LENGTH>();
let token_prefix = create_data::<MAX_TOKEN_PREFIX_LENGTH>();
@@ -93,13 +93,19 @@
name,
description,
token_prefix,
+ permissions: Some(CollectionPermissions {
+ nesting: Some(NestingRule::Permissive),
+ ..Default::default()
+ }),
..Default::default()
},
)
.and_then(CollectionHandle::try_get)
.map(cast)
}
-fn create_collection<T: Config>(owner: T::AccountId) -> Result<CollectionHandle<T>, DispatchError> {
+fn create_collection<T: Config>(
+ owner: T::CrossAccountId,
+) -> Result<CollectionHandle<T>, DispatchError> {
create_collection_raw(
owner,
CollectionMode::NFT,
@@ -127,7 +133,7 @@
bench_init!($($rest)*);
};
($name:ident: collection($owner:ident); $($rest:tt)*) => {
- let $name = create_collection::<T>($owner.clone())?;
+ let $name = create_collection::<T>(T::CrossAccountId::from_sub($owner.clone()))?;
bench_init!($($rest)*);
};
($name:ident: cross; $($rest:tt)*) => {
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -1168,8 +1168,9 @@
);
Ok(new_limit)
}
+
pub fn clamp_permissions(
- mode: CollectionMode,
+ _mode: CollectionMode,
old_limit: &CollectionPermissions,
mut new_limit: CollectionPermissions,
) -> Result<CollectionPermissions, DispatchError> {
@@ -1204,6 +1205,22 @@
fn approve() -> Weight;
fn transfer_from() -> Weight;
fn burn_from() -> Weight;
+
+ /// Differs from burn_item in case of Fungible and Refungible, as it should burn
+ /// whole users's balance
+ ///
+ /// This method shouldn't be used directly, as it doesn't count breadth price, use `burn_recursively` instead
+ fn burn_recursively_self_raw() -> Weight;
+ /// Cost of iterating over `amount` children while burning, without counting child burning itself
+ ///
+ /// This method shouldn't be used directly, as it doesn't count depth price, use `burn_recursively` instead
+ fn burn_recursively_breadth_raw(amount: u32) -> Weight;
+
+ fn burn_recursively(max_selfs: u32, max_breadth: u32) -> Weight {
+ Self::burn_recursively_self_raw()
+ .saturating_mul(max_selfs.max(1) as u64)
+ .saturating_add(Self::burn_recursively_breadth_raw(max_breadth))
+ }
}
pub trait CommonCollectionOperations<T: Config> {
@@ -1233,6 +1250,13 @@
token: TokenId,
amount: u128,
) -> DispatchResultWithPostInfo;
+ fn burn_item_recursively(
+ &self,
+ sender: T::CrossAccountId,
+ token: TokenId,
+ self_budget: &dyn Budget,
+ breadth_budget: &dyn Budget,
+ ) -> DispatchResultWithPostInfo;
fn set_collection_properties(
&self,
sender: T::CrossAccountId,
pallets/fungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/fungible/src/benchmarking.rs
+++ b/pallets/fungible/src/benchmarking.rs
@@ -25,7 +25,9 @@
const SEED: u32 = 1;
-fn create_collection<T: Config>(owner: T::AccountId) -> Result<FungibleHandle<T>, DispatchError> {
+fn create_collection<T: Config>(
+ owner: T::CrossAccountId,
+) -> Result<FungibleHandle<T>, DispatchError> {
create_collection_raw(
owner,
CollectionMode::Fungible(0),
pallets/fungible/src/common.rsdiffbeforeafterboth--- a/pallets/fungible/src/common.rs
+++ b/pallets/fungible/src/common.rs
@@ -16,9 +16,10 @@
use core::marker::PhantomData;
-use frame_support::{dispatch::DispatchResultWithPostInfo, ensure, fail, weights::Weight};
+use frame_support::{dispatch::DispatchResultWithPostInfo, ensure, fail, weights::Weight, traits::Get};
use up_data_structs::{TokenId, CollectionId, CreateItemExData, budget::Budget, CreateItemData};
use pallet_common::{CommonCollectionOperations, CommonWeightInfo, with_weight};
+use pallet_structure::Error as StructureError;
use sp_runtime::ArithmeticError;
use sp_std::{vec::Vec, vec};
use up_data_structs::{Property, PropertyKey, PropertyValue, PropertyKeyPermission};
@@ -91,6 +92,16 @@
fn burn_from() -> Weight {
<SelfWeightOf<T>>::burn_from()
}
+
+ fn burn_recursively_self_raw() -> Weight {
+ // Read to get total balance
+ Self::burn_item() + T::DbWeight::get().reads(1)
+ }
+
+ fn burn_recursively_breadth_raw(_amount: u32) -> Weight {
+ // Fungible tokens can't have children
+ 0
+ }
}
impl<T: Config> CommonCollectionOperations<T> for FungibleHandle<T> {
@@ -170,6 +181,26 @@
)
}
+ fn burn_item_recursively(
+ &self,
+ sender: T::CrossAccountId,
+ token: TokenId,
+ self_budget: &dyn Budget,
+ _breadth_budget: &dyn Budget,
+ ) -> DispatchResultWithPostInfo {
+ // Should not happen?
+ ensure!(
+ token == TokenId::default(),
+ <Error<T>>::FungibleItemsHaveNoId
+ );
+ ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);
+
+ with_weight(
+ <Pallet<T>>::burn(self, &sender, <Balance<T>>::get((self.id, &sender))),
+ <CommonWeights<T>>::burn_recursively_self_raw(),
+ )
+ }
+
fn transfer(
&self,
from: T::CrossAccountId,
pallets/nonfungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/benchmarking.rs
+++ b/pallets/nonfungible/src/benchmarking.rs
@@ -18,12 +18,9 @@
use crate::{Pallet, Config, NonfungibleHandle};
use sp_std::prelude::*;
-use pallet_common::benchmarking::{create_collection_raw, create_data, property_key, property_value};
+use pallet_common::benchmarking::{create_collection_raw, property_key, property_value};
use frame_benchmarking::{benchmarks, account};
-use up_data_structs::{
- CollectionMode, MAX_ITEMS_PER_BATCH, MAX_PROPERTIES_PER_ITEM, CUSTOM_DATA_LIMIT,
- budget::Unlimited,
-};
+use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, MAX_PROPERTIES_PER_ITEM, budget::Unlimited};
use pallet_common::bench_init;
const SEED: u32 = 1;
@@ -49,7 +46,7 @@
}
fn create_collection<T: Config>(
- owner: T::AccountId,
+ owner: T::CrossAccountId,
) -> Result<NonfungibleHandle<T>, DispatchError> {
create_collection_raw(
owner,
@@ -96,6 +93,26 @@
let item = create_max_item(&collection, &sender, burner.clone())?;
}: {<Pallet<T>>::burn(&collection, &burner, item)?}
+ burn_recursively_self_raw {
+ bench_init!{
+ owner: sub; collection: collection(owner);
+ sender: cross_from_sub(owner); burner: cross_sub;
+ };
+ let item = create_max_item(&collection, &sender, burner.clone())?;
+ }: {<Pallet<T>>::burn_recursively(&collection, &burner, item, &Unlimited, &Unlimited)}
+
+ burn_recursively_breadth_plus_self_plus_self_per_each_raw {
+ let b in 0..200;
+ bench_init!{
+ owner: sub; collection: collection(owner);
+ sender: cross_from_sub(owner); burner: cross_sub;
+ };
+ let item = create_max_item(&collection, &sender, burner.clone())?;
+ for i in 0..b {
+ create_max_item(&collection, &sender, T::CrossTokenAddressMapping::token_to_address(collection.id, item))?;
+ }
+ }: {<Pallet<T>>::burn_recursively(&collection, &burner, item, &Unlimited, &Unlimited)}
+
transfer {
bench_init!{
owner: sub; collection: collection(owner);
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -108,6 +108,15 @@
fn burn_from() -> Weight {
<SelfWeightOf<T>>::burn_from()
}
+
+ fn burn_recursively_self_raw() -> Weight {
+ <SelfWeightOf<T>>::burn_recursively_self_raw()
+ }
+
+ fn burn_recursively_breadth_raw(amount: u32) -> Weight {
+ <SelfWeightOf<T>>::burn_recursively_breadth_plus_self_plus_self_per_each_raw(amount)
+ .saturating_sub(Self::burn_recursively_self_raw().saturating_mul(amount as u64 + 1))
+ }
}
fn map_create_data<T: Config>(
@@ -264,6 +273,16 @@
}
}
+ fn burn_item_recursively(
+ &self,
+ sender: T::CrossAccountId,
+ token: TokenId,
+ self_budget: &dyn Budget,
+ breadth_budget: &dyn Budget,
+ ) -> DispatchResultWithPostInfo {
+ <Pallet<T>>::burn_recursively(self, &sender, token, self_budget, breadth_budget)
+ }
+
fn transfer(
&self,
from: T::CrossAccountId,
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -18,7 +18,13 @@
use erc::ERC721Events;
use evm_coder::ToLog;
-use frame_support::{BoundedVec, ensure, fail, transactional, storage::with_transaction};
+use frame_support::{
+ BoundedVec, ensure, fail, transactional,
+ storage::with_transaction,
+ pallet_prelude::DispatchResultWithPostInfo,
+ pallet_prelude::Weight,
+ weights::{PostDispatchInfo, Pays},
+};
use up_data_structs::{
AccessMode, CollectionId, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,
mapping::TokenAddressMapping, NestingRule, budget::Budget, Property, PropertyPermission,
@@ -29,7 +35,7 @@
Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,
eth::collection_id_to_address,
};
-use pallet_structure::Pallet as PalletStructure;
+use pallet_structure::{Pallet as PalletStructure, Error as StructureError};
use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};
use sp_core::H160;
use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};
@@ -39,6 +45,7 @@
use scale_info::TypeInfo;
pub use pallet::*;
+use weights::WeightInfo;
#[cfg(feature = "runtime-benchmarks")]
pub mod benchmarking;
pub mod common;
@@ -373,7 +380,7 @@
<PalletCommon<T>>::deposit_event(CommonEvent::Approved(
collection.id,
token,
- sender.clone(),
+ token_data.owner.clone(),
old_spender,
0,
));
@@ -396,6 +403,45 @@
Ok(())
}
+ #[transactional]
+ pub fn burn_recursively(
+ collection: &NonfungibleHandle<T>,
+ sender: &T::CrossAccountId,
+ token: TokenId,
+ self_budget: &dyn Budget,
+ breadth_budget: &dyn Budget,
+ ) -> DispatchResultWithPostInfo {
+ ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);
+
+ let current_token_account =
+ T::CrossTokenAddressMapping::token_to_address(collection.id, token);
+
+ let mut weight = 0 as Weight;
+
+ // This method is transactional, if user in fact doesn't have permissions to remove token -
+ // tokens removed here will be restored after rejected transaction
+ for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {
+ ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);
+ let PostDispatchInfo { actual_weight, .. } =
+ <PalletStructure<T>>::burn_item_recursively(
+ current_token_account.clone(),
+ collection,
+ token,
+ self_budget,
+ breadth_budget,
+ )?;
+ if let Some(actual_weight) = actual_weight {
+ weight = weight.saturating_add(actual_weight);
+ }
+ }
+
+ Self::burn(collection, sender, token)?;
+ DispatchResultWithPostInfo::Ok(PostDispatchInfo {
+ actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),
+ pays_fee: Pays::Yes,
+ })
+ }
+
pub fn set_token_property(
collection: &NonfungibleHandle<T>,
sender: &T::CrossAccountId,
@@ -964,6 +1010,7 @@
);
ensure_sender_allowed::<T>(handle.id, under, from, sender, nesting_budget)?
}
+ NestingRule::Permissive => {}
}
Ok(())
}
pallets/nonfungible/src/weights.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/weights.rs
+++ b/pallets/nonfungible/src/weights.rs
@@ -36,6 +36,8 @@
fn create_multiple_items(b: u32, ) -> Weight;
fn create_multiple_items_ex(b: u32, ) -> Weight;
fn burn_item() -> Weight;
+ fn burn_recursively_self_raw() -> Weight;
+ fn burn_recursively_breadth_plus_self_plus_self_per_each_raw(b: u32, ) -> Weight;
fn transfer() -> Weight;
fn approve() -> Weight;
fn transfer_from() -> Weight;
@@ -92,7 +94,35 @@
.saturating_add(T::DbWeight::get().reads(4 as Weight))
.saturating_add(T::DbWeight::get().writes(4 as Weight))
}
-
+ // Storage: Nonfungible TokenChildren (r:1 w:0)
+ // Storage: Nonfungible TokenData (r:1 w:1)
+ // Storage: Nonfungible TokensBurnt (r:1 w:1)
+ // Storage: Nonfungible AccountBalance (r:1 w:1)
+ // Storage: Nonfungible Allowance (r:1 w:0)
+ // Storage: Nonfungible Owned (r:0 w:1)
+ // Storage: Nonfungible TokenProperties (r:0 w:1)
+ fn burn_recursively_self_raw() -> Weight {
+ (86_136_000 as Weight)
+ .saturating_add(T::DbWeight::get().reads(5 as Weight))
+ .saturating_add(T::DbWeight::get().writes(5 as Weight))
+ }
+ // Storage: Nonfungible TokenChildren (r:1 w:0)
+ // Storage: Nonfungible TokenData (r:1 w:1)
+ // Storage: Nonfungible TokensBurnt (r:1 w:1)
+ // Storage: Nonfungible AccountBalance (r:1 w:1)
+ // Storage: Nonfungible Allowance (r:1 w:0)
+ // Storage: Nonfungible Owned (r:0 w:1)
+ // Storage: Nonfungible TokenProperties (r:0 w:1)
+ // Storage: Common CollectionById (r:1 w:0)
+ fn burn_recursively_breadth_plus_self_plus_self_per_each_raw(b: u32, ) -> Weight {
+ (0 as Weight)
+ // Standard Error: 42_828_000
+ .saturating_add((381_478_000 as Weight).saturating_mul(b as Weight))
+ .saturating_add(T::DbWeight::get().reads(6 as Weight))
+ .saturating_add(T::DbWeight::get().reads((4 as Weight).saturating_mul(b as Weight)))
+ .saturating_add(T::DbWeight::get().writes(5 as Weight))
+ .saturating_add(T::DbWeight::get().writes((4 as Weight).saturating_mul(b as Weight)))
+ }
// Storage: Nonfungible TokenData (r:1 w:1)
// Storage: Nonfungible AccountBalance (r:2 w:2)
// Storage: Nonfungible Allowance (r:1 w:0)
@@ -204,7 +234,35 @@
.saturating_add(RocksDbWeight::get().reads(4 as Weight))
.saturating_add(RocksDbWeight::get().writes(4 as Weight))
}
-
+ // Storage: Nonfungible TokenChildren (r:1 w:0)
+ // Storage: Nonfungible TokenData (r:1 w:1)
+ // Storage: Nonfungible TokensBurnt (r:1 w:1)
+ // Storage: Nonfungible AccountBalance (r:1 w:1)
+ // Storage: Nonfungible Allowance (r:1 w:0)
+ // Storage: Nonfungible Owned (r:0 w:1)
+ // Storage: Nonfungible TokenProperties (r:0 w:1)
+ fn burn_recursively_self_raw() -> Weight {
+ (86_136_000 as Weight)
+ .saturating_add(RocksDbWeight::get().reads(5 as Weight))
+ .saturating_add(RocksDbWeight::get().writes(5 as Weight))
+ }
+ // Storage: Nonfungible TokenChildren (r:1 w:0)
+ // Storage: Nonfungible TokenData (r:1 w:1)
+ // Storage: Nonfungible TokensBurnt (r:1 w:1)
+ // Storage: Nonfungible AccountBalance (r:1 w:1)
+ // Storage: Nonfungible Allowance (r:1 w:0)
+ // Storage: Nonfungible Owned (r:0 w:1)
+ // Storage: Nonfungible TokenProperties (r:0 w:1)
+ // Storage: Common CollectionById (r:1 w:0)
+ fn burn_recursively_breadth_plus_self_plus_self_per_each_raw(b: u32, ) -> Weight {
+ (0 as Weight)
+ // Standard Error: 42_828_000
+ .saturating_add((381_478_000 as Weight).saturating_mul(b as Weight))
+ .saturating_add(RocksDbWeight::get().reads(6 as Weight))
+ .saturating_add(RocksDbWeight::get().reads((4 as Weight).saturating_mul(b as Weight)))
+ .saturating_add(RocksDbWeight::get().writes(5 as Weight))
+ .saturating_add(RocksDbWeight::get().writes((4 as Weight).saturating_mul(b as Weight)))
+ }
// Storage: Nonfungible TokenData (r:1 w:1)
// Storage: Nonfungible AccountBalance (r:2 w:2)
// Storage: Nonfungible Allowance (r:1 w:0)
pallets/refungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/refungible/src/benchmarking.rs
+++ b/pallets/refungible/src/benchmarking.rs
@@ -50,7 +50,9 @@
Ok(TokenId(<TokensMinted<T>>::get(&collection.id)))
}
-fn create_collection<T: Config>(owner: T::AccountId) -> Result<RefungibleHandle<T>, DispatchError> {
+fn create_collection<T: Config>(
+ owner: T::CrossAccountId,
+) -> Result<RefungibleHandle<T>, DispatchError> {
create_collection_raw(
owner,
CollectionMode::NFT,
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -17,12 +17,13 @@
use core::marker::PhantomData;
use sp_std::collections::btree_map::BTreeMap;
-use frame_support::{dispatch::DispatchResultWithPostInfo, fail, weights::Weight};
+use frame_support::{dispatch::DispatchResultWithPostInfo, ensure, fail, weights::Weight, traits::Get};
use up_data_structs::{
CollectionId, TokenId, CreateItemExData, CreateRefungibleExData, budget::Budget, Property,
PropertyKey, PropertyValue, PropertyKeyPermission, CreateItemData,
};
use pallet_common::{CommonCollectionOperations, CommonWeightInfo, with_weight};
+use pallet_structure::Error as StructureError;
use sp_runtime::DispatchError;
use sp_std::{vec::Vec, vec};
@@ -113,6 +114,15 @@
fn burn_from() -> Weight {
<SelfWeightOf<T>>::burn_from()
}
+
+ fn burn_recursively_self_raw() -> Weight {
+ // Read to get total balance
+ Self::burn_item() + T::DbWeight::get().reads(1)
+ }
+ fn burn_recursively_breadth_raw(_amount: u32) -> Weight {
+ // Refungible token can't have children
+ 0
+ }
}
fn map_create_data<T: Config>(
@@ -205,6 +215,25 @@
)
}
+ fn burn_item_recursively(
+ &self,
+ sender: T::CrossAccountId,
+ token: TokenId,
+ self_budget: &dyn Budget,
+ _breadth_budget: &dyn Budget,
+ ) -> DispatchResultWithPostInfo {
+ ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);
+ with_weight(
+ <Pallet<T>>::burn(
+ self,
+ &sender,
+ token,
+ <Balance<T>>::get((self.id, token, &sender)),
+ ),
+ <CommonWeights<T>>::burn_recursively_self_raw(),
+ )
+ }
+
fn transfer(
&self,
from: T::CrossAccountId,
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//! ## Interface50//!51//! ### Dispatchable Functions52//!53//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and54//! with a specified priority.55//! * `cancel` - cancel a scheduled dispatch, specified by block number and index.56//! * `schedule_named` - augments the `schedule` interface with an additional `Vec<u8>` parameter57//! that can be used for identification.58//! * `cancel_named` - the named complement to the cancel function.5960// Ensure we're `no_std` when compiling for Wasm.61#![cfg_attr(not(feature = "std"), no_std)]6263#[cfg(feature = "runtime-benchmarks")]64mod benchmarking;6566pub mod weights;6768use sp_core::H160;69use codec::{Codec, Decode, Encode};70use frame_system::{self as system, ensure_signed};71pub use pallet::*;72use scale_info::TypeInfo;73use sp_runtime::{74 traits::{BadOrigin, One, Saturating, Zero},75 RuntimeDebug, DispatchErrorWithPostInfo,76};77use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};7879use frame_support::{80 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},81 traits::{82 schedule::{self, DispatchTime, MaybeHashed},83 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,84 StorageVersion,85 },86 weights::{GetDispatchInfo, Weight},87};8889pub use weights::WeightInfo;9091/// Just a simple index for naming period tasks.92pub type PeriodicIndex = u32;93/// The location of a scheduled task that can be used to remove it.94pub type TaskAddress<BlockNumber> = (BlockNumber, u32);95pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;9697type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];98pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;99100/// Information regarding an item to be executed in the future.101#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]102#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]103pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {104 /// The unique identity for this task, if there is one.105 maybe_id: Option<ScheduledId>,106 /// This task's priority.107 priority: schedule::Priority,108 /// The call to be dispatched.109 call: Call,110 /// If the call is periodic, then this points to the information concerning that.111 maybe_periodic: Option<schedule::Period<BlockNumber>>,112 /// The origin to dispatch the call.113 origin: PalletsOrigin,114 _phantom: PhantomData<AccountId>,115}116117pub type ScheduledV3Of<T> = ScheduledV3<118 CallOrHashOf<T>,119 <T as frame_system::Config>::BlockNumber,120 <T as Config>::PalletsOrigin,121 <T as frame_system::Config>::AccountId,122>;123124pub type ScheduledOf<T> = ScheduledV3Of<T>;125126/// The current version of Scheduled struct.127pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =128 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;129130#[cfg(feature = "runtime-benchmarks")]131mod preimage_provider {132 use frame_support::traits::PreimageRecipient;133 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}134 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}135}136137#[cfg(not(feature = "runtime-benchmarks"))]138mod preimage_provider {139 use frame_support::traits::PreimageProvider;140 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}141 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}142}143144pub use preimage_provider::PreimageProviderAndMaybeRecipient;145146pub(crate) trait MarginalWeightInfo: WeightInfo {147 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {148 match (periodic, named, resolved) {149 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),150 (_, true, None) => {151 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)152 }153 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),154 (false, true, Some(false)) => {155 Self::on_initialize_named(2) - Self::on_initialize_named(1)156 }157 (true, false, Some(false)) => {158 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)159 }160 (true, true, Some(false)) => {161 Self::on_initialize_periodic_named(2) - Self::on_initialize_periodic_named(1)162 }163 (false, false, Some(true)) => {164 Self::on_initialize_resolved(2) - Self::on_initialize_resolved(1)165 }166 (false, true, Some(true)) => {167 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)168 }169 (true, false, Some(true)) => {170 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)171 }172 (true, true, Some(true)) => {173 Self::on_initialize_periodic_named_resolved(2)174 - Self::on_initialize_periodic_named_resolved(1)175 }176 }177 }178}179impl<T: WeightInfo> MarginalWeightInfo for T {}180181#[frame_support::pallet]182pub mod pallet {183 use super::*;184 use frame_support::{185 dispatch::PostDispatchInfo,186 pallet_prelude::*,187 traits::{schedule::LookupError, PreimageProvider},188 };189 use frame_system::pallet_prelude::*;190191 /// The current storage version.192 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);193194 #[pallet::pallet]195 #[pallet::generate_store(pub(super) trait Store)]196 #[pallet::storage_version(STORAGE_VERSION)]197 #[pallet::without_storage_info]198 pub struct Pallet<T>(_);199200 /// `system::Config` should always be included in our implied traits.201 #[pallet::config]202 pub trait Config: frame_system::Config {203 /// The overarching event type.204 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;205206 /// The aggregated origin which the dispatch will take.207 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>208 + From<Self::PalletsOrigin>209 + IsType<<Self as system::Config>::Origin>;210211 /// The caller origin, overarching type of all pallets origins.212 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;213214 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;215216 /// The aggregated call type.217 type Call: Parameter218 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>219 + GetDispatchInfo220 + From<system::Call<Self>>;221222 /// The maximum weight that may be scheduled per block for any dispatchables of less223 /// priority than `schedule::HARD_DEADLINE`.224 #[pallet::constant]225 type MaximumWeight: Get<Weight>;226227 /// Required origin to schedule or cancel calls.228 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;229230 /// Compare the privileges of origins.231 ///232 /// This will be used when canceling a task, to ensure that the origin that tries233 /// to cancel has greater or equal privileges as the origin that created the scheduled task.234 ///235 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can236 /// be used. This will only check if two given origins are equal.237 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;238239 /// The maximum number of scheduled calls in the queue for a single block.240 /// Not strictly enforced, but used for weight estimation.241 #[pallet::constant]242 type MaxScheduledPerBlock: Get<u32>;243244 /// Weight information for extrinsics in this pallet.245 type WeightInfo: WeightInfo;246247 /// The preimage provider with which we look up call hashes to get the call.248 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;249250 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.251 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;252253 /// Sponsoring function.254 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;255256 /// The helper type used for custom transaction fee logic.257 type CallExecutor: DispatchCall<Self, H160>;258 }259260 /// A Scheduler-Runtime interface for finer payment handling.261 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {262 fn reserve_balance(263 id: ScheduledId,264 sponsor: <T as frame_system::Config>::AccountId,265 call: <T as Config>::Call,266 count: u32,267 ) -> Result<(), DispatchError>;268269 fn pay_for_call(270 id: ScheduledId,271 sponsor: <T as frame_system::Config>::AccountId,272 call: <T as Config>::Call,273 ) -> Result<u128, DispatchError>;274275 /// Resolve the call dispatch, including any post-dispatch operations.276 fn dispatch_call(277 signer: T::AccountId,278 function: <T as Config>::Call,279 ) -> Result<280 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,281 TransactionValidityError,282 >;283284 fn cancel_reserve(285 id: ScheduledId,286 sponsor: <T as frame_system::Config>::AccountId,287 ) -> Result<u128, DispatchError>;288 }289290 /// Items to be executed, indexed by the block number that they should be executed on.291 #[pallet::storage]292 pub type Agenda<T: Config> =293 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;294295 /// Lookup from identity to the block number and index of the task.296 #[pallet::storage]297 pub(crate) type Lookup<T: Config> =298 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;299300 /// Events type.301 #[pallet::event]302 #[pallet::generate_deposit(pub(super) fn deposit_event)]303 pub enum Event<T: Config> {304 /// Scheduled some task.305 Scheduled { when: T::BlockNumber, index: u32 },306 /// Canceled some task.307 Canceled { when: T::BlockNumber, index: u32 },308 /// Dispatched some task.309 Dispatched {310 task: TaskAddress<T::BlockNumber>,311 id: Option<ScheduledId>,312 result: DispatchResult,313 },314 /// The call for the provided hash was not found so the task has been aborted.315 CallLookupFailed {316 task: TaskAddress<T::BlockNumber>,317 id: Option<ScheduledId>,318 error: LookupError,319 },320 }321322 #[pallet::error]323 pub enum Error<T> {324 /// Failed to schedule a call325 FailedToSchedule,326 /// Cannot find the scheduled call.327 NotFound,328 /// Given target block number is in the past.329 TargetBlockNumberInPast,330 /// Reschedule failed because it does not change scheduled time.331 RescheduleNoChange,332 }333334 #[pallet::hooks]335 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {336 /// Execute the scheduled calls337 fn on_initialize(now: T::BlockNumber) -> Weight {338 let limit = T::MaximumWeight::get();339340 let mut queued = Agenda::<T>::take(now)341 .into_iter()342 .enumerate()343 .filter_map(|(index, s)| Some((index as u32, s?)))344 .collect::<Vec<_>>();345346 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {347 log::warn!(348 target: "runtime::scheduler",349 "Warning: This block has more items queued in Scheduler than \350 expected from the runtime configuration. An update might be needed."351 );352 }353354 queued.sort_by_key(|(_, s)| s.priority);355356 let next = now + One::one();357358 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);359 for (order, (index, mut s)) in queued.into_iter().enumerate() {360 let named = if let Some(ref id) = s.maybe_id {361 Lookup::<T>::remove(id);362 true363 } else {364 false365 };366367 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();368 s.call = call;369370 let resolved = if let Some(completed) = maybe_completed {371 T::PreimageProvider::unrequest_preimage(&completed);372 true373 } else {374 false375 };376 let call = match s.call.as_value().cloned() {377 Some(c) => c,378 None => {379 // Preimage not available - postpone until some block.380 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));381 if let Some(delay) = T::NoPreimagePostponement::get() {382 let until = now.saturating_add(delay);383 if let Some(ref id) = s.maybe_id {384 let index = Agenda::<T>::decode_len(until).unwrap_or(0);385 Lookup::<T>::insert(id, (until, index as u32));386 }387 Agenda::<T>::append(until, Some(s));388 }389 continue;390 }391 };392393 let periodic = s.maybe_periodic.is_some();394 let call_weight = call.get_dispatch_info().weight;395 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));396 let origin =397 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())398 .into();399 if ensure_signed(origin).is_ok() {400 // Weights of Signed dispatches expect their signing account to be whitelisted.401 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));402 }403404 // We allow a scheduled call if any is true:405 // - It's priority is `HARD_DEADLINE`406 // - It does not push the weight past the limit.407 // - It is the first item in the schedule408 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;409 let test_weight = total_weight410 .saturating_add(call_weight)411 .saturating_add(item_weight);412 if !hard_deadline && order > 0 && test_weight > limit {413 // Cannot be scheduled this block - postpone until next.414 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));415 if let Some(ref id) = s.maybe_id {416 // NOTE: We could reasonably not do this (in which case there would be one417 // block where the named and delayed item could not be referenced by name),418 // but we will do it anyway since it should be mostly free in terms of419 // weight and it is slightly cleaner.420 let index = Agenda::<T>::decode_len(next).unwrap_or(0);421 Lookup::<T>::insert(id, (next, index as u32));422 }423 Agenda::<T>::append(next, Some(s));424 continue;425 }426427 let sender = ensure_signed(428 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())429 .into(),430 )431 .unwrap();432433 // // if call have id it was be reserved434 // if s.maybe_id.is_some() {435 // let _ = T::CallExecutor::pay_for_call(436 // s.maybe_id.unwrap(),437 // sender.clone(),438 // call.clone(),439 // );440 // }441442 let r = T::CallExecutor::dispatch_call(sender, call.clone());443444 let mut actual_call_weight: Weight = item_weight;445 let result: Result<_, DispatchError> = match r {446 Ok(o) => match o {447 Ok(di) => {448 actual_call_weight = di.actual_weight.unwrap_or(item_weight);449 Ok(())450 }451 Err(err) => Err(err.error),452 },453 Err(_) => {454 log::error!(455 target: "runtime::scheduler",456 "Warning: Scheduler has failed to execute a post-dispatch transaction. \457 This block might have become invalid.");458 Err(DispatchError::CannotLookup)459 } // todo possibly force a skip/return here, do something with the error460 };461462 total_weight.saturating_accrue(item_weight);463 total_weight.saturating_accrue(actual_call_weight);464465 Self::deposit_event(Event::Dispatched {466 task: (now, index),467 id: s.maybe_id.clone(),468 result,469 });470471 if let &Some((period, count)) = &s.maybe_periodic {472 if count > 1 {473 s.maybe_periodic = Some((period, count - 1));474 } else {475 s.maybe_periodic = None;476 }477 let wake = now + period;478 // If scheduled is named, place its information in `Lookup`479 if let Some(ref id) = s.maybe_id {480 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);481 Lookup::<T>::insert(id, (wake, wake_index as u32));482 }483 Agenda::<T>::append(wake, Some(s));484 }485 }486 0487 //total_weight488 }489 }490491 #[pallet::call]492 impl<T: Config> Pallet<T> {493 /// Schedule a named task.494 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]495 pub fn schedule_named(496 origin: OriginFor<T>,497 id: ScheduledId,498 when: T::BlockNumber,499 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,500 priority: schedule::Priority,501 call: Box<CallOrHashOf<T>>,502 ) -> DispatchResult {503 T::ScheduleOrigin::ensure_origin(origin.clone())?;504 let origin = <T as Config>::Origin::from(origin);505 Self::do_schedule_named(506 id,507 DispatchTime::At(when),508 maybe_periodic,509 priority,510 origin.caller().clone(),511 *call,512 )?;513 Ok(())514 }515516 /// Cancel a named scheduled task.517 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]518 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {519 T::ScheduleOrigin::ensure_origin(origin.clone())?;520 let origin = <T as Config>::Origin::from(origin);521 Self::do_cancel_named(Some(origin.caller().clone()), id)?;522 Ok(())523 }524525 /// Schedule a named task after a delay.526 ///527 /// # <weight>528 /// Same as [`schedule_named`](Self::schedule_named).529 /// # </weight>530 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]531 pub fn schedule_named_after(532 origin: OriginFor<T>,533 id: ScheduledId,534 after: T::BlockNumber,535 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,536 priority: schedule::Priority,537 call: Box<CallOrHashOf<T>>,538 ) -> DispatchResult {539 T::ScheduleOrigin::ensure_origin(origin.clone())?;540 let origin = <T as Config>::Origin::from(origin);541 Self::do_schedule_named(542 id,543 DispatchTime::After(after),544 maybe_periodic,545 priority,546 origin.caller().clone(),547 *call,548 )?;549 Ok(())550 }551 }552}553554impl<T: Config> Pallet<T> {555 #[cfg(feature = "try-runtime")]556 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {557 Ok(())558 }559560 #[cfg(feature = "try-runtime")]561 pub fn post_migrate_to_v3() -> Result<(), &'static str> {562 use frame_support::dispatch::GetStorageVersion;563564 assert!(Self::current_storage_version() == 3);565 for k in Agenda::<T>::iter_keys() {566 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;567 }568 Ok(())569 }570571 /// Helper to migrate scheduler when the pallet origin type has changed.572 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {573 Agenda::<T>::translate::<574 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,575 _,576 >(|_, agenda| {577 Some(578 agenda579 .into_iter()580 .map(|schedule| {581 schedule.map(|schedule| Scheduled {582 maybe_id: schedule.maybe_id,583 priority: schedule.priority,584 call: schedule.call,585 maybe_periodic: schedule.maybe_periodic,586 origin: schedule.origin.into(),587 _phantom: Default::default(),588 })589 })590 .collect::<Vec<_>>(),591 )592 });593 }594595 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {596 let now = frame_system::Pallet::<T>::block_number();597598 let when = match when {599 DispatchTime::At(x) => x,600 // The current block has already completed it's scheduled tasks, so601 // Schedule the task at lest one block after this current block.602 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),603 };604605 if when <= now {606 return Err(Error::<T>::TargetBlockNumberInPast.into());607 }608609 Ok(when)610 }611612 fn do_schedule(613 when: DispatchTime<T::BlockNumber>,614 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,615 priority: schedule::Priority,616 origin: T::PalletsOrigin,617 call: CallOrHashOf<T>,618 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {619 let when = Self::resolve_time(when)?;620 call.ensure_requested::<T::PreimageProvider>();621622 // sanitize maybe_periodic623 let maybe_periodic = maybe_periodic624 .filter(|p| p.1 > 1 && !p.0.is_zero())625 // Remove one from the number of repetitions since we will schedule one now.626 .map(|(p, c)| (p, c - 1));627 let s = Some(Scheduled {628 maybe_id: None,629 priority,630 call,631 maybe_periodic,632 origin,633 _phantom: PhantomData::<T::AccountId>::default(),634 });635 Agenda::<T>::append(when, s);636 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;637 Self::deposit_event(Event::Scheduled { when, index });638639 Ok((when, index))640 }641642 fn do_cancel(643 origin: Option<T::PalletsOrigin>,644 (when, index): TaskAddress<T::BlockNumber>,645 ) -> Result<(), DispatchError> {646 let scheduled = Agenda::<T>::try_mutate(when, |agenda| {647 agenda.get_mut(index as usize).map_or(648 Ok(None),649 |s| -> Result<Option<Scheduled<_, _, _, _>>, DispatchError> {650 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {651 if matches!(652 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),653 Some(Ordering::Less) | None654 ) {655 return Err(BadOrigin.into());656 }657 };658 Ok(s.take())659 },660 )661 })?;662 if let Some(s) = scheduled {663 s.call.ensure_unrequested::<T::PreimageProvider>();664 if let Some(id) = s.maybe_id {665 Lookup::<T>::remove(id);666 }667 Self::deposit_event(Event::Canceled { when, index });668 Ok(())669 } else {670 Err(Error::<T>::NotFound)?671 }672 }673674 fn do_reschedule(675 (when, index): TaskAddress<T::BlockNumber>,676 new_time: DispatchTime<T::BlockNumber>,677 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {678 let new_time = Self::resolve_time(new_time)?;679680 if new_time == when {681 return Err(Error::<T>::RescheduleNoChange.into());682 }683684 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {685 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;686 let task = task.take().ok_or(Error::<T>::NotFound)?;687 Agenda::<T>::append(new_time, Some(task));688 Ok(())689 })?;690691 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;692 Self::deposit_event(Event::Canceled { when, index });693 Self::deposit_event(Event::Scheduled {694 when: new_time,695 index: new_index,696 });697698 Ok((new_time, new_index))699 }700701 fn do_schedule_named(702 id: ScheduledId,703 when: DispatchTime<T::BlockNumber>,704 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,705 priority: schedule::Priority,706 origin: T::PalletsOrigin,707 call: CallOrHashOf<T>,708 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {709 // ensure id it is unique710 if Lookup::<T>::contains_key(&id) {711 return Err(Error::<T>::FailedToSchedule)?;712 }713714 let when = Self::resolve_time(when)?;715716 call.ensure_requested::<T::PreimageProvider>();717718 // sanitize maybe_periodic719 let maybe_periodic = maybe_periodic720 .filter(|p| p.1 > 1 && !p.0.is_zero())721 // Remove one from the number of repetitions since we will schedule one now.722 .map(|(p, c)| (p, c - 1));723724 let s = Scheduled {725 maybe_id: Some(id.clone()),726 priority,727 call: call.clone(),728 maybe_periodic,729 origin: origin.clone(),730 _phantom: Default::default(),731 };732733 // reserve balance for periodic execution734 // let sender =735 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;736 // let repeats = match maybe_periodic {737 // Some(p) => p.1,738 // None => 1,739 // };740 // let _ = T::CallExecutor::reserve_balance(741 // id.clone(),742 // sender,743 // call.as_value().unwrap().clone(),744 // repeats,745 // );746747 Agenda::<T>::append(when, Some(s));748 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;749 let address = (when, index);750 Lookup::<T>::insert(&id, &address);751 Self::deposit_event(Event::Scheduled { when, index });752753 Ok(address)754 }755756 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {757 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {758 if let Some((when, index)) = lookup.take() {759 let i = index as usize;760 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {761 if let Some(s) = agenda.get_mut(i) {762 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {763 if matches!(764 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),765 Some(Ordering::Less) | None766 ) {767 return Err(BadOrigin.into());768 }769 // release balance reserve770 // let sender = ensure_signed(771 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(772 // origin.unwrap(),773 // )774 // .into(),775 // )?;776 // let _ = T::CallExecutor::cancel_reserve(id, sender);777778 s.call.ensure_unrequested::<T::PreimageProvider>();779 }780 *s = None;781 }782 Ok(())783 })?;784785 Self::deposit_event(Event::Canceled { when, index });786 Ok(())787 } else {788 Err(Error::<T>::NotFound)?789 }790 })791 }792793 fn do_reschedule_named(794 id: ScheduledId,795 new_time: DispatchTime<T::BlockNumber>,796 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {797 let new_time = Self::resolve_time(new_time)?;798799 Lookup::<T>::try_mutate_exists(800 id,801 |lookup| -> Result<TaskAddress<T::BlockNumber>, DispatchError> {802 let (when, index) = lookup.ok_or(Error::<T>::NotFound)?;803804 if new_time == when {805 return Err(Error::<T>::RescheduleNoChange.into());806 }807808 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {809 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;810 let task = task.take().ok_or(Error::<T>::NotFound)?;811 Agenda::<T>::append(new_time, Some(task));812813 Ok(())814 })?;815816 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;817 Self::deposit_event(Event::Canceled { when, index });818 Self::deposit_event(Event::Scheduled {819 when: new_time,820 index: new_index,821 });822823 *lookup = Some((new_time, new_index));824825 Ok((new_time, new_index))826 },827 )828 }829}830831impl<T: Config> schedule::v2::Anon<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>832 for Pallet<T>833{834 type Address = TaskAddress<T::BlockNumber>;835 type Hash = T::Hash;836837 fn schedule(838 when: DispatchTime<T::BlockNumber>,839 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,840 priority: schedule::Priority,841 origin: T::PalletsOrigin,842 call: CallOrHashOf<T>,843 ) -> Result<Self::Address, DispatchError> {844 Self::do_schedule(when, maybe_periodic, priority, origin, call)845 }846847 fn cancel((when, index): Self::Address) -> Result<(), ()> {848 Self::do_cancel(None, (when, index)).map_err(|_| ())849 }850851 fn reschedule(852 address: Self::Address,853 when: DispatchTime<T::BlockNumber>,854 ) -> Result<Self::Address, DispatchError> {855 Self::do_reschedule(address, when)856 }857858 fn next_dispatch_time((when, index): Self::Address) -> Result<T::BlockNumber, ()> {859 Agenda::<T>::get(when)860 .get(index as usize)861 .ok_or(())862 .map(|_| when)863 }864}865866impl<T: Config> schedule::v2::Named<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>867 for Pallet<T>868{869 type Address = TaskAddress<T::BlockNumber>;870 type Hash = T::Hash;871872 fn schedule_named(873 id: Vec<u8>,874 when: DispatchTime<T::BlockNumber>,875 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,876 priority: schedule::Priority,877 origin: T::PalletsOrigin,878 call: CallOrHashOf<T>,879 ) -> Result<Self::Address, ()> {880 let inner_id: ScheduledId = id881 .try_into()882 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);883 Self::do_schedule_named(inner_id, when, maybe_periodic, priority, origin, call)884 .map_err(|_| ())885 }886887 fn cancel_named(id: Vec<u8>) -> Result<(), ()> {888 let inner_id: ScheduledId = id889 .try_into()890 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);891 Self::do_cancel_named(None, inner_id).map_err(|_| ())892 }893894 fn reschedule_named(895 id: Vec<u8>,896 when: DispatchTime<T::BlockNumber>,897 ) -> Result<Self::Address, DispatchError> {898 let inner_id: ScheduledId = id899 .try_into()900 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);901 Self::do_reschedule_named(inner_id, when)902 }903904 fn next_dispatch_time(id: Vec<u8>) -> Result<T::BlockNumber, ()> {905 let inner_id: ScheduledId = id906 .try_into()907 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);908 Lookup::<T>::get(inner_id)909 .and_then(|(when, index)| Agenda::<T>::get(when).get(index as usize).map(|_| when))910 .ok_or(())911 }912}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//! # 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//! ## Interface50//!51//! ### Dispatchable Functions52//!53//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and54//! with a specified priority.55//! * `cancel` - cancel a scheduled dispatch, specified by block number and index.56//! * `schedule_named` - augments the `schedule` interface with an additional `Vec<u8>` parameter57//! that can be used for identification.58//! * `cancel_named` - the named complement to the cancel function.5960// Ensure we're `no_std` when compiling for Wasm.61#![cfg_attr(not(feature = "std"), no_std)]6263// FIXME64// #[cfg(feature = "runtime-benchmarks")]65// mod benchmarking;6667pub mod weights;6869use sp_core::H160;70use codec::{Codec, Decode, Encode};71use frame_system::{self as system, ensure_signed};72pub use pallet::*;73use scale_info::TypeInfo;74use sp_runtime::{75 traits::{BadOrigin, One, Saturating, Zero},76 RuntimeDebug, DispatchErrorWithPostInfo,77};78use sp_std::{borrow::Borrow, cmp::Ordering, marker::PhantomData, prelude::*};7980use frame_support::{81 dispatch::{DispatchError, DispatchResult, Dispatchable, Parameter},82 traits::{83 schedule::{self, DispatchTime, MaybeHashed},84 NamedReservableCurrency, EnsureOrigin, Get, IsType, OriginTrait, PrivilegeCmp,85 StorageVersion,86 },87 weights::{GetDispatchInfo, Weight},88};8990pub use weights::WeightInfo;9192/// Just a simple index for naming period tasks.93pub type PeriodicIndex = u32;94/// The location of a scheduled task that can be used to remove it.95pub type TaskAddress<BlockNumber> = (BlockNumber, u32);96pub const MAX_TASK_ID_LENGTH_IN_BYTES: u8 = 16;9798type ScheduledId = [u8; MAX_TASK_ID_LENGTH_IN_BYTES as usize];99pub type CallOrHashOf<T> = MaybeHashed<<T as Config>::Call, <T as frame_system::Config>::Hash>;100101/// Information regarding an item to be executed in the future.102#[cfg_attr(any(feature = "std", test), derive(PartialEq, Eq))]103#[derive(Clone, RuntimeDebug, Encode, Decode, TypeInfo)]104pub struct ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId> {105 /// The unique identity for this task, if there is one.106 maybe_id: Option<ScheduledId>,107 /// This task's priority.108 priority: schedule::Priority,109 /// The call to be dispatched.110 call: Call,111 /// If the call is periodic, then this points to the information concerning that.112 maybe_periodic: Option<schedule::Period<BlockNumber>>,113 /// The origin to dispatch the call.114 origin: PalletsOrigin,115 _phantom: PhantomData<AccountId>,116}117118pub type ScheduledV3Of<T> = ScheduledV3<119 CallOrHashOf<T>,120 <T as frame_system::Config>::BlockNumber,121 <T as Config>::PalletsOrigin,122 <T as frame_system::Config>::AccountId,123>;124125pub type ScheduledOf<T> = ScheduledV3Of<T>;126127/// The current version of Scheduled struct.128pub type Scheduled<Call, BlockNumber, PalletsOrigin, AccountId> =129 ScheduledV3<Call, BlockNumber, PalletsOrigin, AccountId>;130131#[cfg(feature = "runtime-benchmarks")]132mod preimage_provider {133 use frame_support::traits::PreimageRecipient;134 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageRecipient<H> {}135 impl<H, T: PreimageRecipient<H>> PreimageProviderAndMaybeRecipient<H> for T {}136}137138#[cfg(not(feature = "runtime-benchmarks"))]139mod preimage_provider {140 use frame_support::traits::PreimageProvider;141 pub trait PreimageProviderAndMaybeRecipient<H>: PreimageProvider<H> {}142 impl<H, T: PreimageProvider<H>> PreimageProviderAndMaybeRecipient<H> for T {}143}144145pub use preimage_provider::PreimageProviderAndMaybeRecipient;146147pub(crate) trait MarginalWeightInfo: WeightInfo {148 fn item(periodic: bool, named: bool, resolved: Option<bool>) -> Weight {149 match (periodic, named, resolved) {150 (_, false, None) => Self::on_initialize_aborted(2) - Self::on_initialize_aborted(1),151 (_, true, None) => {152 Self::on_initialize_named_aborted(2) - Self::on_initialize_named_aborted(1)153 }154 (false, false, Some(false)) => Self::on_initialize(2) - Self::on_initialize(1),155 (false, true, Some(false)) => {156 Self::on_initialize_named(2) - Self::on_initialize_named(1)157 }158 (true, false, Some(false)) => {159 Self::on_initialize_periodic(2) - Self::on_initialize_periodic(1)160 }161 (true, true, Some(false)) => {162 Self::on_initialize_periodic_named(2) - Self::on_initialize_periodic_named(1)163 }164 (false, false, Some(true)) => {165 Self::on_initialize_resolved(2) - Self::on_initialize_resolved(1)166 }167 (false, true, Some(true)) => {168 Self::on_initialize_named_resolved(2) - Self::on_initialize_named_resolved(1)169 }170 (true, false, Some(true)) => {171 Self::on_initialize_periodic_resolved(2) - Self::on_initialize_periodic_resolved(1)172 }173 (true, true, Some(true)) => {174 Self::on_initialize_periodic_named_resolved(2)175 - Self::on_initialize_periodic_named_resolved(1)176 }177 }178 }179}180impl<T: WeightInfo> MarginalWeightInfo for T {}181182#[frame_support::pallet]183pub mod pallet {184 use super::*;185 use frame_support::{186 dispatch::PostDispatchInfo,187 pallet_prelude::*,188 traits::{schedule::LookupError, PreimageProvider},189 };190 use frame_system::pallet_prelude::*;191192 /// The current storage version.193 const STORAGE_VERSION: StorageVersion = StorageVersion::new(3);194195 #[pallet::pallet]196 #[pallet::generate_store(pub(super) trait Store)]197 #[pallet::storage_version(STORAGE_VERSION)]198 #[pallet::without_storage_info]199 pub struct Pallet<T>(_);200201 /// `system::Config` should always be included in our implied traits.202 #[pallet::config]203 pub trait Config: frame_system::Config {204 /// The overarching event type.205 type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;206207 /// The aggregated origin which the dispatch will take.208 type Origin: OriginTrait<PalletsOrigin = Self::PalletsOrigin>209 + From<Self::PalletsOrigin>210 + IsType<<Self as system::Config>::Origin>;211212 /// The caller origin, overarching type of all pallets origins.213 type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq + TypeInfo;214215 type Currency: NamedReservableCurrency<Self::AccountId, ReserveIdentifier = ScheduledId>;216217 /// The aggregated call type.218 type Call: Parameter219 + Dispatchable<Origin = <Self as Config>::Origin, PostInfo = PostDispatchInfo>220 + GetDispatchInfo221 + From<system::Call<Self>>;222223 /// The maximum weight that may be scheduled per block for any dispatchables of less224 /// priority than `schedule::HARD_DEADLINE`.225 #[pallet::constant]226 type MaximumWeight: Get<Weight>;227228 /// Required origin to schedule or cancel calls.229 type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;230231 /// Compare the privileges of origins.232 ///233 /// This will be used when canceling a task, to ensure that the origin that tries234 /// to cancel has greater or equal privileges as the origin that created the scheduled task.235 ///236 /// For simplicity the [`EqualPrivilegeOnly`](frame_support::traits::EqualPrivilegeOnly) can237 /// be used. This will only check if two given origins are equal.238 type OriginPrivilegeCmp: PrivilegeCmp<Self::PalletsOrigin>;239240 /// The maximum number of scheduled calls in the queue for a single block.241 /// Not strictly enforced, but used for weight estimation.242 #[pallet::constant]243 type MaxScheduledPerBlock: Get<u32>;244245 /// Weight information for extrinsics in this pallet.246 type WeightInfo: WeightInfo;247248 /// The preimage provider with which we look up call hashes to get the call.249 type PreimageProvider: PreimageProviderAndMaybeRecipient<Self::Hash>;250251 /// If `Some` then the number of blocks to postpone execution for when the item is delayed.252 type NoPreimagePostponement: Get<Option<Self::BlockNumber>>;253254 /// Sponsoring function.255 // type SponsorshipHandler: SponsorshipHandler<Self::AccountId, <Self as Config>::Call>;256257 /// The helper type used for custom transaction fee logic.258 type CallExecutor: DispatchCall<Self, H160>;259 }260261 /// A Scheduler-Runtime interface for finer payment handling.262 pub trait DispatchCall<T: frame_system::Config + Config, SelfContainedSignedInfo> {263 fn reserve_balance(264 id: ScheduledId,265 sponsor: <T as frame_system::Config>::AccountId,266 call: <T as Config>::Call,267 count: u32,268 ) -> Result<(), DispatchError>;269270 fn pay_for_call(271 id: ScheduledId,272 sponsor: <T as frame_system::Config>::AccountId,273 call: <T as Config>::Call,274 ) -> Result<u128, DispatchError>;275276 /// Resolve the call dispatch, including any post-dispatch operations.277 fn dispatch_call(278 signer: T::AccountId,279 function: <T as Config>::Call,280 ) -> Result<281 Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>,282 TransactionValidityError,283 >;284285 fn cancel_reserve(286 id: ScheduledId,287 sponsor: <T as frame_system::Config>::AccountId,288 ) -> Result<u128, DispatchError>;289 }290291 /// Items to be executed, indexed by the block number that they should be executed on.292 #[pallet::storage]293 pub type Agenda<T: Config> =294 StorageMap<_, Twox64Concat, T::BlockNumber, Vec<Option<ScheduledV3Of<T>>>, ValueQuery>;295296 /// Lookup from identity to the block number and index of the task.297 #[pallet::storage]298 pub(crate) type Lookup<T: Config> =299 StorageMap<_, Twox64Concat, ScheduledId, TaskAddress<T::BlockNumber>>;300301 /// Events type.302 #[pallet::event]303 #[pallet::generate_deposit(pub(super) fn deposit_event)]304 pub enum Event<T: Config> {305 /// Scheduled some task.306 Scheduled { when: T::BlockNumber, index: u32 },307 /// Canceled some task.308 Canceled { when: T::BlockNumber, index: u32 },309 /// Dispatched some task.310 Dispatched {311 task: TaskAddress<T::BlockNumber>,312 id: Option<ScheduledId>,313 result: DispatchResult,314 },315 /// The call for the provided hash was not found so the task has been aborted.316 CallLookupFailed {317 task: TaskAddress<T::BlockNumber>,318 id: Option<ScheduledId>,319 error: LookupError,320 },321 }322323 #[pallet::error]324 pub enum Error<T> {325 /// Failed to schedule a call326 FailedToSchedule,327 /// Cannot find the scheduled call.328 NotFound,329 /// Given target block number is in the past.330 TargetBlockNumberInPast,331 /// Reschedule failed because it does not change scheduled time.332 RescheduleNoChange,333 }334335 #[pallet::hooks]336 impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {337 /// Execute the scheduled calls338 fn on_initialize(now: T::BlockNumber) -> Weight {339 let limit = T::MaximumWeight::get();340341 let mut queued = Agenda::<T>::take(now)342 .into_iter()343 .enumerate()344 .filter_map(|(index, s)| Some((index as u32, s?)))345 .collect::<Vec<_>>();346347 if queued.len() as u32 > T::MaxScheduledPerBlock::get() {348 log::warn!(349 target: "runtime::scheduler",350 "Warning: This block has more items queued in Scheduler than \351 expected from the runtime configuration. An update might be needed."352 );353 }354355 queued.sort_by_key(|(_, s)| s.priority);356357 let next = now + One::one();358359 let mut total_weight: Weight = T::WeightInfo::on_initialize(0);360 for (order, (index, mut s)) in queued.into_iter().enumerate() {361 let named = if let Some(ref id) = s.maybe_id {362 Lookup::<T>::remove(id);363 true364 } else {365 false366 };367368 let (call, maybe_completed) = s.call.resolved::<T::PreimageProvider>();369 s.call = call;370371 let resolved = if let Some(completed) = maybe_completed {372 T::PreimageProvider::unrequest_preimage(&completed);373 true374 } else {375 false376 };377 let call = match s.call.as_value().cloned() {378 Some(c) => c,379 None => {380 // Preimage not available - postpone until some block.381 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));382 if let Some(delay) = T::NoPreimagePostponement::get() {383 let until = now.saturating_add(delay);384 if let Some(ref id) = s.maybe_id {385 let index = Agenda::<T>::decode_len(until).unwrap_or(0);386 Lookup::<T>::insert(id, (until, index as u32));387 }388 Agenda::<T>::append(until, Some(s));389 }390 continue;391 }392 };393394 let periodic = s.maybe_periodic.is_some();395 let call_weight = call.get_dispatch_info().weight;396 let mut item_weight = T::WeightInfo::item(periodic, named, Some(resolved));397 let origin =398 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())399 .into();400 if ensure_signed(origin).is_ok() {401 // Weights of Signed dispatches expect their signing account to be whitelisted.402 item_weight.saturating_accrue(T::DbWeight::get().reads_writes(1, 1));403 }404405 // We allow a scheduled call if any is true:406 // - It's priority is `HARD_DEADLINE`407 // - It does not push the weight past the limit.408 // - It is the first item in the schedule409 let hard_deadline = s.priority <= schedule::HARD_DEADLINE;410 let test_weight = total_weight411 .saturating_add(call_weight)412 .saturating_add(item_weight);413 if !hard_deadline && order > 0 && test_weight > limit {414 // Cannot be scheduled this block - postpone until next.415 total_weight.saturating_accrue(T::WeightInfo::item(false, named, None));416 if let Some(ref id) = s.maybe_id {417 // NOTE: We could reasonably not do this (in which case there would be one418 // block where the named and delayed item could not be referenced by name),419 // but we will do it anyway since it should be mostly free in terms of420 // weight and it is slightly cleaner.421 let index = Agenda::<T>::decode_len(next).unwrap_or(0);422 Lookup::<T>::insert(id, (next, index as u32));423 }424 Agenda::<T>::append(next, Some(s));425 continue;426 }427428 let sender = ensure_signed(429 <<T as Config>::Origin as From<T::PalletsOrigin>>::from(s.origin.clone())430 .into(),431 )432 .unwrap();433434 // // if call have id it was be reserved435 // if s.maybe_id.is_some() {436 // let _ = T::CallExecutor::pay_for_call(437 // s.maybe_id.unwrap(),438 // sender.clone(),439 // call.clone(),440 // );441 // }442443 let r = T::CallExecutor::dispatch_call(sender, call.clone());444445 let mut actual_call_weight: Weight = item_weight;446 let result: Result<_, DispatchError> = match r {447 Ok(o) => match o {448 Ok(di) => {449 actual_call_weight = di.actual_weight.unwrap_or(item_weight);450 Ok(())451 }452 Err(err) => Err(err.error),453 },454 Err(_) => {455 log::error!(456 target: "runtime::scheduler",457 "Warning: Scheduler has failed to execute a post-dispatch transaction. \458 This block might have become invalid.");459 Err(DispatchError::CannotLookup)460 } // todo possibly force a skip/return here, do something with the error461 };462463 total_weight.saturating_accrue(item_weight);464 total_weight.saturating_accrue(actual_call_weight);465466 Self::deposit_event(Event::Dispatched {467 task: (now, index),468 id: s.maybe_id.clone(),469 result,470 });471472 if let &Some((period, count)) = &s.maybe_periodic {473 if count > 1 {474 s.maybe_periodic = Some((period, count - 1));475 } else {476 s.maybe_periodic = None;477 }478 let wake = now + period;479 // If scheduled is named, place its information in `Lookup`480 if let Some(ref id) = s.maybe_id {481 let wake_index = Agenda::<T>::decode_len(wake).unwrap_or(0);482 Lookup::<T>::insert(id, (wake, wake_index as u32));483 }484 Agenda::<T>::append(wake, Some(s));485 }486 }487 0488 //total_weight489 }490 }491492 #[pallet::call]493 impl<T: Config> Pallet<T> {494 /// Schedule a named task.495 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]496 pub fn schedule_named(497 origin: OriginFor<T>,498 id: ScheduledId,499 when: T::BlockNumber,500 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,501 priority: schedule::Priority,502 call: Box<CallOrHashOf<T>>,503 ) -> DispatchResult {504 T::ScheduleOrigin::ensure_origin(origin.clone())?;505 let origin = <T as Config>::Origin::from(origin);506 Self::do_schedule_named(507 id,508 DispatchTime::At(when),509 maybe_periodic,510 priority,511 origin.caller().clone(),512 *call,513 )?;514 Ok(())515 }516517 /// Cancel a named scheduled task.518 #[pallet::weight(<T as Config>::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get()))]519 pub fn cancel_named(origin: OriginFor<T>, id: ScheduledId) -> DispatchResult {520 T::ScheduleOrigin::ensure_origin(origin.clone())?;521 let origin = <T as Config>::Origin::from(origin);522 Self::do_cancel_named(Some(origin.caller().clone()), id)?;523 Ok(())524 }525526 /// Schedule a named task after a delay.527 ///528 /// # <weight>529 /// Same as [`schedule_named`](Self::schedule_named).530 /// # </weight>531 #[pallet::weight(<T as Config>::WeightInfo::schedule_named(T::MaxScheduledPerBlock::get()))]532 pub fn schedule_named_after(533 origin: OriginFor<T>,534 id: ScheduledId,535 after: T::BlockNumber,536 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,537 priority: schedule::Priority,538 call: Box<CallOrHashOf<T>>,539 ) -> DispatchResult {540 T::ScheduleOrigin::ensure_origin(origin.clone())?;541 let origin = <T as Config>::Origin::from(origin);542 Self::do_schedule_named(543 id,544 DispatchTime::After(after),545 maybe_periodic,546 priority,547 origin.caller().clone(),548 *call,549 )?;550 Ok(())551 }552 }553}554555impl<T: Config> Pallet<T> {556 #[cfg(feature = "try-runtime")]557 pub fn pre_migrate_to_v3() -> Result<(), &'static str> {558 Ok(())559 }560561 #[cfg(feature = "try-runtime")]562 pub fn post_migrate_to_v3() -> Result<(), &'static str> {563 use frame_support::dispatch::GetStorageVersion;564565 assert!(Self::current_storage_version() == 3);566 for k in Agenda::<T>::iter_keys() {567 let _ = Agenda::<T>::try_get(k).map_err(|()| "Invalid item in Agenda")?;568 }569 Ok(())570 }571572 /// Helper to migrate scheduler when the pallet origin type has changed.573 pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {574 Agenda::<T>::translate::<575 Vec<Option<Scheduled<CallOrHashOf<T>, T::BlockNumber, OldOrigin, T::AccountId>>>,576 _,577 >(|_, agenda| {578 Some(579 agenda580 .into_iter()581 .map(|schedule| {582 schedule.map(|schedule| Scheduled {583 maybe_id: schedule.maybe_id,584 priority: schedule.priority,585 call: schedule.call,586 maybe_periodic: schedule.maybe_periodic,587 origin: schedule.origin.into(),588 _phantom: Default::default(),589 })590 })591 .collect::<Vec<_>>(),592 )593 });594 }595596 fn resolve_time(when: DispatchTime<T::BlockNumber>) -> Result<T::BlockNumber, DispatchError> {597 let now = frame_system::Pallet::<T>::block_number();598599 let when = match when {600 DispatchTime::At(x) => x,601 // The current block has already completed it's scheduled tasks, so602 // Schedule the task at lest one block after this current block.603 DispatchTime::After(x) => now.saturating_add(x).saturating_add(One::one()),604 };605606 if when <= now {607 return Err(Error::<T>::TargetBlockNumberInPast.into());608 }609610 Ok(when)611 }612613 fn do_schedule(614 when: DispatchTime<T::BlockNumber>,615 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,616 priority: schedule::Priority,617 origin: T::PalletsOrigin,618 call: CallOrHashOf<T>,619 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {620 let when = Self::resolve_time(when)?;621 call.ensure_requested::<T::PreimageProvider>();622623 // sanitize maybe_periodic624 let maybe_periodic = maybe_periodic625 .filter(|p| p.1 > 1 && !p.0.is_zero())626 // Remove one from the number of repetitions since we will schedule one now.627 .map(|(p, c)| (p, c - 1));628 let s = Some(Scheduled {629 maybe_id: None,630 priority,631 call,632 maybe_periodic,633 origin,634 _phantom: PhantomData::<T::AccountId>::default(),635 });636 Agenda::<T>::append(when, s);637 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;638 Self::deposit_event(Event::Scheduled { when, index });639640 Ok((when, index))641 }642643 fn do_cancel(644 origin: Option<T::PalletsOrigin>,645 (when, index): TaskAddress<T::BlockNumber>,646 ) -> Result<(), DispatchError> {647 let scheduled = Agenda::<T>::try_mutate(when, |agenda| {648 agenda.get_mut(index as usize).map_or(649 Ok(None),650 |s| -> Result<Option<Scheduled<_, _, _, _>>, DispatchError> {651 if let (Some(ref o), Some(ref s)) = (origin, s.borrow()) {652 if matches!(653 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),654 Some(Ordering::Less) | None655 ) {656 return Err(BadOrigin.into());657 }658 };659 Ok(s.take())660 },661 )662 })?;663 if let Some(s) = scheduled {664 s.call.ensure_unrequested::<T::PreimageProvider>();665 if let Some(id) = s.maybe_id {666 Lookup::<T>::remove(id);667 }668 Self::deposit_event(Event::Canceled { when, index });669 Ok(())670 } else {671 Err(Error::<T>::NotFound)?672 }673 }674675 fn do_reschedule(676 (when, index): TaskAddress<T::BlockNumber>,677 new_time: DispatchTime<T::BlockNumber>,678 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {679 let new_time = Self::resolve_time(new_time)?;680681 if new_time == when {682 return Err(Error::<T>::RescheduleNoChange.into());683 }684685 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {686 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;687 let task = task.take().ok_or(Error::<T>::NotFound)?;688 Agenda::<T>::append(new_time, Some(task));689 Ok(())690 })?;691692 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;693 Self::deposit_event(Event::Canceled { when, index });694 Self::deposit_event(Event::Scheduled {695 when: new_time,696 index: new_index,697 });698699 Ok((new_time, new_index))700 }701702 fn do_schedule_named(703 id: ScheduledId,704 when: DispatchTime<T::BlockNumber>,705 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,706 priority: schedule::Priority,707 origin: T::PalletsOrigin,708 call: CallOrHashOf<T>,709 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {710 // ensure id it is unique711 if Lookup::<T>::contains_key(&id) {712 return Err(Error::<T>::FailedToSchedule)?;713 }714715 let when = Self::resolve_time(when)?;716717 call.ensure_requested::<T::PreimageProvider>();718719 // sanitize maybe_periodic720 let maybe_periodic = maybe_periodic721 .filter(|p| p.1 > 1 && !p.0.is_zero())722 // Remove one from the number of repetitions since we will schedule one now.723 .map(|(p, c)| (p, c - 1));724725 let s = Scheduled {726 maybe_id: Some(id.clone()),727 priority,728 call: call.clone(),729 maybe_periodic,730 origin: origin.clone(),731 _phantom: Default::default(),732 };733734 // reserve balance for periodic execution735 // let sender =736 // ensure_signed(<<T as Config>::Origin as From<T::PalletsOrigin>>::from(origin).into())?;737 // let repeats = match maybe_periodic {738 // Some(p) => p.1,739 // None => 1,740 // };741 // let _ = T::CallExecutor::reserve_balance(742 // id.clone(),743 // sender,744 // call.as_value().unwrap().clone(),745 // repeats,746 // );747748 Agenda::<T>::append(when, Some(s));749 let index = Agenda::<T>::decode_len(when).unwrap_or(1) as u32 - 1;750 let address = (when, index);751 Lookup::<T>::insert(&id, &address);752 Self::deposit_event(Event::Scheduled { when, index });753754 Ok(address)755 }756757 fn do_cancel_named(origin: Option<T::PalletsOrigin>, id: ScheduledId) -> DispatchResult {758 Lookup::<T>::try_mutate_exists(id, |lookup| -> DispatchResult {759 if let Some((when, index)) = lookup.take() {760 let i = index as usize;761 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {762 if let Some(s) = agenda.get_mut(i) {763 if let (Some(ref o), Some(ref s)) = (origin.clone(), s.borrow()) {764 if matches!(765 T::OriginPrivilegeCmp::cmp_privilege(o, &s.origin),766 Some(Ordering::Less) | None767 ) {768 return Err(BadOrigin.into());769 }770 // release balance reserve771 // let sender = ensure_signed(772 // <<T as Config>::Origin as From<T::PalletsOrigin>>::from(773 // origin.unwrap(),774 // )775 // .into(),776 // )?;777 // let _ = T::CallExecutor::cancel_reserve(id, sender);778779 s.call.ensure_unrequested::<T::PreimageProvider>();780 }781 *s = None;782 }783 Ok(())784 })?;785786 Self::deposit_event(Event::Canceled { when, index });787 Ok(())788 } else {789 Err(Error::<T>::NotFound)?790 }791 })792 }793794 fn do_reschedule_named(795 id: ScheduledId,796 new_time: DispatchTime<T::BlockNumber>,797 ) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {798 let new_time = Self::resolve_time(new_time)?;799800 Lookup::<T>::try_mutate_exists(801 id,802 |lookup| -> Result<TaskAddress<T::BlockNumber>, DispatchError> {803 let (when, index) = lookup.ok_or(Error::<T>::NotFound)?;804805 if new_time == when {806 return Err(Error::<T>::RescheduleNoChange.into());807 }808809 Agenda::<T>::try_mutate(when, |agenda| -> DispatchResult {810 let task = agenda.get_mut(index as usize).ok_or(Error::<T>::NotFound)?;811 let task = task.take().ok_or(Error::<T>::NotFound)?;812 Agenda::<T>::append(new_time, Some(task));813814 Ok(())815 })?;816817 let new_index = Agenda::<T>::decode_len(new_time).unwrap_or(1) as u32 - 1;818 Self::deposit_event(Event::Canceled { when, index });819 Self::deposit_event(Event::Scheduled {820 when: new_time,821 index: new_index,822 });823824 *lookup = Some((new_time, new_index));825826 Ok((new_time, new_index))827 },828 )829 }830}831832impl<T: Config> schedule::v2::Anon<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>833 for Pallet<T>834{835 type Address = TaskAddress<T::BlockNumber>;836 type Hash = T::Hash;837838 fn schedule(839 when: DispatchTime<T::BlockNumber>,840 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,841 priority: schedule::Priority,842 origin: T::PalletsOrigin,843 call: CallOrHashOf<T>,844 ) -> Result<Self::Address, DispatchError> {845 Self::do_schedule(when, maybe_periodic, priority, origin, call)846 }847848 fn cancel((when, index): Self::Address) -> Result<(), ()> {849 Self::do_cancel(None, (when, index)).map_err(|_| ())850 }851852 fn reschedule(853 address: Self::Address,854 when: DispatchTime<T::BlockNumber>,855 ) -> Result<Self::Address, DispatchError> {856 Self::do_reschedule(address, when)857 }858859 fn next_dispatch_time((when, index): Self::Address) -> Result<T::BlockNumber, ()> {860 Agenda::<T>::get(when)861 .get(index as usize)862 .ok_or(())863 .map(|_| when)864 }865}866867impl<T: Config> schedule::v2::Named<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin>868 for Pallet<T>869{870 type Address = TaskAddress<T::BlockNumber>;871 type Hash = T::Hash;872873 fn schedule_named(874 id: Vec<u8>,875 when: DispatchTime<T::BlockNumber>,876 maybe_periodic: Option<schedule::Period<T::BlockNumber>>,877 priority: schedule::Priority,878 origin: T::PalletsOrigin,879 call: CallOrHashOf<T>,880 ) -> Result<Self::Address, ()> {881 let inner_id: ScheduledId = id882 .try_into()883 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);884 Self::do_schedule_named(inner_id, when, maybe_periodic, priority, origin, call)885 .map_err(|_| ())886 }887888 fn cancel_named(id: Vec<u8>) -> Result<(), ()> {889 let inner_id: ScheduledId = id890 .try_into()891 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);892 Self::do_cancel_named(None, inner_id).map_err(|_| ())893 }894895 fn reschedule_named(896 id: Vec<u8>,897 when: DispatchTime<T::BlockNumber>,898 ) -> Result<Self::Address, DispatchError> {899 let inner_id: ScheduledId = id900 .try_into()901 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);902 Self::do_reschedule_named(inner_id, when)903 }904905 fn next_dispatch_time(id: Vec<u8>) -> Result<T::BlockNumber, ()> {906 let inner_id: ScheduledId = id907 .try_into()908 .unwrap_or([0; MAX_TASK_ID_LENGTH_IN_BYTES as usize]);909 Lookup::<T>::get(inner_id)910 .and_then(|(when, index)| Agenda::<T>::get(when).get(index as usize).map(|_| when))911 .ok_or(())912 }913}pallets/structure/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/structure/src/benchmarking.rs
+++ b/pallets/structure/src/benchmarking.rs
@@ -5,6 +5,7 @@
use up_data_structs::{
CreateCollectionData, CollectionMode, CreateItemData, CreateNftData, budget::Unlimited,
};
+use pallet_common::Config as CommonConfig;
use pallet_evm::account::CrossAccountId;
const SEED: u32 = 1;
@@ -14,8 +15,8 @@
let caller: T::AccountId = account("caller", 0, SEED);
let caller_cross = T::CrossAccountId::from_sub(caller.clone());
- T::Currency::deposit_creating(&caller, T::CollectionCreationPrice::get());
- T::CollectionDispatch::create(caller, CreateCollectionData {
+ <T as CommonConfig>::Currency::deposit_creating(&caller, T::CollectionCreationPrice::get());
+ T::CollectionDispatch::create(caller_cross.clone(), CreateCollectionData {
mode: CollectionMode::NFT,
..Default::default()
})?;
pallets/structure/src/lib.rsdiffbeforeafterboth--- a/pallets/structure/src/lib.rs
+++ b/pallets/structure/src/lib.rs
@@ -3,7 +3,7 @@
use pallet_common::CommonCollectionOperations;
use sp_std::collections::btree_set::BTreeSet;
-use frame_support::dispatch::{DispatchError, DispatchResult};
+use frame_support::dispatch::{DispatchError, DispatchResult, DispatchResultWithPostInfo};
use frame_support::fail;
pub use pallet::*;
use pallet_common::{dispatch::CollectionDispatch, CollectionHandle};
@@ -29,6 +29,8 @@
OuroborosDetected,
/// While searched for owner, encountered depth limit
DepthLimit,
+ /// While iterating over children, encountered breadth limit
+ BreadthLimit,
/// While searched for owner, found token owner by not-yet-existing token
TokenNotFound,
}
@@ -184,6 +186,19 @@
Err(<Error<T>>::DepthLimit.into())
}
+ pub fn burn_item_recursively(
+ from: T::CrossAccountId,
+ collection: CollectionId,
+ token: TokenId,
+ self_budget: &dyn Budget,
+ breadth_budget: &dyn Budget,
+ ) -> DispatchResultWithPostInfo {
+ let handle = <CollectionHandle<T>>::try_get(collection)?;
+ let dispatch = T::CollectionDispatch::dispatch(handle);
+ let dispatch = dispatch.as_dyn();
+ dispatch.burn_item_recursively(from.clone(), token, self_budget, breadth_budget)
+ }
+
pub fn check_nesting(
from: T::CrossAccountId,
under: &T::CrossAccountId,
pallets/unique/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/unique/src/benchmarking.rs
+++ b/pallets/unique/src/benchmarking.rs
@@ -22,7 +22,10 @@
use frame_support::traits::{tokens::currency::Currency, Get};
use frame_benchmarking::{benchmarks, account};
use sp_runtime::DispatchError;
-use pallet_common::benchmarking::{create_data, create_var_data, create_u16_data};
+use pallet_common::{
+ Config as CommonConfig,
+ benchmarking::{create_data, create_u16_data},
+};
const SEED: u32 = 1;
@@ -30,7 +33,7 @@
owner: T::AccountId,
mode: CollectionMode,
) -> Result<CollectionId, DispatchError> {
- T::Currency::deposit_creating(&owner, T::CollectionCreationPrice::get());
+ <T as CommonConfig>::Currency::deposit_creating(&owner, T::CollectionCreationPrice::get());
let col_name = create_u16_data::<MAX_COLLECTION_NAME_LENGTH>();
let col_desc = create_u16_data::<MAX_COLLECTION_DESCRIPTION_LENGTH>();
let token_prefix = create_data::<MAX_TOKEN_PREFIX_LENGTH>();
@@ -54,7 +57,7 @@
let token_prefix = create_data::<MAX_TOKEN_PREFIX_LENGTH>();
let mode: CollectionMode = CollectionMode::NFT;
let caller: T::AccountId = account("caller", 0, SEED);
- T::Currency::deposit_creating(&caller, T::CollectionCreationPrice::get());
+ <T as CommonConfig>::Currency::deposit_creating(&caller, T::CollectionCreationPrice::get());
}: _(RawOrigin::Signed(caller.clone()), col_name.clone(), col_desc.clone(), token_prefix.clone(), mode)
verify {
assert_eq!(<pallet_common::CollectionById<T>>::get(CollectionId(1)).unwrap().owner, caller);
@@ -77,16 +80,6 @@
let collection = create_nft_collection::<T>(caller.clone())?;
<Pallet<T>>::add_to_allow_list(RawOrigin::Signed(caller.clone()).into(), collection, T::CrossAccountId::from_sub(allowlist_account.clone()))?;
}: _(RawOrigin::Signed(caller.clone()), collection, T::CrossAccountId::from_sub(allowlist_account))
-
- set_public_access_mode {
- let caller: T::AccountId = account("caller", 0, SEED);
- let collection = create_nft_collection::<T>(caller.clone())?;
- }: _(RawOrigin::Signed(caller.clone()), collection, AccessMode::AllowList)
-
- set_mint_permission {
- let caller: T::AccountId = account("caller", 0, SEED);
- let collection = create_nft_collection::<T>(caller.clone())?;
- }: _(RawOrigin::Signed(caller.clone()), collection, true)
change_collection_owner {
let caller: T::AccountId = account("caller", 0, SEED);
@@ -145,7 +138,6 @@
owner_can_transfer: Some(true),
sponsored_data_rate_limit: None,
transfers_enabled: Some(true),
- nesting_rule: None,
};
}: set_collection_limits(RawOrigin::Signed(caller.clone()), collection, cl)
}
primitives/data-structs/src/lib.rsdiffbeforeafterboth--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -469,6 +469,8 @@
#[derivative(Debug(format_with = "bounded::set_debug"))]
BoundedBTreeSet<CollectionId, ConstU32<16>>,
),
+ /// Used for tests
+ Permissive,
}
#[derive(Encode, Decode, Debug, Clone, Copy, PartialEq, TypeInfo, MaxEncodedLen)]
runtime/common/src/weights.rsdiffbeforeafterboth--- a/runtime/common/src/weights.rs
+++ b/runtime/common/src/weights.rs
@@ -89,4 +89,12 @@
fn burn_from() -> Weight {
dispatch_weight::<T>() + max_weight_of!(burn_from())
}
+
+ fn burn_recursively_self_raw() -> Weight {
+ max_weight_of!(burn_recursively_self_raw())
+ }
+
+ fn burn_recursively_breadth_raw(amount: u32) -> Weight {
+ max_weight_of!(burn_recursively_breadth_raw(amount))
+ }
}
runtime/unique/src/lib.rsdiffbeforeafterboth--- a/runtime/unique/src/lib.rs
+++ b/runtime/unique/src/lib.rs
@@ -73,6 +73,7 @@
CollectionId, TokenId, TokenData, Property, PropertyKeyPermission, CollectionLimits,
CollectionStats, RpcCollection,
mapping::{EvmTokenAddressMapping, CrossTokenAddressMapping},
+ TokenChild,
};
// use pallet_contracts::weights::WeightInfo;