feat: waitForConfirmation

Author: bigearsenal

Sources/SolanaSwift/APIClient/APIClient+Extension.swift

@@ -183,4 +183,28 @@ extension SolanaAPIClient {
         }
         return knownWallets + wallets
     }
+    
+    /// Wait until transaction is confirmed, return even when there is one or more confirmations and request timed out
+    /// - Parameters:
+    ///   - signature: signature of the transaction
+    ///   - ignoreStatus: ignore status and return true even when observation is timed out
+    public func waitForConfirmation(signature: String, ignoreStatus: Bool, timeout: Int = 60, delay: Int = 2) async throws {
+        var statuses = [TransactionStatus]()
+        for try await status in observeSignatureStatus(signature: signature, timeout: timeout, delay: delay) {
+            statuses.append(status)
+        }
+        
+        // if the status is important
+        if !ignoreStatus {
+            guard let lastStatus = statuses.last else {
+                throw SolanaError.transactionHasNotBeenConfirmed
+            }
+            switch lastStatus {
+            case .confirmed, .finalized:
+                return
+            default:
+                throw SolanaError.transactionHasNotBeenConfirmed
+            }
+        }
+    }
 }

Sources/SolanaSwift/Models/SolanaError.swift

@@ -40,6 +40,9 @@ public enum SolanaError: Swift.Error, Equatable {
     // Socket error
     case socket(Swift.Error)
 
+    // Transaction has not been confirmed
+    case transactionHasNotBeenConfirmed
+    
     // Other
     case other(String)
     case unknown

Tests/SolanaSwiftUnitTests/APIClient/ObserveTransactionStatusTests.swift

@@ -15,19 +15,7 @@ class ObserveTransactionStatusTests: XCTestCase {
     var statuses: [TransactionStatus]!
 
     override func setUpWithError() throws {
-        let mock = NetworkManagerMock([
-            .success(mockResponse(confirmations: 0, confirmationStatus: "processed")),
-            .failure(CustomError.unknownNetworkError),
-            .success(mockResponse(confirmations: 1, confirmationStatus: "confirmed")),
-            .failure(CustomError.unknownNetworkError),
-            .failure(SolanaError.unknown),
-            .success(mockResponse(confirmations: 5, confirmationStatus: "confirmed")),
-            .success(mockResponse(confirmations: 10, confirmationStatus: "confirmed")),
-            .failure(SolanaError.unknown),
-            .success(mockResponse(confirmations: nil, confirmationStatus: "finalized")),
-        ])
-        apiClient = JSONRPCAPIClient(endpoint: endpoint, networkManager: mock)
-        statuses = []
+        resetAPIClient()
     }
 
     override func tearDownWithError() throws {
@@ -60,6 +48,74 @@ class ObserveTransactionStatusTests: XCTestCase {
         XCTAssertEqual(statuses.last, .finalized)
     }
 
+    func testWaitForConfirmationIgnoreStatus() async throws {
+        // return anyway after time out, even when transaction is not surely confimed
+        let response: [Result<String, Error>] = [
+            .failure(CustomError.unknownNetworkError),
+            .failure(CustomError.unknownNetworkError),
+            .failure(SolanaError.unknown),
+            .success(mockResponse(confirmations: 5, confirmationStatus: "confirmed")),
+            .success(mockResponse(confirmations: 10, confirmationStatus: "confirmed")),
+            .failure(SolanaError.unknown),
+            .success(mockResponse(confirmations: nil, confirmationStatus: "finalized")),
+        ]
+        
+        resetAPIClient(customResponse: response)
+        try await apiClient.waitForConfirmation(signature: "adfijidjfaisdf", ignoreStatus: true, timeout: 1, delay: 1)
+        
+        resetAPIClient(customResponse: response)
+        try await apiClient.waitForConfirmation(signature: "adfijidjfaisdf", ignoreStatus: true)
+    }
+    
+    func testWaitForConfirmationNotIgnoreStatus() async throws {
+        // return only if transaction is confirmed or partially confirmed
+        let response: [Result<String, Error>] = [
+            .failure(CustomError.unknownNetworkError),
+            .failure(CustomError.unknownNetworkError),
+            .failure(SolanaError.unknown),
+            .success(mockResponse(confirmations: 5, confirmationStatus: "confirmed")),
+            .success(mockResponse(confirmations: 10, confirmationStatus: "confirmed")),
+            .failure(SolanaError.unknown),
+            .success(mockResponse(confirmations: nil, confirmationStatus: "finalized")),
+        ]
+        
+        resetAPIClient(customResponse: response)
+        do {
+            try await apiClient.waitForConfirmation(signature: "adfijidjfaisdf", ignoreStatus: true, timeout: 1, delay: 1)
+        } catch {
+            XCTAssertTrue(error.isEqualTo(.transactionHasNotBeenConfirmed))
+        }
+        
+        resetAPIClient(customResponse: response)
+        do {
+            try await apiClient.waitForConfirmation(signature: "adfijidjfaisdf", ignoreStatus: true, timeout: 3, delay: 1)
+        } catch {
+            XCTAssertTrue(error.isEqualTo(.transactionHasNotBeenConfirmed))
+        }
+        
+        resetAPIClient(customResponse: response)
+        try await apiClient.waitForConfirmation(signature: "adfijidjfaisdf", ignoreStatus: true, timeout: 7, delay: 1)
+        
+        resetAPIClient(customResponse: response)
+        try await apiClient.waitForConfirmation(signature: "adfijidjfaisdf", ignoreStatus: true, delay: 1)
+    }
+    
+    private func resetAPIClient(customResponse: [Result<String, Error>]? = nil) {
+        let mock = NetworkManagerMock(customResponse ?? [
+            .success(mockResponse(confirmations: 0, confirmationStatus: "processed")),
+            .failure(CustomError.unknownNetworkError),
+            .success(mockResponse(confirmations: 1, confirmationStatus: "confirmed")),
+            .failure(CustomError.unknownNetworkError),
+            .failure(SolanaError.unknown),
+            .success(mockResponse(confirmations: 5, confirmationStatus: "confirmed")),
+            .success(mockResponse(confirmations: 10, confirmationStatus: "confirmed")),
+            .failure(SolanaError.unknown),
+            .success(mockResponse(confirmations: nil, confirmationStatus: "finalized")),
+        ])
+        apiClient = JSONRPCAPIClient(endpoint: endpoint, networkManager: mock)
+        statuses = []
+    }
+    
     // MARK: - Helpers
 
     func mockResponse(confirmations: Int?, confirmationStatus: String) -> String {