mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-30 00:17:56 +00:00
Bound uses of Call (#11649)
* Introduce preimages module in traits * Multisize Preimages * Len not actually necessary * Tweaks to the preimage API * Fixes * Get Scheduler building with new API * Scheduler tests pass * Bounded Scheduler 🎉 * Use Agenda holes and introduce IncompleteSince to avoid need to reschedule * Tests pass with new weight system * New benchmarks * Add missing file * Drop preimage when permenantly overeight * Drop preimage when permenantly overeight * Referenda uses latest preimage API * Testing ok * Adding tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add preimage migration Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Docs * Remove dbg * Refactor Democracy * Refactor Democracy * Add final MEL * Remove silly maps * Fixes * Minor refactor * Formatting * Fixes * Fixes * Fixes * Update frame/preimage/src/lib.rs Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Add migrations to Democracy * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Resolve conflicts Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Revert "Resolve conflicts" This reverts commit 734d66d69e54553471ffa54fa52e3e304dc8f106. * Undo wrong resolves... Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * WIP Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Make compile Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * massage clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * More clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * clippy annoyance Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * clippy annoyance Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix benchmarks Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * add missing file * Test <Preimage as QueryPreimage> Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * More tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Clippy harassment Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add test Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fixup tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove old stuff Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fmt Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Test <Scheduler as Anon> trait functions Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update pallet-ui tests Why is this needed? Should not be the case unless master is broken... Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * More scheduler trait test Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * More tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Apply review suggestion Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Beauty fixes Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add Scheduler test migration_v3_to_v4_works Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Merge fixup Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Keep referenda benchmarks instantiatable Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update weights Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use new scheduler weight functions Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use new democracy weight functions Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use weight compare functions Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Update pallet-ui tests Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * More renaming… Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * More renaming… Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add comment Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Implement OnRuntimeUpgrade for scheduler::v3_to_v4 migration Put the migration into a proper `MigrateToV4` struct and implement the OnRuntimeUpgrade hooks for it. Also move the test to use that instead. This should make it easier for adding it to Polkadot. Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Clippy Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Handle undecodable Agendas Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove trash Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix test Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use new OnRuntimeUpgrade functions Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * fix test Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix BoundedSlice::truncate_from Co-authored-by: jakoblell Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix pre_upgrade hook return values Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add more error logging Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Find too large preimages in the pre_upgrade hook Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Test that too large Calls in agendas are ignored Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use new OnRuntimeUpgrade hooks Why did the CI not catch this?! Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * works fine - just more logs Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix staking migration Causing issues on Kusama... Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix UI tests No idea why this is needed. This is actually undoing an earlier change. Maybe the CI has different rustc versions!? Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Remove multisig's Calls (#12072) * Remove multisig's Calls * Multisig: Fix tests and re-introduce reserve logic (#12241) * Fix tests and re-introduce reserve logic * fix benches * add todo * remove irrelevant bench * [Feature] Add a migration that drains and refunds stored calls (#12313) * [Feature] Add a migration that drains and refunds stored calls * migration fixes * fixes * address review comments * consume the whole block weight * fix assertions * license header * fix interface Co-authored-by: parity-processbot <> Co-authored-by: parity-processbot <> Co-authored-by: Roman Useinov <roman.useinov@gmail.com> * Fix test Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix multisig benchmarks Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * ".git/.scripts/bench-bot.sh" pallet dev pallet_democracy * ".git/.scripts/bench-bot.sh" pallet dev pallet_scheduler * ".git/.scripts/bench-bot.sh" pallet dev pallet_preimage Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: parity-processbot <> Co-authored-by: Roman Useinov <roman.useinov@gmail.com>
This commit is contained in:
@@ -3181,8 +3181,8 @@ mod tests {
|
||||
dispatch::{DispatchClass, DispatchInfo, Pays},
|
||||
metadata::*,
|
||||
traits::{
|
||||
CrateVersion, Get, GetCallName, IntegrityTest, OnFinalize, OnIdle, OnInitialize,
|
||||
OnRuntimeUpgrade, PalletInfo,
|
||||
CallerTrait, CrateVersion, Get, GetCallName, IntegrityTest, OnFinalize, OnIdle,
|
||||
OnInitialize, OnRuntimeUpgrade, PalletInfo,
|
||||
},
|
||||
};
|
||||
use sp_weights::RuntimeDbWeight;
|
||||
@@ -3300,6 +3300,16 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
impl CallerTrait<<TraitImpl as system::Config>::AccountId> for OuterOrigin {
|
||||
fn into_system(self) -> Option<RawOrigin<<TraitImpl as system::Config>::AccountId>> {
|
||||
unimplemented!("Not required in tests!")
|
||||
}
|
||||
|
||||
fn as_system_ref(&self) -> Option<&RawOrigin<<TraitImpl as system::Config>::AccountId>> {
|
||||
unimplemented!("Not required in tests!")
|
||||
}
|
||||
}
|
||||
|
||||
impl crate::traits::OriginTrait for OuterOrigin {
|
||||
type Call = <TraitImpl as system::Config>::RuntimeCall;
|
||||
type PalletsOrigin = OuterOrigin;
|
||||
@@ -3325,6 +3335,10 @@ mod tests {
|
||||
unimplemented!("Not required in tests!")
|
||||
}
|
||||
|
||||
fn into_caller(self) -> Self::PalletsOrigin {
|
||||
unimplemented!("Not required in tests!")
|
||||
}
|
||||
|
||||
fn try_with_caller<R>(
|
||||
self,
|
||||
_f: impl FnOnce(Self::PalletsOrigin) -> Result<R, Self::PalletsOrigin>,
|
||||
@@ -3344,6 +3358,9 @@ mod tests {
|
||||
fn as_signed(self) -> Option<Self::AccountId> {
|
||||
unimplemented!("Not required in tests!")
|
||||
}
|
||||
fn as_system_ref(&self) -> Option<&RawOrigin<Self::AccountId>> {
|
||||
unimplemented!("Not required in tests!")
|
||||
}
|
||||
}
|
||||
|
||||
impl system::Config for TraitImpl {
|
||||
|
||||
@@ -58,10 +58,11 @@ pub use misc::{
|
||||
Backing, ConstBool, ConstI128, ConstI16, ConstI32, ConstI64, ConstI8, ConstU128, ConstU16,
|
||||
ConstU32, ConstU64, ConstU8, DefensiveSaturating, EnsureInherentsAreFirst, EqualPrivilegeOnly,
|
||||
EstimateCallFee, ExecuteBlock, ExtrinsicCall, Get, GetBacking, GetDefault, HandleLifetime,
|
||||
IsSubType, IsType, Len, OffchainWorker, OnKilledAccount, OnNewAccount, PreimageProvider,
|
||||
PreimageRecipient, PrivilegeCmp, SameOrOther, Time, TryCollect, TryDrop, TypedGet, UnixTime,
|
||||
WrapperKeepOpaque, WrapperOpaque,
|
||||
IsSubType, IsType, Len, OffchainWorker, OnKilledAccount, OnNewAccount, PrivilegeCmp,
|
||||
SameOrOther, Time, TryCollect, TryDrop, TypedGet, UnixTime, WrapperKeepOpaque, WrapperOpaque,
|
||||
};
|
||||
#[allow(deprecated)]
|
||||
pub use misc::{PreimageProvider, PreimageRecipient};
|
||||
#[doc(hidden)]
|
||||
pub use misc::{DEFENSIVE_OP_INTERNAL_ERROR, DEFENSIVE_OP_PUBLIC_ERROR};
|
||||
|
||||
@@ -96,8 +97,9 @@ mod dispatch;
|
||||
#[allow(deprecated)]
|
||||
pub use dispatch::EnsureOneOf;
|
||||
pub use dispatch::{
|
||||
AsEnsureOriginWithArg, EitherOf, EitherOfDiverse, EnsureOrigin, EnsureOriginWithArg,
|
||||
MapSuccess, NeverEnsureOrigin, OriginTrait, TryMapSuccess, UnfilteredDispatchable,
|
||||
AsEnsureOriginWithArg, CallerTrait, EitherOf, EitherOfDiverse, EnsureOrigin,
|
||||
EnsureOriginWithArg, MapSuccess, NeverEnsureOrigin, OriginTrait, TryMapSuccess,
|
||||
UnfilteredDispatchable,
|
||||
};
|
||||
|
||||
mod voting;
|
||||
@@ -106,6 +108,9 @@ pub use voting::{
|
||||
U128CurrencyToVote, VoteTally,
|
||||
};
|
||||
|
||||
mod preimages;
|
||||
pub use preimages::{Bounded, BoundedInline, FetchResult, Hash, QueryPreimage, StorePreimage};
|
||||
|
||||
#[cfg(feature = "try-runtime")]
|
||||
mod try_runtime;
|
||||
#[cfg(feature = "try-runtime")]
|
||||
|
||||
@@ -236,17 +236,25 @@ pub trait UnfilteredDispatchable {
|
||||
fn dispatch_bypass_filter(self, origin: Self::RuntimeOrigin) -> DispatchResultWithPostInfo;
|
||||
}
|
||||
|
||||
/// The trait implemented by the overarching enumeration of the different pallets' origins.
|
||||
/// Unlike `OriginTrait` impls, this does not include any kind of dispatch/call filter. Also, this
|
||||
/// trait is more flexible in terms of how it can be used: it is a `Parameter` and `Member`, so it
|
||||
/// can be used as dispatchable parameters as well as in storage items.
|
||||
pub trait CallerTrait<AccountId>: Parameter + Member + From<RawOrigin<AccountId>> {
|
||||
/// Extract the signer from the message if it is a `Signed` origin.
|
||||
fn into_system(self) -> Option<RawOrigin<AccountId>>;
|
||||
|
||||
/// Extract a reference to the system-level `RawOrigin` if it is that.
|
||||
fn as_system_ref(&self) -> Option<&RawOrigin<AccountId>>;
|
||||
}
|
||||
|
||||
/// Methods available on `frame_system::Config::RuntimeOrigin`.
|
||||
pub trait OriginTrait: Sized {
|
||||
/// Runtime call type, as in `frame_system::Config::Call`
|
||||
type Call;
|
||||
|
||||
/// The caller origin, overarching type of all pallets origins.
|
||||
type PalletsOrigin: Parameter
|
||||
+ Member
|
||||
+ Into<Self>
|
||||
+ From<RawOrigin<Self::AccountId>>
|
||||
+ MaxEncodedLen;
|
||||
type PalletsOrigin: Into<Self> + CallerTrait<Self::AccountId> + MaxEncodedLen;
|
||||
|
||||
/// The AccountId used across the system.
|
||||
type AccountId;
|
||||
@@ -266,9 +274,12 @@ pub trait OriginTrait: Sized {
|
||||
/// For root origin caller, the filters are bypassed and true is returned.
|
||||
fn filter_call(&self, call: &Self::Call) -> bool;
|
||||
|
||||
/// Get the caller.
|
||||
/// Get a reference to the caller (`CallerTrait` impl).
|
||||
fn caller(&self) -> &Self::PalletsOrigin;
|
||||
|
||||
/// Consume `self` and return the caller.
|
||||
fn into_caller(self) -> Self::PalletsOrigin;
|
||||
|
||||
/// Do something with the caller, consuming self but returning it if the caller was unused.
|
||||
fn try_with_caller<R>(
|
||||
self,
|
||||
@@ -285,7 +296,20 @@ pub trait OriginTrait: Sized {
|
||||
fn signed(by: Self::AccountId) -> Self;
|
||||
|
||||
/// Extract the signer from the message if it is a `Signed` origin.
|
||||
fn as_signed(self) -> Option<Self::AccountId>;
|
||||
fn as_signed(self) -> Option<Self::AccountId> {
|
||||
self.into_caller().into_system().and_then(|s| {
|
||||
if let RawOrigin::Signed(who) = s {
|
||||
Some(who)
|
||||
} else {
|
||||
None
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/// Extract a reference to the sytsem origin, if that's what the caller is.
|
||||
fn as_system_ref(&self) -> Option<&RawOrigin<Self::AccountId>> {
|
||||
self.caller().as_system_ref()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
||||
@@ -932,7 +932,7 @@ pub trait PreimageRecipient<Hash>: PreimageProvider<Hash> {
|
||||
/// Maximum size of a preimage.
|
||||
type MaxSize: Get<u32>;
|
||||
|
||||
/// Store the bytes of a preimage on chain.
|
||||
/// Store the bytes of a preimage on chain infallible due to the bounded type.
|
||||
fn note_preimage(bytes: crate::BoundedVec<u8, Self::MaxSize>);
|
||||
|
||||
/// Clear a previously noted preimage. This is infallible and should be treated more like a
|
||||
|
||||
@@ -0,0 +1,317 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) 2019-2022 Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
//! Stuff for dealing with 32-byte hashed preimages.
|
||||
|
||||
use codec::{Decode, Encode, EncodeLike, MaxEncodedLen};
|
||||
use sp_core::{RuntimeDebug, H256};
|
||||
use sp_io::hashing::blake2_256;
|
||||
use sp_runtime::{traits::ConstU32, DispatchError};
|
||||
use sp_std::borrow::Cow;
|
||||
|
||||
pub type Hash = H256;
|
||||
pub type BoundedInline = crate::BoundedVec<u8, ConstU32<128>>;
|
||||
|
||||
#[derive(
|
||||
Encode, Decode, MaxEncodedLen, Clone, Eq, PartialEq, scale_info::TypeInfo, RuntimeDebug,
|
||||
)]
|
||||
#[codec(mel_bound())]
|
||||
pub enum Bounded<T> {
|
||||
/// A Blake2 256 hash with no preimage length. We
|
||||
/// do not support creation of this except for transitioning from legacy state.
|
||||
/// In the future we will make this a pure `Dummy` item storing only the final `dummy` field.
|
||||
Legacy { hash: Hash, dummy: sp_std::marker::PhantomData<T> },
|
||||
/// A an bounded `Call`. Its encoding must be at most 128 bytes.
|
||||
Inline(BoundedInline),
|
||||
/// A Blake2-256 hash of the call together with an upper limit for its size.
|
||||
Lookup { hash: Hash, len: u32 },
|
||||
}
|
||||
|
||||
impl<T> Bounded<T> {
|
||||
/// Casts the wrapped type into something that encodes alike.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// use frame_support::traits::Bounded;
|
||||
///
|
||||
/// // Transmute from `String` to `&str`.
|
||||
/// let x: Bounded<String> = Bounded::Inline(Default::default());
|
||||
/// let _: Bounded<&str> = x.transmute();
|
||||
/// ```
|
||||
pub fn transmute<S: Encode>(self) -> Bounded<S>
|
||||
where
|
||||
T: Encode + EncodeLike<S>,
|
||||
{
|
||||
use Bounded::*;
|
||||
match self {
|
||||
Legacy { hash, .. } => Legacy { hash, dummy: sp_std::marker::PhantomData },
|
||||
Inline(x) => Inline(x),
|
||||
Lookup { hash, len } => Lookup { hash, len },
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns the hash of the preimage.
|
||||
///
|
||||
/// The hash is re-calculated every time if the preimage is inlined.
|
||||
pub fn hash(&self) -> H256 {
|
||||
use Bounded::*;
|
||||
match self {
|
||||
Legacy { hash, .. } => *hash,
|
||||
Inline(x) => blake2_256(x.as_ref()).into(),
|
||||
Lookup { hash, .. } => *hash,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// The maximum we expect a single legacy hash lookup to be.
|
||||
const MAX_LEGACY_LEN: u32 = 1_000_000;
|
||||
|
||||
impl<T> Bounded<T> {
|
||||
/// Returns the length of the preimage or `None` if the length is unknown.
|
||||
pub fn len(&self) -> Option<u32> {
|
||||
match self {
|
||||
Self::Legacy { .. } => None,
|
||||
Self::Inline(i) => Some(i.len() as u32),
|
||||
Self::Lookup { len, .. } => Some(*len),
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns whether the image will require a lookup to be peeked.
|
||||
pub fn lookup_needed(&self) -> bool {
|
||||
match self {
|
||||
Self::Inline(..) => false,
|
||||
Self::Legacy { .. } | Self::Lookup { .. } => true,
|
||||
}
|
||||
}
|
||||
|
||||
/// The maximum length of the lookup that is needed to peek `Self`.
|
||||
pub fn lookup_len(&self) -> Option<u32> {
|
||||
match self {
|
||||
Self::Inline(..) => None,
|
||||
Self::Legacy { .. } => Some(MAX_LEGACY_LEN),
|
||||
Self::Lookup { len, .. } => Some(*len),
|
||||
}
|
||||
}
|
||||
|
||||
/// Constructs a `Lookup` bounded item.
|
||||
pub fn unrequested(hash: Hash, len: u32) -> Self {
|
||||
Self::Lookup { hash, len }
|
||||
}
|
||||
|
||||
/// Constructs a `Legacy` bounded item.
|
||||
#[deprecated = "This API is only for transitioning to Scheduler v3 API"]
|
||||
pub fn from_legacy_hash(hash: impl Into<Hash>) -> Self {
|
||||
Self::Legacy { hash: hash.into(), dummy: sp_std::marker::PhantomData }
|
||||
}
|
||||
}
|
||||
|
||||
pub type FetchResult = Result<Cow<'static, [u8]>, DispatchError>;
|
||||
|
||||
/// A interface for looking up preimages from their hash on chain.
|
||||
pub trait QueryPreimage {
|
||||
/// Returns whether a preimage exists for a given hash and if so its length.
|
||||
fn len(hash: &Hash) -> Option<u32>;
|
||||
|
||||
/// Returns the preimage for a given hash. If given, `len` must be the size of the preimage.
|
||||
fn fetch(hash: &Hash, len: Option<u32>) -> FetchResult;
|
||||
|
||||
/// Returns whether a preimage request exists for a given hash.
|
||||
fn is_requested(hash: &Hash) -> bool;
|
||||
|
||||
/// Request that someone report a preimage. Providers use this to optimise the economics for
|
||||
/// preimage reporting.
|
||||
fn request(hash: &Hash);
|
||||
|
||||
/// Cancel a previous preimage request.
|
||||
fn unrequest(hash: &Hash);
|
||||
|
||||
/// Request that the data required for decoding the given `bounded` value is made available.
|
||||
fn hold<T>(bounded: &Bounded<T>) {
|
||||
use Bounded::*;
|
||||
match bounded {
|
||||
Inline(..) => {},
|
||||
Legacy { hash, .. } | Lookup { hash, .. } => Self::request(hash),
|
||||
}
|
||||
}
|
||||
|
||||
/// No longer request that the data required for decoding the given `bounded` value is made
|
||||
/// available.
|
||||
fn drop<T>(bounded: &Bounded<T>) {
|
||||
use Bounded::*;
|
||||
match bounded {
|
||||
Inline(..) => {},
|
||||
Legacy { hash, .. } | Lookup { hash, .. } => Self::unrequest(hash),
|
||||
}
|
||||
}
|
||||
|
||||
/// Check to see if all data required for the given `bounded` value is available for its
|
||||
/// decoding.
|
||||
fn have<T>(bounded: &Bounded<T>) -> bool {
|
||||
use Bounded::*;
|
||||
match bounded {
|
||||
Inline(..) => true,
|
||||
Legacy { hash, .. } | Lookup { hash, .. } => Self::len(hash).is_some(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a `Bounded` instance based on the `hash` and `len` of the encoded value. This may not
|
||||
/// be `peek`-able or `realize`-able.
|
||||
fn pick<T>(hash: Hash, len: u32) -> Bounded<T> {
|
||||
Self::request(&hash);
|
||||
Bounded::Lookup { hash, len }
|
||||
}
|
||||
|
||||
/// Convert the given `bounded` instance back into its original instance, also returning the
|
||||
/// exact size of its encoded form if it needed to be looked-up from a stored preimage).
|
||||
///
|
||||
/// NOTE: This does not remove any data needed for realization. If you will no longer use the
|
||||
/// `bounded`, call `realize` instead or call `drop` afterwards.
|
||||
fn peek<T: Decode>(bounded: &Bounded<T>) -> Result<(T, Option<u32>), DispatchError> {
|
||||
use Bounded::*;
|
||||
match bounded {
|
||||
Inline(data) => T::decode(&mut &data[..]).ok().map(|x| (x, None)),
|
||||
Lookup { hash, len } => {
|
||||
let data = Self::fetch(hash, Some(*len))?;
|
||||
T::decode(&mut &data[..]).ok().map(|x| (x, Some(data.len() as u32)))
|
||||
},
|
||||
Legacy { hash, .. } => {
|
||||
let data = Self::fetch(hash, None)?;
|
||||
T::decode(&mut &data[..]).ok().map(|x| (x, Some(data.len() as u32)))
|
||||
},
|
||||
}
|
||||
.ok_or(DispatchError::Corruption)
|
||||
}
|
||||
|
||||
/// Convert the given `bounded` value back into its original instance. If successful,
|
||||
/// `drop` any data backing it. This will not break the realisability of independently
|
||||
/// created instances of `Bounded` which happen to have identical data.
|
||||
fn realize<T: Decode>(bounded: &Bounded<T>) -> Result<(T, Option<u32>), DispatchError> {
|
||||
let r = Self::peek(bounded)?;
|
||||
Self::drop(bounded);
|
||||
Ok(r)
|
||||
}
|
||||
}
|
||||
|
||||
/// A interface for managing preimages to hashes on chain.
|
||||
///
|
||||
/// Note that this API does not assume any underlying user is calling, and thus
|
||||
/// does not handle any preimage ownership or fees. Other system level logic that
|
||||
/// uses this API should implement that on their own side.
|
||||
pub trait StorePreimage: QueryPreimage {
|
||||
/// The maximum length of preimage we can store.
|
||||
///
|
||||
/// This is the maximum length of the *encoded* value that can be passed to `bound`.
|
||||
const MAX_LENGTH: usize;
|
||||
|
||||
/// Request and attempt to store the bytes of a preimage on chain.
|
||||
///
|
||||
/// May return `DispatchError::Exhausted` if the preimage is just too big.
|
||||
fn note(bytes: Cow<[u8]>) -> Result<Hash, DispatchError>;
|
||||
|
||||
/// Attempt to clear a previously noted preimage. Exactly the same as `unrequest` but is
|
||||
/// provided for symmetry.
|
||||
fn unnote(hash: &Hash) {
|
||||
Self::unrequest(hash)
|
||||
}
|
||||
|
||||
/// Convert an otherwise unbounded or large value into a type ready for placing in storage. The
|
||||
/// result is a type whose `MaxEncodedLen` is 131 bytes.
|
||||
///
|
||||
/// NOTE: Once this API is used, you should use either `drop` or `realize`.
|
||||
fn bound<T: Encode>(t: T) -> Result<Bounded<T>, DispatchError> {
|
||||
let data = t.encode();
|
||||
let len = data.len() as u32;
|
||||
Ok(match BoundedInline::try_from(data) {
|
||||
Ok(bounded) => Bounded::Inline(bounded),
|
||||
Err(unbounded) => Bounded::Lookup { hash: Self::note(unbounded.into())?, len },
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl QueryPreimage for () {
|
||||
fn len(_: &Hash) -> Option<u32> {
|
||||
None
|
||||
}
|
||||
fn fetch(_: &Hash, _: Option<u32>) -> FetchResult {
|
||||
Err(DispatchError::Unavailable)
|
||||
}
|
||||
fn is_requested(_: &Hash) -> bool {
|
||||
false
|
||||
}
|
||||
fn request(_: &Hash) {}
|
||||
fn unrequest(_: &Hash) {}
|
||||
}
|
||||
|
||||
impl StorePreimage for () {
|
||||
const MAX_LENGTH: usize = 0;
|
||||
fn note(_: Cow<[u8]>) -> Result<Hash, DispatchError> {
|
||||
Err(DispatchError::Exhausted)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::{bounded_vec, BoundedVec};
|
||||
|
||||
#[test]
|
||||
fn bounded_size_is_correct() {
|
||||
assert_eq!(<Bounded<Vec<u8>> as MaxEncodedLen>::max_encoded_len(), 131);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bounded_basic_works() {
|
||||
let data: BoundedVec<u8, _> = bounded_vec![b'a', b'b', b'c'];
|
||||
let len = data.len() as u32;
|
||||
let hash = blake2_256(&data).into();
|
||||
|
||||
// Inline works
|
||||
{
|
||||
let bound: Bounded<Vec<u8>> = Bounded::Inline(data.clone());
|
||||
assert_eq!(bound.hash(), hash);
|
||||
assert_eq!(bound.len(), Some(len));
|
||||
assert!(!bound.lookup_needed());
|
||||
assert_eq!(bound.lookup_len(), None);
|
||||
}
|
||||
// Legacy works
|
||||
{
|
||||
let bound: Bounded<Vec<u8>> = Bounded::Legacy { hash, dummy: Default::default() };
|
||||
assert_eq!(bound.hash(), hash);
|
||||
assert_eq!(bound.len(), None);
|
||||
assert!(bound.lookup_needed());
|
||||
assert_eq!(bound.lookup_len(), Some(1_000_000));
|
||||
}
|
||||
// Lookup works
|
||||
{
|
||||
let bound: Bounded<Vec<u8>> = Bounded::Lookup { hash, len: data.len() as u32 };
|
||||
assert_eq!(bound.hash(), hash);
|
||||
assert_eq!(bound.len(), Some(len));
|
||||
assert!(bound.lookup_needed());
|
||||
assert_eq!(bound.lookup_len(), Some(len));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bounded_transmuting_works() {
|
||||
let data: BoundedVec<u8, _> = bounded_vec![b'a', b'b', b'c'];
|
||||
|
||||
// Transmute a `String` into a `&str`.
|
||||
let x: Bounded<String> = Bounded::Inline(data.clone());
|
||||
let y: Bounded<&str> = x.transmute();
|
||||
assert_eq!(y, Bounded::Inline(data));
|
||||
}
|
||||
}
|
||||
@@ -17,6 +17,8 @@
|
||||
|
||||
//! Traits and associated utilities for scheduling dispatchables in FRAME.
|
||||
|
||||
#[allow(deprecated)]
|
||||
use super::PreimageProvider;
|
||||
use codec::{Codec, Decode, Encode, EncodeLike, MaxEncodedLen};
|
||||
use scale_info::TypeInfo;
|
||||
use sp_runtime::{traits::Saturating, DispatchError, RuntimeDebug};
|
||||
@@ -128,6 +130,7 @@ impl<T: Decode, H> MaybeHashed<T, H> {
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: deprecate
|
||||
pub mod v1 {
|
||||
use super::*;
|
||||
|
||||
@@ -283,6 +286,7 @@ pub mod v1 {
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: deprecate
|
||||
pub mod v2 {
|
||||
use super::*;
|
||||
|
||||
@@ -375,6 +379,97 @@ pub mod v2 {
|
||||
}
|
||||
}
|
||||
|
||||
pub use v1::*;
|
||||
pub mod v3 {
|
||||
use super::*;
|
||||
use crate::traits::Bounded;
|
||||
|
||||
use super::PreimageProvider;
|
||||
/// A type that can be used as a scheduler.
|
||||
pub trait Anon<BlockNumber, Call, Origin> {
|
||||
/// An address which can be used for removing a scheduled task.
|
||||
type Address: Codec + MaxEncodedLen + Clone + Eq + EncodeLike + Debug + TypeInfo;
|
||||
|
||||
/// Schedule a dispatch to happen at the beginning of some block in the future.
|
||||
///
|
||||
/// This is not named.
|
||||
fn schedule(
|
||||
when: DispatchTime<BlockNumber>,
|
||||
maybe_periodic: Option<Period<BlockNumber>>,
|
||||
priority: Priority,
|
||||
origin: Origin,
|
||||
call: Bounded<Call>,
|
||||
) -> Result<Self::Address, DispatchError>;
|
||||
|
||||
/// Cancel a scheduled task. If periodic, then it will cancel all further instances of that,
|
||||
/// also.
|
||||
///
|
||||
/// Will return an `Unavailable` error if the `address` is invalid.
|
||||
///
|
||||
/// NOTE: This guaranteed to work only *before* the point that it is due to be executed.
|
||||
/// If it ends up being delayed beyond the point of execution, then it cannot be cancelled.
|
||||
///
|
||||
/// NOTE2: This will not work to cancel periodic tasks after their initial execution. For
|
||||
/// that, you must name the task explicitly using the `Named` trait.
|
||||
fn cancel(address: Self::Address) -> Result<(), DispatchError>;
|
||||
|
||||
/// Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed
|
||||
/// only if it is executed *before* the currently scheduled block. For periodic tasks,
|
||||
/// this dispatch is guaranteed to succeed only before the *initial* execution; for
|
||||
/// others, use `reschedule_named`.
|
||||
///
|
||||
/// Will return an `Unavailable` error if the `address` is invalid.
|
||||
fn reschedule(
|
||||
address: Self::Address,
|
||||
when: DispatchTime<BlockNumber>,
|
||||
) -> Result<Self::Address, DispatchError>;
|
||||
|
||||
/// Return the next dispatch time for a given task.
|
||||
///
|
||||
/// Will return an `Unavailable` error if the `address` is invalid.
|
||||
fn next_dispatch_time(address: Self::Address) -> Result<BlockNumber, DispatchError>;
|
||||
}
|
||||
|
||||
pub type TaskName = [u8; 32];
|
||||
|
||||
/// A type that can be used as a scheduler.
|
||||
pub trait Named<BlockNumber, Call, Origin> {
|
||||
/// An address which can be used for removing a scheduled task.
|
||||
type Address: Codec + MaxEncodedLen + Clone + Eq + EncodeLike + sp_std::fmt::Debug;
|
||||
|
||||
/// Schedule a dispatch to happen at the beginning of some block in the future.
|
||||
///
|
||||
/// - `id`: The identity of the task. This must be unique and will return an error if not.
|
||||
fn schedule_named(
|
||||
id: TaskName,
|
||||
when: DispatchTime<BlockNumber>,
|
||||
maybe_periodic: Option<Period<BlockNumber>>,
|
||||
priority: Priority,
|
||||
origin: Origin,
|
||||
call: Bounded<Call>,
|
||||
) -> Result<Self::Address, DispatchError>;
|
||||
|
||||
/// Cancel a scheduled, named task. If periodic, then it will cancel all further instances
|
||||
/// of that, also.
|
||||
///
|
||||
/// Will return an `Unavailable` error if the `id` is invalid.
|
||||
///
|
||||
/// NOTE: This guaranteed to work only *before* the point that it is due to be executed.
|
||||
/// If it ends up being delayed beyond the point of execution, then it cannot be cancelled.
|
||||
fn cancel_named(id: TaskName) -> Result<(), DispatchError>;
|
||||
|
||||
/// Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed
|
||||
/// only if it is executed *before* the currently scheduled block.
|
||||
///
|
||||
/// Will return an `Unavailable` error if the `id` is invalid.
|
||||
fn reschedule_named(
|
||||
id: TaskName,
|
||||
when: DispatchTime<BlockNumber>,
|
||||
) -> Result<Self::Address, DispatchError>;
|
||||
|
||||
/// Return the next dispatch time for a given task.
|
||||
///
|
||||
/// Will return an `Unavailable` error if the `id` is invalid.
|
||||
fn next_dispatch_time(id: TaskName) -> Result<BlockNumber, DispatchError>;
|
||||
}
|
||||
}
|
||||
|
||||
pub use v1::*;
|
||||
|
||||
Reference in New Issue
Block a user