feat: Rebrand Polkadot/Substrate references to PezkuwiChain
This commit systematically rebrands various references from Parity Technologies' Polkadot/Substrate ecosystem to PezkuwiChain within the kurdistan-sdk. Key changes include: - Updated external repository URLs (zombienet-sdk, parity-db, parity-scale-codec, wasm-instrument) to point to pezkuwichain forks. - Modified internal documentation and code comments to reflect PezkuwiChain naming and structure. - Replaced direct references to with or specific paths within the for XCM, Pezkuwi, and other modules. - Cleaned up deprecated issue and PR references in various and files, particularly in and modules. - Adjusted image and logo URLs in documentation to point to PezkuwiChain assets. - Removed or rephrased comments related to external Polkadot/Substrate PRs and issues. This is a significant step towards fully customizing the SDK for the PezkuwiChain ecosystem.
This commit is contained in:
@@ -0,0 +1,640 @@
|
||||
// This file is part of Bizinikiwi.
|
||||
|
||||
// Copyright (C) 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.
|
||||
|
||||
//! # Utility Pallet
|
||||
//! A stateless pallet with helpers for dispatch management which does no re-authentication.
|
||||
//!
|
||||
//! - [`Config`]
|
||||
//! - [`Call`]
|
||||
//!
|
||||
//! ## Overview
|
||||
//!
|
||||
//! This pallet contains two basic pieces of functionality:
|
||||
//! - Batch dispatch: A stateless operation, allowing any origin to execute multiple calls in a
|
||||
//! single dispatch. This can be useful to amalgamate proposals, combining `set_code` with
|
||||
//! corresponding `set_storage`s, for efficient multiple payouts with just a single signature
|
||||
//! verify, or in combination with one of the other two dispatch functionality.
|
||||
//! - Pseudonymal dispatch: A stateless operation, allowing a signed origin to execute a call from
|
||||
//! an alternative signed origin. Each account has 2 * 2**16 possible "pseudonyms" (alternative
|
||||
//! account IDs) and these can be stacked. This can be useful as a key management tool, where you
|
||||
//! need multiple distinct accounts (e.g. as controllers for many staking accounts), but where
|
||||
//! it's perfectly fine to have each of them controlled by the same underlying keypair. Derivative
|
||||
//! accounts are, for the purposes of proxy filtering considered exactly the same as the origin
|
||||
//! and are thus hampered with the origin's filters.
|
||||
//!
|
||||
//! Since proxy filters are respected in all dispatches of this pallet, it should never need to be
|
||||
//! filtered by any proxy.
|
||||
//!
|
||||
//! ## Interface
|
||||
//!
|
||||
//! ### Dispatchable Functions
|
||||
//!
|
||||
//! #### For batch dispatch
|
||||
//! * `batch` - Dispatch multiple calls from the sender's origin.
|
||||
//!
|
||||
//! #### For pseudonymal dispatch
|
||||
//! * `as_derivative` - Dispatch a call from a derivative signed origin.
|
||||
|
||||
// Ensure we're `no_std` when compiling for Wasm.
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
mod benchmarking;
|
||||
mod tests;
|
||||
pub mod weights;
|
||||
|
||||
extern crate alloc;
|
||||
|
||||
use alloc::{boxed::Box, vec::Vec};
|
||||
use codec::{Decode, Encode};
|
||||
use pezframe_support::{
|
||||
dispatch::{
|
||||
extract_actual_weight,
|
||||
DispatchClass::{Normal, Operational},
|
||||
GetDispatchInfo, PostDispatchInfo,
|
||||
},
|
||||
traits::{IsSubType, OriginTrait, UnfilteredDispatchable},
|
||||
};
|
||||
use pezsp_core::TypeId;
|
||||
use pezsp_io::hashing::blake2_256;
|
||||
use pezsp_runtime::traits::{BadOrigin, Dispatchable, TrailingZeroInput};
|
||||
pub use weights::WeightInfo;
|
||||
|
||||
pub use pallet::*;
|
||||
|
||||
#[pezframe_support::pallet]
|
||||
pub mod pallet {
|
||||
use super::*;
|
||||
use pezframe_support::{dispatch::DispatchClass, pezpallet_prelude::*};
|
||||
use pezframe_system::pezpallet_prelude::*;
|
||||
|
||||
#[pallet::pallet]
|
||||
pub struct Pallet<T>(_);
|
||||
|
||||
/// Configuration trait.
|
||||
#[pallet::config]
|
||||
pub trait Config: pezframe_system::Config {
|
||||
/// The overarching event type.
|
||||
#[allow(deprecated)]
|
||||
type RuntimeEvent: From<Event> + IsType<<Self as pezframe_system::Config>::RuntimeEvent>;
|
||||
|
||||
/// The overarching call type.
|
||||
type RuntimeCall: Parameter
|
||||
+ Dispatchable<RuntimeOrigin = Self::RuntimeOrigin, PostInfo = PostDispatchInfo>
|
||||
+ GetDispatchInfo
|
||||
+ From<pezframe_system::Call<Self>>
|
||||
+ UnfilteredDispatchable<RuntimeOrigin = Self::RuntimeOrigin>
|
||||
+ IsSubType<Call<Self>>
|
||||
+ IsType<<Self as pezframe_system::Config>::RuntimeCall>;
|
||||
|
||||
/// The caller origin, overarching type of all pallets origins.
|
||||
type PalletsOrigin: Parameter +
|
||||
Into<<Self as pezframe_system::Config>::RuntimeOrigin> +
|
||||
IsType<<<Self as pezframe_system::Config>::RuntimeOrigin as pezframe_support::traits::OriginTrait>::PalletsOrigin>;
|
||||
|
||||
/// Weight information for extrinsics in this pallet.
|
||||
type WeightInfo: WeightInfo;
|
||||
}
|
||||
|
||||
#[pallet::event]
|
||||
#[pallet::generate_deposit(pub(super) fn deposit_event)]
|
||||
pub enum Event {
|
||||
/// Batch of dispatches did not complete fully. Index of first failing dispatch given, as
|
||||
/// well as the error.
|
||||
BatchInterrupted { index: u32, error: DispatchError },
|
||||
/// Batch of dispatches completed fully with no error.
|
||||
BatchCompleted,
|
||||
/// Batch of dispatches completed but has errors.
|
||||
BatchCompletedWithErrors,
|
||||
/// A single item within a Batch of dispatches has completed with no error.
|
||||
ItemCompleted,
|
||||
/// A single item within a Batch of dispatches has completed with error.
|
||||
ItemFailed { error: DispatchError },
|
||||
/// A call was dispatched.
|
||||
DispatchedAs { result: DispatchResult },
|
||||
/// Main call was dispatched.
|
||||
IfElseMainSuccess,
|
||||
/// The fallback call was dispatched.
|
||||
IfElseFallbackCalled { main_error: DispatchError },
|
||||
}
|
||||
|
||||
// Align the call size to 1KB. As we are currently compiling the runtime for native/wasm
|
||||
// the `size_of` of the `Call` can be different. To ensure that this don't leads to
|
||||
// mismatches between native/wasm or to different metadata for the same runtime, we
|
||||
// algin the call size. The value is chosen big enough to hopefully never reach it.
|
||||
const CALL_ALIGN: u32 = 1024;
|
||||
|
||||
#[pallet::extra_constants]
|
||||
impl<T: Config> Pallet<T> {
|
||||
/// The limit on the number of batched calls.
|
||||
fn batched_calls_limit() -> u32 {
|
||||
let allocator_limit = pezsp_core::MAX_POSSIBLE_ALLOCATION;
|
||||
let call_size = (core::mem::size_of::<<T as Config>::RuntimeCall>() as u32)
|
||||
.div_ceil(CALL_ALIGN) *
|
||||
CALL_ALIGN;
|
||||
// The margin to take into account vec doubling capacity.
|
||||
let margin_factor = 3;
|
||||
|
||||
allocator_limit / margin_factor / call_size
|
||||
}
|
||||
}
|
||||
|
||||
#[pallet::hooks]
|
||||
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
|
||||
fn integrity_test() {
|
||||
// If you hit this error, you need to try to `Box` big dispatchable parameters.
|
||||
assert!(
|
||||
core::mem::size_of::<<T as Config>::RuntimeCall>() as u32 <= CALL_ALIGN,
|
||||
"Call enum size should be smaller than {} bytes.",
|
||||
CALL_ALIGN,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[pallet::error]
|
||||
pub enum Error<T> {
|
||||
/// Too many calls batched.
|
||||
TooManyCalls,
|
||||
}
|
||||
|
||||
#[pallet::call]
|
||||
impl<T: Config> Pallet<T> {
|
||||
/// Send a batch of dispatch calls.
|
||||
///
|
||||
/// May be called from any origin except `None`.
|
||||
///
|
||||
/// - `calls`: The calls to be dispatched from the same origin. The number of call must not
|
||||
/// exceed the constant: `batched_calls_limit` (available in constant metadata).
|
||||
///
|
||||
/// If origin is root then the calls are dispatched without checking origin filter. (This
|
||||
/// includes bypassing `pezframe_system::Config::BaseCallFilter`).
|
||||
///
|
||||
/// ## Complexity
|
||||
/// - O(C) where C is the number of calls to be batched.
|
||||
///
|
||||
/// This will return `Ok` in all circumstances. To determine the success of the batch, an
|
||||
/// event is deposited. If a call failed and the batch was interrupted, then the
|
||||
/// `BatchInterrupted` event is deposited, along with the number of successful calls made
|
||||
/// and the error of the failed call. If all were successful, then the `BatchCompleted`
|
||||
/// event is deposited.
|
||||
#[pallet::call_index(0)]
|
||||
#[pallet::weight({
|
||||
let (dispatch_weight, dispatch_class) = Pallet::<T>::weight_and_dispatch_class(&calls);
|
||||
let dispatch_weight = dispatch_weight.saturating_add(T::WeightInfo::batch(calls.len() as u32));
|
||||
(dispatch_weight, dispatch_class)
|
||||
})]
|
||||
pub fn batch(
|
||||
origin: OriginFor<T>,
|
||||
calls: Vec<<T as Config>::RuntimeCall>,
|
||||
) -> DispatchResultWithPostInfo {
|
||||
// Do not allow the `None` origin.
|
||||
if ensure_none(origin.clone()).is_ok() {
|
||||
return Err(BadOrigin.into());
|
||||
}
|
||||
|
||||
let is_root = ensure_root(origin.clone()).is_ok();
|
||||
let calls_len = calls.len();
|
||||
ensure!(calls_len <= Self::batched_calls_limit() as usize, Error::<T>::TooManyCalls);
|
||||
|
||||
// Track the actual weight of each of the batch calls.
|
||||
let mut weight = Weight::zero();
|
||||
for (index, call) in calls.into_iter().enumerate() {
|
||||
let info = call.get_dispatch_info();
|
||||
// If origin is root, don't apply any dispatch filters; root can call anything.
|
||||
let result = if is_root {
|
||||
call.dispatch_bypass_filter(origin.clone())
|
||||
} else {
|
||||
call.dispatch(origin.clone())
|
||||
};
|
||||
// Add the weight of this call.
|
||||
weight = weight.saturating_add(extract_actual_weight(&result, &info));
|
||||
if let Err(e) = result {
|
||||
Self::deposit_event(Event::BatchInterrupted {
|
||||
index: index as u32,
|
||||
error: e.error,
|
||||
});
|
||||
// Take the weight of this function itself into account.
|
||||
let base_weight = T::WeightInfo::batch(index.saturating_add(1) as u32);
|
||||
// Return the actual used weight + base_weight of this call.
|
||||
return Ok(Some(base_weight.saturating_add(weight)).into());
|
||||
}
|
||||
Self::deposit_event(Event::ItemCompleted);
|
||||
}
|
||||
Self::deposit_event(Event::BatchCompleted);
|
||||
let base_weight = T::WeightInfo::batch(calls_len as u32);
|
||||
Ok(Some(base_weight.saturating_add(weight)).into())
|
||||
}
|
||||
|
||||
/// Send a call through an indexed pseudonym of the sender.
|
||||
///
|
||||
/// Filter from origin are passed along. The call will be dispatched with an origin which
|
||||
/// use the same filter as the origin of this call.
|
||||
///
|
||||
/// NOTE: If you need to ensure that any account-based filtering is not honored (i.e.
|
||||
/// because you expect `proxy` to have been used prior in the call stack and you do not want
|
||||
/// the call restrictions to apply to any sub-accounts), then use `as_multi_threshold_1`
|
||||
/// in the Multisig pallet instead.
|
||||
///
|
||||
/// NOTE: Prior to version *12, this was called `as_limited_sub`.
|
||||
///
|
||||
/// The dispatch origin for this call must be _Signed_.
|
||||
#[pallet::call_index(1)]
|
||||
#[pallet::weight({
|
||||
let dispatch_info = call.get_dispatch_info();
|
||||
(
|
||||
T::WeightInfo::as_derivative()
|
||||
// AccountData for inner call origin accountdata.
|
||||
.saturating_add(T::DbWeight::get().reads_writes(1, 1))
|
||||
.saturating_add(dispatch_info.call_weight),
|
||||
dispatch_info.class,
|
||||
)
|
||||
})]
|
||||
pub fn as_derivative(
|
||||
origin: OriginFor<T>,
|
||||
index: u16,
|
||||
call: Box<<T as Config>::RuntimeCall>,
|
||||
) -> DispatchResultWithPostInfo {
|
||||
let mut origin = origin;
|
||||
let who = ensure_signed(origin.clone())?;
|
||||
let pseudonym = derivative_account_id(who, index);
|
||||
origin.set_caller_from(pezframe_system::RawOrigin::Signed(pseudonym));
|
||||
let info = call.get_dispatch_info();
|
||||
let result = call.dispatch(origin);
|
||||
// Always take into account the base weight of this call.
|
||||
let mut weight = T::WeightInfo::as_derivative()
|
||||
.saturating_add(T::DbWeight::get().reads_writes(1, 1));
|
||||
// Add the real weight of the dispatch.
|
||||
weight = weight.saturating_add(extract_actual_weight(&result, &info));
|
||||
result
|
||||
.map_err(|mut err| {
|
||||
err.post_info = Some(weight).into();
|
||||
err
|
||||
})
|
||||
.map(|_| Some(weight).into())
|
||||
}
|
||||
|
||||
/// Send a batch of dispatch calls and atomically execute them.
|
||||
/// The whole transaction will rollback and fail if any of the calls failed.
|
||||
///
|
||||
/// May be called from any origin except `None`.
|
||||
///
|
||||
/// - `calls`: The calls to be dispatched from the same origin. The number of call must not
|
||||
/// exceed the constant: `batched_calls_limit` (available in constant metadata).
|
||||
///
|
||||
/// If origin is root then the calls are dispatched without checking origin filter. (This
|
||||
/// includes bypassing `pezframe_system::Config::BaseCallFilter`).
|
||||
///
|
||||
/// ## Complexity
|
||||
/// - O(C) where C is the number of calls to be batched.
|
||||
#[pallet::call_index(2)]
|
||||
#[pallet::weight({
|
||||
let (dispatch_weight, dispatch_class) = Pallet::<T>::weight_and_dispatch_class(&calls);
|
||||
let dispatch_weight = dispatch_weight.saturating_add(T::WeightInfo::batch_all(calls.len() as u32));
|
||||
(dispatch_weight, dispatch_class)
|
||||
})]
|
||||
pub fn batch_all(
|
||||
origin: OriginFor<T>,
|
||||
calls: Vec<<T as Config>::RuntimeCall>,
|
||||
) -> DispatchResultWithPostInfo {
|
||||
// Do not allow the `None` origin.
|
||||
if ensure_none(origin.clone()).is_ok() {
|
||||
return Err(BadOrigin.into());
|
||||
}
|
||||
|
||||
let is_root = ensure_root(origin.clone()).is_ok();
|
||||
let calls_len = calls.len();
|
||||
ensure!(calls_len <= Self::batched_calls_limit() as usize, Error::<T>::TooManyCalls);
|
||||
|
||||
// Track the actual weight of each of the batch calls.
|
||||
let mut weight = Weight::zero();
|
||||
for (index, call) in calls.into_iter().enumerate() {
|
||||
let info = call.get_dispatch_info();
|
||||
// If origin is root, bypass any dispatch filter; root can call anything.
|
||||
let result = if is_root {
|
||||
call.dispatch_bypass_filter(origin.clone())
|
||||
} else {
|
||||
let mut filtered_origin = origin.clone();
|
||||
// Don't allow users to nest `batch_all` calls.
|
||||
filtered_origin.add_filter(
|
||||
move |c: &<T as pezframe_system::Config>::RuntimeCall| {
|
||||
let c = <T as Config>::RuntimeCall::from_ref(c);
|
||||
!matches!(c.is_sub_type(), Some(Call::batch_all { .. }))
|
||||
},
|
||||
);
|
||||
call.dispatch(filtered_origin)
|
||||
};
|
||||
// Add the weight of this call.
|
||||
weight = weight.saturating_add(extract_actual_weight(&result, &info));
|
||||
result.map_err(|mut err| {
|
||||
// Take the weight of this function itself into account.
|
||||
let base_weight = T::WeightInfo::batch_all(index.saturating_add(1) as u32);
|
||||
// Return the actual used weight + base_weight of this call.
|
||||
err.post_info = Some(base_weight.saturating_add(weight)).into();
|
||||
err
|
||||
})?;
|
||||
Self::deposit_event(Event::ItemCompleted);
|
||||
}
|
||||
Self::deposit_event(Event::BatchCompleted);
|
||||
let base_weight = T::WeightInfo::batch_all(calls_len as u32);
|
||||
Ok(Some(base_weight.saturating_add(weight)).into())
|
||||
}
|
||||
|
||||
/// Dispatches a function call with a provided origin.
|
||||
///
|
||||
/// The dispatch origin for this call must be _Root_.
|
||||
///
|
||||
/// ## Complexity
|
||||
/// - O(1).
|
||||
#[pallet::call_index(3)]
|
||||
#[pallet::weight({
|
||||
let dispatch_info = call.get_dispatch_info();
|
||||
(
|
||||
T::WeightInfo::dispatch_as()
|
||||
.saturating_add(dispatch_info.call_weight),
|
||||
dispatch_info.class,
|
||||
)
|
||||
})]
|
||||
pub fn dispatch_as(
|
||||
origin: OriginFor<T>,
|
||||
as_origin: Box<T::PalletsOrigin>,
|
||||
call: Box<<T as Config>::RuntimeCall>,
|
||||
) -> DispatchResult {
|
||||
ensure_root(origin)?;
|
||||
|
||||
let res = call.dispatch_bypass_filter((*as_origin).into());
|
||||
|
||||
Self::deposit_event(Event::DispatchedAs {
|
||||
result: res.map(|_| ()).map_err(|e| e.error),
|
||||
});
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Send a batch of dispatch calls.
|
||||
/// Unlike `batch`, it allows errors and won't interrupt.
|
||||
///
|
||||
/// May be called from any origin except `None`.
|
||||
///
|
||||
/// - `calls`: The calls to be dispatched from the same origin. The number of call must not
|
||||
/// exceed the constant: `batched_calls_limit` (available in constant metadata).
|
||||
///
|
||||
/// If origin is root then the calls are dispatch without checking origin filter. (This
|
||||
/// includes bypassing `pezframe_system::Config::BaseCallFilter`).
|
||||
///
|
||||
/// ## Complexity
|
||||
/// - O(C) where C is the number of calls to be batched.
|
||||
#[pallet::call_index(4)]
|
||||
#[pallet::weight({
|
||||
let (dispatch_weight, dispatch_class) = Pallet::<T>::weight_and_dispatch_class(&calls);
|
||||
let dispatch_weight = dispatch_weight.saturating_add(T::WeightInfo::force_batch(calls.len() as u32));
|
||||
(dispatch_weight, dispatch_class)
|
||||
})]
|
||||
pub fn force_batch(
|
||||
origin: OriginFor<T>,
|
||||
calls: Vec<<T as Config>::RuntimeCall>,
|
||||
) -> DispatchResultWithPostInfo {
|
||||
// Do not allow the `None` origin.
|
||||
if ensure_none(origin.clone()).is_ok() {
|
||||
return Err(BadOrigin.into());
|
||||
}
|
||||
|
||||
let is_root = ensure_root(origin.clone()).is_ok();
|
||||
let calls_len = calls.len();
|
||||
ensure!(calls_len <= Self::batched_calls_limit() as usize, Error::<T>::TooManyCalls);
|
||||
|
||||
// Track the actual weight of each of the batch calls.
|
||||
let mut weight = Weight::zero();
|
||||
// Track failed dispatch occur.
|
||||
let mut has_error: bool = false;
|
||||
for call in calls.into_iter() {
|
||||
let info = call.get_dispatch_info();
|
||||
// If origin is root, don't apply any dispatch filters; root can call anything.
|
||||
let result = if is_root {
|
||||
call.dispatch_bypass_filter(origin.clone())
|
||||
} else {
|
||||
call.dispatch(origin.clone())
|
||||
};
|
||||
// Add the weight of this call.
|
||||
weight = weight.saturating_add(extract_actual_weight(&result, &info));
|
||||
if let Err(e) = result {
|
||||
has_error = true;
|
||||
Self::deposit_event(Event::ItemFailed { error: e.error });
|
||||
} else {
|
||||
Self::deposit_event(Event::ItemCompleted);
|
||||
}
|
||||
}
|
||||
if has_error {
|
||||
Self::deposit_event(Event::BatchCompletedWithErrors);
|
||||
} else {
|
||||
Self::deposit_event(Event::BatchCompleted);
|
||||
}
|
||||
let base_weight = T::WeightInfo::force_batch(calls_len as u32);
|
||||
Ok(Some(base_weight.saturating_add(weight)).into())
|
||||
}
|
||||
|
||||
/// Dispatch a function call with a specified weight.
|
||||
///
|
||||
/// This function does not check the weight of the call, and instead allows the
|
||||
/// Root origin to specify the weight of the call.
|
||||
///
|
||||
/// The dispatch origin for this call must be _Root_.
|
||||
#[pallet::call_index(5)]
|
||||
#[pallet::weight((*weight, call.get_dispatch_info().class))]
|
||||
pub fn with_weight(
|
||||
origin: OriginFor<T>,
|
||||
call: Box<<T as Config>::RuntimeCall>,
|
||||
weight: Weight,
|
||||
) -> DispatchResult {
|
||||
ensure_root(origin)?;
|
||||
let _ = weight; // Explicitly don't check the the weight witness.
|
||||
|
||||
let res = call.dispatch_bypass_filter(pezframe_system::RawOrigin::Root.into());
|
||||
res.map(|_| ()).map_err(|e| e.error)
|
||||
}
|
||||
|
||||
/// Dispatch a fallback call in the event the main call fails to execute.
|
||||
/// May be called from any origin except `None`.
|
||||
///
|
||||
/// This function first attempts to dispatch the `main` call.
|
||||
/// If the `main` call fails, the `fallback` is attemted.
|
||||
/// if the fallback is successfully dispatched, the weights of both calls
|
||||
/// are accumulated and an event containing the main call error is deposited.
|
||||
///
|
||||
/// In the event of a fallback failure the whole call fails
|
||||
/// with the weights returned.
|
||||
///
|
||||
/// - `main`: The main call to be dispatched. This is the primary action to execute.
|
||||
/// - `fallback`: The fallback call to be dispatched in case the `main` call fails.
|
||||
///
|
||||
/// ## Dispatch Logic
|
||||
/// - If the origin is `root`, both the main and fallback calls are executed without
|
||||
/// applying any origin filters.
|
||||
/// - If the origin is not `root`, the origin filter is applied to both the `main` and
|
||||
/// `fallback` calls.
|
||||
///
|
||||
/// ## Use Case
|
||||
/// - Some use cases might involve submitting a `batch` type call in either main, fallback
|
||||
/// or both.
|
||||
#[pallet::call_index(6)]
|
||||
#[pallet::weight({
|
||||
let main = main.get_dispatch_info();
|
||||
let fallback = fallback.get_dispatch_info();
|
||||
(
|
||||
T::WeightInfo::if_else()
|
||||
.saturating_add(main.call_weight)
|
||||
.saturating_add(fallback.call_weight),
|
||||
if main.class == Operational && fallback.class == Operational { Operational } else { Normal },
|
||||
)
|
||||
})]
|
||||
pub fn if_else(
|
||||
origin: OriginFor<T>,
|
||||
main: Box<<T as Config>::RuntimeCall>,
|
||||
fallback: Box<<T as Config>::RuntimeCall>,
|
||||
) -> DispatchResultWithPostInfo {
|
||||
// Do not allow the `None` origin.
|
||||
if ensure_none(origin.clone()).is_ok() {
|
||||
return Err(BadOrigin.into());
|
||||
}
|
||||
|
||||
let is_root = ensure_root(origin.clone()).is_ok();
|
||||
|
||||
// Track the weights
|
||||
let mut weight = T::WeightInfo::if_else();
|
||||
|
||||
let main_info = main.get_dispatch_info();
|
||||
|
||||
// Execute the main call first
|
||||
let main_result = if is_root {
|
||||
main.dispatch_bypass_filter(origin.clone())
|
||||
} else {
|
||||
main.dispatch(origin.clone())
|
||||
};
|
||||
|
||||
// Add weight of the main call
|
||||
weight = weight.saturating_add(extract_actual_weight(&main_result, &main_info));
|
||||
|
||||
let Err(main_error) = main_result else {
|
||||
// If the main result is Ok, we skip the fallback logic entirely
|
||||
Self::deposit_event(Event::IfElseMainSuccess);
|
||||
return Ok(Some(weight).into());
|
||||
};
|
||||
|
||||
// If the main call failed, execute the fallback call
|
||||
let fallback_info = fallback.get_dispatch_info();
|
||||
|
||||
let fallback_result = if is_root {
|
||||
fallback.dispatch_bypass_filter(origin.clone())
|
||||
} else {
|
||||
fallback.dispatch(origin)
|
||||
};
|
||||
|
||||
// Add weight of the fallback call
|
||||
weight = weight.saturating_add(extract_actual_weight(&fallback_result, &fallback_info));
|
||||
|
||||
let Err(fallback_error) = fallback_result else {
|
||||
// Fallback succeeded.
|
||||
Self::deposit_event(Event::IfElseFallbackCalled { main_error: main_error.error });
|
||||
return Ok(Some(weight).into());
|
||||
};
|
||||
|
||||
// Both calls have failed, return fallback error
|
||||
Err(pezsp_runtime::DispatchErrorWithPostInfo {
|
||||
error: fallback_error.error,
|
||||
post_info: Some(weight).into(),
|
||||
})
|
||||
}
|
||||
|
||||
/// Dispatches a function call with a provided origin.
|
||||
///
|
||||
/// Almost the same as [`Pallet::dispatch_as`] but forwards any error of the inner call.
|
||||
///
|
||||
/// The dispatch origin for this call must be _Root_.
|
||||
#[pallet::call_index(7)]
|
||||
#[pallet::weight({
|
||||
let dispatch_info = call.get_dispatch_info();
|
||||
(
|
||||
T::WeightInfo::dispatch_as_fallible()
|
||||
.saturating_add(dispatch_info.call_weight),
|
||||
dispatch_info.class,
|
||||
)
|
||||
})]
|
||||
pub fn dispatch_as_fallible(
|
||||
origin: OriginFor<T>,
|
||||
as_origin: Box<T::PalletsOrigin>,
|
||||
call: Box<<T as Config>::RuntimeCall>,
|
||||
) -> DispatchResult {
|
||||
ensure_root(origin)?;
|
||||
|
||||
call.dispatch_bypass_filter((*as_origin).into()).map_err(|e| e.error)?;
|
||||
|
||||
Self::deposit_event(Event::DispatchedAs { result: Ok(()) });
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Config> Pallet<T> {
|
||||
/// Get the accumulated `weight` and the dispatch class for the given `calls`.
|
||||
fn weight_and_dispatch_class(
|
||||
calls: &[<T as Config>::RuntimeCall],
|
||||
) -> (Weight, DispatchClass) {
|
||||
let dispatch_infos = calls.iter().map(|call| call.get_dispatch_info());
|
||||
let (dispatch_weight, dispatch_class) = dispatch_infos.fold(
|
||||
(Weight::zero(), DispatchClass::Operational),
|
||||
|(total_weight, dispatch_class): (Weight, DispatchClass), di| {
|
||||
(
|
||||
total_weight.saturating_add(di.call_weight),
|
||||
// If not all are `Operational`, we want to use `DispatchClass::Normal`.
|
||||
if di.class == DispatchClass::Normal { di.class } else { dispatch_class },
|
||||
)
|
||||
},
|
||||
);
|
||||
|
||||
(dispatch_weight, dispatch_class)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A pallet identifier. These are per pallet and should be stored in a registry somewhere.
|
||||
#[derive(Clone, Copy, Eq, PartialEq, Encode, Decode)]
|
||||
#[allow(dead_code)]
|
||||
struct IndexedUtilityPalletId(u16);
|
||||
|
||||
impl TypeId for IndexedUtilityPalletId {
|
||||
const TYPE_ID: [u8; 4] = *b"suba";
|
||||
}
|
||||
|
||||
impl<T: Config> Pallet<T> {
|
||||
#[deprecated(
|
||||
note = "`Pallet::derivative_account_id` will be removed after August 2025. Please instead use the freestanding module function `derivative_account_id`."
|
||||
)]
|
||||
pub fn derivative_account_id(who: T::AccountId, index: u16) -> T::AccountId {
|
||||
derivative_account_id(who, index)
|
||||
}
|
||||
}
|
||||
|
||||
/// Derive a derivative account ID from the owner account and the sub-account index.
|
||||
///
|
||||
/// The derived account with `index` of `who` is defined as:
|
||||
/// `b2b256("modlpy/utilisuba" ++ who ++ index)` where index is encoded as fixed size SCALE u16, the
|
||||
/// prefix string as SCALE u8 vector and `who` by its canonical SCALE encoding. The resulting
|
||||
/// account ID is then decoded from the hash with trailing zero bytes in case that the AccountId
|
||||
/// type is longer than 32 bytes. Note that this *could* lead to collisions when using AccountId
|
||||
/// types that are shorter than 32 bytes, especially in testing environments that are using u64.
|
||||
pub fn derivative_account_id<AccountId: Encode + Decode>(who: AccountId, index: u16) -> AccountId {
|
||||
let entropy = (b"modlpy/utilisuba", who, index).using_encoded(blake2_256);
|
||||
Decode::decode(&mut TrailingZeroInput::new(entropy.as_ref()))
|
||||
.expect("infinite length input; no invalid inputs for type; qed")
|
||||
}
|
||||
Reference in New Issue
Block a user