Metadata V15: Expose API to fetch metadata for version

bin/node-template/runtime/src/lib.rs

@@ -354,6 +354,14 @@ impl_runtime_apis! {
 		fn metadata() -> OpaqueMetadata {
 			OpaqueMetadata::new(Runtime::metadata().into())
 		}
+
+		fn metadata_at_version(version: u32) -> Option<OpaqueMetadata> {
+			Runtime::metadata_at_version(version)
+		}
+
+		fn metadata_versions() -> sp_std::vec::Vec<u32> {
+			Runtime::metadata_versions()
+		}
 	}
 
 	impl sp_block_builder::BlockBuilder<Block> for Runtime {

bin/node/runtime/src/lib.rs

@@ -1941,6 +1941,14 @@ impl_runtime_apis! {
 		fn metadata() -> OpaqueMetadata {
 			OpaqueMetadata::new(Runtime::metadata().into())
 		}
+
+		fn metadata_at_version(version: u32) -> Option<OpaqueMetadata> {
+			Runtime::metadata_at_version(version)
+		}
+
+		fn metadata_versions() -> sp_std::vec::Vec<u32> {
+			Runtime::metadata_versions()
+		}
 	}
 
 	impl sp_block_builder::BlockBuilder<Block> for Runtime {

client/rpc-spec-v2/src/chain_head/tests.rs

@@ -170,7 +170,7 @@ async fn follow_with_runtime() {
 
 	let runtime_str = "{\"specName\":\"test\",\"implName\":\"parity-test\",\"authoringVersion\":1,\
 		\"specVersion\":2,\"implVersion\":2,\"apis\":[[\"0xdf6acb689907609b\",4],\
-		[\"0x37e397fc7c91f5e4\",1],[\"0xd2bc9897eed08f15\",3],[\"0x40fe3ad401f8959a\",6],\
+		[\"0x37e397fc7c91f5e4\",2],[\"0xd2bc9897eed08f15\",3],[\"0x40fe3ad401f8959a\",6],\
 		[\"0xc6e9a76309f39b09\",1],[\"0xdd718d5cc53262d4\",1],[\"0xcbca25e39f142387\",2],\
 		[\"0xf78b278be53f454c\",2],[\"0xab3c0572291feb8b\",1],[\"0xbc9d89904f5b923f\",1]],\
 		\"transactionVersion\":1,\"stateVersion\":1}";

client/rpc/src/state/tests.rs

@@ -484,7 +484,7 @@ async fn should_return_runtime_version() {
 
 	let result = "{\"specName\":\"test\",\"implName\":\"parity-test\",\"authoringVersion\":1,\
 		\"specVersion\":2,\"implVersion\":2,\"apis\":[[\"0xdf6acb689907609b\",4],\
-		[\"0x37e397fc7c91f5e4\",1],[\"0xd2bc9897eed08f15\",3],[\"0x40fe3ad401f8959a\",6],\
+		[\"0x37e397fc7c91f5e4\",2],[\"0xd2bc9897eed08f15\",3],[\"0x40fe3ad401f8959a\",6],\
 		[\"0xc6e9a76309f39b09\",1],[\"0xdd718d5cc53262d4\",1],[\"0xcbca25e39f142387\",2],\
 		[\"0xf78b278be53f454c\",2],[\"0xab3c0572291feb8b\",1],[\"0xbc9d89904f5b923f\",1]],\
 		\"transactionVersion\":1,\"stateVersion\":1}";

frame/support/Cargo.toml

@@ -70,6 +70,7 @@ std = [
 	"log/std",
 	"environmental/std",
 ]
+# The runtime supports the metadata V14.
 runtime-benchmarks = []
 try-runtime = []
 # By default some types have documentation, `no-metadata-docs` allows to reduce the documentation

frame/support/procedural/src/construct_runtime/expand/metadata.rs

@@ -59,25 +59,27 @@ pub fn expand_runtime_metadata(
 
 			quote! {
 				#attr
-				#scrate::metadata::PalletMetadata {
+				#scrate::metadata_ir::PalletMetadataIR {
 					name: stringify!(#name),
 					index: #index,
 					storage: #storage,
 					calls: #calls,
 					event: #event,
 					constants: #constants,
 					error: #errors,
+					// No docs collected for now.
+					docs: Default::default(),
 				}
 			}
 		})
 		.collect::<Vec<_>>();
 
 	quote! {
 		impl #runtime {
-			pub fn metadata() -> #scrate::metadata::RuntimeMetadataPrefixed {
-				#scrate::metadata::RuntimeMetadataLastVersion::new(
-					#scrate::sp_std::vec![ #(#pallets),* ],
-					#scrate::metadata::ExtrinsicMetadata {
+			fn metadata_ir() -> #scrate::metadata_ir::MetadataIR {
+				#scrate::metadata_ir::MetadataIR {
+					pallets: #scrate::sp_std::vec![ #(#pallets),* ],
+					extrinsic: #scrate::metadata_ir::ExtrinsicMetadataIR {
 						ty: #scrate::scale_info::meta_type::<#extrinsic>(),
 						version: <#extrinsic as #scrate::sp_runtime::traits::ExtrinsicMetadata>::VERSION,
 						signed_extensions: <
@@ -86,15 +88,29 @@ pub fn expand_runtime_metadata(
 								>::SignedExtensions as #scrate::sp_runtime::traits::SignedExtension
 							>::metadata()
 								.into_iter()
-								.map(|meta| #scrate::metadata::SignedExtensionMetadata {
+								.map(|meta| #scrate::metadata_ir::SignedExtensionMetadataIR {
 									identifier: meta.identifier,
 									ty: meta.ty,
 									additional_signed: meta.additional_signed,
 								})
 								.collect(),
 					},
-					#scrate::scale_info::meta_type::<#runtime>()
-				).into()
+					ty: #scrate::scale_info::meta_type::<#runtime>()
+				}
+			}
+
+			pub fn metadata() -> #scrate::metadata::RuntimeMetadataPrefixed {
+				#scrate::metadata_ir::into_latest(#runtime::metadata_ir())
+			}
+
+			pub fn metadata_at_version(version: u32) -> Option<#scrate::OpaqueMetadata> {
+				#scrate::metadata_ir::into_version(#runtime::metadata_ir(), version).map(|prefixed| {
+					#scrate::OpaqueMetadata::new(prefixed.into())
+				})
+			}
+
+			pub fn metadata_versions() -> #scrate::sp_std::vec::Vec<u32> {
+				#scrate::metadata_ir::supported_versions()
 			}
 		}
 	}
