fix(send): propagate async broadcast failures

Author: reez

BDKSwiftExampleWallet/Service/BDK Service/BDKService.swift

@@ -571,9 +571,9 @@ final class BDKService {
 
         var sweptTxids: [Txid] = []
         var lastWIFOperationError: Error?
-        
+
         var destinationScript: Script?
-        
+
         for descriptorString in candidates {
             guard
                 let descriptor = try? Descriptor(
@@ -855,7 +855,7 @@ struct BDKClient {
     let syncWithInspector: (SyncScriptInspector) async throws -> Void
     let fullScanWithInspector: (FullScanScriptInspector) async throws -> Void
     let getAddress: () throws -> String
-    let send: (String, UInt64, UInt64) throws -> Void
+    let send: (String, UInt64, UInt64) async throws -> Void
     let sweepWif: (String, UInt64) async throws -> [Txid]
     let calculateFee: (Transaction) throws -> Amount
     let calculateFeeRate: (Transaction) throws -> UInt64
@@ -897,9 +897,7 @@ extension BDKClient {
         },
         getAddress: { try BDKService.shared.getAddress() },
         send: { (address, amount, feeRate) in
-            Task {
-                try await BDKService.shared.send(address: address, amount: amount, feeRate: feeRate)
-            }
+            try await BDKService.shared.send(address: address, amount: amount, feeRate: feeRate)
         },
         sweepWif: { (wif, feeRate) in
             try await BDKService.shared.sweepWif(wif: wif, feeRate: feeRate)

BDKSwiftExampleWallet/View Model/Send/BuildTransactionViewModel.swift

@@ -68,9 +68,9 @@ class BuildTransactionViewModel {
         }
     }
 
-    func send(address: String, amount: UInt64, feeRate: UInt64) {
+    func send(address: String, amount: UInt64, feeRate: UInt64) async {
         do {
-            try bdkClient.send(address, amount, feeRate)
+            try await bdkClient.send(address, amount, feeRate)
             NotificationCenter.default.post(
                 name: .transactionSent,
                 object: nil

BDKSwiftExampleWallet/View/Send/BuildTransactionView.swift

@@ -120,22 +120,26 @@ struct BuildTransactionView: View {
                             if let amt = UInt64(amount) {
                                 viewModel.buildTransactionViewError = nil
                                 isError = false
-                                viewModel.send(
-                                    address: address,
-                                    amount: amt,
-                                    feeRate: UInt64(fee)
-                                )
-                                DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
-                                    if self.viewModel.buildTransactionViewError == nil {
-                                        self.isSent = true
-                                        DispatchQueue.main.asyncAfter(deadline: .now() + 1.5) {
-                                            self.navigationPath.removeLast(
-                                                self.navigationPath.count
-                                            )
+                                Task { @MainActor in
+                                    await viewModel.send(
+                                        address: address,
+                                        amount: amt,
+                                        feeRate: UInt64(fee)
+                                    )
+                                    DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
+                                        if self.viewModel.buildTransactionViewError == nil {
+                                            self.isSent = true
+                                            DispatchQueue.main.asyncAfter(
+                                                deadline: .now() + 1.5
+                                            ) {
+                                                self.navigationPath.removeLast(
+                                                    self.navigationPath.count
+                                                )
+                                            }
+                                        } else {
+                                            self.isSent = false
+                                            self.isError = true
                                         }
-                                    } else {
-                                        self.isSent = false
-                                        self.isError = true
                                     }
                                 }
                             } else {

BDKSwiftExampleWalletTests/View Model/BDKSwiftExampleWalletSendViewModelTests.swift

@@ -5,11 +5,51 @@
 //  Created by Matthew Ramsden on 8/24/23.
 //
 
+import BitcoinDevKit
 import XCTest
 
 @testable import BDKSwiftExampleWallet
 
 final class BDKSwiftExampleWalletSendViewModelTests: XCTestCase {
+    private enum TestSendError: Error {
+        case failed
+    }
+
+    private func makeBDKClient(
+        send: @escaping (String, UInt64, UInt64) async throws -> Void
+    ) -> BDKClient {
+        BDKClient(
+            loadWallet: BDKClient.mock.loadWallet,
+            deleteWallet: BDKClient.mock.deleteWallet,
+            createWalletFromSeed: BDKClient.mock.createWalletFromSeed,
+            createWalletFromDescriptor: BDKClient.mock.createWalletFromDescriptor,
+            createWalletFromXPub: BDKClient.mock.createWalletFromXPub,
+            getBalance: BDKClient.mock.getBalance,
+            transactions: BDKClient.mock.transactions,
+            listUnspent: BDKClient.mock.listUnspent,
+            syncWithInspector: BDKClient.mock.syncWithInspector,
+            fullScanWithInspector: BDKClient.mock.fullScanWithInspector,
+            getAddress: BDKClient.mock.getAddress,
+            send: send,
+            sweepWif: BDKClient.mock.sweepWif,
+            calculateFee: BDKClient.mock.calculateFee,
+            calculateFeeRate: BDKClient.mock.calculateFeeRate,
+            sentAndReceived: BDKClient.mock.sentAndReceived,
+            txDetails: BDKClient.mock.txDetails,
+            buildTransaction: BDKClient.mock.buildTransaction,
+            getBackupInfo: BDKClient.mock.getBackupInfo,
+            needsFullScan: BDKClient.mock.needsFullScan,
+            setNeedsFullScan: BDKClient.mock.setNeedsFullScan,
+            getNetwork: BDKClient.mock.getNetwork,
+            getEsploraURL: BDKClient.mock.getEsploraURL,
+            updateNetwork: BDKClient.mock.updateNetwork,
+            updateEsploraURL: BDKClient.mock.updateEsploraURL,
+            getAddressType: BDKClient.mock.getAddressType,
+            updateAddressType: BDKClient.mock.updateAddressType,
+            getClientType: BDKClient.mock.getClientType,
+            updateClientType: BDKClient.mock.updateClientType
+        )
+    }
 
     @MainActor
     func testAmountViewModel() async {
@@ -52,4 +92,40 @@ final class BDKSwiftExampleWalletSendViewModelTests: XCTestCase {
         )
     }
 
+    @MainActor
+    func testBuildTransactionViewModelSendPostsTransactionSentNotification() async {
+        let viewModel = BuildTransactionViewModel(
+            bdkClient: makeBDKClient(send: { _, _, _ in })
+        )
+        let expectation = XCTNSNotificationExpectation(name: .transactionSent)
+
+        await viewModel.send(
+            address: "tb1pxg0lakl0x4jee73f38m334qsma7mn2yv764x9an5ylht6tx8ccdsxtktrt",
+            amount: 100_000,
+            feeRate: 17
+        )
+
+        await fulfillment(of: [expectation], timeout: 1.0)
+        XCTAssertNil(viewModel.buildTransactionViewError)
+        XCTAssertFalse(viewModel.showingBuildTransactionViewErrorAlert)
+    }
+
+    @MainActor
+    func testBuildTransactionViewModelSendSurfacesAsyncFailure() async {
+        let viewModel = BuildTransactionViewModel(
+            bdkClient: makeBDKClient(send: { _, _, _ in
+                throw TestSendError.failed
+            })
+        )
+
+        await viewModel.send(
+            address: "tb1pxg0lakl0x4jee73f38m334qsma7mn2yv764x9an5ylht6tx8ccdsxtktrt",
+            amount: 100_000,
+            feeRate: 17
+        )
+
+        XCTAssertNotNil(viewModel.buildTransactionViewError)
+        XCTAssertTrue(viewModel.showingBuildTransactionViewErrorAlert)
+    }
+
 }