feat: added option to in onboard to synchronise using kyoto and saving in keychain

Author: r1b2ns

BDKSwiftExampleWallet/Resources/Localizable.xcstrings

@@ -691,6 +691,9 @@
           }
         }
       }
+    },
+    "Kyoto" : {
+
     },
     "Navigation Title" : {
       "extractionState" : "stale",
@@ -1143,6 +1146,9 @@
           }
         }
       }
+    },
+    "Sync type" : {
+
     },
     "Syncing" : {
       "extractionState" : "manual",

BDKSwiftExampleWallet/Service/BDK Service/BDKService.swift

@@ -11,8 +11,15 @@ import Foundation
 private class BDKService {
     static var shared: BDKService = BDKService()
 
-//    private let service: BDKSyncService = KyotoService.live
-    private let service: BDKSyncService = EsploraService.live
+    private var syncMode: SyncMode?
+    private var service: BDKSyncService {
+        switch try? keyClient.getSyncMode() {
+        case .kyoto:
+            return KyotoService.live
+        default:
+            return EsploraService.live
+        }
+    }
     private let keyClient: KeyClient
     private var needsFullScan: Bool = false
     private(set) var network: Network
@@ -46,6 +53,13 @@ private class BDKService {
             try? keyClient.saveEsploraURL(newURL)
         }
     }
+    
+    func updateSyncMode(_ mode: SyncMode) {
+        if syncMode != mode {
+            self.syncMode = mode
+            try? keyClient.saveSyncMode(mode)
+        }
+    }
 
     func getAddress() throws -> String {
         try service.getAddress()
@@ -114,15 +128,15 @@ private class BDKService {
         try await service.startFullScan(progress: progress)
     }
 
-    func calculateFee(tx: Transaction) throws -> Amount {
+    func calculateFee(tx: BitcoinDevKit.Transaction) throws -> Amount {
         try service.calculateFee(tx: tx)
     }
 
-    func calculateFeeRate(tx: Transaction) throws -> UInt64 {
+    func calculateFeeRate(tx: BitcoinDevKit.Transaction) throws -> UInt64 {
         try service.calculateFeeRate(tx: tx)
     }
 
-    func sentAndReceived(tx: Transaction) throws -> SentAndReceivedValues {
+    func sentAndReceived(tx: BitcoinDevKit.Transaction) throws -> SentAndReceivedValues {
         try service.sentAndReceived(tx: tx)
     }
 
@@ -154,9 +168,9 @@ struct BDKClient {
     let fullScanWithFullScanProgress: (@escaping FullScanProgress) async throws -> Void
     let getAddress: () throws -> String
     let send: (String, UInt64, UInt64) throws -> Void
-    let calculateFee: (Transaction) throws -> Amount
-    let calculateFeeRate: (Transaction) throws -> UInt64
-    let sentAndReceived: (Transaction) throws -> SentAndReceivedValues
+    let calculateFee: (BitcoinDevKit.Transaction) throws -> Amount
+    let calculateFeeRate: (BitcoinDevKit.Transaction) throws -> UInt64
+    let sentAndReceived: (BitcoinDevKit.Transaction) throws -> SentAndReceivedValues
     let buildTransaction: (String, UInt64, UInt64) throws -> Psbt
     let getBackupInfo: () throws -> BackupInfo
     let needsFullScan: () -> Bool
@@ -166,6 +180,7 @@ struct BDKClient {
     let updateNetwork: (Network) -> Void
     let updateEsploraURL: (String) -> Void
     let stop: () async throws -> Void
+    let upateSyncMode: (SyncMode) -> Void
 }
 
 extension BDKClient {
@@ -221,6 +236,9 @@ extension BDKClient {
         },
         stop: {
             try await BDKService.shared.stop()
+        },
+        upateSyncMode: { mode in
+            BDKService.shared.updateSyncMode(mode)
         }
     )
 }
@@ -278,7 +296,8 @@ extension BDKClient {
             getEsploraURL: { Constants.Config.EsploraServerURLNetwork.Signet.mutiny },
             updateNetwork: { _ in },
             updateEsploraURL: { _ in },
-            stop: { }
+            stop: { },
+            upateSyncMode: { _ in }
         )
     }
 #endif

BDKSwiftExampleWallet/Service/BDKSyncService/BDKSyncService.swift

@@ -11,6 +11,10 @@ import Foundation
 typealias FullScanProgress = (UInt64) -> Void
 typealias SyncScanProgress = (UInt64, UInt64) -> Void
 
+enum SyncMode: String {
+    case esplora, kyoto
+}
+
 protocol BDKSyncService {
     var connection: Connection? { get }
     var keyClient: KeyClient { get }

BDKSwiftExampleWallet/Service/BDKSyncService/EsploraService.swift

@@ -14,8 +14,6 @@ extension EsploraService {
 
 final class EsploraService: BDKSyncService {
 
-    static let shared = EsploraService()
-    
     var connection: Connection?
     var keyClient: KeyClient
     var network: Network

BDKSwiftExampleWallet/Service/BDKSyncService/KyotoService.swift

@@ -13,11 +13,6 @@ extension KyotoService {
 }
 
 final class KyotoService: BDKSyncService {
-        
-//    private static let nodeHeight: UInt32 = 250_000
-    private static let nodeHeight: UInt32 = 800_000
-    
-    static let shared = KyotoService()
 
     var connection: Connection?
     var keyClient: KeyClient

BDKSwiftExampleWallet/Service/Key Service/KeyService.swift

@@ -68,6 +68,17 @@ private struct KeyService {
         try deleteBackupInfo()
         try deleteEsploraURL()
     }
+    
+    func saveSyncMode(_ mode: SyncMode) throws {
+        keychain[string: "SyncMode"] = mode.rawValue
+    }
+    
+    func getSyncMode() throws -> SyncMode? {
+        guard let mode = keychain[string: "SyncMode"] else {
+            return nil
+        }
+        return SyncMode(rawValue: mode)
+    }
 }
 
 struct KeyClient {
@@ -81,6 +92,8 @@ struct KeyClient {
     let saveBackupInfo: (BackupInfo) throws -> Void
     let saveNetwork: (String) throws -> Void
     let deleteAllData: () throws -> Void
+    let saveSyncMode: (SyncMode) throws -> Void
+    let getSyncMode: () throws -> SyncMode?
 
     private init(
         deleteBackupInfo: @escaping () throws -> Void,
@@ -92,7 +105,9 @@ struct KeyClient {
         saveBackupInfo: @escaping (BackupInfo) throws -> Void,
         saveEsploraURL: @escaping (String) throws -> Void,
         saveNetwork: @escaping (String) throws -> Void,
-        deleteAllData: @escaping () throws -> Void
+        deleteAllData: @escaping () throws -> Void,
+        saveSyncMode: @escaping (SyncMode) throws -> Void,
+        getSyncMode: @escaping () throws -> SyncMode?
     ) {
         self.deleteBackupInfo = deleteBackupInfo
         self.deleteEsplora = deleteEsplora
@@ -104,6 +119,8 @@ struct KeyClient {
         self.saveEsploraURL = saveEsploraURL
         self.saveNetwork = saveNetwork
         self.deleteAllData = deleteAllData
+        self.saveSyncMode = saveSyncMode
+        self.getSyncMode = getSyncMode
     }
 }
 
@@ -118,7 +135,9 @@ extension KeyClient {
         saveBackupInfo: { backupInfo in try KeyService().saveBackupInfo(backupInfo: backupInfo) },
         saveEsploraURL: { url in try KeyService().saveEsploraURL(url: url) },
         saveNetwork: { network in try KeyService().saveNetwork(network: network) },
-        deleteAllData: { try KeyService().deletaAllData() }
+        deleteAllData: { try KeyService().deletaAllData() },
+        saveSyncMode: { mode in try KeyService().saveSyncMode(mode) },
+        getSyncMode: { try KeyService().getSyncMode() }
     )
 }
 
@@ -159,7 +178,9 @@ extension KeyClient {
             saveBackupInfo: { _ in },
             saveEsploraURL: { _ in },
             saveNetwork: { _ in },
-            deleteAllData: { }
+            deleteAllData: { },
+            saveSyncMode: { _ in },
+            getSyncMode: { .esplora }
         )
     }
 #endif

BDKSwiftExampleWallet/View Model/OnboardingViewModel.swift

@@ -16,6 +16,11 @@ class OnboardingViewModel: ObservableObject {
     let bdkClient: BDKClient
 
     @AppStorage("isOnboarding") var isOnboarding: Bool?
+    @Published var syncMode: SyncMode? {
+        didSet {
+            bdkClient.upateSyncMode(syncMode ?? .esplora)
+        }
+    }
     @Published var createWithPersistError: CreateWithPersistError?
     var isDescriptor: Bool {
         words.hasPrefix("tr(") || words.hasPrefix("wpkh(") || words.hasPrefix("wsh(")

BDKSwiftExampleWallet/View/OnboardingView.swift

@@ -122,24 +122,35 @@ struct OnboardingView: View {
                     .opacity(animateContent ? 1 : 0)
                     .animation(.easeOut(duration: 0.5).delay(1.5), value: animateContent)
 
-                    Picker("Esplora Server", selection: $viewModel.selectedURL) {
-                        ForEach(viewModel.availableURLs, id: \.self) { url in
-                            Text(
-                                url.replacingOccurrences(
-                                    of: "https://",
-                                    with: ""
-                                ).replacingOccurrences(
-                                    of: "http://",
-                                    with: ""
-                                )
-                            )
-                            .tag(url)
-                        }
+                    Picker("Sync type", selection: $viewModel.syncMode) {
+                        Text("Esplora Server").tag(SyncMode.esplora)
+                        Text("Kyoto").tag(SyncMode.kyoto)
                     }
                     .pickerStyle(.automatic)
                     .tint(.primary)
                     .opacity(animateContent ? 1 : 0)
                     .animation(.easeOut(duration: 0.5).delay(1.5), value: animateContent)
+                    
+                    if viewModel.syncMode == nil || viewModel.syncMode == .esplora {
+                        Picker("Esplora Server", selection: $viewModel.selectedURL) {
+                            ForEach(viewModel.availableURLs, id: \.self) { url in
+                                Text(
+                                    url.replacingOccurrences(
+                                        of: "https://",
+                                        with: ""
+                                    ).replacingOccurrences(
+                                        of: "http://",
+                                        with: ""
+                                    )
+                                )
+                                .tag(url)
+                            }
+                        }
+                        .pickerStyle(.automatic)
+                        .tint(.primary)
+                        .opacity(animateContent ? 1 : 0)
+                        .animation(.easeOut(duration: 0.5).delay(1.5), value: animateContent)
+                    }
                 }
 
                 if !viewModel.words.isEmpty {