Add pallet attribute macro to declare pallets (#6877)

* rename system Config to system Trait. command used: ``` find frame/ bin/ test-utils/ utils/ -name *.rs -exec sed -i 's/system::Trait>::/system::Config>::/g' {} \; find frame/ bin/ test-utils/ utils/ -name *.rs -exec sed -i 's/impl frame_system::Trait for /impl frame_system::Config for /g' {} \; find frame/ bin/ test-utils/ utils/ -name *.rs -exec sed -i 's/impl system::Trait for /impl system::Config for /g' {} \; ``` plus some manual ones especially for frame-support tests and frame-system * make construct_runtime handle Pallet and Module pallets can now be implemented on struct named Pallet or Module, both definition are valid. This is because next macro will generate only Pallet placeholder. * introduce pallet attribute macro currently just with tests, frame_system and other example hasn't been upgraded * allow to print some upgrade helper from decl_storage * Improved error msg, typo. Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Improved error msg, typo. Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Improved error message on unexpected attributes + ui test * add test for transactional * various typo * some tips when spans are lost * allow pallet to depend on other pallet instances * make event type metadata consistent with call and constant * error messages * ignore doc example * fix pallet upgrade template * fixup * fix doc * fix indentation * Apply suggestions code formatting Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * some renames + fix compilation * remove unsupported genesis config type alias * merge fixup * fix ui tests * additional doc * implement StorageInstance with new syntax * fix line width * fix doc: because pallet doc goes below reexport doc * Update frame/support/procedural/src/pallet/parse/event.rs Co-authored-by: Andrew Jones <ascjones@gmail.com> * Update frame/system/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/support/test/tests/pallet_ui.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * improve doc as suggested * revert construct_runtime Pallet part. This revert the changes on construct_runtime. Now construct_runtime is unchanged and instead pallet macro create a type alias `type Module<..> = Pallet<..>` to be used by construct_runtime * refactor with less intricated code * fix ui test with new image * fix ui tests * add minor tests Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Andrew Jones <ascjones@gmail.com> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2026-04-26 16:57:58 +00:00 · 2020-12-24 12:33:40 +01:00
parent 8e3d8a6a09
commit 6dfad0921b
131 changed files with 9610 additions and 31 deletions
@@ -0,0 +1,298 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2020 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.
+
+use sp_runtime::traits::Block as _;
+
+pub trait SomeAssociation {
+	type A: frame_support::dispatch::Parameter + Default;
+}
+impl SomeAssociation for u64 {
+	type A = u64;
+}
+
+mod pallet_old {
+	use frame_support::{
+		decl_storage, decl_error, decl_event, decl_module, weights::Weight, traits::Get, Parameter
+	};
+	use frame_system::ensure_root;
+	use super::SomeAssociation;
+
+	pub trait Config: frame_system::Config {
+		type SomeConst: Get<Self::Balance>;
+		type Balance: Parameter + codec::HasCompact + From<u32> + Into<Weight> + Default
+			+ SomeAssociation;
+		type Event: From<Event<Self>> + Into<<Self as frame_system::Config>::Event>;
+	}
+
+	decl_storage! {
+		trait Store for Module<T: Config> as Example {
+			/// Some documentation
+			Dummy get(fn dummy) config(): Option<T::Balance>;
+			Bar get(fn bar) config(): map hasher(blake2_128_concat) T::AccountId => T::Balance;
+			Foo get(fn foo) config(): T::Balance = 3.into();
+			Double get(fn double): double_map
+				hasher(blake2_128_concat) u32,
+				hasher(twox_64_concat) u64
+				=> <T::Balance as SomeAssociation>::A;
+		}
+	}
+
+	decl_event!(
+		pub enum Event<T> where Balance = <T as Config>::Balance {
+			/// Dummy event, just here so there's a generic type that's used.
+			Dummy(Balance),
+		}
+	);
+
+	decl_module! {
+		pub struct Module<T: Config> for enum Call where origin: T::Origin {
+			type Error = Error<T>;
+			fn deposit_event() = default;
+			const SomeConst: T::Balance = T::SomeConst::get();
+
+			#[weight = <T::Balance as Into<Weight>>::into(new_value.clone())]
+			fn set_dummy(origin, #[compact] new_value: T::Balance) {
+				ensure_root(origin)?;
+
+				<Dummy<T>>::put(&new_value);
+				Self::deposit_event(RawEvent::Dummy(new_value));
+			}
+
+			fn on_initialize(_n: T::BlockNumber) -> Weight {
+				<Dummy<T>>::put(T::Balance::from(10));
+				10
+			}
+
+			fn on_finalize(_n: T::BlockNumber) {
+				<Dummy<T>>::put(T::Balance::from(11));
+			}
+		}
+	}
+
+	decl_error! {
+		pub enum Error for Module<T: Config> {
+			/// Some wrong behavior
+			Wrong,
+		}
+	}
+}
+
+#[frame_support::pallet]
+pub mod pallet {
+	use super::SomeAssociation;
+	use frame_support::pallet_prelude::*;
+	use frame_system::pallet_prelude::*;
+	use frame_system::ensure_root;
+
+	#[pallet::config]
+	pub trait Config: frame_system::Config {
+		type Balance: Parameter + codec::HasCompact + From<u32> + Into<Weight> + Default
+			+ MaybeSerializeDeserialize + SomeAssociation;
+		#[pallet::constant]
+		type SomeConst: Get<Self::Balance>;
+		type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
+	}
+
+	#[pallet::pallet]
+	pub struct Pallet<T>(PhantomData<T>);
+
+	#[pallet::hooks]
+	impl<T: Config> Hooks<T::BlockNumber> for Pallet<T> {
+		fn on_initialize(_n: T::BlockNumber) -> Weight {
+			<Dummy<T>>::put(T::Balance::from(10));
+			10
+		}
+
+		fn on_finalize(_n: T::BlockNumber) {
+			<Dummy<T>>::put(T::Balance::from(11));
+		}
+	}
+
+	#[pallet::call]
+	impl<T: Config> Pallet<T> {
+		#[pallet::weight(<T::Balance as Into<Weight>>::into(new_value.clone()))]
+		fn set_dummy(
+			origin: OriginFor<T>,
+			#[pallet::compact] new_value: T::Balance
+		) -> DispatchResultWithPostInfo {
+			ensure_root(origin)?;
+
+			<Dummy<T>>::put(&new_value);
+			Self::deposit_event(Event::Dummy(new_value));
+
+			Ok(().into())
+		}
+	}
+
+	#[pallet::error]
+	pub enum Error<T> {
+		/// Some wrong behavior
+		Wrong,
+	}
+
+	#[pallet::event]
+	#[pallet::generate_deposit(fn deposit_event)]
+	#[pallet::metadata(T::Balance = "Balance")]
+	pub enum Event<T: Config> {
+		/// Dummy event, just here so there's a generic type that's used.
+		Dummy(T::Balance),
+	}
+
+	#[pallet::storage]
+	/// Some documentation
+	type Dummy<T: Config> = StorageValue<_, T::Balance, OptionQuery>;
+
+	#[pallet::storage]
+	type Bar<T: Config> = StorageMap<_, Blake2_128Concat, T::AccountId, T::Balance, ValueQuery>;
+
+	#[pallet::type_value] pub fn OnFooEmpty<T: Config>() -> T::Balance { 3.into() }
+	#[pallet::storage]
+	type Foo<T: Config> = StorageValue<_, T::Balance, ValueQuery, OnFooEmpty<T>>;
+
+	#[pallet::storage]
+	type Double<T: Config> = StorageDoubleMap<
+		_, Blake2_128Concat, u32, Twox64Concat, u64, <T::Balance as SomeAssociation>::A, ValueQuery
+	>;
+
+	#[pallet::genesis_config]
+	pub struct GenesisConfig<T: Config> {
+		dummy: Option<T::Balance>,
+		bar: Vec<(T::AccountId, T::Balance)>,
+		foo: T::Balance,
+	}
+
+	impl<T: Config> Default for GenesisConfig<T> {
+		fn default() -> Self {
+			GenesisConfig {
+				dummy: Default::default(),
+				bar: Default::default(),
+				foo: OnFooEmpty::<T>::get(),
+			}
+		}
+	}
+
+	#[pallet::genesis_build]
+	impl<T: Config> GenesisBuild<T> for GenesisConfig<T> {
+		fn build(&self) {
+			if let Some(dummy) = self.dummy.as_ref() {
+				<Dummy<T>>::put(dummy);
+			}
+			for (k, v) in &self.bar {
+				<Bar<T>>::insert(k, v);
+			}
+			<Foo<T>>::put(&self.foo);
+		}
+	}
+}
+
+frame_support::parameter_types!(
+	pub const SomeConst: u64 = 10;
+	pub const BlockHashCount: u32 = 250;
+);
+
+impl frame_system::Config for Runtime {
+	type BaseCallFilter = ();
+	type Origin = Origin;
+	type Index = u64;
+	type BlockNumber = u32;
+	type Call = Call;
+	type Hash = sp_runtime::testing::H256;
+	type Hashing = sp_runtime::traits::BlakeTwo256;
+	type AccountId = u64;
+	type Lookup = sp_runtime::traits::IdentityLookup<Self::AccountId>;
+	type Header = Header;
+	type Event = Event;
+	type BlockHashCount = BlockHashCount;
+	type BlockWeights = ();
+	type BlockLength = ();
+	type DbWeight = ();
+	type Version = ();
+	type PalletInfo = PalletInfo;
+	type AccountData = ();
+	type OnNewAccount = ();
+	type OnKilledAccount = ();
+	type SystemWeightInfo = ();
+}
+impl pallet::Config for Runtime {
+	type Event = Event;
+	type SomeConst = SomeConst;
+	type Balance = u64;
+}
+impl pallet_old::Config for Runtime {
+	type Event = Event;
+	type SomeConst = SomeConst;
+	type Balance = u64;
+}
+
+pub type Header = sp_runtime::generic::Header<u32, sp_runtime::traits::BlakeTwo256>;
+pub type Block = sp_runtime::generic::Block<Header, UncheckedExtrinsic>;
+pub type UncheckedExtrinsic = sp_runtime::generic::UncheckedExtrinsic<u32, Call, (), ()>;
+
+frame_support::construct_runtime!(
+	pub enum Runtime where
+		Block = Block,
+		NodeBlock = Block,
+		UncheckedExtrinsic = UncheckedExtrinsic
+	{
+		System: frame_system::{Module, Call, Event<T>},
+		// NOTE: name Example here is needed in order to have same module prefix
+		Example: pallet::{Module, Call, Event<T>, Config<T>, Storage},
+		PalletOld: pallet_old::{Module, Call, Event<T>, Config<T>, Storage},
+	}
+);
+
+#[cfg(test)]
+mod test {
+	use super::Runtime;
+	use super::pallet;
+	use super::pallet_old;
+	use codec::{Decode, Encode};
+
+	#[test]
+	fn metadata() {
+		let metadata = Runtime::metadata();
+		let modules = match metadata.1 {
+			frame_metadata::RuntimeMetadata::V12(frame_metadata::RuntimeMetadataV12 {
+				modules: frame_metadata::DecodeDifferent::Encode(m),
+				..
+			}) => m,
+			_ => unreachable!(),
+		};
+		pretty_assertions::assert_eq!(modules[1].storage, modules[2].storage);
+		pretty_assertions::assert_eq!(modules[1].calls, modules[2].calls);
+		pretty_assertions::assert_eq!(modules[1].event, modules[2].event);
+		pretty_assertions::assert_eq!(modules[1].constants, modules[2].constants);
+		pretty_assertions::assert_eq!(modules[1].errors, modules[2].errors);
+	}
+
+	#[test]
+	fn types() {
+		assert_eq!(
+			pallet_old::Event::<Runtime>::decode(
+				&mut &pallet::Event::<Runtime>::Dummy(10).encode()[..]
+			).unwrap(),
+			pallet_old::Event::<Runtime>::Dummy(10),
+		);
+
+		assert_eq!(
+			pallet_old::Call::<Runtime>::decode(
+				&mut &pallet::Call::<Runtime>::set_dummy(10).encode()[..]
+			).unwrap(),
+			pallet_old::Call::<Runtime>::set_dummy(10),
+		);
+	}
+}