Custom extra (#89)

* Run rustfmt.

* Make extra customizable.

* Update to alpha 6.

examples/kusama_balance_transfer.rs

@@ -39,8 +39,13 @@ async fn transfer_balance() -> Result<sp_core::H256, Error> {
 
     // note use of `KusamaRuntime`
     substrate_subxt::ClientBuilder::<KusamaRuntime>::new()
-        .build().await?
-        .xt(signer, None).await?
-        .submit(balances::transfer::<KusamaRuntime>(dest.clone().into(), 10_000))
+        .build()
+        .await?
+        .xt(signer, None)
+        .await?
+        .submit(balances::transfer::<KusamaRuntime>(
+            dest.clone().into(),
+            10_000,
+        ))
         .await
 }

examples/submit_and_watch.rs

@@ -51,9 +51,8 @@ fn main() {
     match result {
         Ok(extrinsic_success) => {
             match extrinsic_success
-                .find_event::<(AccountId, AccountId, Balance)>(
-                    "Balances", "Transfer",
-                ) {
+                .find_event::<(AccountId, AccountId, Balance)>("Balances", "Transfer")
+            {
                 Some(Ok((_from, _to, value))) => {
                     println!("Balance transfer success: value: {:?}", value)
                 }

src/extrinsic.rs

@@ -53,10 +53,10 @@ use crate::frame::{
 /// returned via `additional_signed()`.
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
 pub struct CheckVersion<T: System + Send + Sync>(
-    PhantomData<T>,
+    pub PhantomData<T>,
     /// Local version to be used for `AdditionalSigned`
     #[codec(skip)]
-    u32,
+    pub u32,
 );
 
 impl<T> SignedExtension for CheckVersion<T>
@@ -68,7 +68,6 @@ where
     type Call = ();
     type AdditionalSigned = u32;
     type Pre = ();
-    type DispatchInfo = ();
     fn additional_signed(
         &self,
     ) -> Result<Self::AdditionalSigned, TransactionValidityError> {
@@ -84,10 +83,10 @@ where
 /// returned via `additional_signed()`.
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
 pub struct CheckGenesis<T: System + Send + Sync>(
-    PhantomData<T>,
+    pub PhantomData<T>,
     /// Local genesis hash to be used for `AdditionalSigned`
     #[codec(skip)]
-    T::Hash,
+    pub T::Hash,
 );
 
 impl<T> SignedExtension for CheckGenesis<T>
@@ -99,7 +98,6 @@ where
     type Call = ();
     type AdditionalSigned = T::Hash;
     type Pre = ();
-    type DispatchInfo = ();
     fn additional_signed(
         &self,
     ) -> Result<Self::AdditionalSigned, TransactionValidityError> {
@@ -117,10 +115,10 @@ where
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
 pub struct CheckEra<T: System + Send + Sync>(
     /// The default structure for the Extra encoding
-    (Era, PhantomData<T>),
+    pub (Era, PhantomData<T>),
     /// Local genesis hash to be used for `AdditionalSigned`
     #[codec(skip)]
-    T::Hash,
+    pub T::Hash,
 );
 
 impl<T> SignedExtension for CheckEra<T>
@@ -132,7 +130,6 @@ where
     type Call = ();
     type AdditionalSigned = T::Hash;
     type Pre = ();
-    type DispatchInfo = ();
     fn additional_signed(
         &self,
     ) -> Result<Self::AdditionalSigned, TransactionValidityError> {
@@ -142,7 +139,7 @@ where
 
 /// Nonce check and increment to give replay protection for transactions.
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
-pub struct CheckNonce<T: System + Send + Sync>(#[codec(compact)] T::Index);
+pub struct CheckNonce<T: System + Send + Sync>(#[codec(compact)] pub T::Index);
 
 impl<T> SignedExtension for CheckNonce<T>
 where
@@ -153,7 +150,6 @@ where
     type Call = ();
     type AdditionalSigned = ();
     type Pre = ();
-    type DispatchInfo = ();
     fn additional_signed(
         &self,
     ) -> Result<Self::AdditionalSigned, TransactionValidityError> {
@@ -163,7 +159,7 @@ where
 
 /// Resource limit check.
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
-pub struct CheckWeight<T: System + Send + Sync>(PhantomData<T>);
+pub struct CheckWeight<T: System + Send + Sync>(pub PhantomData<T>);
 
 impl<T> SignedExtension for CheckWeight<T>
 where
@@ -174,7 +170,6 @@ where
     type Call = ();
     type AdditionalSigned = ();
     type Pre = ();
-    type DispatchInfo = ();
     fn additional_signed(
         &self,
     ) -> Result<Self::AdditionalSigned, TransactionValidityError> {
@@ -185,7 +180,7 @@ where
 /// Require the transactor pay for themselves and maybe include a tip to gain additional priority
 /// in the queue.
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
-pub struct ChargeTransactionPayment<T: Balances>(#[codec(compact)] T::Balance);
+pub struct ChargeTransactionPayment<T: Balances>(#[codec(compact)] pub T::Balance);
 
 impl<T> SignedExtension for ChargeTransactionPayment<T>
 where
@@ -196,7 +191,6 @@ where
     type Call = ();
     type AdditionalSigned = ();
     type Pre = ();
-    type DispatchInfo = ();
     fn additional_signed(
         &self,
     ) -> Result<Self::AdditionalSigned, TransactionValidityError> {
@@ -206,7 +200,7 @@ where
 
 /// Checks if a transaction would exhausts the block gas limit.
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
-pub struct CheckBlockGasLimit<T: System + Send + Sync>(PhantomData<T>);
+pub struct CheckBlockGasLimit<T: System + Send + Sync>(pub PhantomData<T>);
 
 impl<T> SignedExtension for CheckBlockGasLimit<T>
 where
@@ -217,7 +211,6 @@ where
     type Call = ();
     type AdditionalSigned = ();
     type Pre = ();
-    type DispatchInfo = ();
     fn additional_signed(
         &self,
     ) -> Result<Self::AdditionalSigned, TransactionValidityError> {
@@ -225,12 +218,19 @@ where
     }
 }
 
-pub trait SignedExtra<T> {
+/// Trait for implementing transaction extras for a runtime.
+pub trait SignedExtra<T: System> {
+    /// The type the extras.
     type Extra: SignedExtension;
 
+    /// Creates a new `SignedExtra`.
+    fn new(version: u32, nonce: T::Index, genesis_hash: T::Hash) -> Self;
+
+    /// Returns the transaction extra.
     fn extra(&self) -> Self::Extra;
 }
 
+/// Default `SignedExtra` for substrate runtimes.
 #[derive(Encode, Decode, Clone, Eq, PartialEq, Debug)]
 pub struct DefaultExtra<T: System> {
     version: u32,
@@ -238,16 +238,6 @@ pub struct DefaultExtra<T: System> {
     genesis_hash: T::Hash,
 }
 
-impl<T: System + Balances + Send + Sync> DefaultExtra<T> {
-    pub fn new(version: u32, nonce: T::Index, genesis_hash: T::Hash) -> Self {
-        DefaultExtra {
-            version,
-            nonce,
-            genesis_hash,
-        }
-    }
-}
-
 impl<T: System + Balances + Send + Sync> SignedExtra<T> for DefaultExtra<T> {
     type Extra = (
         CheckVersion<T>,
@@ -259,6 +249,14 @@ impl<T: System + Balances + Send + Sync> SignedExtra<T> for DefaultExtra<T> {
         CheckBlockGasLimit<T>,
     );
 
+    fn new(version: u32, nonce: T::Index, genesis_hash: T::Hash) -> Self {
+        DefaultExtra {
+            version,
+            nonce,
+            genesis_hash,
+        }
+    }
+
     fn extra(&self) -> Self::Extra {
         (
             CheckVersion(PhantomData, self.version),
@@ -279,7 +277,6 @@ impl<T: System + Balances + Send + Sync> SignedExtension for DefaultExtra<T> {
     type AdditionalSigned =
         <<Self as SignedExtra<T>>::Extra as SignedExtension>::AdditionalSigned;
     type Pre = ();
-    type DispatchInfo = ();
 
     fn additional_signed(
         &self,
@@ -288,7 +285,7 @@ impl<T: System + Balances + Send + Sync> SignedExtension for DefaultExtra<T> {
     }
 }
 
-pub fn create_and_sign<T: System + Send + Sync, C, P, S, E>(
+pub(crate) fn create_and_sign<T: System + Send + Sync, C, P, S, E>(
     signer: P,
     call: C,
     extra: E,

src/frame/system.rs

@@ -40,6 +40,7 @@ use sp_runtime::{
         MaybeSerialize,
         MaybeSerializeDeserialize,
         Member,
+        SignedExtension,
         SimpleBitOps,
     },
     RuntimeDebug,
@@ -51,6 +52,7 @@ use std::{
 
 use crate::{
     error::Error,
+    extrinsic::SignedExtra,
     frame::{
         balances::Balances,
         Call,
@@ -157,8 +159,10 @@ pub trait SystemStore {
     ) -> Pin<Box<dyn Future<Output = Result<AccountInfo<Self::System>, Error>> + Send>>;
 }
 
-impl<T: System + Balances + Sync + Send + 'static, S: 'static> SystemStore
-    for Client<T, S>
+impl<T: System + Balances + Sync + Send + 'static, S: 'static, E> SystemStore
+    for Client<T, S, E>
+where
+    E: SignedExtra<T> + SignedExtension + 'static,
 {
     type System = T;
 

src/lib.rs

@@ -65,6 +65,7 @@ use sp_runtime::{
     },
     traits::{
         IdentifyAccount,
+        SignedExtension,
         Verify,
     },
     MultiSignature,
@@ -82,6 +83,7 @@ mod runtimes;
 pub use self::{
     error::Error,
     events::RawEvent,
+    extrinsic::*,
     frame::*,
     rpc::ExtrinsicSuccess,
     runtimes::*,
@@ -91,10 +93,6 @@ use self::{
         EventsDecoder,
         EventsError,
     },
-    extrinsic::{
-        DefaultExtra,
-        SignedExtra,
-    },
     frame::{
         balances::Balances,
         system::{
@@ -114,12 +112,12 @@ use self::{
 
 /// ClientBuilder for constructing a Client.
 #[derive(Default)]
-pub struct ClientBuilder<T: System, S = MultiSignature> {
-    _marker: std::marker::PhantomData<(T, S)>,
+pub struct ClientBuilder<T: System, S = MultiSignature, E = DefaultExtra<T>> {
+    _marker: std::marker::PhantomData<(T, S, E)>,
     url: Option<String>,
 }
 
-impl<T: System, S> ClientBuilder<T, S> {
+impl<T: System, S, E> ClientBuilder<T, S, E> {
     /// Creates a new ClientBuilder.
     pub fn new() -> Self {
         Self {
@@ -135,7 +133,7 @@ impl<T: System, S> ClientBuilder<T, S> {
     }
 
     /// Creates a new Client.
-    pub async fn build(self) -> Result<Client<T, S>, Error> {
+    pub async fn build(self) -> Result<Client<T, S, E>, Error> {
         let url = self.url.unwrap_or("ws://127.0.0.1:9944".to_string());
         let rpc = Rpc::connect_ws(&url).await?;
 
@@ -156,15 +154,15 @@ impl<T: System, S> ClientBuilder<T, S> {
 }
 
 /// Client to interface with a substrate node.
-pub struct Client<T: System, S = MultiSignature> {
+pub struct Client<T: System, S = MultiSignature, E = DefaultExtra<T>> {
     rpc: Rpc<T>,
     genesis_hash: T::Hash,
     metadata: Metadata,
     runtime_version: RuntimeVersion,
-    _marker: PhantomData<fn() -> S>,
+    _marker: PhantomData<(fn() -> S, E)>,
 }
 
-impl<T: System, S> Clone for Client<T, S> {
+impl<T: System, S, E> Clone for Client<T, S, E> {
     fn clone(&self) -> Self {
         Self {
             rpc: self.rpc.clone(),
@@ -176,7 +174,10 @@ impl<T: System, S> Clone for Client<T, S> {
     }
 }
 
-impl<T: System + Balances + Sync + Send + 'static, S: 'static> Client<T, S> {
+impl<T: System + Balances + Sync + Send + 'static, S: 'static, E> Client<T, S, E>
+where
+    E: SignedExtra<T> + SignedExtension + 'static,
+{
     /// Returns the chain metadata.
     pub fn metadata(&self) -> &Metadata {
         &self.metadata
@@ -256,18 +257,18 @@ impl<T: System + Balances + Sync + Send + 'static, S: 'static> Client<T, S> {
     }
 
     /// Create and submit an extrinsic and return corresponding Hash if successful
-    pub async fn submit_extrinsic<E: Encode>(
+    pub async fn submit_extrinsic<X: Encode>(
         &self,
-        extrinsic: E,
+        extrinsic: X,
     ) -> Result<T::Hash, Error> {
         let xt_hash = self.rpc.submit_extrinsic(extrinsic).await?;
         Ok(xt_hash)
     }
 
     /// Create and submit an extrinsic and return corresponding Event if successful
-    pub async fn submit_and_watch_extrinsic<E: Encode + 'static>(
+    pub async fn submit_and_watch_extrinsic<X: Encode + 'static>(
         self,
-        extrinsic: E,
+        extrinsic: X,
         decoder: EventsDecoder<T>,
     ) -> Result<ExtrinsicSuccess<T>, Error> {
         let success = self
@@ -304,10 +305,7 @@ impl<T: System + Balances + Sync + Send + 'static, S: 'static> Client<T, S> {
         &self,
         account_id: <T as System>::AccountId,
         call: Call<C>,
-    ) -> Result<
-        Vec<u8>,
-        Error,
-    >
+    ) -> Result<Vec<u8>, Error>
     where
         C: codec::Encode,
     {
@@ -318,7 +316,7 @@ impl<T: System + Balances + Sync + Send + 'static, S: 'static> Client<T, S> {
             .metadata()
             .module_with_calls(&call.module)
             .and_then(|module| module.call(&call.function, call.args))?;
-        let extra: extrinsic::DefaultExtra<T> = extrinsic::DefaultExtra::new(version, account_nonce, genesis_hash);
+        let extra: E = E::new(version, account_nonce, genesis_hash);
         let raw_payload = SignedPayload::new(call, extra.extra())?;
         Ok(raw_payload.encode())
     }
@@ -328,7 +326,7 @@ impl<T: System + Balances + Sync + Send + 'static, S: 'static> Client<T, S> {
         &self,
         signer: P,
         nonce: Option<T::Index>,
-    ) -> Result<XtBuilder<T, P, S>, Error>
+    ) -> Result<XtBuilder<T, P, S, E>, Error>
     where
         P: Pair,
         P::Signature: Codec,
@@ -355,17 +353,18 @@ impl<T: System + Balances + Sync + Send + 'static, S: 'static> Client<T, S> {
 
 /// Transaction builder.
 #[derive(Clone)]
-pub struct XtBuilder<T: System, P, S> {
-    client: Client<T, S>,
+pub struct XtBuilder<T: System, P, S, E> {
+    client: Client<T, S, E>,
     nonce: T::Index,
     runtime_version: RuntimeVersion,
     genesis_hash: T::Hash,
     signer: P,
 }
 
-impl<T: System + Balances + Send + Sync + 'static, P, S: 'static> XtBuilder<T, P, S>
+impl<T: System + Balances + Send + Sync + 'static, P, S: 'static, E> XtBuilder<T, P, S, E>
 where
     P: Pair,
+    E: SignedExtra<T> + SignedExtension + 'static,
 {
     /// Returns the chain metadata.
     pub fn metadata(&self) -> &Metadata {
@@ -378,36 +377,32 @@ where
     }
 
     /// Sets the nonce to a new value.
-    pub fn set_nonce(&mut self, nonce: T::Index) -> &mut XtBuilder<T, P, S> {
+    pub fn set_nonce(&mut self, nonce: T::Index) -> &mut XtBuilder<T, P, S, E> {
         self.nonce = nonce;
         self
     }
 
     /// Increment the nonce
-    pub fn increment_nonce(&mut self) -> &mut XtBuilder<T, P, S> {
+    pub fn increment_nonce(&mut self) -> &mut XtBuilder<T, P, S, E> {
         self.set_nonce(self.nonce() + 1.into());
         self
     }
 }
 
-impl<T: System + Balances + Send + Sync + 'static, P, S: 'static> XtBuilder<T, P, S>
+impl<T: System + Balances + Send + Sync + 'static, P, S: 'static, E> XtBuilder<T, P, S, E>
 where
     P: Pair,
     S: Verify + Codec + From<P::Signature>,
     S::Signer: From<P::Public> + IdentifyAccount<AccountId = T::AccountId>,
     T::Address: From<T::AccountId>,
+    E: SignedExtra<T> + SignedExtension + 'static,
 {
     /// Creates and signs an Extrinsic for the supplied `Call`
     pub fn create_and_sign<C>(
         &self,
         call: Call<C>,
     ) -> Result<
-        UncheckedExtrinsic<
-            T::Address,
-            Encoded,
-            S,
-            <DefaultExtra<T> as SignedExtra<T>>::Extra,
-        >,
+        UncheckedExtrinsic<T::Address, Encoded, S, <E as SignedExtra<T>>::Extra>,
         Error,
     >
     where
@@ -428,7 +423,7 @@ where
             account_nonce
         );
 
-        let extra = extrinsic::DefaultExtra::new(version, account_nonce, genesis_hash);
+        let extra = E::new(version, account_nonce, genesis_hash);
         let xt = extrinsic::create_and_sign::<_, _, _, S, _>(signer, call, extra)?;
         Ok(xt)
     }
@@ -441,7 +436,7 @@ where
     }
 
     /// Submits transaction to the chain and watch for events.
-    pub fn watch(self) -> EventsSubscriber<T, P, S> {
+    pub fn watch(self) -> EventsSubscriber<T, P, S, E> {
         let metadata = self.client.metadata().clone();
         let decoder = EventsDecoder::try_from(metadata).map_err(Into::into);
         EventsSubscriber {
@@ -453,19 +448,20 @@ where
 }
 
 /// Submits an extrinsic and subscribes to the triggered events
-pub struct EventsSubscriber<T: System, P, S> {
-    client: Client<T, S>,
-    builder: XtBuilder<T, P, S>,
+pub struct EventsSubscriber<T: System, P, S, E> {
+    client: Client<T, S, E>,
+    builder: XtBuilder<T, P, S, E>,
     decoder: Result<EventsDecoder<T>, EventsError>,
 }
 
-impl<T: System + Balances + Send + Sync + 'static, P, S: 'static>
-    EventsSubscriber<T, P, S>
+impl<T: System + Balances + Send + Sync + 'static, P, S: 'static, E>
+    EventsSubscriber<T, P, S, E>
 where
     P: Pair,
     S: Verify + Codec + From<P::Signature>,
     S::Signer: From<P::Public> + IdentifyAccount<AccountId = T::AccountId>,
     T::Address: From<T::AccountId>,
+    E: SignedExtra<T> + SignedExtension + 'static,
 {
     /// Access the events decoder for registering custom type sizes
     pub fn events_decoder<
@@ -511,7 +507,10 @@ impl codec::Encode for Encoded {
 
 #[cfg(test)]
 mod tests {
-    use sp_keyring::{ AccountKeyring, Ed25519Keyring };
+    use sp_keyring::{
+        AccountKeyring,
+        Ed25519Keyring,
+    };
 
     use super::*;
     use crate::{
@@ -616,7 +615,6 @@ mod tests {
     #[test]
     #[ignore] // requires locally running substrate node
     fn test_create_raw_payload() {
-        
         let result: Result<_, Error> = async_std::task::block_on(async move {
             let signer_pair = Ed25519Keyring::Alice.pair();
             let signer_account_id = Ed25519Keyring::Alice.to_account_id();
@@ -624,20 +622,32 @@ mod tests {
 
             let client = test_client().await;
 
-            // create raw payload with AccoundId and sign it          
-            let raw_payload = client.create_raw_payload(signer_account_id, balances::transfer::<Runtime>(dest.clone().into(), 10_000)).await?;
-            let raw_signature = signer_pair.sign(raw_payload.encode().split_off(2).as_slice());
+            // create raw payload with AccoundId and sign it
+            let raw_payload = client
+                .create_raw_payload(
+                    signer_account_id,
+                    balances::transfer::<Runtime>(dest.clone().into(), 10_000),
+                )
+                .await?;
+            let raw_signature =
+                signer_pair.sign(raw_payload.encode().split_off(2).as_slice());
             let raw_multisig = MultiSignature::from(raw_signature);
 
             // create signature with Xtbuilder
             let xt = client.xt(signer_pair.clone(), None).await?;
-            let xt_multi_sig = xt.create_and_sign(balances::transfer::<Runtime>(dest.clone().into(), 10_000))?.signature.unwrap().1;
+            let xt_multi_sig = xt
+                .create_and_sign(balances::transfer::<Runtime>(
+                    dest.clone().into(),
+                    10_000,
+                ))?
+                .signature
+                .unwrap()
+                .1;
 
             // compare signatures
             assert_eq!(raw_multisig, xt_multi_sig);
 
             Ok(())
-            
         });
 
         assert!(result.is_ok())