GenesisBuild<T,I> deprecated. BuildGenesisConfig added. (#14306)

* frame::support: GenesisConfig types for Runtime enabled

* frame::support: macro generating GenesisBuild::build for RuntimeGenesisConfig

* frame: ambiguity BuildStorage vs GenesisBuild fixed

* fix

* RuntimeGenesisBuild added

* Revert "frame: ambiguity BuildStorage vs GenesisBuild fixed"

This reverts commit 950f3d019d0e21c55a739c44cc19cdabd3ff0293.

* Revert "fix"

This reverts commit a2f76dd24e9a16cf9230d45825ed28787211118b.

* Revert "RuntimeGenesisBuild added"

This reverts commit 3c131b618138ced29c01ab8d15d8c6410c9e128b.

* Revert "Revert "frame: ambiguity BuildStorage vs GenesisBuild fixed""

This reverts commit 2b1ecd467231eddec69f8d328039ba48a380da3d.

* Revert "Revert "fix""

This reverts commit fd7fa629adf579d83e30e6ae9fd162637fc45e30.

* Code review suggestions

* frame: BuildGenesisConfig added, BuildGenesis deprecated

* frame: some pallets updated with BuildGenesisConfig

* constuct_runtime: support for BuildGenesisConfig

* frame::support: genesis_build macro supports BuildGenesisConfig

* frame: BuildGenesisConfig added, BuildGenesis deprecated

* Cargo.lock update

* test-runtime: fixes

* Revert "fix"

This reverts commit a2f76dd24e9a16cf9230d45825ed28787211118b.

* Revert "frame: ambiguity BuildStorage vs GenesisBuild fixed"

This reverts commit 950f3d019d0e21c55a739c44cc19cdabd3ff0293.

* self review

* doc fixed

* ui tests fixed

* fmt

* tests fixed

* genesis_build macrto fixed for non-generic GenesisConfig

* BuildGenesisConfig constraints added

* warning fixed

* some duplication removed

* fmt

* fix

* doc tests fix

* doc fix

* cleanup: remove BuildModuleGenesisStorage

* self review comments

* fix

* Update frame/treasury/src/tests.rs

Co-authored-by: Sebastian Kunert <skunert49@gmail.com>

* Update frame/support/src/traits/hooks.rs

Co-authored-by: Sebastian Kunert <skunert49@gmail.com>

* doc fix: GenesisBuild exposed

* ".git/.scripts/commands/fmt/fmt.sh"

* frame: more serde(skip) + cleanup

* Update frame/support/src/traits/hooks.rs

Co-authored-by: Davide Galassi <davxy@datawok.net>

* frame: phantom fields moved to the end of structs

* chain-spec: Default::default cleanup

* test-runtime: phantom at the end

* merge master fixes

* fix

* fix

* fix

* fix

* fix (facepalm)

* Update frame/support/procedural/src/pallet/expand/genesis_build.rs

Co-authored-by: Bastian Köcher <git@kchr.de>

* fmt

* fix

* fix

---------

Co-authored-by: parity-processbot <>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Co-authored-by: Davide Galassi <davxy@datawok.net>
Co-authored-by: Bastian Köcher <git@kchr.de>

substrate/frame/support/procedural/src/construct_runtime/expand/config.rs

@@ -29,7 +29,7 @@ pub fn expand_outer_config(
 ) -> TokenStream {
 	let mut types = TokenStream::new();
 	let mut fields = TokenStream::new();
-	let mut build_storage_calls = TokenStream::new();
+	let mut genesis_build_calls = TokenStream::new();
 	let mut query_genesis_config_part_macros = Vec::new();
 
 	for decl in pallet_decls {
@@ -52,8 +52,8 @@ pub fn expand_outer_config(
 
 			types.extend(expand_config_types(attr, runtime, decl, &config, part_is_generic));
 			fields.extend(quote!(#attr pub #field_name: #config,));
-			build_storage_calls
-				.extend(expand_config_build_storage_call(scrate, attr, runtime, decl, field_name));
+			genesis_build_calls
+				.extend(expand_config_build_storage_call(scrate, &config, attr, field_name));
 			query_genesis_config_part_macros.push(quote! {
 				#path::__substrate_genesis_config_check::is_genesis_config_defined!(#pallet_name);
 				#[cfg(feature = "std")]
@@ -67,9 +67,7 @@ pub fn expand_outer_config(
 
 		#types
 
-		#[cfg(any(feature = "std", test))]
 		use #scrate::serde as __genesis_config_serde_import__;
-		#[cfg(any(feature = "std", test))]
 		#[derive(#scrate::serde::Serialize, #scrate::serde::Deserialize, Default)]
 		#[serde(rename_all = "camelCase")]
 		#[serde(deny_unknown_fields)]
@@ -88,13 +86,17 @@ pub fn expand_outer_config(
 				&self,
 				storage: &mut #scrate::sp_runtime::Storage,
 			) -> std::result::Result<(), String> {
-				#build_storage_calls
-
 				#scrate::BasicExternalities::execute_with_storage(storage, || {
-					<AllPalletsWithSystem as #scrate::traits::OnGenesis>::on_genesis();
-				});
+					<Self as #scrate::traits::BuildGenesisConfig>::build(&self);
+					Ok(())
+				})
+			}
+		}
 
-				Ok(())
+		impl #scrate::traits::BuildGenesisConfig for RuntimeGenesisConfig {
+			fn build(&self) {
+				#genesis_build_calls
+				<AllPalletsWithSystem as #scrate::traits::OnGenesis>::on_genesis();
 			}
 		}
 	}
@@ -112,17 +114,14 @@ fn expand_config_types(
 	match (decl.instance.as_ref(), part_is_generic) {
 		(Some(inst), true) => quote! {
 			#attr
-			#[cfg(any(feature = "std", test))]
 			pub type #config = #path::GenesisConfig<#runtime, #path::#inst>;
 		},
 		(None, true) => quote! {
 			#attr
-			#[cfg(any(feature = "std", test))]
 			pub type #config = #path::GenesisConfig<#runtime>;
 		},
 		(_, false) => quote! {
 			#attr
-			#[cfg(any(feature = "std", test))]
 			pub type #config = #path::GenesisConfig;
 		},
 	}
@@ -130,21 +129,12 @@ fn expand_config_types(
 
 fn expand_config_build_storage_call(
 	scrate: &TokenStream,
+	pallet_genesis_config: &Ident,
 	attr: &TokenStream,
-	runtime: &Ident,
-	decl: &Pallet,
 	field_name: &Ident,
 ) -> TokenStream {
-	let path = &decl.path;
-	let instance = if let Some(inst) = decl.instance.as_ref() {
-		quote!(#path::#inst)
-	} else {
-		quote!(#path::__InherentHiddenInstance)
-	};
-
 	quote! {
 		#attr
-		#scrate::sp_runtime::BuildModuleGenesisStorage::
-			<#runtime, #instance>::build_module_genesis_storage(&self.#field_name, storage)?;
+		<#pallet_genesis_config as #scrate::traits::BuildGenesisConfig>::build(&self.#field_name);
 	}
 }

substrate/frame/support/procedural/src/lib.rs

@@ -1651,8 +1651,7 @@ pub fn genesis_config(_: TokenStream, _: TokenStream) -> TokenStream {
 /// The macro will add the following attribute:
 /// * `#[cfg(feature = "std")]`
 ///
-/// The macro will implement `sp_runtime::BuildModuleGenesisStorage` using `()` as a second
-/// generic for non-instantiable pallets.
+/// The macro will implement `sp_runtime::BuildStorage`.
 #[proc_macro_attribute]
 pub fn genesis_build(_: TokenStream, _: TokenStream) -> TokenStream {
 	pallet_macro_stub()

substrate/frame/support/procedural/src/pallet/expand/genesis_build.rs

@@ -18,7 +18,7 @@
 use crate::pallet::Def;
 
 ///
-/// * implement the trait `sp_runtime::BuildModuleGenesisStorage`
+/// * implement the trait `sp_runtime::BuildStorage`
 pub fn expand_genesis_build(def: &mut Def) -> proc_macro2::TokenStream {
 	let genesis_config = if let Some(genesis_config) = &def.genesis_config {
 		genesis_config
@@ -28,34 +28,22 @@ pub fn expand_genesis_build(def: &mut Def) -> proc_macro2::TokenStream {
 	let genesis_build = def.genesis_build.as_ref().expect("Checked by def parser");
 
 	let frame_support = &def.frame_support;
-	let type_impl_gen = &def.type_impl_generics(genesis_build.attr_span);
-	let type_use_gen = &def.type_use_generics(genesis_build.attr_span);
-	let trait_use_gen = if def.config.has_instance {
-		quote::quote_spanned!(genesis_build.attr_span => T, I)
-	} else {
-		// `__InherentHiddenInstance` used by construct_runtime here is alias for `()`
-		quote::quote_spanned!(genesis_build.attr_span => T, ())
-	};
+	let type_impl_gen = &genesis_config.gen_kind.type_impl_gen(genesis_build.attr_span);
 	let gen_cfg_ident = &genesis_config.genesis_config;
-
-	let gen_cfg_use_gen = genesis_config.gen_kind.type_use_gen(genesis_build.attr_span);
+	let gen_cfg_use_gen = &genesis_config.gen_kind.type_use_gen(genesis_build.attr_span);
 
 	let where_clause = &genesis_build.where_clause;
 
 	quote::quote_spanned!(genesis_build.attr_span =>
 		#[cfg(feature = "std")]
-		impl<#type_impl_gen> #frame_support::sp_runtime::BuildModuleGenesisStorage<#trait_use_gen>
-			for #gen_cfg_ident<#gen_cfg_use_gen> #where_clause
-		{
-			fn build_module_genesis_storage(
-				&self,
-				storage: &mut #frame_support::sp_runtime::Storage,
-			) -> std::result::Result<(), std::string::String> {
-				#frame_support::BasicExternalities::execute_with_storage(storage, || {
-					<Self as #frame_support::traits::GenesisBuild<#type_use_gen>>::build(self);
-					Ok(())
-				})
+			impl<#type_impl_gen> #frame_support::sp_runtime::BuildStorage for #gen_cfg_ident<#gen_cfg_use_gen> #where_clause
+			{
+				fn assimilate_storage(&self, storage: &mut sp_runtime::Storage) -> std::result::Result<(), std::string::String> {
+					#frame_support::BasicExternalities::execute_with_storage(storage, || {
+						self.build();
+						Ok(())
+					})
+				}
 			}
-		}
 	)
 }

substrate/frame/support/procedural/src/pallet/parse/genesis_build.rs

@@ -23,7 +23,7 @@ pub struct GenesisBuildDef {
 	/// The index of item in pallet module.
 	pub index: usize,
 	/// A set of usage of instance, must be check for consistency with trait.
-	pub instances: Vec<helper::InstanceUsage>,
+	pub instances: Option<Vec<helper::InstanceUsage>>,
 	/// The where_clause used.
 	pub where_clause: Option<syn::WhereClause>,
 	/// The span of the pallet::genesis_build attribute.
@@ -53,7 +53,8 @@ impl GenesisBuildDef {
 			})?
 			.1;
 
-		let instances = vec![helper::check_genesis_builder_usage(item_trait)?];
+		let instances =
+			helper::check_genesis_builder_usage(item_trait)?.map(|instances| vec![instances]);
 
 		Ok(Self { attr_span, index, instances, where_clause: item.generics.where_clause.clone() })
 	}

substrate/frame/support/procedural/src/pallet/parse/helper.rs

@@ -23,6 +23,7 @@ mod keyword {
 	syn::custom_keyword!(I);
 	syn::custom_keyword!(compact);
 	syn::custom_keyword!(GenesisBuild);
+	syn::custom_keyword!(BuildGenesisConfig);
 	syn::custom_keyword!(Config);
 	syn::custom_keyword!(T);
 	syn::custom_keyword!(Pallet);
@@ -488,26 +489,32 @@ pub fn check_type_def_gen(
 /// Check the syntax:
 /// * either `GenesisBuild<T>`
 /// * or `GenesisBuild<T, I>`
+/// * or `BuildGenesisConfig`
 ///
-/// return the instance if found.
-pub fn check_genesis_builder_usage(type_: &syn::Path) -> syn::Result<InstanceUsage> {
+/// return the instance if found for `GenesisBuild`
+/// return None for BuildGenesisConfig
+pub fn check_genesis_builder_usage(type_: &syn::Path) -> syn::Result<Option<InstanceUsage>> {
 	let expected = "expected `GenesisBuild<T>` or `GenesisBuild<T, I>`";
-	pub struct Checker(InstanceUsage);
+	pub struct Checker(Option<InstanceUsage>);
 	impl syn::parse::Parse for Checker {
 		fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
 			let mut instance_usage = InstanceUsage { span: input.span(), has_instance: false };
 
-			input.parse::<keyword::GenesisBuild>()?;
-			input.parse::<syn::Token![<]>()?;
-			input.parse::<keyword::T>()?;
-			if input.peek(syn::Token![,]) {
-				instance_usage.has_instance = true;
-				input.parse::<syn::Token![,]>()?;
-				input.parse::<keyword::I>()?;
+			if input.peek(keyword::GenesisBuild) {
+				input.parse::<keyword::GenesisBuild>()?;
+				input.parse::<syn::Token![<]>()?;
+				input.parse::<keyword::T>()?;
+				if input.peek(syn::Token![,]) {
+					instance_usage.has_instance = true;
+					input.parse::<syn::Token![,]>()?;
+					input.parse::<keyword::I>()?;
+				}
+				input.parse::<syn::Token![>]>()?;
+				return Ok(Self(Some(instance_usage)))
+			} else {
+				input.parse::<keyword::BuildGenesisConfig>()?;
+				return Ok(Self(None))
 			}
-			input.parse::<syn::Token![>]>()?;
-
-			Ok(Self(instance_usage))
 		}
 	}
 

substrate/frame/support/procedural/src/pallet/parse/mod.rs

@@ -268,7 +268,7 @@ impl Def {
 			instances.extend_from_slice(&genesis_config.instances[..]);
 		}
 		if let Some(genesis_build) = &self.genesis_build {
-			instances.extend_from_slice(&genesis_build.instances[..]);
+			genesis_build.instances.as_ref().map(|i| instances.extend_from_slice(&i));
 		}
 		if let Some(extra_constants) = &self.extra_constants {
 			instances.extend_from_slice(&extra_constants.instances[..]);