@@ -157,7 +173,7 @@ fn expand_pallet_metadata_events(
 
 		quote! {
 			Some(
-				#scrate::metadata::PalletEventMetadata {
+				#scrate::metadata_ir::PalletEventMetadataIR {
 					ty: #scrate::scale_info::meta_type::<#pallet_event>()
 				}
 			)

frame/support/procedural/src/pallet/expand/call.rs

@@ -362,7 +362,7 @@ pub fn expand_call(def: &mut Def) -> proc_macro2::TokenStream {
 
 		impl<#type_impl_gen> #pallet_ident<#type_use_gen> #where_clause {
 			#[doc(hidden)]
-			pub fn call_functions() -> #frame_support::metadata::PalletCallMetadata {
+			pub fn call_functions() -> #frame_support::metadata_ir::PalletCallMetadataIR {
 				#frame_support::scale_info::meta_type::<#call_ident<#type_use_gen>>().into()
 			}
 		}

frame/support/procedural/src/pallet/expand/constants.rs

@@ -85,7 +85,7 @@ pub fn expand_constants(def: &mut Def) -> proc_macro2::TokenStream {
 		let default_byte_impl = &const_.default_byte_impl;
 
 		quote::quote!({
-			#frame_support::metadata::PalletConstantMetadata {
+			#frame_support::metadata_ir::PalletConstantMetadataIR {
 				name: #ident_str,
 				ty: #frame_support::scale_info::meta_type::<#const_type>(),
 				value: { #default_byte_impl },
@@ -99,7 +99,7 @@ pub fn expand_constants(def: &mut Def) -> proc_macro2::TokenStream {
 
 			#[doc(hidden)]
 			pub fn pallet_constants_metadata()
-				-> #frame_support::sp_std::vec::Vec<#frame_support::metadata::PalletConstantMetadata>
+				-> #frame_support::sp_std::vec::Vec<#frame_support::metadata_ir::PalletConstantMetadataIR>
 			{
 				#frame_support::sp_std::vec![ #( #consts ),* ]
 			}

frame/support/procedural/src/pallet/expand/pallet_struct.rs

@@ -82,8 +82,8 @@ pub fn expand_pallet_struct(def: &mut Def) -> proc_macro2::TokenStream {
 		quote::quote_spanned!(def.pallet_struct.attr_span =>
 			impl<#type_impl_gen> #pallet_ident<#type_use_gen> #config_where_clause {
 				#[doc(hidden)]
-				pub fn error_metadata() -> Option<#frame_support::metadata::PalletErrorMetadata> {
-					Some(#frame_support::metadata::PalletErrorMetadata {
+				pub fn error_metadata() -> Option<#frame_support::metadata_ir::PalletErrorMetadataIR> {
+					Some(#frame_support::metadata_ir::PalletErrorMetadataIR {
 						ty: #frame_support::scale_info::meta_type::<#error_ident<#type_use_gen>>()
 					})
 				}
@@ -93,7 +93,7 @@ pub fn expand_pallet_struct(def: &mut Def) -> proc_macro2::TokenStream {
 		quote::quote_spanned!(def.pallet_struct.attr_span =>
 			impl<#type_impl_gen> #pallet_ident<#type_use_gen> #config_where_clause {
 				#[doc(hidden)]
-				pub fn error_metadata() -> Option<#frame_support::metadata::PalletErrorMetadata> {
+				pub fn error_metadata() -> Option<#frame_support::metadata_ir::PalletErrorMetadataIR> {
 					None
 				}
 			}

frame/support/procedural/src/pallet/expand/storage.rs

@@ -639,8 +639,8 @@ pub fn expand_storages(def: &mut Def) -> proc_macro2::TokenStream {
 			#completed_where_clause
 		{
 			#[doc(hidden)]
-			pub fn storage_metadata() -> #frame_support::metadata::PalletStorageMetadata {
-				#frame_support::metadata::PalletStorageMetadata {
+			pub fn storage_metadata() -> #frame_support::metadata_ir::PalletStorageMetadataIR {
+				#frame_support::metadata_ir::PalletStorageMetadataIR {
 					prefix: <
 						<T as #frame_system::Config>::PalletInfo as
 						#frame_support::traits::PalletInfo

frame/support/procedural/src/storage/metadata.rs

@@ -27,7 +27,7 @@ fn storage_line_metadata_type(scrate: &TokenStream, line: &StorageLineDefExt) ->
 	match &line.storage_type {
 		StorageLineTypeDef::Simple(_) => {
 			quote! {
-				#scrate::metadata::StorageEntryType::Plain(
+				#scrate::metadata_ir::StorageEntryTypeIR::Plain(
 					#scrate::scale_info::meta_type::<#value_type>()
 				)
 			}
@@ -36,8 +36,8 @@ fn storage_line_metadata_type(scrate: &TokenStream, line: &StorageLineDefExt) ->
 			let hasher = map.hasher.into_metadata();
 			let key = &map.key;
 			quote! {
-				#scrate::metadata::StorageEntryType::Map {
-					hashers: #scrate::sp_std::vec! [ #scrate::metadata::#hasher ],
+				#scrate::metadata_ir::StorageEntryTypeIR::Map {
+					hashers: #scrate::sp_std::vec! [ #scrate::metadata_ir::#hasher ],
 					key: #scrate::scale_info::meta_type::<#key>(),
 					value: #scrate::scale_info::meta_type::<#value_type>(),
 				}
@@ -49,10 +49,10 @@ fn storage_line_metadata_type(scrate: &TokenStream, line: &StorageLineDefExt) ->
 			let key1 = &map.key1;
 			let key2 = &map.key2;
 			quote! {
-				#scrate::metadata::StorageEntryType::Map {
+				#scrate::metadata_ir::StorageEntryTypeIR::Map {
 					hashers: #scrate::sp_std::vec! [
-						#scrate::metadata::#hasher1,
-						#scrate::metadata::#hasher2,
+						#scrate::metadata_ir::#hasher1,
+						#scrate::metadata_ir::#hasher2,
 					],
 					key: #scrate::scale_info::meta_type::<(#key1, #key2)>(),
 					value: #scrate::scale_info::meta_type::<#value_type>(),
@@ -67,9 +67,9 @@ fn storage_line_metadata_type(scrate: &TokenStream, line: &StorageLineDefExt) ->
 				.map(|hasher| hasher.to_storage_hasher_struct())
 				.collect::<Vec<_>>();
 			quote! {
-				#scrate::metadata::StorageEntryType::Map {
+				#scrate::metadata_ir::StorageEntryTypeIR::Map {
 					hashers: #scrate::sp_std::vec! [
-						#( #scrate::metadata::StorageHasher::#hashers, )*
+						#( #scrate::metadata_ir::StorageHasherIR::#hashers, )*
 					],
 					key: #scrate::scale_info::meta_type::<#key_tuple>(),
 					value: #scrate::scale_info::meta_type::<#value_type>(),
@@ -159,9 +159,9 @@ pub fn impl_metadata(def: &DeclStorageDefExt) -> TokenStream {
 		let str_name = line.name.to_string();
 
 		let modifier = if line.is_option {
-			quote!(#scrate::metadata::StorageEntryModifier::Optional)
+			quote!(#scrate::metadata_ir::StorageEntryModifierIR::Optional)
 		} else {
-			quote!(#scrate::metadata::StorageEntryModifier::Default)
+			quote!(#scrate::metadata_ir::StorageEntryModifierIR::Default)
 		};
 
 		let ty = storage_line_metadata_type(scrate, line);
@@ -172,7 +172,7 @@ pub fn impl_metadata(def: &DeclStorageDefExt) -> TokenStream {
 		let docs = get_doc_literals(&line.attrs);
 
 		let entry = quote! {
-			#scrate::metadata::StorageEntryMetadata {
+			#scrate::metadata_ir::StorageEntryMetadataIR {
 				name: #str_name,
 				modifier: #modifier,
 				ty: #ty,
@@ -194,7 +194,7 @@ pub fn impl_metadata(def: &DeclStorageDefExt) -> TokenStream {
 	};
 
 	let store_metadata = quote!(
-		#scrate::metadata::PalletStorageMetadata {
+		#scrate::metadata_ir::PalletStorageMetadataIR {
 			prefix: #prefix,
 			entries: #scrate::sp_std::vec![ #entries ],
 		}
@@ -209,7 +209,7 @@ pub fn impl_metadata(def: &DeclStorageDefExt) -> TokenStream {
 
 		impl #module_impl #module_struct #where_clause {
 			#[doc(hidden)]
-			pub fn storage_metadata() -> #scrate::metadata::PalletStorageMetadata {
+			pub fn storage_metadata() -> #scrate::metadata_ir::PalletStorageMetadataIR {
 				#store_metadata
 			}
 		}

frame/support/procedural/src/storage/mod.rs

@@ -454,13 +454,13 @@ impl HasherKind {
 
 	fn into_metadata(&self) -> proc_macro2::TokenStream {
 		match self {
-			HasherKind::Blake2_256 => quote!(StorageHasher::Blake2_256),
-			HasherKind::Blake2_128 => quote!(StorageHasher::Blake2_128),
-			HasherKind::Blake2_128Concat => quote!(StorageHasher::Blake2_128Concat),
-			HasherKind::Twox256 => quote!(StorageHasher::Twox256),
-			HasherKind::Twox128 => quote!(StorageHasher::Twox128),
-			HasherKind::Twox64Concat => quote!(StorageHasher::Twox64Concat),
-			HasherKind::Identity => quote!(StorageHasher::Identity),
+			HasherKind::Blake2_256 => quote!(StorageHasherIR::Blake2_256),
+			HasherKind::Blake2_128 => quote!(StorageHasherIR::Blake2_128),
+			HasherKind::Blake2_128Concat => quote!(StorageHasherIR::Blake2_128Concat),
+			HasherKind::Twox256 => quote!(StorageHasherIR::Twox256),
+			HasherKind::Twox128 => quote!(StorageHasherIR::Twox128),
+			HasherKind::Twox64Concat => quote!(StorageHasherIR::Twox64Concat),
+			HasherKind::Identity => quote!(StorageHasherIR::Identity),
 		}
 	}
 }

frame/support/src/dispatch.rs

@@ -2973,7 +2973,7 @@ macro_rules! __dispatch_impl_metadata {
 		{
 			#[doc(hidden)]
 			#[allow(dead_code)]
-			pub fn call_functions() -> $crate::metadata::PalletCallMetadata {
+			pub fn call_functions() -> $crate::metadata_ir::PalletCallMetadataIR {
 				$crate::scale_info::meta_type::<$call_type<$trait_instance $(, $instance)?>>().into()
 			}
 		}
@@ -2994,7 +2994,7 @@ macro_rules! __impl_error_metadata {
 		{
 			#[doc(hidden)]
 			#[allow(dead_code)]
-			pub fn error_metadata() -> Option<$crate::metadata::PalletErrorMetadata> {
+			pub fn error_metadata() -> Option<$crate::metadata_ir::PalletErrorMetadataIR> {
 				None
 			}
 		}
@@ -3009,8 +3009,8 @@ macro_rules! __impl_error_metadata {
 		{
 			#[doc(hidden)]
 			#[allow(dead_code)]
-			pub fn error_metadata() -> Option<$crate::metadata::PalletErrorMetadata> {
-				Some($crate::metadata::PalletErrorMetadata {
+			pub fn error_metadata() -> Option<$crate::metadata_ir::PalletErrorMetadataIR> {
+				Some($crate::metadata_ir::PalletErrorMetadataIR {
 					ty: $crate::scale_info::meta_type::<$( $error_type )*>()
 				})
 			}
@@ -3085,7 +3085,7 @@ macro_rules! __impl_module_constants_metadata {
 		{
 			#[doc(hidden)]
 			#[allow(dead_code)]
-			pub fn pallet_constants_metadata() -> $crate::sp_std::vec::Vec<$crate::metadata::PalletConstantMetadata> {
+			pub fn pallet_constants_metadata() -> $crate::sp_std::vec::Vec<$crate::metadata_ir::PalletConstantMetadataIR> {
 				// Create the `ByteGetter`s
 				$(
 					#[allow(non_upper_case_types)]
@@ -3109,7 +3109,7 @@ macro_rules! __impl_module_constants_metadata {
 				)*
 				$crate::sp_std::vec![
 					$(
-						$crate::metadata::PalletConstantMetadata {
+						$crate::metadata_ir::PalletConstantMetadataIR {
 							name: stringify!($name),
 							ty: $crate::scale_info::meta_type::<$type>(),
 							value: $default_byte_name::<$const_trait_instance $(, $const_instance)?>(
@@ -3183,7 +3183,7 @@ mod tests {
 	use super::*;
 	use crate::{
 		dispatch::{DispatchClass, DispatchInfo, Pays},
-		metadata::*,
+		metadata_ir::*,
 		traits::{
 			CallerTrait, CrateVersion, Get, GetCallName, IntegrityTest, OnFinalize, OnIdle,
 			OnInitialize, OnRuntimeUpgrade, PalletInfo,
@@ -3381,7 +3381,7 @@ mod tests {
 	fn module_json_metadata() {
 		let metadata = Module::<TraitImpl>::call_functions();
 		let expected_metadata =
-			PalletCallMetadata { ty: scale_info::meta_type::<Call<TraitImpl>>() };
+			PalletCallMetadataIR { ty: scale_info::meta_type::<Call<TraitImpl>>() };
 		assert_eq!(expected_metadata, metadata);
 	}