Remove use of trait Store from all pallets and deprecate it. (#13535)

* Remove use of trait Store from staking pallet * Remove use of trait Store from bounties pallet * Remove use of trait Store from collective pallet * Remove use of trait Store from babe pallet * Remove use of trait Store from assets pallet * Remove use of trait Store from grandpa pallet * Remove use of trait Store from balances pallet * Remove use of trait Store from authorship pallet * Remove use of trait Store from authority-discovery pallet * Remove use of trait Store from atomic-swap pallet * Remove use of trait Store from sudo pallet * Remove use of trait Store from scheduler pallet * Remove use of trait Store from scored-pool pallet * Remove use of trait Store from society pallet * Remove use of trait Store from lottery pallet * Remove use of trait Store from executive pallet * Remove use of trait Store from democracy pallet * Remove use of trait Store from elections-phragmen pallet * Remove use of trait Store from indices pallet * Remove use of trait Store from identity pallet * Remove use of trait Store from multisig pallet * Remove use of trait Store from merkle-mountain-range pallet * Remove use of trait Store from im-online pallet * Remove use of trait Store from membership pallet * Remove use of trait Store from nicks pallet * Remove use of trait Store from session pallet * Remove use of trait Store from transaction-payment pallet * Remove use of trait Store from utility pallet * Remove use of trait Store from child-bounties pallet * Remove use of trait Store from nis pallet * Remove use of trait Store from nfts pallet * Remove use of trait Store from conviction-voting pallet * Remove use of trait Store from treasury pallet * Remove use of trait Store from vesting pallet * Remove use of trait Store from preimage pallet * Remove use of trait Store from uniques pallet * Remove use of trait Store from ranked-collective pallet * Remove use of trait Store from beefy-mmr pallet * Remove use of trait Store from referenda pallet * Remove use of trait Store from whitelist pallet * Remove use of trait Store from alliance pallet * Remove use of trait Store from nomination-pools pallet * Remove use of trait Store from state-trie-migration pallet * Remove use of trait Store from message-queue pallet * Remove use of trait Store from root-offences pallet * Remove use of trait Store from root-testing pallet * Remove use of trait Store from timestamps pallet * Remove use of trait Store from system pallet * Remove use of trait Store from offences pallet * Remove use of trait Store from recovery pallet * Remove use of trait Store from node-authorization pallet * Remove use of trait Store from proxy pallet * Remove use of trait Store from benchmarking pallet * Remove use of trait Store from bags-list pallet * Add deprecated warning in store_trait * Change warning message * Run cargo fmt * Fix warning and update tests * Remove unnecessary allow deprecated * Remove use of trait Store * Fix mismatch in expected output * Minor update to warning message for deprecation of generate_store with Store trait attribute * Fixes as per review comments * Fixes as per review suggestions * Remove use of Store trait from core-fellowship pallet * Fix type in store_trait.rs * Fixes as pre review comment
2026-06-13 19:51:05 +00:00 · 2023-03-13 21:00:05 +05:30
parent f6b9e056ae
commit 2009821cde
89 changed files with 119 additions and 168 deletions
@@ -22,7 +22,7 @@ use syn::spanned::Spanned;
 /// * generate Store trait with all storages,
 /// * implement Store trait for Pallet.
 pub fn expand_store_trait(def: &mut Def) -> proc_macro2::TokenStream {
-	let (trait_vis, trait_store) =
+	let (trait_vis, trait_store, attribute_span) =
 		if let Some(store) = &def.pallet_struct.store { store } else { return Default::default() };

 	let type_impl_gen = &def.type_impl_generics(trait_store.span());
@@ -36,8 +36,19 @@ pub fn expand_store_trait(def: &mut Def) -> proc_macro2::TokenStream {
 	let storage_names = &def.storages.iter().map(|storage| &storage.ident).collect::<Vec<_>>();
 	let storage_cfg_attrs =
 		&def.storages.iter().map(|storage| &storage.cfg_attrs).collect::<Vec<_>>();
+	let warnig_struct_name = syn::Ident::new("Store", *attribute_span);
+	let warning: syn::ItemStruct = syn::parse_quote!(
+		#[deprecated(note = r"
+		Use of `#[pallet::generate_store(pub(super) trait Store)]` will be removed soon.
+		Check https://github.com/paritytech/substrate/pull/13535 for more details.")]
+		struct #warnig_struct_name;
+	);

 	quote::quote_spanned!(trait_store.span() =>
+		const _:() = {
+			#warning
+			const _: Option<#warnig_struct_name> = None;
+		};
 		#trait_vis trait #trait_store {
 			#(
 				#(#storage_cfg_attrs)*
@@ -38,7 +38,7 @@ pub struct PalletStructDef {
 	/// The keyword Pallet used (contains span).
 	pub pallet: keyword::Pallet,
 	/// Whether the trait `Store` must be generated.
-	pub store: Option<(syn::Visibility, keyword::Store)>,
+	pub store: Option<(syn::Visibility, keyword::Store, proc_macro2::Span)>,
 	/// The span of the pallet::pallet attribute.
 	pub attr_span: proc_macro2::Span,
 	/// Whether to specify the storages max encoded len when implementing `StorageInfoTrait`.
@@ -78,13 +78,13 @@ impl syn::parse::Parse for PalletStructAttr {

 		let lookahead = content.lookahead1();
 		if lookahead.peek(keyword::generate_store) {
-			let span = content.parse::<keyword::generate_store>()?.span();
-
+			content.parse::<keyword::generate_store>()?;
 			let generate_content;
 			syn::parenthesized!(generate_content in content);
 			let vis = generate_content.parse::<syn::Visibility>()?;
 			generate_content.parse::<syn::Token![trait]>()?;
 			let keyword = generate_content.parse::<keyword::Store>()?;
+			let span = content.span();
 			Ok(Self::GenerateStore { vis, keyword, span })
 		} else if lookahead.peek(keyword::without_storage_info) {
 			let span = content.parse::<keyword::without_storage_info>()?.span();
@@ -123,8 +123,8 @@ impl PalletStructDef {
 		let struct_attrs: Vec<PalletStructAttr> = helper::take_item_pallet_attrs(&mut item.attrs)?;
 		for attr in struct_attrs {
 			match attr {
-				PalletStructAttr::GenerateStore { vis, keyword, .. } if store.is_none() => {
-					store = Some((vis, keyword));
+				PalletStructAttr::GenerateStore { vis, keyword, span } if store.is_none() => {
+					store = Some((vis, keyword, span));
 				},
 				PalletStructAttr::WithoutStorageInfoTrait(span)
 					if without_storage_info.is_none() =>