Implement new API for sign_and_submit_then_watch (#354)

* WIP Implementing new event subscription API

* back to lifetimes, fix example

* no more need for accept_weak_inclusion

* thread lifetime through to prevent 'temporary dropped' issue

* make working with events a little nicer

* Get tests compiling

* fmt and clippy

* _name back to name

* dont take ownership, just have stronger note

* Attempt to fix test

* remove commented-out code

* Add a couple more helper methods and a test

* Remove custom ExtrinsicFailed handling; treat them like other events

* Handle runtime errors in TransactionProgress related bits

* cargo fmt + clippy

* Fix some of the failing tests

* remove unused import

* fix transfer_error test

* Fix compile errors against new substrate latest

* Comment tweaks, and force test-runtime rebuild

* Drop the TransactionProgress subscription when we hit 'end' statuses

* cargo fmt

* find_event to find_first_event and helper to return all matching events

* TransactionProgressStatus to TransactionStatus

* Copy and improve docs on TransactionStatus from substrate

* debug impl for Client to avoid manual debug impls elsewhere

* Add and tweak comments, specifically a note about block inclusion on errors

* clippy + fmt

* Fix docs

* Ignore 'error' statuses and adhere to the substrate docs

* tweak and improve some comments per @dvdplm's suggestions

* Break transaction* structs into separate file

* fmt and fix doc link

tests/integration/frame/staking.rs

@@ -21,7 +21,6 @@ use crate::{
             ValidatorPrefs,
         },
         staking,
-        system,
         DefaultConfig,
     },
     test_context,
@@ -55,21 +54,19 @@ fn default_validator_prefs() -> ValidatorPrefs {
 }
 
 #[async_std::test]
-async fn validate_with_controller_account() -> Result<(), Error> {
+async fn validate_with_controller_account() {
     let alice = PairSigner::<DefaultConfig, _>::new(AccountKeyring::Alice.pair());
     let cxt = test_context().await;
-    let result = cxt
-        .api
+    cxt.api
         .tx()
         .staking()
         .validate(default_validator_prefs())
         .sign_and_submit_then_watch(&alice)
-        .await?;
-
-    let success = result.find_event::<system::events::ExtrinsicSuccess>()?;
-    assert!(success.is_some());
-
-    Ok(())
+        .await
+        .unwrap()
+        .wait_for_finalized_success()
+        .await
+        .expect("should be successful");
 }
 
 #[async_std::test]
@@ -82,6 +79,8 @@ async fn validate_not_possible_for_stash_account() -> Result<(), Error> {
         .staking()
         .validate(default_validator_prefs())
         .sign_and_submit_then_watch(&alice_stash)
+        .await?
+        .wait_for_finalized_success()
         .await;
     assert_matches!(announce_validator, Err(Error::Runtime(RuntimeError::Module(module_err))) => {
         assert_eq!(module_err.pallet, "Staking");
@@ -91,23 +90,21 @@ async fn validate_not_possible_for_stash_account() -> Result<(), Error> {
 }
 
 #[async_std::test]
-async fn nominate_with_controller_account() -> Result<(), Error> {
+async fn nominate_with_controller_account() {
     let alice = PairSigner::<DefaultConfig, _>::new(AccountKeyring::Alice.pair());
     let bob = PairSigner::<DefaultConfig, _>::new(AccountKeyring::Bob.pair());
     let cxt = test_context().await;
 
-    let result = cxt
-        .api
+    cxt.api
         .tx()
         .staking()
         .nominate(vec![bob.account_id().clone().into()])
         .sign_and_submit_then_watch(&alice)
-        .await?;
-
-    let success = result.find_event::<system::events::ExtrinsicSuccess>()?;
-    assert!(success.is_some());
-
-    Ok(())
+        .await
+        .unwrap()
+        .wait_for_finalized_success()
+        .await
+        .expect("should be successful");
 }
 
 #[async_std::test]
@@ -123,6 +120,8 @@ async fn nominate_not_possible_for_stash_account() -> Result<(), Error> {
         .staking()
         .nominate(vec![bob.account_id().clone().into()])
         .sign_and_submit_then_watch(&alice_stash)
+        .await?
+        .wait_for_finalized_success()
         .await;
 
     assert_matches!(nomination, Err(Error::Runtime(RuntimeError::Module(module_err))) => {
@@ -147,6 +146,8 @@ async fn chill_works_for_controller_only() -> Result<(), Error> {
         .staking()
         .nominate(vec![bob_stash.account_id().clone().into()])
         .sign_and_submit_then_watch(&alice)
+        .await?
+        .wait_for_finalized_success()
         .await?;
 
     let ledger = cxt
@@ -164,6 +165,8 @@ async fn chill_works_for_controller_only() -> Result<(), Error> {
         .staking()
         .chill()
         .sign_and_submit_then_watch(&alice_stash)
+        .await?
+        .wait_for_finalized_success()
         .await;
 
     assert_matches!(chill, Err(Error::Runtime(RuntimeError::Module(module_err))) => {
@@ -171,15 +174,18 @@ async fn chill_works_for_controller_only() -> Result<(), Error> {
         assert_eq!(module_err.error, "NotController");
     });
 
-    let result = cxt
+    let is_chilled = cxt
         .api
         .tx()
         .staking()
         .chill()
         .sign_and_submit_then_watch(&alice)
-        .await?;
-    let chill = result.find_event::<staking::events::Chilled>()?;
-    assert!(chill.is_some());
+        .await?
+        .wait_for_finalized_success()
+        .await?
+        .has_event::<staking::events::Chilled>()?;
+    assert!(is_chilled);
+
     Ok(())
 }
 
@@ -198,6 +204,8 @@ async fn tx_bond() -> Result<(), Error> {
             RewardDestination::Stash,
         )
         .sign_and_submit_then_watch(&alice)
+        .await?
+        .wait_for_finalized_success()
         .await;
 
     assert!(bond.is_ok());
@@ -212,6 +220,8 @@ async fn tx_bond() -> Result<(), Error> {
             RewardDestination::Stash,
         )
         .sign_and_submit_then_watch(&alice)
+        .await?
+        .wait_for_finalized_success()
         .await;
 
     assert_matches!(bond_again, Err(Error::Runtime(RuntimeError::Module(module_err))) => {