Utilize Metadata V15

.github/workflows/nightly.yml

@@ -9,7 +9,7 @@ on:
 env:
   CARGO_TERM_COLOR: always
   # Use latest substrate for nightly runs:
-  SUBSTRATE_URL: https://releases.parity.io/substrate/x86_64-debian:stretch/latest/substrate/substrate
+  SUBSTRATE_URL: https://releases.parity.io/substrate/x86_64-debian:bullseye/latest/substrate/substrate
 
 jobs:
   tests:

.github/workflows/rust.yml

@@ -19,7 +19,7 @@ concurrency:
 env:
     CARGO_TERM_COLOR: always
     # TODO: Currently pointing at latest substrate; is there a suitable binary we can pin to here?
-    SUBSTRATE_URL: https://releases.parity.io/substrate/x86_64-debian:stretch/latest/substrate/substrate
+    SUBSTRATE_URL: https://releases.parity.io/substrate/x86_64-debian:bullseye/latest/substrate/substrate
 
 jobs:
     build:
@@ -169,7 +169,7 @@ jobs:
     nonwasm_light_client_tests:
         name: "Test Light Client"
         runs-on: ubuntu-latest-16-cores
-        timeout-minutes: 15
+        timeout-minutes: 25
         steps:
             - name: Checkout sources
               uses: actions/checkout@v3

Cargo.toml

@@ -45,7 +45,7 @@ console_error_panic_hook = "0.1.7"
 darling = "0.20.0"
 derivative = "2.2.0"
 either = "1.8.1"
-frame-metadata = { version = "15.1.0", features = ["v14", "v15-unstable", "std"] }
+frame-metadata = { version = "16.0.0", default-features = false, features = ["current", "std"] }
 futures = { version = "0.3.27", default-features = false, features = ["std"] }
 getrandom = { version = "0.2", default-features = false }
 hex = "0.4.3"
@@ -58,7 +58,7 @@ proc-macro-error = "1.0.4"
 proc-macro2 = "1.0.63"
 quote = "1.0.29"
 regex = "1.8.4"
-scale-info = "2.8.0"
+scale-info = "2.9.0"
 scale-value = "0.10.0"
 scale-bits = "0.3"
 scale-decode = "0.7.0"

codegen/src/api/mod.rs

@@ -289,13 +289,12 @@ impl RuntimeGenerator {
     ) -> Result<TokenStream2, CodegenError> {
         let item_mod_attrs = item_mod.attrs.clone();
         let item_mod_ir = ir::ItemMod::try_from(item_mod)?;
-        let default_derives = derives.default_derives();
 
         let type_gen = TypeGenerator::new(
             self.metadata.types(),
             "runtime_types",
             type_substitutes,
-            derives.clone(),
+            derives,
             crate_path.clone(),
             should_gen_docs,
         );
@@ -382,46 +381,6 @@ impl RuntimeGenerator {
             })
             .collect::<Result<Vec<_>, CodegenError>>()?;
 
-        let outer_event_variants = self.metadata.pallets().filter_map(|p| {
-            let variant_name = format_ident!("{}", p.name());
-            let mod_name = format_ident!("{}", p.name().to_string().to_snake_case());
-            let index = proc_macro2::Literal::u8_unsuffixed(p.index());
-
-            p.event_ty_id().map(|_| {
-                quote! {
-                    #[codec(index = #index)]
-                    #variant_name(#mod_name::Event),
-                }
-            })
-        });
-
-        let outer_event = quote! {
-            #default_derives
-            pub enum Event {
-                #( #outer_event_variants )*
-            }
-        };
-
-        let outer_extrinsic_variants = self.metadata.pallets().filter_map(|p| {
-            let variant_name = format_ident!("{}", p.name());
-            let mod_name = format_ident!("{}", p.name().to_string().to_snake_case());
-            let index = proc_macro2::Literal::u8_unsuffixed(p.index());
-
-            p.call_ty_id().map(|_| {
-                quote! {
-                    #[codec(index = #index)]
-                    #variant_name(#mod_name::Call),
-                }
-            })
-        });
-
-        let outer_extrinsic = quote! {
-            #default_derives
-            pub enum Call {
-                #( #outer_extrinsic_variants )*
-            }
-        };
-
         let root_event_if_arms = self.metadata.pallets().filter_map(|p| {
             let variant_name_str = &p.name();
             let variant_name = format_ident!("{}", variant_name_str);
@@ -459,26 +418,6 @@ impl RuntimeGenerator {
             })
         });
 
