Metadata V15: Expose API to fetch metadata for version (#13287)

* impl_runtime_apis: Generate getters for `metadata_at` functions

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* runtime: Implement new `Metadata` runtime trait

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* runtime: Move `metadata_at` functions to construct_runtime macro

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* contruct_runtime: Use `OpaqueMetadata` from hidden imports

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* Adjust testing

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/tests: Add tests for the new API

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/tests: Adjust metdata naming

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Expose `metadata-v14` feature flag

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Expose metadata only under feature flags

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Expose v14 metadata by default

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Expose metadata feature for testing

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Test metadata under different feature flags

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* Update primitives/api/src/lib.rs

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

* Update primitives/api/src/lib.rs

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

* client/tests: Adjust testing to reflect trait Metadata change

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/metadata-ir: Add intermediate representation types for metadata

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/metadata-ir: Convert metadata to V14

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/metadata-ir: Add API to convert metadata to multiple versions

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/metadata-ir: Expose V14 under feature flag

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Adjust to metadata IR

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: More adjustments

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Guard v14 details under feature flag

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Adjust testing

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* CI: Ensure `quick-benchmarks` uses `metadata-v14`

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Use `metadata-v14` for benchmarks

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* Adjust cargo fmt

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* kitchensink-runtime: Add feature flag for `metadata-v14`

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support/test: Adjust testing

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support/test: Check crates locally

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* Activate metadata-v14 for pallets

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* Remove metadata-v14 feature flag

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/metadata_ir: Move `api.rs` to `mod.rs`

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Handle latest metadata conversion via IR

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/tests: Add constant for metadata version 14

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support/test: Fix merge conflict

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* Update frame/support/Cargo.toml

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

* Update frame/support/src/metadata_ir/mod.rs

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

* Update frame/support/test/Cargo.toml

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

* Update primitives/api/src/lib.rs

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

* frame/metadata: Collect pallet documentation for MetadataIR

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/tests: Check pallet documentation is propagated to MetadataIR

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* frame/support: Improve documentation

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

---------

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Co-authored-by: parity-processbot <>
Co-authored-by: Bastian Köcher <git@kchr.de>
This commit is contained in:
Alexandru Vasile
2023-03-15 19:49:28 +02:00
committed by GitHub
parent 8945c1bd42
commit 1a88833d73
31 changed files with 1002 additions and 316 deletions
+105 -102
View File
@@ -19,7 +19,7 @@
// Do not complain about unused `dispatch` and `dispatch_aux`.
#[allow(dead_code)]
mod tests {
use frame_support::metadata::*;
use frame_support::metadata_ir::*;
use sp_io::TestExternalities;
frame_support::decl_module! {
@@ -104,195 +104,195 @@ mod tests {
type Origin2 = u32;
}
fn expected_metadata() -> PalletStorageMetadata {
PalletStorageMetadata {
fn expected_metadata() -> PalletStorageMetadataIR {
PalletStorageMetadataIR {
prefix: "TestStorage",
entries: vec![
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "U32",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![" Hello, this is doc!"],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBU32",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "U32MYDEF",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBU32MYDEF",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GETU32",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBGETU32",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GETU32WITHCONFIG",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBGETU32WITHCONFIG",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GETU32MYDEF",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBGETU32MYDEF",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![3, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GETU32WITHCONFIGMYDEF",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![2, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBGETU32WITHCONFIGMYDEF",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![1, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBGETU32WITHCONFIGMYDEFOPT",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GetU32WithBuilder",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GetOptU32WithBuilderSome",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GetOptU32WithBuilderNone",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "MAPU32",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Blake2_128Concat],
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Blake2_128Concat],
key: scale_info::meta_type::<u32>(),
value: scale_info::meta_type::<[u8; 4]>(),
},
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBMAPU32",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Blake2_128Concat],
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Blake2_128Concat],
key: scale_info::meta_type::<u32>(),
value: scale_info::meta_type::<[u8; 4]>(),
},
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GETMAPU32",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Blake2_128Concat],
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Blake2_128Concat],
key: scale_info::meta_type::<u32>(),
value: scale_info::meta_type::<[u8; 4]>(),
},
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBGETMAPU32",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Blake2_128Concat],
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Blake2_128Concat],
key: scale_info::meta_type::<u32>(),
value: scale_info::meta_type::<[u8; 4]>(),
},
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "GETMAPU32MYDEF",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Blake2_128Concat],
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Blake2_128Concat],
key: scale_info::meta_type::<u32>(),
value: scale_info::meta_type::<[u8; 4]>(),
},
default: vec![109, 97, 112, 100], // "map"
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "PUBGETMAPU32MYDEF",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Blake2_128Concat],
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Blake2_128Concat],
key: scale_info::meta_type::<u32>(),
value: scale_info::meta_type::<[u8; 4]>(),
},
default: vec![112, 117, 98, 109], // "pubmap"
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "DOUBLEMAP",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Map {
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Map {
hashers: vec![
StorageHasher::Blake2_128Concat,
StorageHasher::Blake2_128Concat,
StorageHasherIR::Blake2_128Concat,
StorageHasherIR::Blake2_128Concat,
],
key: scale_info::meta_type::<(u32, u32)>(),
value: scale_info::meta_type::<[u8; 4]>(),
@@ -300,13 +300,13 @@ mod tests {
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "DOUBLEMAP2",
modifier: StorageEntryModifier::Optional,
ty: StorageEntryType::Map {
modifier: StorageEntryModifierIR::Optional,
ty: StorageEntryTypeIR::Map {
hashers: vec![
StorageHasher::Blake2_128Concat,
StorageHasher::Blake2_128Concat,
StorageHasherIR::Blake2_128Concat,
StorageHasherIR::Blake2_128Concat,
],
key: scale_info::meta_type::<(u32, u32)>(),
value: scale_info::meta_type::<[u8; 4]>(),
@@ -314,47 +314,50 @@ mod tests {
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "COMPLEXTYPE1",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<(Option<u32>,)>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<(Option<u32>,)>()),
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "COMPLEXTYPE2",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<(
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<(
[[(u16, Option<()>); 32]; 12],
u32,
)>()),
default: [0u8; 1156].to_vec(),
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "COMPLEXTYPE3",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<[u32; 25]>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<[u32; 25]>()),
default: [0u8; 100].to_vec(),
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "NMAP",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
key: scale_info::meta_type::<(u32, u16)>(),
hashers: vec![StorageHasher::Blake2_128Concat, StorageHasher::Twox64Concat],
hashers: vec![
StorageHasherIR::Blake2_128Concat,
StorageHasherIR::Twox64Concat,
],
value: scale_info::meta_type::<u8>(),
},
default: vec![0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "NMAP2",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
key: scale_info::meta_type::<u32>(),
hashers: vec![StorageHasher::Blake2_128Concat],
hashers: vec![StorageHasherIR::Blake2_128Concat],
value: scale_info::meta_type::<u8>(),
},
default: vec![0],
+16 -16
View File
@@ -20,9 +20,9 @@
use codec::{Codec, Decode, Encode, EncodeLike, MaxEncodedLen};
use frame_support::{
inherent::{InherentData, InherentIdentifier, MakeFatalError, ProvideInherent},
metadata::{
PalletStorageMetadata, StorageEntryMetadata, StorageEntryModifier, StorageEntryType,
StorageHasher,
metadata_ir::{
PalletStorageMetadataIR, StorageEntryMetadataIR, StorageEntryModifierIR,
StorageEntryTypeIR, StorageHasherIR,
},
traits::{ConstU32, Get},
Parameter, StorageDoubleMap, StorageMap, StorageValue,
@@ -410,33 +410,33 @@ fn storage_with_instance_basic_operation() {
});
}
fn expected_metadata() -> PalletStorageMetadata {
PalletStorageMetadata {
fn expected_metadata() -> PalletStorageMetadataIR {
PalletStorageMetadataIR {
prefix: "Instance2Module2",
entries: vec![
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "Value",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(scale_info::meta_type::<u32>()),
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Plain(scale_info::meta_type::<u32>()),
default: vec![0, 0, 0, 0],
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "Map",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Identity],
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Identity],
key: scale_info::meta_type::<u64>(),
value: scale_info::meta_type::<u64>(),
},
default: [0u8; 8].to_vec(),
docs: vec![],
},
StorageEntryMetadata {
StorageEntryMetadataIR {
name: "DoubleMap",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Map {
hashers: vec![StorageHasher::Identity, StorageHasher::Identity],
modifier: StorageEntryModifierIR::Default,
ty: StorageEntryTypeIR::Map {
hashers: vec![StorageHasherIR::Identity, StorageHasherIR::Identity],
key: scale_info::meta_type::<(u64, u64)>(),
value: scale_info::meta_type::<u64>(),
},
@@ -37,6 +37,9 @@ use sp_io::{
};
use sp_runtime::{DispatchError, ModuleError};
/// Latest stable metadata version used for testing.
const LATEST_METADATA_VERSION: u32 = 14;
pub struct SomeType1;
impl From<SomeType1> for u64 {
fn from(_t: SomeType1) -> Self {
@@ -1593,6 +1596,43 @@ fn metadata() {
pretty_assertions::assert_eq!(actual_metadata.pallets, expected_metadata.pallets);
}
#[test]
fn metadata_at_version() {
use frame_support::metadata::*;
use sp_core::Decode;
let metadata = Runtime::metadata();
let at_metadata = match Runtime::metadata_at_version(LATEST_METADATA_VERSION) {
Some(opaque) => {
let bytes = &*opaque;
let metadata: RuntimeMetadataPrefixed = Decode::decode(&mut &bytes[..]).unwrap();
metadata
},
_ => panic!("metadata has been bumped, test needs to be updated"),
};
assert_eq!(metadata, at_metadata);
}
#[test]
fn metadata_versions() {
assert_eq!(vec![LATEST_METADATA_VERSION], Runtime::metadata_versions());
}
#[test]
fn metadata_ir_pallet_runtime_docs() {
let ir = Runtime::metadata_ir();
let pallet = ir
.pallets
.iter()
.find(|pallet| pallet.name == "Example")
.expect("Pallet should be present");
let readme = "Support code for the runtime.\n\nLicense: Apache-2.0";
let expected = vec![" Pallet documentation", readme, readme];
assert_eq!(pallet.docs, expected);
}
#[test]
fn test_pallet_runtime_docs() {
let docs = crate::pallet::Pallet::<Runtime>::pallet_documentation_metadata();