wip: Remove subxt Config associated types by relying on enriched metadata (v16)

codegen/src/api/custom_values.rs

@@ -9,7 +9,7 @@ use std::collections::HashSet;
 use subxt_metadata::{CustomValueMetadata, Metadata};
 
 use proc_macro2::TokenStream as TokenStream2;
-use quote::quote;
+use quote::{format_ident, quote};
 
 /// Generate the custom values mod, if there are any custom values in the metadata. Else returns None.
 pub fn generate_custom_values(
@@ -19,6 +19,18 @@ pub fn generate_custom_values(
 ) -> TokenStream2 {
     let mut fn_names_taken = HashSet::new();
     let custom = metadata.custom();
+    let custom_types = custom.iter().map(|custom| {
+        let name = format_ident!("{}", custom.name());
+
+        let Ok(ty) = type_gen.resolve_type_path(custom.type_id()) else {
+            return quote! {};
+        };
+        let ty = ty.to_token_stream(type_gen.settings());
+        quote! {
+            pub type #name = #ty;
+        }
+    });
+
     let custom_values_fns = custom.iter().filter_map(|custom_value| {
         generate_custom_value_fn(custom_value, type_gen, crate_path, &mut fn_names_taken)
     });
@@ -29,6 +41,12 @@ pub fn generate_custom_values(
         impl CustomValuesApi {
             #(#custom_values_fns)*
         }
+
+        pub mod custom_types {
+            pub use super::*;
+
+            #(#custom_types)*
+        }
     }
 }
 

core/src/config/polkadot.rs

@@ -17,14 +17,22 @@ pub use primitive_types::{H256, U256};
 pub enum PolkadotConfig {}
 
 impl Config for PolkadotConfig {
-    type Hash = <SubstrateConfig as Config>::Hash;
-    type AccountId = <SubstrateConfig as Config>::AccountId;
-    type Address = MultiAddress<Self::AccountId, ()>;
-    type Signature = <SubstrateConfig as Config>::Signature;
-    type Hasher = <SubstrateConfig as Config>::Hasher;
-    type Header = <SubstrateConfig as Config>::Header;
+    // coming from: System::Config
+    type Hash = <SubstrateConfig as Config>::Hash; // Done
+    type AccountId = <SubstrateConfig as Config>::AccountId; // Done
+    type Hasher = <SubstrateConfig as Config>::Hasher; // Done
+
+    // coming from <runtime as traits::Block>::Extrinsic type
+    type Address = MultiAddress<Self::AccountId, ()>; // Done
+    type Signature = <SubstrateConfig as Config>::Signature; // Done
+
+    // coming from <runtime as traits::Block>::Header type
+    type Header = <SubstrateConfig as Config>::Header; // Done
+
     type ExtrinsicParams = PolkadotExtrinsicParams<Self>;
-    type AssetId = u32;
+
+    // coming from Assets::Config (interested in foreign Assets specifically)
+    type AssetId = u32; // Done
 }
 
 /// A struct representing the signed extra and additional parameters required

subxt/examples/metadata_config.rs

@@ -0,0 +1,63 @@
+#![allow(missing_docs)]
+use subxt::{OnlineClient, SubstrateConfig};
+use subxt_core::config::{Config, DefaultExtrinsicParams};
+use subxt_signer::sr25519::dev;
+
+// Generate an interface that we can use from the node's metadata.
+#[subxt::subxt(runtime_metadata_insecure_url = "ws://localhost:9999")]
+pub mod polkadot {}
+
+// Derives aren't strictly needed, they just make developer life easier.
+#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
+pub enum MetadataConfig {}
+
+impl Config for MetadataConfig {
+    // Extracted from metadata directly:
+    type Hash = polkadot::custom_types::Hash;
+    type AccountId = polkadot::custom_types::AccountId;
+    type AssetId = polkadot::custom_types::AssetId;
+    type Address = polkadot::custom_types::Address;
+
+    // Present in metadata but this PoC needs to add
+    // fn specific per name of type to impl the hashing fn.
+    type Hasher = <SubstrateConfig as Config>::Hasher;
+    // Present in metadata but this PoC needs to impl the header
+    // trait to make use of this.
+    type Header = <SubstrateConfig as Config>::Header;
+    // Same story, present in md but needs subxt::tx::Signer<T>.
+    // type Signature = polkadot::custom_types::Signature;
+    type Signature = <SubstrateConfig as Config>::Signature;
+
+    // Not exposed in metadata, seems like heavily involved with
+    // code functionality which cannot safely be expressed in the
+    // metadata.
+    type ExtrinsicParams = DefaultExtrinsicParams<Self>;
+}
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // Create a new API client, configured to talk to nodes.
+    let api = OnlineClient::<MetadataConfig>::from_insecure_url("ws://localhost:9999").await?;
+
+    // Build a balance transfer extrinsic.
+    let dest = dev::bob().public_key().into();
+    let balance_transfer_tx = polkadot::tx().balances().transfer_allow_death(dest, 10_000);
+
+    // Submit the balance transfer extrinsic from Alice, and wait for it to be successful
+    // and in a finalized block. We get back the extrinsic events if all is well.
+    let from = dev::alice();
+    let events = api
+        .tx()
+        .sign_and_submit_then_watch_default(&balance_transfer_tx, &from)
+        .await?
+        .wait_for_finalized_success()
+        .await?;
+
+    // Find a Transfer event and print it.
+    let transfer_event = events.find_first::<polkadot::balances::events::Transfer>()?;
+    if let Some(event) = transfer_event {
+        println!("Balance transfer success: {event:?}");
+    }
+
+    Ok(())
+}