react-native-zcash 0.5.0 → 0.6.0

package/ios/ZCashLightClientKit/Error/ZcashErrorCode.swift

@@ -1,4 +1,4 @@
-// Generated using Sourcery 2.0.2 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 2.0.3 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 /*
@@ -9,12 +9,18 @@ error originates. And it can help with debugging.
 */
 
 public enum ZcashErrorCode: String {
-    /// Some error happened that is not handled as `ZcashError`.
+    /// Some error happened that is not handled as `ZcashError`. All errors in the SDK are (should be) `ZcashError`.
     case unknown = "ZUNKWN0001"
     /// Updating of paths in `Initilizer` according to alias failed.
     case initializerCantUpdateURLWithAlias = "ZINIT0001"
     /// Alias used to create this instance of the `SDKSynchronizer` is already used by other instance.
     case initializerAliasAlreadyInUse = "ZINIT0002"
+    /// Object on disk at `generalStorageURL` path exists. But it file not directory.
+    case initializerGeneralStorageExistsButIsFile = "ZINIT0003"
+    /// Can't create directory at `generalStorageURL` path.
+    case initializerGeneralStorageCantCreate = "ZINIT0004"
+    /// Can't set `isExcludedFromBackup` flag to `generalStorageURL`.
+    case initializerCantSetNoBackupFlagToGeneralStorageURL = "ZINIT0005"
     /// Unknown GRPC Service error
     case serviceUnknownError = "ZSRVC0001"
     /// LightWalletService.getInfo failed.
@@ -33,6 +39,8 @@ public enum ZcashErrorCode: String {
     case serviceFetchUTXOsFailed = "ZSRVC0008"
     /// LightWalletService.blockStream failed.
     case serviceBlockStreamFailed = "ZSRVC0000"
+    /// LightWalletService.getSubtreeRoots failed.
+    case serviceSubtreeRootsStreamFailed = "ZSRVC0009"
     /// SimpleConnectionProvider init of Connection failed.
     case simpleConnectionProvider = "ZSCPC0001"
     /// Downloaded file with sapling spending parameters isn't valid.
@@ -51,8 +59,12 @@ public enum ZcashErrorCode: String {
     case blockDAOLatestBlockHeight = "ZBDAO0003"
     /// SQLite query failed when fetching the latest block from the database.
     case blockDAOLatestBlock = "ZBDAO0004"
-    /// Fetched latesxt block information from DB but can't decode them.
+    /// Fetched latest block information from DB but can't decode them.
     case blockDAOLatestBlockCantDecode = "ZBDAO0005"
+    /// SQLite query failed when fetching the first unenhanced block from the database.
+    case blockDAOFirstUnenhancedHeight = "ZBDAO0006"
+    /// Fetched unenhanced block information from DB but can't decode them.
+    case blockDAOFirstUnenhancedCantDecode = "ZBDAO0007"
     /// Error from rust layer when calling ZcashRustBackend.createAccount
     case rustCreateAccount = "ZRUST0001"
     /// Error from rust layer when calling ZcashRustBackend.createToAddress
@@ -113,8 +125,6 @@ public enum ZcashErrorCode: String {
     case rustPutUnspentTransparentOutput = "ZRUST0029"
     /// Error unrelated to chain validity from rust layer when calling ZcashRustBackend.validateCombinedChain
     case rustValidateCombinedChainValidationFailed = "ZRUST0030"
-    /// Error from rust layer which means that combined chain isn't valid.
-    case rustValidateCombinedChainInvalidChain = "ZRUST0031"
     /// Error from rust layer when calling ZcashRustBackend.rewindToHeight
     case rustRewindToHeight = "ZRUST0032"
     /// Error from rust layer when calling ZcashRustBackend.rewindCacheToHeight
@@ -143,6 +153,26 @@ public enum ZcashErrorCode: String {
     case rustGetTransparentReceiverInvalidAddress = "ZRUST0044"
     /// Transparent receiver generated by rust layer is invalid when calling ZcashRustBackend.getTransparentReceiver
     case rustGetTransparentReceiverInvalidReceiver = "ZRUST0045"
+    /// Unable to allocate memory required to write blocks when calling ZcashRustBackend.putSaplingSubtreeRoots
+    case rustPutSaplingSubtreeRootsAllocationProblem = "ZRUST0046"
+    /// Error from rust layer when calling ZcashRustBackend.putSaplingSubtreeRoots
+    case rustPutSaplingSubtreeRoots = "ZRUST0047"
+    /// Error from rust layer when calling ZcashRustBackend.updateChainTip
+    case rustUpdateChainTip = "ZRUST0048"
+    /// Error from rust layer when calling ZcashRustBackend.suggestScanRanges
+    case rustSuggestScanRanges = "ZRUST0049"
+    /// Invalid transaction ID length when calling ZcashRustBackend.getMemo. txId must be 32 bytes.
+    case rustGetMemoInvalidTxIdLength = "ZRUST0050"
+    /// Error from rust layer when calling ZcashRustBackend.getScanProgress
+    case rustGetScanProgress = "ZRUST0051"
+    /// Error from rust layer when calling ZcashRustBackend.fullyScannedHeight
+    case rustFullyScannedHeight = "ZRUST0052"
+    /// Error from rust layer when calling ZcashRustBackend.maxScannedHeight
+    case rustMaxScannedHeight = "ZRUST0053"
+    /// Error from rust layer when calling ZcashRustBackend.latestCachedBlockHeight
+    case rustLatestCachedBlockHeight = "ZRUST0054"
+    /// Rust layer's call ZcashRustBackend.getScanProgress returned values that after computation are outside of allowed range 0-100%.
+    case rustScanProgressOutOfRange = "ZRUST0055"
     /// SQLite query failed when fetching all accounts from the database.
     case accountDAOGetAll = "ZADAO0001"
     /// Fetched accounts from SQLite but can't decode them.
@@ -291,6 +321,14 @@ public enum ZcashErrorCode: String {
     case compactBlockProcessorChainName = "ZCBPEO0016"
     /// Consensus BranchIDs don't match this is probably an API or programming error.
     case compactBlockProcessorConsensusBranchID = "ZCBPEO0017"
+    /// Rewind of DownloadBlockAction failed as no action is possible to unwrapp.
+    case compactBlockProcessorDownloadBlockActionRewind = "ZCBPEO0018"
+    /// Put sapling subtree roots to the DB failed.
+    case compactBlockProcessorPutSaplingSubtreeRoots = "ZCBPEO0019"
+    /// Getting the `lastScannedHeight` failed but it's supposed to always provide some value.
+    case compactBlockProcessorLastScannedHeight = "ZCBPEO0020"
+    /// Getting the `supportedSyncAlgorithm` failed but it's supposed to always provide some value.
+    case compactBlockProcessorSupportedSyncAlgorithm = "ZCBPEO0021"
     /// The synchronizer is unprepared.
     case synchronizerNotPrepared = "ZSYNCO0001"
     /// Memos can't be sent to transparent addresses.

package/ios/ZCashLightClientKit/Error/ZcashErrorCodeDefinition.swift

@@ -38,6 +38,15 @@ enum ZcashErrorDefinition {
     /// Alias used to create this instance of the `SDKSynchronizer` is already used by other instance.
     // sourcery: code="ZINIT0002"
     case initializerAliasAlreadyInUse(_ alias: ZcashSynchronizerAlias)
+    /// Object on disk at `generalStorageURL` path exists. But it file not directory.
+    // sourcery: code="ZINIT0003"
+    case initializerGeneralStorageExistsButIsFile(_ generalStorageURL: URL)
+    /// Can't create directory at `generalStorageURL` path.
+    // sourcery: code="ZINIT0004"
+    case initializerGeneralStorageCantCreate(_ generalStorageURL: URL, _ error: Error)
+    /// Can't set `isExcludedFromBackup` flag to `generalStorageURL`.
+    // sourcery: code="ZINIT0005"
+    case initializerCantSetNoBackupFlagToGeneralStorageURL(_ generalStorageURL: URL, _ error: Error)
 
     // MARK: - LightWalletService
 
@@ -68,6 +77,9 @@ enum ZcashErrorDefinition {
     /// LightWalletService.blockStream failed.
     // sourcery: code="ZSRVC0000"
     case serviceBlockStreamFailed(_ error: LightWalletServiceError)
+    /// LightWalletService.getSubtreeRoots failed.
+    // sourcery: code="ZSRVC0009"
+    case serviceSubtreeRootsStreamFailed(_ error: LightWalletServiceError)
 
     // MARK: SQLite connection
 
@@ -113,10 +125,18 @@ enum ZcashErrorDefinition {
     /// - `sqliteError` is error produced by SQLite library.
     // sourcery: code="ZBDAO0004"
     case blockDAOLatestBlock(_ sqliteError: Error)
-    /// Fetched latesxt block information from DB but can't decode them.
+    /// Fetched latest block information from DB but can't decode them.
     /// - `error` is decoding error.
     // sourcery: code="ZBDAO0005"
     case blockDAOLatestBlockCantDecode(_ error: Error)
+    /// SQLite query failed when fetching the first unenhanced block from the database.
+    /// - `sqliteError` is error produced by SQLite library.
+    // sourcery: code="ZBDAO0006"
+    case blockDAOFirstUnenhancedHeight(_ sqliteError: Error)
+    /// Fetched unenhanced block information from DB but can't decode them.
+    /// - `error` is decoding error.
+    // sourcery: code="ZBDAO0007"
+    case blockDAOFirstUnenhancedCantDecode(_ error: Error)
 
     // MARK: - Rust
 
@@ -234,10 +254,6 @@ enum ZcashErrorDefinition {
     /// - `rustError` contains error generated by the rust layer.
     // sourcery: code="ZRUST0030"
     case rustValidateCombinedChainValidationFailed(_ rustError: String)
-    /// Error from rust layer which means that combined chain isn't valid.
-    /// - `upperBound` is the height of the highest invalid block (on the assumption that the highest block in the cache database is correct).
-    // sourcery: code="ZRUST0031"
-    case rustValidateCombinedChainInvalidChain(_ upperBound: Int32)
     /// Error from rust layer when calling ZcashRustBackend.rewindToHeight
     /// - `rustError` contains error generated by the rust layer.
     // sourcery: code="ZRUST0032"
@@ -290,6 +306,44 @@ enum ZcashErrorDefinition {
     /// Transparent receiver generated by rust layer is invalid when calling ZcashRustBackend.getTransparentReceiver
     // sourcery: code="ZRUST0045"
     case rustGetTransparentReceiverInvalidReceiver
+    /// Unable to allocate memory required to write blocks when calling ZcashRustBackend.putSaplingSubtreeRoots
+    /// sourcery: code="ZRUST0046"
+    case rustPutSaplingSubtreeRootsAllocationProblem
+    /// Error from rust layer when calling ZcashRustBackend.putSaplingSubtreeRoots
+    /// - `rustError` contains error generated by the rust layer.
+    /// sourcery: code="ZRUST0047"
+    case rustPutSaplingSubtreeRoots(_ rustError: String)
+    /// Error from rust layer when calling ZcashRustBackend.updateChainTip
+    /// - `rustError` contains error generated by the rust layer.
+    /// sourcery: code="ZRUST0048"
+    case rustUpdateChainTip(_ rustError: String)
+    /// Error from rust layer when calling ZcashRustBackend.suggestScanRanges
+    /// - `rustError` contains error generated by the rust layer.
+    /// sourcery: code="ZRUST0049"
+    case rustSuggestScanRanges(_ rustError: String)
+    /// Invalid transaction ID length when calling ZcashRustBackend.getMemo. txId must be 32 bytes.
+    // sourcery: code="ZRUST0050"
+    case rustGetMemoInvalidTxIdLength
+    /// Error from rust layer when calling ZcashRustBackend.getScanProgress
+    /// - `rustError` contains error generated by the rust layer.
+    // sourcery: code="ZRUST0051"
+    case rustGetScanProgress(_ rustError: String)
+    /// Error from rust layer when calling ZcashRustBackend.fullyScannedHeight
+    /// - `rustError` contains error generated by the rust layer.
+    // sourcery: code="ZRUST0052"
+    case rustFullyScannedHeight(_ rustError: String)
+    /// Error from rust layer when calling ZcashRustBackend.maxScannedHeight
+    /// - `rustError` contains error generated by the rust layer.
+    // sourcery: code="ZRUST0053"
+    case rustMaxScannedHeight(_ rustError: String)
+    /// Error from rust layer when calling ZcashRustBackend.latestCachedBlockHeight
+    /// - `rustError` contains error generated by the rust layer.
+    // sourcery: code="ZRUST0054"
+    case rustLatestCachedBlockHeight(_ rustError: String)
+    /// Rust layer's call ZcashRustBackend.getScanProgress returned values that after computation are outside of allowed range 0-100%.
+    /// - `progress` value reported
+    // sourcery: code="ZRUST0055"
+    case rustScanProgressOutOfRange(_ progress: String)
 
     // MARK: - Account DAO
 
@@ -572,7 +626,19 @@ enum ZcashErrorDefinition {
     /// Consensus BranchIDs don't match this is probably an API or programming error.
     // sourcery: code="ZCBPEO0017"
     case compactBlockProcessorConsensusBranchID
-    
+    /// Rewind of DownloadBlockAction failed as no action is possible to unwrapp.
+    // sourcery: code="ZCBPEO0018"
+    case compactBlockProcessorDownloadBlockActionRewind
+    /// Put sapling subtree roots to the DB failed.
+    // sourcery: code="ZCBPEO0019"
+    case compactBlockProcessorPutSaplingSubtreeRoots(_ error: Error)
+    /// Getting the `lastScannedHeight` failed but it's supposed to always provide some value.
+    // sourcery: code="ZCBPEO0020"
+    case compactBlockProcessorLastScannedHeight
+    /// Getting the `supportedSyncAlgorithm` failed but it's supposed to always provide some value.
+    // sourcery: code="ZCBPEO0021"
+    case compactBlockProcessorSupportedSyncAlgorithm
+
     // MARK: - SDKSynchronizer
     
     /// The synchronizer is unprepared.

package/ios/ZCashLightClientKit/Extensions/Bool+ToData.swift

@@ -0,0 +1,15 @@
+//
+//  Bool+ToData.swift
+//  
+//
+//  Created by Michal Fousek on 21.05.2023.
+//
+
+import Foundation
+
+extension Bool {
+    func toData() -> Data {
+        var value = self
+        return withUnsafeBytes(of: &value) { Data($0) }
+    }
+}

package/ios/ZCashLightClientKit/Extensions/Data+ToOtherTypes.swift

@@ -0,0 +1,18 @@
+//
+//  Data+ToOtherTypes.swift
+//  
+//
+//  Created by Michal Fousek on 21.05.2023.
+//
+
+import Foundation
+
+extension Data {
+    func toInt() -> Int {
+        return self.withUnsafeBytes { $0.load(as: Int.self) }
+    }
+
+    func toBool() -> Bool {
+        return self.withUnsafeBytes { $0.load(as: Bool.self) }
+    }
+}

package/ios/ZCashLightClientKit/Extensions/Int+ToData.swift

@@ -0,0 +1,15 @@
+//
+//  Int+ToData.swift
+//  
+//
+//  Created by Michal Fousek on 21.05.2023.
+//
+
+import Foundation
+
+extension Int {
+    func toData() -> Data {
+        var value = self
+        return withUnsafeBytes(of: &value) { Data($0) }
+    }
+}

package/ios/ZCashLightClientKit/Initializer.swift

@@ -90,6 +90,7 @@ public class Initializer {
     struct URLs {
         let fsBlockDbRoot: URL
         let dataDbURL: URL
+        let generalStorageURL: URL
         let spendParamsURL: URL
         let outputParamsURL: URL
     }
@@ -112,6 +113,7 @@ public class Initializer {
     let alias: ZcashSynchronizerAlias
     let endpoint: LightWalletEndpoint
     let fsBlockDbRoot: URL
+    let generalStorageURL: URL
     let dataDbURL: URL
     let spendParamsURL: URL
     let outputParamsURL: URL
@@ -142,13 +144,20 @@ public class Initializer {
     ///  - cacheDbURL: previous location of the cacheDb. If you don't know what a cacheDb is and you are adopting this SDK for the first time then
     ///                just pass `nil` here.
     ///  - fsBlockDbRoot: location of the compact blocks cache
+    ///  - generalStorageURL: Location of the directory where the SDK can store any information it needs. A directory doesn't have to exist. But the
+    ///                       SDK must be able to write to this location after it creates this directory. It is suggested that this directory is
+    ///                       a subdirectory of the `Documents` directory. If this information is stored in `Documents` then the system itself won't
+    ///                       remove these data.
     ///  - dataDbURL: Location of the data db
     ///  - endpoint: the endpoint representing the lightwalletd instance you want to point to
     ///  - spendParamsURL: location of the spend parameters
     ///  - outputParamsURL: location of the output parameters
+    ///  - loggingPolicy: the `LoggingPolicy` for the logger
+    ///  - enableBackendTracing: this enables tracing for super detailed debugging. it will slow down everything 10 or 100x.
     convenience public init(
         cacheDbURL: URL?,
         fsBlockDbRoot: URL,
+        generalStorageURL: URL,
         dataDbURL: URL,
         endpoint: LightWalletEndpoint,
         network: ZcashNetwork,
@@ -156,7 +165,8 @@ public class Initializer {
         outputParamsURL: URL,
         saplingParamsSourceURL: SaplingParamsSourceURL,
         alias: ZcashSynchronizerAlias = .default,
-        loggingPolicy: LoggingPolicy = .default(.debug)
+        loggingPolicy: LoggingPolicy = .default(.debug),
+        enableBackendTracing: Bool = false
     ) {
         let container = DIContainer()
         
@@ -166,6 +176,7 @@ public class Initializer {
             container: container,
             cacheDbURL: cacheDbURL,
             fsBlockDbRoot: fsBlockDbRoot,
+            generalStorageURL: generalStorageURL,
             dataDbURL: dataDbURL,
             endpoint: endpoint,
             network: network,
@@ -173,7 +184,8 @@ public class Initializer {
             outputParamsURL: outputParamsURL,
             saplingParamsSourceURL: saplingParamsSourceURL,
             alias: alias,
-            loggingPolicy: loggingPolicy
+            loggingPolicy: loggingPolicy,
+            enableBackendTracing: enableBackendTracing
         )
         
         self.init(
@@ -194,6 +206,7 @@ public class Initializer {
         container: DIContainer,
         cacheDbURL: URL?,
         fsBlockDbRoot: URL,
+        generalStorageURL: URL,
         dataDbURL: URL,
         endpoint: LightWalletEndpoint,
         network: ZcashNetwork,
@@ -201,7 +214,8 @@ public class Initializer {
         outputParamsURL: URL,
         saplingParamsSourceURL: SaplingParamsSourceURL,
         alias: ZcashSynchronizerAlias = .default,
-        loggingPolicy: LoggingPolicy = .default(.debug)
+        loggingPolicy: LoggingPolicy = .default(.debug),
+        enableBackendTracing: Bool = false
     ) {
         // It's not possible to fail from constructor. Technically it's possible but it can be pain for the client apps to handle errors thrown
         // from constructor. So `parsingError` is just stored in initializer and `SDKSynchronizer.prepare()` throw this error if it exists.
@@ -209,6 +223,7 @@ public class Initializer {
             container: container,
             cacheDbURL: cacheDbURL,
             fsBlockDbRoot: fsBlockDbRoot,
+            generalStorageURL: generalStorageURL,
             dataDbURL: dataDbURL,
             endpoint: endpoint,
             network: network,
@@ -216,7 +231,8 @@ public class Initializer {
             outputParamsURL: outputParamsURL,
             saplingParamsSourceURL: saplingParamsSourceURL,
             alias: alias,
-            loggingPolicy: loggingPolicy
+            loggingPolicy: loggingPolicy,
+            enableBackendTracing: enableBackendTracing
         )
 
         self.init(
@@ -247,6 +263,7 @@ public class Initializer {
         self.cacheDbURL = cacheDbURL
         self.rustBackend = container.resolve(ZcashRustBackendWelding.self)
         self.fsBlockDbRoot = urls.fsBlockDbRoot
+        self.generalStorageURL = urls.generalStorageURL
         self.dataDbURL = urls.dataDbURL
         self.endpoint = endpoint
         self.spendParamsURL = urls.spendParamsURL
@@ -278,6 +295,7 @@ public class Initializer {
         container: DIContainer,
         cacheDbURL: URL?,
         fsBlockDbRoot: URL,
+        generalStorageURL: URL,
         dataDbURL: URL,
         endpoint: LightWalletEndpoint,
         network: ZcashNetwork,
@@ -285,11 +303,13 @@ public class Initializer {
         outputParamsURL: URL,
         saplingParamsSourceURL: SaplingParamsSourceURL,
         alias: ZcashSynchronizerAlias,
-        loggingPolicy: LoggingPolicy = .default(.debug)
+        loggingPolicy: LoggingPolicy = .default(.debug),
+        enableBackendTracing: Bool = false
     ) -> (URLs, ZcashError?) {
         let urls = URLs(
             fsBlockDbRoot: fsBlockDbRoot,
             dataDbURL: dataDbURL,
+            generalStorageURL: generalStorageURL,
             spendParamsURL: spendParamsURL,
             outputParamsURL: outputParamsURL
         )
@@ -304,7 +324,8 @@ public class Initializer {
             alias: alias,
             networkType: network.networkType,
             endpoint: endpoint,
-            loggingPolicy: loggingPolicy
+            loggingPolicy: loggingPolicy,
+            enableBackendTracing: enableBackendTracing
         )
         
         return (updatedURLs, parsingError)
@@ -360,10 +381,15 @@ public class Initializer {
             return .failure(.initializerCantUpdateURLWithAlias(urls.outputParamsURL))
         }
 
+        guard let updatedGeneralStorageURL = urls.generalStorageURL.updateLastPathComponent(with: alias) else {
+            return .failure(.initializerCantUpdateURLWithAlias(urls.generalStorageURL))
+        }
+
         return .success(
             URLs(
                 fsBlockDbRoot: updatedFsBlockDbRoot,
                 dataDbURL: updatedDataDbURL,
+                generalStorageURL: updatedGeneralStorageURL,
                 spendParamsURL: updatedSpendParamsURL,
                 outputParamsURL: updateOutputParamsURL
             )
@@ -383,7 +409,7 @@ public class Initializer {
     /// - Parameter seed: ZIP-32 Seed bytes for the wallet that will be initialized
     /// - Throws: `InitializerError.dataDbInitFailed` if the creation of the dataDb fails
     /// `InitializerError.accountInitFailed` if the account table can't be initialized. 
-    func initialize(with seed: [UInt8]?, viewingKeys: [UnifiedFullViewingKey], walletBirthday: BlockHeight) async throws -> InitializationResult {
+    func initialize(with seed: [UInt8]?, walletBirthday: BlockHeight, for walletMode: WalletInitMode) async throws -> InitializationResult {
         try await storage.create()
 
         if case .seedRequired = try await rustBackend.initDataDb(seed: seed) {
@@ -391,27 +417,22 @@ public class Initializer {
         }
 
         let checkpoint = Checkpoint.birthday(with: walletBirthday, network: network)
-        do {
-            try await rustBackend.initBlocksTable(
-                height: Int32(checkpoint.height),
-                hash: checkpoint.hash,
-                time: checkpoint.time,
-                saplingTree: checkpoint.saplingTree
-            )
-        } catch ZcashError.rustInitBlocksTableDataDbNotEmpty {
-            // this is fine
-        } catch {
-            throw error
-        }
 
         self.walletBirthday = checkpoint.height
- 
-        do {
-            try await rustBackend.initAccountsTable(ufvks: viewingKeys)
-        } catch ZcashError.rustInitAccountsTableDataDbNotEmpty {
-            // this is fine
-        } catch {
-            throw error
+
+        // If there are no accounts it must be created, the default amount of accounts is 1
+        if let seed, try accountRepository.getAll().isEmpty {
+            var chainTip: UInt32?
+            
+            if walletMode == .restoreWallet {
+                chainTip = UInt32(try await lightWalletService.latestBlockHeight())
+            }
+            
+            _ = try await rustBackend.createAccount(
+                seed: seed,
+                treeState: checkpoint.treeState(),
+                recoverUntil: chainTip
+            )
         }
 
         return .success

package/ios/ZCashLightClientKit/Metrics/SDKMetrics.swift

@@ -32,9 +32,6 @@ import Foundation
 /// We encourage you to check`SDKMetricsTests` and other tests in the Test/PerformanceTests/ folder.
 public class SDKMetrics {
     public struct BlockMetricReport: Equatable {
-        public let startHeight: BlockHeight
-        public let progressHeight: BlockHeight
-        public let targetHeight: BlockHeight
         public let batchSize: Int
         public let startTime: TimeInterval
         public let endTime: TimeInterval
@@ -43,7 +40,6 @@ public class SDKMetrics {
     
     public enum Operation {
         case downloadBlocks
-        case validateBlocks
         case scanBlocks
         case enhancement
         case fetchUTXOs
@@ -75,7 +71,6 @@ public class SDKMetrics {
     /// `SDKMetrics` focuses deeply on sync process and metrics related to it. By default there are reports around
     /// block operations like download, validate, etc. This method pushes data on a stack for the specific operation.
     func pushProgressReport(
-        progress: BlockProgress,
         start: Date,
         end: Date,
         batchSize: Int,
@@ -84,9 +79,6 @@ public class SDKMetrics {
         guard isEnabled else { return }
         
         let blockMetricReport = BlockMetricReport(
-            startHeight: progress.startHeight,
-            progressHeight: progress.progressHeight,
-            targetHeight: progress.targetHeight,
             batchSize: batchSize,
             startTime: start.timeIntervalSinceReferenceDate,
             endTime: end.timeIntervalSinceReferenceDate
@@ -158,7 +150,6 @@ public class SDKMetrics {
 extension SDKMetrics {
     public struct CumulativeSummary: Equatable {
         public let downloadedBlocksReport: ReportSummary?
-        public let validatedBlocksReport: ReportSummary?
         public let scannedBlocksReport: ReportSummary?
         public let enhancementReport: ReportSummary?
         public let fetchUTXOsReport: ReportSummary?
@@ -177,7 +168,6 @@ extension SDKMetrics {
     /// independently. A `ReportSummary` is the result per `operation`, providing min, max and avg times.
     public func cumulativeSummary() -> CumulativeSummary {
         let downloadReport = summaryFor(reports: reports[.downloadBlocks])
-        let validateReport = summaryFor(reports: reports[.validateBlocks])
         let scanReport = summaryFor(reports: reports[.scanBlocks])
         let enhancementReport = summaryFor(reports: reports[.enhancement])
         let fetchUTXOsReport = summaryFor(reports: reports[.fetchUTXOs])
@@ -189,7 +179,6 @@ extension SDKMetrics {
         
         return CumulativeSummary(
             downloadedBlocksReport: downloadReport,
-            validatedBlocksReport: validateReport,
             scannedBlocksReport: scanReport,
             enhancementReport: enhancementReport,
             fetchUTXOsReport: fetchUTXOsReport,
@@ -217,7 +206,6 @@ extension SDKMetrics {
         cumulativeSummaries.forEach { summary in
             finalSummary = CumulativeSummary(
                 downloadedBlocksReport: accumulate(left: finalSummary?.downloadedBlocksReport, right: summary.downloadedBlocksReport),
-                validatedBlocksReport: accumulate(left: finalSummary?.validatedBlocksReport, right: summary.validatedBlocksReport),
                 scannedBlocksReport: accumulate(left: finalSummary?.scannedBlocksReport, right: summary.scannedBlocksReport),
                 enhancementReport: accumulate(left: finalSummary?.enhancementReport, right: summary.enhancementReport),
                 fetchUTXOsReport: accumulate(left: finalSummary?.fetchUTXOsReport, right: summary.fetchUTXOsReport),

package/ios/ZCashLightClientKit/Model/Checkpoint.swift

@@ -71,6 +71,18 @@ extension Checkpoint: Decodable {
         }
         return height
     }
+
+    public func treeState() -> TreeState {
+        var ret = TreeState()
+        ret.height = UInt64(height)
+        ret.hash = hash
+        ret.time = time
+        ret.saplingTree = saplingTree
+        if let tree = orchardTree {
+            ret.orchardTree = tree
+        }
+        return ret
+    }
 }
 
 public extension BlockHeight {

package/ios/ZCashLightClientKit/Model/ScanProgress.swift

@@ -0,0 +1,29 @@
+//
+//  ScanProgress.swift
+//  
+//
+//  Created by Jack Grigg on 06/09/2023.
+//
+
+import Foundation
+
+struct ScanProgress: Equatable {
+    let numerator: UInt64
+    let denominator: UInt64
+    
+    func progress() throws -> Float {
+        guard denominator != 0 else {
+            // this shouldn't happen but if it does, we need to get notified by clients and work on a fix
+            throw ZcashError.rustScanProgressOutOfRange("\(numerator)/\(denominator)")
+        }
+
+        let value = Float(numerator) / Float(denominator)
+        
+        // this shouldn't happen but if it does, we need to get notified by clients and work on a fix
+        if value > 1.0 {
+            throw ZcashError.rustScanProgressOutOfRange("\(value)")
+        }
+
+        return value
+    }
+}

package/ios/ZCashLightClientKit/Model/ScanRange.swift

@@ -0,0 +1,31 @@
+//
+//  ScanRange.swift
+//
+//
+//  Created by Jack Grigg on 17/07/2023.
+//
+
+import Foundation
+
+struct ScanRange {
+    enum Priority: UInt8 {
+        case ignored = 0
+        case scanned = 10
+        case historic = 20
+        case openAdjacent = 30
+        case foundNote = 40
+        case chainTip = 50
+        case verify = 60
+        
+        init(_ value: UInt8) {
+            if let priority = Priority(rawValue: value) {
+                self = priority
+            } else {
+                fatalError("The value \(value) is out of the range of priorities.")
+            }
+        }
+    }
+    
+    let range: Range<BlockHeight>
+    let priority: Priority
+}

package/ios/ZCashLightClientKit/Modules/Service/GRPC/LightWalletGRPCService.swift

@@ -262,6 +262,21 @@ extension LightWalletGRPCService: LightWalletService {
             }
         }
     }
+    
+    func getSubtreeRoots(_ request: GetSubtreeRootsArg) -> AsyncThrowingStream<SubtreeRoot, Error> {
+        let stream = compactTxStreamer.getSubtreeRoots(request)
+        var iterator = stream.makeAsyncIterator()
+        
+        return AsyncThrowingStream() {
+            do {
+                guard let subtreeRoot = try await iterator.next() else { return nil }
+                return subtreeRoot
+            } catch {
+                let serviceError = error.mapToServiceError()
+                throw ZcashError.serviceSubtreeRootsStreamFailed(serviceError)
+            }
+        }
+    }
 
     func closeConnection() {
         _ = channel.close()