Use the generated DispatchError instead of the hardcoded Substrate one (#394)

* WIP DispatchError generic param

* main crate now compiling with new E generic param for DispatchError

* Remove E param from RpcClient since it doesn't really need it

* Point to generated DispatchError in codegen so no need for additional param there

* More error hunting; cargo check --all-targets passes now

* Use our own RuntimeVersion struct (for now) to avoid error decoding into sp_version::RuntimeVersion

* cargo fmt

* fix docs and expose private documented thing that I think should be pub

* move error info to compile time so that we can make DispatchError a little nicer to work with

* cargo fmt

* clippy

* Rework error handling to remove <E> param in most cases

* fix Error doc ambiguity (hopefully)

* doc tweaks

* docs: remove dismbiguation thing that isn't needed now

* One more Error<E> that can be a BasicError

* rewrite pallet errors thing into normal loops to tidy

* tidy errors codegen a little

* tidy examples/custom_type_derives.rs a little

* cargo fmt

* silcnce clippy in example

tests/integration/frame/balances.rs

@@ -19,6 +19,7 @@ use crate::{
         balances,
         runtime_types,
         system,
+        DispatchError,
     },
     pair_signer,
     test_context,
@@ -33,13 +34,11 @@ use subxt::{
     DefaultConfig,
     Error,
     EventSubscription,
-    PalletError,
-    RuntimeError,
     Signer,
 };
 
 #[async_std::test]
-async fn tx_basic_transfer() -> Result<(), subxt::Error> {
+async fn tx_basic_transfer() -> Result<(), subxt::Error<DispatchError>> {
     let alice = pair_signer(AccountKeyring::Alice.pair());
     let bob = pair_signer(AccountKeyring::Bob.pair());
     let bob_address = bob.account_id().clone().into();
@@ -111,7 +110,7 @@ async fn storage_total_issuance() {
 }
 
 #[async_std::test]
-async fn storage_balance_lock() -> Result<(), subxt::Error> {
+async fn storage_balance_lock() -> Result<(), subxt::Error<DispatchError>> {
     let bob = pair_signer(AccountKeyring::Bob.pair());
     let charlie = AccountKeyring::Charlie.to_account_id();
     let cxt = test_context().await;
@@ -181,13 +180,10 @@ async fn transfer_error() {
         .wait_for_finalized_success()
         .await;
 
-    if let Err(Error::Runtime(RuntimeError::Module(error))) = res {
-        let error2 = PalletError {
-            pallet: "Balances".into(),
-            error: "InsufficientBalance".into(),
-            description: vec!["Balance too low to send value".to_string()],
-        };
-        assert_eq!(error, error2);
+    if let Err(Error::Runtime(err)) = res {
+        let details = err.inner().details().unwrap();
+        assert_eq!(details.pallet, "Balances");
+        assert_eq!(details.error, "InsufficientBalance");
     } else {
         panic!("expected a runtime module error");
     }

tests/integration/frame/contracts.rs

@@ -25,6 +25,7 @@ use crate::{
         },
         system,
         DefaultAccountData,
+        DispatchError,
     },
     test_context,
     NodeRuntimeSignedExtra,
@@ -67,7 +68,9 @@ impl ContractsTestContext {
         self.cxt.api.tx().contracts()
     }
 
-    async fn instantiate_with_code(&self) -> Result<(Hash, AccountId), Error> {
+    async fn instantiate_with_code(
+        &self,
+    ) -> Result<(Hash, AccountId), Error<DispatchError>> {
         log::info!("instantiate_with_code:");
         const CONTRACT: &str = r#"
                 (module
@@ -118,7 +121,7 @@ impl ContractsTestContext {
         code_hash: Hash,
         data: Vec<u8>,
         salt: Vec<u8>,
-    ) -> Result<AccountId, Error> {
+    ) -> Result<AccountId, Error<DispatchError>> {
         // call instantiate extrinsic
         let result = self
             .contracts_tx()
@@ -147,7 +150,8 @@ impl ContractsTestContext {
         &self,
         contract: AccountId,
         input_data: Vec<u8>,
-    ) -> Result<TransactionProgress<'_, DefaultConfig>, Error> {
+    ) -> Result<TransactionProgress<'_, DefaultConfig, DispatchError>, Error<DispatchError>>
+    {
         log::info!("call: {:?}", contract);
         let result = self
             .contracts_tx()

tests/integration/frame/staking.rs

@@ -21,6 +21,7 @@ use crate::{
             ValidatorPrefs,
         },
         staking,
+        DispatchError,
     },
     pair_signer,
     test_context,
@@ -33,7 +34,6 @@ use sp_core::{
 use sp_keyring::AccountKeyring;
 use subxt::{
     Error,
-    RuntimeError,
     Signer,
 };
 
@@ -67,7 +67,7 @@ async fn validate_with_controller_account() {
 }
 
 #[async_std::test]
-async fn validate_not_possible_for_stash_account() -> Result<(), Error> {
+async fn validate_not_possible_for_stash_account() -> Result<(), Error<DispatchError>> {
     let alice_stash = pair_signer(get_from_seed("Alice//stash"));
     let cxt = test_context().await;
     let announce_validator = cxt
@@ -79,9 +79,10 @@ async fn validate_not_possible_for_stash_account() -> Result<(), Error> {
         .await?
         .wait_for_finalized_success()
         .await;
-    assert_matches!(announce_validator, Err(Error::Runtime(RuntimeError::Module(module_err))) => {
-        assert_eq!(module_err.pallet, "Staking");
-        assert_eq!(module_err.error, "NotController");
+    assert_matches!(announce_validator, Err(Error::Runtime(err)) => {
+        let details = err.inner().details().unwrap();
+        assert_eq!(details.pallet, "Staking");
+        assert_eq!(details.error, "NotController");
     });
     Ok(())
 }
@@ -105,7 +106,7 @@ async fn nominate_with_controller_account() {
 }
 
 #[async_std::test]
-async fn nominate_not_possible_for_stash_account() -> Result<(), Error> {
+async fn nominate_not_possible_for_stash_account() -> Result<(), Error<DispatchError>> {
     let alice_stash = pair_signer(get_from_seed("Alice//stash"));
     let bob = pair_signer(AccountKeyring::Bob.pair());
     let cxt = test_context().await;
@@ -120,15 +121,16 @@ async fn nominate_not_possible_for_stash_account() -> Result<(), Error> {
         .wait_for_finalized_success()
         .await;
 
-    assert_matches!(nomination, Err(Error::Runtime(RuntimeError::Module(module_err))) => {
-        assert_eq!(module_err.pallet, "Staking");
-        assert_eq!(module_err.error, "NotController");
+    assert_matches!(nomination, Err(Error::Runtime(err)) => {
+        let details = err.inner().details().unwrap();
+        assert_eq!(details.pallet, "Staking");
+        assert_eq!(details.error, "NotController");
     });
     Ok(())
 }
 
 #[async_std::test]
-async fn chill_works_for_controller_only() -> Result<(), Error> {
+async fn chill_works_for_controller_only() -> Result<(), Error<DispatchError>> {
     let alice_stash = pair_signer(get_from_seed("Alice//stash"));
     let bob_stash = pair_signer(get_from_seed("Bob//stash"));
     let alice = pair_signer(AccountKeyring::Alice.pair());
@@ -163,9 +165,10 @@ async fn chill_works_for_controller_only() -> Result<(), Error> {
         .wait_for_finalized_success()
         .await;
 
-    assert_matches!(chill, Err(Error::Runtime(RuntimeError::Module(module_err))) => {
-        assert_eq!(module_err.pallet, "Staking");
-        assert_eq!(module_err.error, "NotController");
+    assert_matches!(chill, Err(Error::Runtime(err)) => {
+        let details = err.inner().details().unwrap();
+        assert_eq!(details.pallet, "Staking");
+        assert_eq!(details.error, "NotController");
     });
 
     let is_chilled = cxt
@@ -184,7 +187,7 @@ async fn chill_works_for_controller_only() -> Result<(), Error> {
 }
 
 #[async_std::test]
-async fn tx_bond() -> Result<(), Error> {
+async fn tx_bond() -> Result<(), Error<DispatchError>> {
     let alice = pair_signer(AccountKeyring::Alice.pair());
     let cxt = test_context().await;
 
@@ -218,16 +221,16 @@ async fn tx_bond() -> Result<(), Error> {
         .wait_for_finalized_success()
         .await;
 
-    assert_matches!(bond_again, Err(Error::Runtime(RuntimeError::Module(module_err))) => {
-        assert_eq!(module_err.pallet, "Staking");
-        assert_eq!(module_err.error, "AlreadyBonded");
+    assert_matches!(bond_again, Err(Error::Runtime(err)) => {
+        let details = err.inner().details().unwrap();
+        assert_eq!(details.pallet, "Staking");
+        assert_eq!(details.error, "AlreadyBonded");
     });
-
     Ok(())
 }
 
 #[async_std::test]
-async fn storage_history_depth() -> Result<(), Error> {
+async fn storage_history_depth() -> Result<(), Error<DispatchError>> {
     let cxt = test_context().await;
     let history_depth = cxt.api.storage().staking().history_depth(None).await?;
     assert_eq!(history_depth, 84);
@@ -235,7 +238,7 @@ async fn storage_history_depth() -> Result<(), Error> {
 }
 
 #[async_std::test]
-async fn storage_current_era() -> Result<(), Error> {
+async fn storage_current_era() -> Result<(), Error<DispatchError>> {
     let cxt = test_context().await;
     let _current_era = cxt
         .api
@@ -248,7 +251,7 @@ async fn storage_current_era() -> Result<(), Error> {
 }
 
 #[async_std::test]
-async fn storage_era_reward_points() -> Result<(), Error> {
+async fn storage_era_reward_points() -> Result<(), Error<DispatchError>> {
     let cxt = test_context().await;
     let current_era_result = cxt
         .api

tests/integration/frame/sudo.rs

@@ -18,6 +18,7 @@ use crate::{
     node_runtime::{
         runtime_types,
         sudo,
+        DispatchError,
     },
     pair_signer,
     test_context,
@@ -28,7 +29,7 @@ type Call = runtime_types::node_runtime::Call;
 type BalancesCall = runtime_types::pallet_balances::pallet::Call;
 
 #[async_std::test]
-async fn test_sudo() -> Result<(), subxt::Error> {
+async fn test_sudo() -> Result<(), subxt::Error<DispatchError>> {
     let alice = pair_signer(AccountKeyring::Alice.pair());
     let bob = AccountKeyring::Bob.to_account_id().into();
     let cxt = test_context().await;
@@ -54,7 +55,7 @@ async fn test_sudo() -> Result<(), subxt::Error> {
 }
 
 #[async_std::test]
-async fn test_sudo_unchecked_weight() -> Result<(), subxt::Error> {
+async fn test_sudo_unchecked_weight() -> Result<(), subxt::Error<DispatchError>> {
     let alice = pair_signer(AccountKeyring::Alice.pair());
     let bob = AccountKeyring::Bob.to_account_id().into();
     let cxt = test_context().await;

tests/integration/frame/system.rs

@@ -15,7 +15,10 @@
 // along with subxt.  If not, see <http://www.gnu.org/licenses/>.
 
 use crate::{
-    node_runtime::system,
+    node_runtime::{
+        system,
+        DispatchError,
+    },
     pair_signer,
     test_context,
 };
@@ -24,7 +27,7 @@ use sp_keyring::AccountKeyring;
 use subxt::Signer;
 
 #[async_std::test]
-async fn storage_account() -> Result<(), subxt::Error> {
+async fn storage_account() -> Result<(), subxt::Error<DispatchError>> {
     let alice = pair_signer(AccountKeyring::Alice.pair());
 
     let cxt = test_context().await;
@@ -40,7 +43,7 @@ async fn storage_account() -> Result<(), subxt::Error> {
 }
 
 #[async_std::test]
-async fn tx_remark_with_event() -> Result<(), subxt::Error> {
+async fn tx_remark_with_event() -> Result<(), subxt::Error<DispatchError>> {
     let alice = pair_signer(AccountKeyring::Alice.pair());
     let cxt = test_context().await;