Rework Subxt API to support offline and dynamic transactions (#593)

* WIP API changes * debug impls * Get main crate compiling with first round of changes * Some tidy up * Add WithExtrinsicParams, and have SubstrateConfig + PolkadotConfig, not DefaultConfig * move transaction into extrinsic folder * Add runtime updates back to OnlineClient * rework to be 'client first' to fit better with storage + events * add support for events to Client * tidy dupe trait bound * Wire storage into client, but need to remove static reliance * various tidy up and start stripping codegen to remove bits we dont need now * First pass updating calls and constants codegen * WIP storage client updates * First pass migrated runtime storage over to new format * pass over codegen to generate StorageAddresses and throw other stuff out * don't need a Call trait any more * shuffle things around a bit * Various proc_macro fixes to get 'cargo check' working * organise what's exposed from subxt * Get first example working; balance_transfer_with_params * get balance_transfer example compiling * get concurrent_storage_requests.rs example compiling * get fetch_all_accounts example compiling * get a bunch more of the examples compiling * almost get final example working; type mismatch to look into * wee tweaks * move StorageAddress to separate file * pass Defaultable/Iterable info to StorageAddress in codegen * fix storage validation ne, and partial run through example code * Remove static iteration and strip a generic param from everything * fix doc tests in subxt crate * update test utils and start fixing frame tests * fix frame staking tests * fix the rest of the test compile issues, Borrow on storage values * cargo fmt * remove extra logging during tests * Appease clippy and no more need for into_iter on events * cargo fmt * fix dryRun tests by waiting for blocks * wait for blocks instead of sleeping or other test hacks * cargo fmt * Fix doc links * Traitify StorageAddress * remove out-of-date doc comments * optimise decoding storage a little * cleanup tx stuff, trait for TxPayload, remove Err type param and decode at runtime * clippy fixes * fix doc links * fix doc example * constant address trait for consistency * fix a typo and remove EncodeWithMetadata stuff * Put EventDetails behind a proper interface and allow decoding into top level event, too * fix docs * tweak StorageAddress docs * re-export StorageAddress at root for consistency * fix clippy things * Add support for dynamic values * fix double encoding of storage map key after refactor * clippy fix * Fixes and add a dynamic usage example (needs new scale_value release) * bump scale_value version * cargo fmt * Tweak event bits * cargo fmt * Add a test and bump scale-value to 0.4.0 to support this * remove unnecessary vec from dynamic example * Various typo/grammar fixes Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> * Address PR nits * Undo accidental rename in changelog * Small PR nits/tidyups * fix tests; codegen change against latest substrate * tweak storage address util names * move error decoding to DecodeError and expose * impl some basic traits on the extrinsic param builder Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>
2026-06-17 11:21:07 +00:00 · 2022-08-08 11:55:20 +01:00
parent 7a09ac6cd7
commit e48f0e3b1d
84 changed files with 23097 additions and 35863 deletions
@@ -0,0 +1,109 @@
+// Copyright 2019-2022 Parity Technologies (UK) Ltd.
+// This file is dual-licensed as Apache-2.0 or GPL-3.0.
+// see LICENSE for license details.
+
+use crate::{
+    dynamic::DecodedValue,
+    metadata::DecodeWithMetadata,
+};
+use std::borrow::Cow;
+
+/// This represents a constant address. Anything implementing this trait
+/// can be used to fetch constants.
+pub trait ConstantAddress {
+    /// The target type of the value that lives at this address.
+    type Target: DecodeWithMetadata;
+
+    /// The name of the pallet that the constant lives under.
+    fn pallet_name(&self) -> &str;
+
+    /// The name of the constant in a given pallet.
+    fn constant_name(&self) -> &str;
+
+    /// An optional hash which, if present, will be checked against
+    /// the node metadata to confirm that the return type matches what
+    /// we are expecting.
+    fn validation_hash(&self) -> Option<[u8; 32]> {
+        None
+    }
+}
+
+/// This represents a statically generated constant lookup address.
+pub struct StaticConstantAddress<ReturnTy> {
+    pallet_name: &'static str,
+    constant_name: &'static str,
+    constant_hash: Option<[u8; 32]>,
+    _marker: std::marker::PhantomData<ReturnTy>,
+}
+
+impl<ReturnTy> StaticConstantAddress<ReturnTy> {
+    /// Create a new [`StaticConstantAddress`] that will be validated
+    /// against node metadata using the hash given.
+    pub fn new(
+        pallet_name: &'static str,
+        constant_name: &'static str,
+        hash: [u8; 32],
+    ) -> Self {
+        Self {
+            pallet_name,
+            constant_name,
+            constant_hash: Some(hash),
+            _marker: std::marker::PhantomData,
+        }
+    }
+
+    /// Do not validate this constant prior to accessing it.
+    pub fn unvalidated(self) -> Self {
+        Self {
+            pallet_name: self.pallet_name,
+            constant_name: self.constant_name,
+            constant_hash: None,
+            _marker: self._marker,
+        }
+    }
+}
+
+impl<ReturnTy: DecodeWithMetadata> ConstantAddress for StaticConstantAddress<ReturnTy> {
+    type Target = ReturnTy;
+
+    fn pallet_name(&self) -> &str {
+        self.pallet_name
+    }
+
+    fn constant_name(&self) -> &str {
+        self.constant_name
+    }
+
+    fn validation_hash(&self) -> Option<[u8; 32]> {
+        self.constant_hash
+    }
+}
+
+/// This represents a dynamically generated constant address.
+pub struct DynamicConstantAddress<'a> {
+    pallet_name: Cow<'a, str>,
+    constant_name: Cow<'a, str>,
+}
+
+/// Construct a new dynamic constant lookup.
+pub fn dynamic<'a>(
+    pallet_name: impl Into<Cow<'a, str>>,
+    constant_name: impl Into<Cow<'a, str>>,
+) -> DynamicConstantAddress<'a> {
+    DynamicConstantAddress {
+        pallet_name: pallet_name.into(),
+        constant_name: constant_name.into(),
+    }
+}
+
+impl<'a> ConstantAddress for DynamicConstantAddress<'a> {
+    type Target = DecodedValue;
+
+    fn pallet_name(&self) -> &str {
+        &self.pallet_name
+    }
+
+    fn constant_name(&self) -> &str {
+        &self.constant_name
+    }
+}
@@ -0,0 +1,78 @@
+// Copyright 2019-2022 Parity Technologies (UK) Ltd.
+// This file is dual-licensed as Apache-2.0 or GPL-3.0.
+// see LICENSE for license details.
+
+use super::ConstantAddress;
+use crate::{
+    client::OfflineClientT,
+    error::Error,
+    metadata::{
+        DecodeWithMetadata,
+        MetadataError,
+    },
+    Config,
+};
+use derivative::Derivative;
+
+/// A client for accessing constants.
+#[derive(Derivative)]
+#[derivative(Clone(bound = "Client: Clone"))]
+pub struct ConstantsClient<T, Client> {
+    client: Client,
+    _marker: std::marker::PhantomData<T>,
+}
+
+impl<T, Client> ConstantsClient<T, Client> {
+    /// Create a new [`ConstantsClient`].
+    pub fn new(client: Client) -> Self {
+        Self {
+            client,
+            _marker: std::marker::PhantomData,
+        }
+    }
+}
+
+impl<T: Config, Client: OfflineClientT<T>> ConstantsClient<T, Client> {
+    /// Run the validation logic against some constant address you'd like to access. Returns `Ok(())`
+    /// if the address is valid (or if it's not possible to check since the address has no validation hash).
+    /// Return an error if the address was not valid or something went wrong trying to validate it (ie
+    /// the pallet or constant in question do not exist at all).
+    pub fn validate<Address: ConstantAddress>(
+        &self,
+        address: &Address,
+    ) -> Result<(), Error> {
+        if let Some(actual_hash) = address.validation_hash() {
+            let expected_hash = self
+                .client
+                .metadata()
+                .constant_hash(address.pallet_name(), address.constant_name())?;
+            if actual_hash != expected_hash {
+                return Err(MetadataError::IncompatibleMetadata.into())
+            }
+        }
+        Ok(())
+    }
+
+    /// Access the constant at the address given, returning the type defined by this address.
+    /// This is probably used with addresses given from static codegen, although you can manually
+    /// construct your own, too.
+    pub fn at<Address: ConstantAddress>(
+        &self,
+        address: &Address,
+    ) -> Result<<Address::Target as DecodeWithMetadata>::Target, Error> {
+        let metadata = self.client.metadata();
+
+        // 1. Validate constant shape if hash given:
+        self.validate(address)?;
+
+        // 2. Attempt to decode the constant into the type given:
+        let pallet = metadata.pallet(address.pallet_name())?;
+        let constant = pallet.constant(address.constant_name())?;
+        let value = Address::Target::decode_with_metadata(
+            &mut &*constant.value,
+            constant.ty.id(),
+            &metadata,
+        )?;
+        Ok(value)
+    }
+}
@@ -0,0 +1,16 @@
+// Copyright 2019-2022 Parity Technologies (UK) Ltd.
+// This file is dual-licensed as Apache-2.0 or GPL-3.0.
+// see LICENSE for license details.
+
+//! Types associated with accessing constants.
+
+mod constant_address;
+mod constants_client;
+
+pub use constant_address::{
+    dynamic,
+    ConstantAddress,
+    DynamicConstantAddress,
+    StaticConstantAddress,
+};
+pub use constants_client::ConstantsClient;