metadata: Use v15 internally (#912)

* Update frame-metadata to v15.1.0 Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Enable V15 unstable metadata in frame-metadata Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Move validation hashing to dedicated file Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Use sp-metadata-ir from substrate to work with metadata Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Revert using sp-metadata-ir in favor of conversion to v15 Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Convert v14 to v15 Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Use v15 for validation Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * codegen: Use v15 for codegen Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata/bench: Use v15 Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Adjust to v15 metadata Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Adjust testing Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Improve documentation Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * force CI Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Address feedback Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Use HASH_LEN Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadta: Remove `LatestRuntimeMetadata` type alias Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * metadata: Remove `metadata_to_latest` to avoid pancis Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> --------- Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
2026-06-22 19:41:07 +00:00 · 2023-04-20 17:59:28 +03:00
parent 2f1b67b384
commit 59d195d4ad
30 changed files with 1087 additions and 920 deletions
@@ -18,7 +18,7 @@ default = ["subxt/integration-tests"]
 [dev-dependencies]
 assert_matches = "1.5.0"
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive", "full", "bit-vec"] }
-frame-metadata = "15.0.0"
+frame-metadata = { version = "15.1.0", features = ["v14", "v15-unstable", "std"] }
 futures = "0.3.27"
 hex = "0.4.3"
 regex = "1.7.3"
@@ -29,6 +29,7 @@ sp-keyring = "23.0.0"
 syn = "1.0.109"
 subxt = { version = "0.28.0", path = "../../subxt" }
 subxt-codegen = { version = "0.28.0", path = "../../codegen" }
+subxt-metadata = { version = "0.28.0", path = "../../metadata" }
 test-runtime = { path = "../test-runtime" }
 tokio = { version = "1.27", features = ["macros", "time"] }
 tracing = "0.1.34"
@@ -105,8 +105,11 @@ async fn runtime_api_call() -> Result<(), subxt::Error> {
        .call_raw::<(Compact<u32>, RuntimeMetadataPrefixed)>("Metadata_metadata", None)
        .await?;
    let metadata_call = match meta.1 {
-        frame_metadata::RuntimeMetadata::V14(metadata) => metadata,
-        _ => panic!("Metadata V14 unavailable"),
+        frame_metadata::RuntimeMetadata::V14(metadata) => {
+            subxt_metadata::metadata_v14_to_latest(metadata)
+        }
+        frame_metadata::RuntimeMetadata::V15(metadata) => metadata,
+        _ => panic!("Metadata V14 or V15 unavailable"),
    };

    // Compare the runtime API call against the `state_getMetadata`.
@@ -394,10 +394,12 @@ async fn rpc_state_call() {
        .await
        .unwrap();
    let metadata_call = match meta.1 {
-        frame_metadata::RuntimeMetadata::V14(metadata) => metadata,
-        _ => panic!("Metadata V14 unavailable"),
+        frame_metadata::RuntimeMetadata::V14(metadata) => {
+            subxt_metadata::metadata_v14_to_latest(metadata)
+        }
+        frame_metadata::RuntimeMetadata::V15(metadata) => metadata,
+        _ => panic!("Metadata V14 or V15 unavailable"),
    };
-
    // Compare the runtime API call against the `state_getMetadata`.
    let metadata = api.rpc().metadata(None).await.unwrap();
    let metadata = metadata.runtime_metadata();
@@ -14,7 +14,8 @@ fn metadata_docs() -> Vec<String> {
    // Load the runtime metadata downloaded from a node via `test-runtime`.
    let meta = load_test_metadata();
    let metadata = match meta.1 {
-        frame_metadata::RuntimeMetadata::V14(v14) => v14,
+        frame_metadata::RuntimeMetadata::V14(v14) => subxt_metadata::metadata_v14_to_latest(v14),
+        frame_metadata::RuntimeMetadata::V15(v15) => v15,
        _ => panic!("Unsupported metadata version {:?}", meta.1),
    };

@@ -4,9 +4,11 @@

 use crate::{node_runtime, test_context, TestContext};
 use frame_metadata::{
-    ExtrinsicMetadata, PalletCallMetadata, PalletMetadata, PalletStorageMetadata,
-    RuntimeMetadataPrefixed, RuntimeMetadataV14, StorageEntryMetadata, StorageEntryModifier,
-    StorageEntryType,
+    v15::{
+        ExtrinsicMetadata, PalletCallMetadata, PalletMetadata, PalletStorageMetadata,
+        RuntimeMetadataV15, StorageEntryMetadata, StorageEntryModifier, StorageEntryType,
+    },
+    RuntimeMetadataPrefixed,
 };
 use scale_info::{
    build::{Fields, Variants},
@@ -15,7 +17,7 @@ use scale_info::{
 use subxt::{Metadata, OfflineClient, SubstrateConfig};

 async fn metadata_to_api(
-    metadata: RuntimeMetadataV14,
+    metadata: RuntimeMetadataV15,
    ctx: &TestContext,
 ) -> OfflineClient<SubstrateConfig> {
    let prefixed = RuntimeMetadataPrefixed::from(metadata);
@@ -37,7 +39,7 @@ async fn full_metadata_check() {
    assert!(node_runtime::validate_codegen(&api).is_ok());

    // Modify the metadata.
-    let mut metadata: RuntimeMetadataV14 = api.metadata().runtime_metadata().clone();
+    let mut metadata = api.metadata().runtime_metadata().clone();
    metadata.pallets[0].name = "NewPallet".to_string();

    let api = metadata_to_api(metadata, &ctx).await;
@@ -59,7 +61,7 @@ async fn constant_values_are_not_validated() {
    assert!(api.constants().at(&deposit_addr).is_ok());

    // Modify the metadata.
-    let mut metadata: RuntimeMetadataV14 = api.metadata().runtime_metadata().clone();
+    let mut metadata = api.metadata().runtime_metadata().clone();

    let mut existential = metadata
        .pallets
@@ -89,11 +91,12 @@ fn default_pallet() -> PalletMetadata {
        constants: vec![],
        error: None,
        index: 0,
+        docs: vec![],
    }
 }

-fn pallets_to_metadata(pallets: Vec<PalletMetadata>) -> RuntimeMetadataV14 {
-    RuntimeMetadataV14::new(
+fn pallets_to_metadata(pallets: Vec<PalletMetadata>) -> RuntimeMetadataV15 {
+    RuntimeMetadataV15::new(
        pallets,
        ExtrinsicMetadata {
            ty: meta_type::<()>(),
@@ -101,6 +104,7 @@ fn pallets_to_metadata(pallets: Vec<PalletMetadata>) -> RuntimeMetadataV14 {
            signed_extensions: vec![],
        },
        meta_type::<()>(),
+        vec![],
    )
 }

@@ -11,7 +11,7 @@ publish = false
 [dev-dependencies]
 trybuild = "1.0.79"
 scale-info = { version = "2.5.0", features = ["bit-vec"] }
-frame-metadata = "15.0.0"
+frame-metadata = { version = "15.1.0", features = ["v14", "v15-unstable", "std"] }
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive", "full", "bit-vec"] }
 subxt = { path = "../../subxt" }
 subxt-metadata = { path = "../../metadata" }
@@ -3,7 +3,8 @@
 // see LICENSE for license details.

 use frame_metadata::{
-    RuntimeMetadataPrefixed, StorageEntryMetadata, StorageEntryModifier, StorageEntryType,
+    v15::{StorageEntryMetadata, StorageEntryModifier, StorageEntryType},
+    RuntimeMetadataPrefixed,
 };
 use scale_info::meta_type;

@@ -7,8 +7,11 @@ mod metadata_test_runner;
 mod pallet_metadata_test_runner;

 use frame_metadata::{
-    v14::RuntimeMetadataV14, ExtrinsicMetadata, PalletMetadata, PalletStorageMetadata,
-    RuntimeMetadataPrefixed, StorageEntryMetadata,
+    v15::{
+        ExtrinsicMetadata, PalletMetadata, PalletStorageMetadata, RuntimeMetadataV15,
+        StorageEntryMetadata,
+    },
+    RuntimeMetadataPrefixed,
 };
 use scale_info::{meta_type, IntoPortable, TypeInfo};

@@ -28,7 +31,7 @@ pub fn generate_metadata_from_pallets_custom_dispatch_error<DispatchError: TypeI
        signed_extensions: vec![],
    };

-    // Construct metadata manually from our types (See `RuntimeMetadataV14::new()`).
+    // Construct metadata manually from our types (See `RuntimeMetadataV15::new()`).
    // Add any extra types we need to the registry.
    let mut registry = scale_info::Registry::new();
    let pallets = registry.map_into_portable(pallets);
@@ -48,11 +51,12 @@ pub fn generate_metadata_from_pallets_custom_dispatch_error<DispatchError: TypeI
    // Metadata needs to contain this DispatchError, since codegen looks for it.
    registry.register_type(&meta_type::<DispatchError>());

-    let metadata = RuntimeMetadataV14 {
+    let metadata = RuntimeMetadataV15 {
        types: registry.into(),
        pallets,
        extrinsic,
        ty,
+        apis: vec![],
    };

    RuntimeMetadataPrefixed::from(metadata)
@@ -86,6 +90,7 @@ pub fn generate_metadata_from_storage_entries(
        calls: None,
        event: None,
        error: None,
+        docs: vec![],
    };

    generate_metadata_from_pallets(vec![pallet])
@@ -3,15 +3,15 @@
 // see LICENSE for license details.

 use codec::{Decode, Encode};
-use frame_metadata::{RuntimeMetadataPrefixed, RuntimeMetadataV14};
+use frame_metadata::{v15::RuntimeMetadataV15, RuntimeMetadataPrefixed};
 use std::io::Read;
-use subxt_metadata::retain_metadata_pallets;
+use subxt_metadata::{metadata_v14_to_latest, retain_metadata_pallets};

 static TEST_DIR_PREFIX: &str = "subxt_generated_pallets_ui_tests_";
 static METADATA_FILE: &str = "../../artifacts/polkadot_metadata.scale";

 pub struct PalletMetadataTestRunner {
-    metadata: RuntimeMetadataV14,
+    metadata: RuntimeMetadataV15,
    index: usize,
 }

@@ -28,8 +28,9 @@ impl PalletMetadataTestRunner {
            Decode::decode(&mut &*bytes).expect("Cannot decode metadata bytes");

        let metadata = match meta.1 {
-            frame_metadata::RuntimeMetadata::V14(v14) => v14,
-            _ => panic!("Unsupported metadata version. Tests support only v14"),
+            frame_metadata::RuntimeMetadata::V14(v14) => metadata_v14_to_latest(v14),
+            frame_metadata::RuntimeMetadata::V15(v15) => v15,
+            _ => panic!("Unsupported metadata version {:?}", meta.1),
        };

        PalletMetadataTestRunner { metadata, index: 0 }