mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-17 00:51:06 +00:00
Allow pallet error enum variants to contain fields (#10242)
* Allow pallet errors to contain at most one field * Update docs on pallet::error * Reword documentation * cargo fmt * Introduce CompactPalletError trait and require #[pallet::error] fields to implement them * cargo fmt * Do not assume tuple variants * Add CompactPalletError derive macro * Check for error type compactness in construct_runtime * cargo fmt * Derive CompactPalletError instead of implementing it directly during macro expansion * Implement CompactPalletError on OptionBool instead of Option<bool> * Check for type idents instead of variant ident * Add doc comments for ErrorCompactnessTest * Add an trait implementation of ErrorCompactnessTest for () * Convert the error field of DispatchError to a 4-element byte array * Add static check for pallet error size * Rename to MAX_PALLET_ERROR_ENCODED_SIZE * Remove ErrorCompactnessTest trait * Remove check_compactness * Return only the most significant byte when constructing a custom InvalidTransaction * Rename CompactPalletError to PalletError * Use counter to generate unique idents for assert macros * Make declarative pallet macros compile with pallet error size checks * Remove unused doc comment * Try and fix build errors * Fix build errors * Add macro_use for some test modules * Test fix * Fix compilation errors * Remove unneeded #[macro_use] * Resolve import ambiguity * Make path to pallet Error enum more specific * Fix test expectation * Disambiguate imports * Fix test expectations * Revert appending pallet module name to path * Rename bags_list::list::Error to BagError * Fixes * Fixes * Fixes * Fix test expectations * Fix test expectation * Add more implementations for PalletError * Lift the 1-field requirement for nested pallet errors * Fix UI test expectation * Remove PalletError impl for OptionBool * Use saturating operations * cargo fmt * Delete obsolete test * Fix test expectation * Try and use assert macro in const context * Pull out the pallet error size check macro * Fix UI test for const assertion * cargo fmt * Apply clippy suggestion * Fix doc comment * Docs for create_tt_return_macro * Ensure TryInto is imported in earlier Rust editions * Apply suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Fix up comments and names * Implement PalletError for Never * cargo fmt * Don't compile example code * Bump API version for block builder * Factor in codec attributes while derving PalletError * Rename module and fix unit test * Add missing attribute * Check API version and convert ApplyExtrinsicResult accordingly * Rename BagError to ListError Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Use codec crate re-exported from frame support * Add links to types mentioned in doc comments Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * cargo fmt * cargo fmt * Re-add attribute for hidden docs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
This commit is contained in:
Keith Yeung
@@ -93,7 +93,9 @@ pub use self::{
|
||||
StorageMap, StorageNMap, StoragePrefixedMap, StorageValue,
|
||||
},
|
||||
};
|
||||
pub use sp_runtime::{self, print, traits::Printable, ConsensusEngineId};
|
||||
pub use sp_runtime::{
|
||||
self, print, traits::Printable, ConsensusEngineId, MAX_MODULE_ERROR_ENCODED_SIZE,
|
||||
};
|
||||
|
||||
use codec::{Decode, Encode};
|
||||
use scale_info::TypeInfo;
|
||||
@@ -103,7 +105,7 @@ use sp_runtime::TypeId;
|
||||
pub const LOG_TARGET: &'static str = "runtime::frame-support";
|
||||
|
||||
/// A type that cannot be instantiated.
|
||||
#[derive(Debug, PartialEq, Eq, Clone, TypeInfo)]
|
||||
#[derive(Encode, Decode, Debug, PartialEq, Eq, Clone, TypeInfo)]
|
||||
pub enum Never {}
|
||||
|
||||
/// A pallet identifier. These are per pallet and should be stored in a registry somewhere.
|
||||
@@ -598,11 +600,12 @@ pub fn debug(data: &impl sp_std::fmt::Debug) {
|
||||
|
||||
#[doc(inline)]
|
||||
pub use frame_support_procedural::{
|
||||
construct_runtime, decl_storage, match_and_insert, transactional, RuntimeDebugNoBound,
|
||||
construct_runtime, decl_storage, match_and_insert, transactional, PalletError,
|
||||
RuntimeDebugNoBound,
|
||||
};
|
||||
|
||||
#[doc(hidden)]
|
||||
pub use frame_support_procedural::__generate_dummy_part_checker;
|
||||
pub use frame_support_procedural::{__create_tt_macro, __generate_dummy_part_checker};
|
||||
|
||||
/// Derive [`Clone`] but do not bound any generic.
|
||||
///
|
||||
@@ -847,6 +850,32 @@ macro_rules! assert_ok {
|
||||
};
|
||||
}
|
||||
|
||||
/// Assert that the maximum encoding size does not exceed the value defined in
|
||||
/// [`MAX_MODULE_ERROR_ENCODED_SIZE`] during compilation.
|
||||
///
|
||||
/// This macro is intended to be used in conjunction with `tt_call!`.
|
||||
#[macro_export]
|
||||
macro_rules! assert_error_encoded_size {
|
||||
{
|
||||
path = [{ $($path:ident)::+ }]
|
||||
runtime = [{ $runtime:ident }]
|
||||
assert_message = [{ $assert_message:literal }]
|
||||
error = [{ $error:ident }]
|
||||
} => {
|
||||
const _: () = assert!(
|
||||
<
|
||||
$($path::)+$error<$runtime> as $crate::traits::PalletError
|
||||
>::MAX_ENCODED_SIZE <= $crate::MAX_MODULE_ERROR_ENCODED_SIZE,
|
||||
$assert_message
|
||||
);
|
||||
};
|
||||
{
|
||||
path = [{ $($path:ident)::+ }]
|
||||
runtime = [{ $runtime:ident }]
|
||||
assert_message = [{ $assert_message:literal }]
|
||||
} => {};
|
||||
}
|
||||
|
||||
#[cfg(feature = "std")]
|
||||
#[doc(hidden)]
|
||||
pub use serde::{Deserialize, Serialize};
|
||||
@@ -1375,6 +1404,7 @@ pub mod pallet_prelude {
|
||||
TransactionTag, TransactionValidity, TransactionValidityError, UnknownTransaction,
|
||||
ValidTransaction,
|
||||
},
|
||||
MAX_MODULE_ERROR_ENCODED_SIZE,
|
||||
};
|
||||
pub use sp_std::marker::PhantomData;
|
||||
}
|
||||
@@ -1652,10 +1682,25 @@ pub mod pallet_prelude {
|
||||
/// pub enum Error<T> {
|
||||
/// /// $some_optional_doc
|
||||
/// $SomeFieldLessVariant,
|
||||
/// /// $some_more_optional_doc
|
||||
/// $SomeVariantWithOneField(FieldType),
|
||||
/// ...
|
||||
/// }
|
||||
/// ```
|
||||
/// I.e. a regular rust enum named `Error`, with generic `T` and fieldless variants.
|
||||
/// I.e. a regular rust enum named `Error`, with generic `T` and fieldless or multiple-field
|
||||
/// variants.
|
||||
///
|
||||
/// Any field type in the enum variants must implement [`scale_info::TypeInfo`] in order to be
|
||||
/// properly used in the metadata, and its encoded size should be as small as possible,
|
||||
/// preferably 1 byte in size in order to reduce storage size. The error enum itself has an
|
||||
/// absolute maximum encoded size specified by [`MAX_MODULE_ERROR_ENCODED_SIZE`].
|
||||
///
|
||||
/// Field types in enum variants must also implement [`PalletError`](traits::PalletError),
|
||||
/// otherwise the pallet will fail to compile. Rust primitive types have already implemented
|
||||
/// the [`PalletError`](traits::PalletError) trait along with some commonly used stdlib types
|
||||
/// such as `Option` and `PhantomData`, and hence in most use cases, a manual implementation is
|
||||
/// not necessary and is discouraged.
|
||||
///
|
||||
/// The generic `T` mustn't bound anything and where clause is not allowed. But bounds and
|
||||
/// where clause shouldn't be needed for any usecase.
|
||||
///
|
||||
|
||||
Reference in New Issue
Block a user