TreeState support

Sources/ZcashLightClientKit/Block/Scan/BlockScanner.swift

@@ -23,6 +23,7 @@ protocol BlockScanner {
 struct BlockScannerImpl {
     let config: BlockScannerConfig
     let rustBackend: ZcashRustBackendWelding
+    let service: LightWalletService
     let transactionRepository: TransactionRepository
     let metrics: SDKMetrics
     let logger: Logger
@@ -56,7 +57,9 @@ extension BlockScannerImpl: BlockScanner {
             let scanSummary: ScanSummary
             let scanStartTime = Date()
             do {
-                scanSummary = try await self.rustBackend.scanBlocks(fromHeight: Int32(startHeight), limit: batchSize)
+                let fromState = try await service.getTreeState(BlockID(height: startHeight - 1))
+
+                scanSummary = try await self.rustBackend.scanBlocks(fromHeight: Int32(startHeight), fromState: fromState, limit: batchSize)
             } catch {
                 logger.debug("block scanning failed with error: \(String(describing: error))")
                 throw error

Sources/ZcashLightClientKit/Modules/Service/GRPC/LightWalletGRPCService.swift

@@ -277,6 +277,10 @@ extension LightWalletGRPCService: LightWalletService {
             }
         }
     }
+
+    func getTreeState(_ id: BlockID) async throws -> TreeState {
+        try await compactTxStreamer.getTreeState(id)
+    }
 
     func closeConnection() {
         _ = channel.close()

Sources/ZcashLightClientKit/Modules/Service/LightWalletService.swift

@@ -24,7 +24,7 @@
 }
 
 extension LightWalletServiceError: Equatable {
     // swiftlint:disable cyclomatic_complexity
     public static func == (lhs: Self, rhs: Self) -> Bool {
         switch lhs {
         case .generalError(let message):
@@ -196,4 +196,6 @@
     /// - Parameters:
     ///   - request: Request to send to GetSubtreeRoots.
     func getSubtreeRoots(_ request: GetSubtreeRootsArg) -> AsyncThrowingStream<SubtreeRoot, Error>
+
+    func getTreeState(_ id: BlockID) async throws -> TreeState
 }

Sources/ZcashLightClientKit/Rust/ZcashRustBackend.swift

@@ -5,7 +5,7 @@
 //  Created by Jack Grigg on 5/8/19.
 //  Copyright © 2019 Electric Coin Company. All rights reserved.
 //
 // swiftlint:disable type_body_length
 import Foundation
 import libzcashlc
 
@@ -628,7 +628,7 @@
             fromStateBytes,
             UInt(fromStateBytes.count),
             limit,
             networkType.networkId)
         globalDBLock.unlock()
 
         guard let summaryPtr else {
@@ -859,6 +859,7 @@
     }
 }
 
+// swiftlint:disable large_tuple line_length
 struct FfiTxId {
     var tuple: (UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8)
     var array: [UInt8] {

Sources/ZcashLightClientKit/Synchronizer/Dependencies.swift

@@ -120,6 +120,7 @@ enum Dependencies {
         }
 
         container.register(type: BlockScanner.self, isSingleton: true) { di in
+            let service = di.resolve(LightWalletService.self)
             let rustBackend = di.resolve(ZcashRustBackendWelding.self)
             let transactionRepository = di.resolve(TransactionRepository.self)
             let metrics = di.resolve(SDKMetrics.self)
@@ -133,6 +134,7 @@ enum Dependencies {
             return BlockScannerImpl(
                 config: blockScannerConfig,
                 rustBackend: rustBackend,
+                service: service,
                 transactionRepository: transactionRepository,
                 metrics: metrics,
                 logger: logger

Tests/TestUtils/DarkSideWalletService.swift

@@ -190,6 +190,10 @@ class DarksideWalletService: LightWalletService {
     func getSubtreeRoots(_ request: ZcashLightClientKit.GetSubtreeRootsArg) -> AsyncThrowingStream<ZcashLightClientKit.SubtreeRoot, Error> {
         service.getSubtreeRoots(request)
     }
+
+    func getTreeState(_ id: BlockID) async throws -> TreeState {
+        try await service.getTreeState(id)
+    }
 }
 
 enum DarksideWalletDConstants: NetworkConstants {

Tests/TestUtils/FakeService.swift

@@ -82,4 +82,8 @@ class MockLightWalletService: LightWalletService {
     func getSubtreeRoots(_ request: ZcashLightClientKit.GetSubtreeRootsArg) -> AsyncThrowingStream<ZcashLightClientKit.SubtreeRoot, Error> {
         service.getSubtreeRoots(request)
     }
+
+    func getTreeState(_ id: BlockID) async throws -> TreeState {
+        try await service.getTreeState(id)
+    }
 }

Tests/TestUtils/Sourcery/GeneratedMocks/AutoMockable.generated.swift

@@ -963,6 +963,30 @@ class LightWalletServiceMock: LightWalletService {
         }
     }
 
+    // MARK: - getTreeState
+
+    var getTreeStateThrowableError: Error?
+    var getTreeStateCallsCount = 0
+    var getTreeStateCalled: Bool {
+        return getTreeStateCallsCount > 0
+    }
+    var getTreeStateReceivedId: BlockID?
+    var getTreeStateReturnValue: TreeState!
+    var getTreeStateClosure: ((BlockID) async throws -> TreeState)?
+
+    func getTreeState(_ id: BlockID) async throws -> TreeState {
+        if let error = getTreeStateThrowableError {
+            throw error
+        }
+        getTreeStateCallsCount += 1
+        getTreeStateReceivedId = id
+        if let closure = getTreeStateClosure {
+            return try await closure(id)
+        } else {
+            return getTreeStateReturnValue
+        }
+    }
+
 }
 class LightWalletdInfoMock: LightWalletdInfo {
 

Tests/TestUtils/Stubs.swift

@@ -102,8 +102,8 @@ class RustBackendMockHelper {
             try await rustBackend.suggestScanRanges()
         }
 
-        await rustBackendMock.setScanBlocksFromHeightLimitClosure() { fromHeight, limit in
-            try await rustBackend.scanBlocks(fromHeight: fromHeight, limit: limit)
+        await rustBackendMock.setScanBlocksFromHeightFromStateLimitClosure { fromHeight, fromState, limit in
+            try await rustBackend.scanBlocks(fromHeight: fromHeight, fromState: fromState, limit: limit)
         }
     }