Fix unstable-light-client + ChainHeadBackend tx events (#1865)

* Fix unstable-light-client + ChainHeadBackend tx events * Add note that Broadcasted event should no longer be returned at all * fmt
paritytech · Nov 13, 2024 · 057c847 · 057c847
1 parent f861adf
commit 057c847
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 25 deletions.
diff --git a/subxt/src/backend/chain_head/mod.rs b/subxt/src/backend/chain_head/mod.rs
@@ -682,9 +682,7 @@ impl<T: Config + Send + Sync + 'static> Backend<T> for ChainHeadBackend<T> {
                     rpc_methods::TransactionStatus::BestChainBlockIncluded { block: None } => {
                         TransactionStatus::NoLongerInBestBlock
                     }
-                    rpc_methods::TransactionStatus::Broadcasted { num_peers } => {
-                        TransactionStatus::Broadcasted { num_peers }
-                    }
+                    rpc_methods::TransactionStatus::Broadcasted => TransactionStatus::Broadcasted,
                     rpc_methods::TransactionStatus::Dropped { error, .. } => {
                         TransactionStatus::Dropped { message: error }
                     }

diff --git a/subxt/src/backend/chain_head/rpc_methods.rs b/subxt/src/backend/chain_head/rpc_methods.rs
@@ -709,10 +709,11 @@ pub enum TransactionStatus<Hash> {
     /// Transaction is part of the future queue.
     Validated,
     /// The transaction has been broadcast to other nodes.
-    Broadcasted {
-        /// Number of peers it's been broadcast to.
-        num_peers: u32,
-    },
+    ///
+    /// Note: This event is no longer expected to be returned as of
+    /// the chainHead_v1 spec, but we do so for compatibility with
+    /// older versions of Smoldot, which do return it.
+    Broadcasted,
     /// Transaction has been included in block with given details.
     /// Null is returned if the transaction is no longer in any block
     /// of the best chain.
@@ -737,8 +738,6 @@ pub enum TransactionStatus<Hash> {
     },
     /// The transaction was dropped.
     Dropped {
-        /// Was the transaction broadcasted to other nodes before being dropped?
-        broadcasted: bool,
         /// Human readable message; why was it dropped.
         error: String,
     },

diff --git a/subxt/src/backend/legacy/mod.rs b/subxt/src/backend/legacy/mod.rs
@@ -354,10 +354,8 @@ impl<T: Config + Send + Sync + 'static> Backend<T> for LegacyBackend<T> {
                         RpcTransactionStatus::Retracted(_) => None,
                         // These roughly map across:
                         RpcTransactionStatus::Ready => Some(TransactionStatus::Validated),
-                        RpcTransactionStatus::Broadcast(peers) => {
-                            Some(TransactionStatus::Broadcasted {
-                                num_peers: peers.len() as u32,
-                            })
+                        RpcTransactionStatus::Broadcast(_peers) => {
+                            Some(TransactionStatus::Broadcasted)
                         }
                         RpcTransactionStatus::InBlock(hash) => {
                             Some(TransactionStatus::InBestBlock {

diff --git a/subxt/src/backend/mod.rs b/subxt/src/backend/mod.rs
@@ -290,10 +290,7 @@ pub enum TransactionStatus<Hash> {
     /// Transaction is part of the future queue.
     Validated,
     /// The transaction has been broadcast to other nodes.
-    Broadcasted {
-        /// Number of peers it's been broadcast to.
-        num_peers: u32,
-    },
+    Broadcasted,
     /// Transaction is no longer in a best block.
     NoLongerInBestBlock,
     /// Transaction has been included in block with given hash.

diff --git a/subxt/src/tx/tx_progress.rs b/subxt/src/tx/tx_progress.rs
@@ -135,7 +135,7 @@ impl<T: Config, C: Clone> Stream for TxProgress<T, C> {
         sub.poll_next_unpin(cx).map_ok(|status| {
             match status {
                 BackendTxStatus::Validated => TxStatus::Validated,
-                BackendTxStatus::Broadcasted { num_peers } => TxStatus::Broadcasted { num_peers },
+                BackendTxStatus::Broadcasted => TxStatus::Broadcasted,
                 BackendTxStatus::NoLongerInBestBlock => TxStatus::NoLongerInBestBlock,
                 BackendTxStatus::InBestBlock { hash } => {
                     TxStatus::InBestBlock(TxInBlock::new(hash, self.ext_hash, self.client.clone()))
@@ -172,10 +172,7 @@ pub enum TxStatus<T: Config, C> {
     /// Transaction is part of the future queue.
     Validated,
     /// The transaction has been broadcast to other nodes.
-    Broadcasted {
-        /// Number of peers it's been broadcast to.
-        num_peers: u32,
-    },
+    Broadcasted,
     /// Transaction is no longer in a best block.
     NoLongerInBestBlock,
     /// Transaction has been included in block with given hash.
@@ -363,7 +360,7 @@ mod test {
     #[tokio::test]
     async fn wait_for_finalized_returns_err_when_error() {
         let tx_progress = mock_tx_progress(vec![
-            MockSubstrateTxStatus::Broadcasted { num_peers: 2 },
+            MockSubstrateTxStatus::Broadcasted,
             MockSubstrateTxStatus::Error {
                 message: "err".into(),
             },
@@ -378,7 +375,7 @@ mod test {
     #[tokio::test]
     async fn wait_for_finalized_returns_err_when_invalid() {
         let tx_progress = mock_tx_progress(vec![
-            MockSubstrateTxStatus::Broadcasted { num_peers: 2 },
+            MockSubstrateTxStatus::Broadcasted,
             MockSubstrateTxStatus::Invalid {
                 message: "err".into(),
             },
@@ -393,7 +390,7 @@ mod test {
     #[tokio::test]
     async fn wait_for_finalized_returns_err_when_dropped() {
         let tx_progress = mock_tx_progress(vec![
-            MockSubstrateTxStatus::Broadcasted { num_peers: 2 },
+            MockSubstrateTxStatus::Broadcasted,
             MockSubstrateTxStatus::Dropped {
                 message: "err".into(),
             },