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-19 13:31:04 +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,148 @@
+// 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.
+
+//! This module contains the trait and types used to represent
+//! transactions that can be submitted.
+
+use crate::{
+    dynamic::Value,
+    error::{
+        Error,
+        MetadataError,
+    },
+    metadata::Metadata,
+};
+use codec::Encode;
+use std::borrow::Cow;
+
+/// This represents a transaction payload that can be submitted
+/// to a node.
+pub trait TxPayload {
+    /// The name of the pallet that the call lives under.
+    fn pallet_name(&self) -> &str;
+
+    /// The name of the call.
+    fn call_name(&self) -> &str;
+
+    /// Encode call data to the provided output.
+    fn encode_call_data(
+        &self,
+        metadata: &Metadata,
+        out: &mut Vec<u8>,
+    ) -> Result<(), Error>;
+
+    /// An optional validation hash that can be provided
+    /// to verify that the shape of the call on the node
+    /// aligns with our expectations.
+    fn validation_hash(&self) -> Option<[u8; 32]> {
+        None
+    }
+}
+
+/// This represents a statically generated transaction payload.
+pub struct StaticTxPayload<CallData> {
+    pallet_name: &'static str,
+    call_name: &'static str,
+    call_data: CallData,
+    validation_hash: Option<[u8; 32]>,
+}
+
+impl<CallData> StaticTxPayload<CallData> {
+    /// Create a new [`StaticTxPayload`] from static data.
+    pub fn new(
+        pallet_name: &'static str,
+        call_name: &'static str,
+        call_data: CallData,
+        validation_hash: [u8; 32],
+    ) -> Self {
+        StaticTxPayload {
+            pallet_name,
+            call_name,
+            call_data,
+            validation_hash: Some(validation_hash),
+        }
+    }
+
+    /// Do not validate this call prior to submitting it.
+    pub fn unvalidated(self) -> Self {
+        Self {
+            validation_hash: None,
+            ..self
+        }
+    }
+}
+
+impl<CallData: Encode> TxPayload for StaticTxPayload<CallData> {
+    fn pallet_name(&self) -> &str {
+        self.pallet_name
+    }
+
+    fn call_name(&self) -> &str {
+        self.call_name
+    }
+
+    fn encode_call_data(
+        &self,
+        metadata: &Metadata,
+        out: &mut Vec<u8>,
+    ) -> Result<(), Error> {
+        let pallet = metadata.pallet(self.pallet_name)?;
+        let pallet_index = pallet.index();
+        let call_index = pallet.call_index(self.call_name)?;
+
+        pallet_index.encode_to(out);
+        call_index.encode_to(out);
+        self.call_data.encode_to(out);
+        Ok(())
+    }
+
+    fn validation_hash(&self) -> Option<[u8; 32]> {
+        self.validation_hash
+    }
+}
+
+/// This represents a dynamically generated transaction payload.
+pub struct DynamicTxPayload<'a> {
+    pallet_name: Cow<'a, str>,
+    call_name: Cow<'a, str>,
+    fields: Vec<Value<()>>,
+}
+
+/// Construct a new dynamic transaction payload to submit to a node.
+pub fn dynamic<'a>(
+    pallet_name: impl Into<Cow<'a, str>>,
+    call_name: impl Into<Cow<'a, str>>,
+    fields: Vec<Value<()>>,
+) -> DynamicTxPayload<'a> {
+    DynamicTxPayload {
+        pallet_name: pallet_name.into(),
+        call_name: call_name.into(),
+        fields,
+    }
+}
+
+impl<'a> TxPayload for DynamicTxPayload<'a> {
+    fn pallet_name(&self) -> &str {
+        &self.pallet_name
+    }
+
+    fn call_name(&self) -> &str {
+        &self.call_name
+    }
+
+    fn encode_call_data(
+        &self,
+        metadata: &Metadata,
+        out: &mut Vec<u8>,
+    ) -> Result<(), Error> {
+        let pallet = metadata.pallet(&self.pallet_name)?;
+        let call_id = pallet.call_ty_id().ok_or(MetadataError::CallNotFound)?;
+        let call_value =
+            Value::unnamed_variant(self.call_name.to_owned(), self.fields.clone());
+
+        pallet.index().encode_to(out);
+        scale_value::scale::encode_as_type(&call_value, call_id, metadata.types(), out)?;
+        Ok(())
+    }
+}