-        let outer_error_variants = self.metadata.pallets().filter_map(|p| {
-            let variant_name = format_ident!("{}", p.name());
-            let mod_name = format_ident!("{}", p.name().to_string().to_snake_case());
-            let index = proc_macro2::Literal::u8_unsuffixed(p.index());
-
-            p.error_ty_id().map(|_| {
-                quote! {
-                    #[codec(index = #index)]
-                    #variant_name(#mod_name::Error),
-                }
-            })
-        });
-
-        let outer_error = quote! {
-            #default_derives
-            pub enum Error {
-                #( #outer_error_variants )*
-            }
-        };
-
         let root_error_if_arms = self.metadata.pallets().filter_map(|p| {
             let variant_name_str = &p.name();
             let variant_name = format_ident!("{}", variant_name_str);
@@ -526,6 +465,12 @@ impl RuntimeGenerator {
             should_gen_docs,
         )?;
 
+        // Fetch the paths of the outer enums.
+        // Substrate exposes those under `kitchensink_runtime`, while Polkadot under `polkadot_runtime`.
+        let call_path = type_gen.resolve_type_path(self.metadata.outer_enums().call_enum_ty());
+        let event_path = type_gen.resolve_type_path(self.metadata.outer_enums().event_enum_ty());
+        let error_path = type_gen.resolve_type_path(self.metadata.outer_enums().error_enum_ty());
+
         Ok(quote! {
             #( #item_mod_attrs )*
             #[allow(dead_code, unused_imports, non_camel_case_types)]
@@ -551,7 +496,8 @@ impl RuntimeGenerator {
                 /// The error type returned when there is a runtime issue.
                 pub type DispatchError = #types_mod_ident::sp_runtime::DispatchError;
 
-                #outer_event
+                /// The outer event enum.
+                pub type Event = #event_path;
 
                 impl #crate_path::events::RootEvent for Event {
                     fn root_event(pallet_bytes: &[u8], pallet_name: &str, pallet_ty: u32, metadata: &#crate_path::Metadata) -> Result<Self, #crate_path::Error> {
@@ -561,7 +507,8 @@ impl RuntimeGenerator {
                     }
                 }
 
-                #outer_extrinsic
+                /// The outer extrinsic enum.
+                pub type Call = #call_path;
 
                 impl #crate_path::blocks::RootExtrinsic for Call {
                     fn root_extrinsic(pallet_bytes: &[u8], pallet_name: &str, pallet_ty: u32, metadata: &#crate_path::Metadata) -> Result<Self, #crate_path::Error> {
@@ -571,7 +518,8 @@ impl RuntimeGenerator {
                     }
                 }
 
-                #outer_error
+                /// The outer error enum representing the DispatchError's Module variant.
+                pub type Error = #error_path;
 
                 impl #crate_path::error::RootError for Error {
                     fn root_error(pallet_bytes: &[u8], pallet_name: &str, metadata: &#crate_path::Metadata) -> Result<Self, #crate_path::Error> {

codegen/src/error.rs

@@ -19,7 +19,7 @@ pub enum CodegenError {
     #[error("Failed IO for {0}, make sure that you are providing the correct file path for metadata: {1}")]
     Io(String, std::io::Error),
     /// Cannot decode the metadata bytes.
-    #[error("Could not decode metadata, only V14 metadata is supported: {0}")]
+    #[error("Could not decode metadata, only V14 and V15 metadata are supported: {0}")]
     Decode(#[from] codec::Error),
     /// Out of line modules are not supported.
     #[error("Out-of-line subxt modules are not supported, make sure you are providing a body to your module: pub mod polkadot {{ ... }}")]

codegen/src/utils/fetch_metadata.rs

@@ -204,12 +204,9 @@ async fn fetch_metadata(
         client: &impl ClientT,
         version: MetadataVersion,
     ) -> Result<Vec<u8>, FetchMetadataError> {
-        if !matches!(
-            version,
-            MetadataVersion::Latest | MetadataVersion::Version(14)
-        ) {
+        if !matches!(version, MetadataVersion::Version(14)) {
             return Err(FetchMetadataError::Other(
-                "The node can only return version 14 metadata but you've asked for something else"
+                "The node can only return version 14 metadata using the legacy API but you've asked for something else"
                     .to_string(),
             ));
         }