react-native-zcash 0.6.11 → 0.6.12

package/ios/ZCashLightClientKit/Synchronizer.swift

@@ -42,13 +42,8 @@ public struct SynchronizerState: Equatable {
     /// status of the whole sync process
     var internalSyncStatus: InternalSyncStatus
     public var syncStatus: SyncStatus
-    /// height of the latest scanned block known to this synchronizer.
-    public var latestScannedHeight: BlockHeight
     /// height of the latest block on the blockchain known to this synchronizer.
     public var latestBlockHeight: BlockHeight
-    /// timestamp of the latest scanned block on the blockchain known to this synchronizer.
-    /// The anchor point is timeIntervalSince1970
-    public var latestScannedTime: TimeInterval
 
     /// Represents a synchronizer that has made zero progress hasn't done a sync attempt
     public static var zero: SynchronizerState {
@@ -57,9 +52,7 @@ public struct SynchronizerState: Equatable {
             shieldedBalance: .zero,
             transparentBalance: .zero,
             internalSyncStatus: .unprepared,
-            latestScannedHeight: .zero,
-            latestBlockHeight: .zero,
-            latestScannedTime: 0
+            latestBlockHeight: .zero
         )
     }
     
@@ -68,17 +61,13 @@ public struct SynchronizerState: Equatable {
         shieldedBalance: WalletBalance,
         transparentBalance: WalletBalance,
         internalSyncStatus: InternalSyncStatus,
-        latestScannedHeight: BlockHeight,
-        latestBlockHeight: BlockHeight,
-        latestScannedTime: TimeInterval
+        latestBlockHeight: BlockHeight
     ) {
         self.syncSessionID = syncSessionID
         self.shieldedBalance = shieldedBalance
         self.transparentBalance = transparentBalance
         self.internalSyncStatus = internalSyncStatus
-        self.latestScannedHeight = latestScannedHeight
         self.latestBlockHeight = latestBlockHeight
-        self.latestScannedTime = latestScannedTime
         self.syncStatus = internalSyncStatus.mapToSyncStatus()
     }
 }
@@ -119,7 +108,7 @@ public protocol Synchronizer: AnyObject {
 
     /// An object that when enabled collects mertrics from the synchronizer
     var metrics: SDKMetrics { get }
-    
+
     /// Initialize the wallet. The ZIP-32 seed bytes can optionally be passed to perform
     /// database migrations. most of the times the seed won't be needed. If they do and are
     /// not provided this will fail with `InitializationResult.seedRequired`. It could
@@ -131,9 +120,11 @@ public protocol Synchronizer: AnyObject {
     /// do not already exist). These files can be given a prefix for scenarios where multiple wallets
     ///
     /// - Parameters:
-    ///   - seed: ZIP-32 Seed bytes for the wallet that will be initialized.
-    ///   - viewingKeys: Viewing key derived from seed.
+    ///   - seed: ZIP-32 Seed bytes for the wallet that will be initialized
     ///   - walletBirthday: Birthday of wallet.
+    ///   - for: [walletMode] Set `.newWallet` when preparing synchronizer for a brand new generated wallet,
+    ///   `.restoreWallet` when wallet is about to be restored from a seed
+    ///   and  `.existingWallet` for all other scenarios.
     /// - Throws:
     ///     - `aliasAlreadyInUse` if the Alias used to create this instance is already used by other instance.
     ///     - `cantUpdateURLWithAlias` if the updating of paths in `Initilizer` according to alias fails. When this happens it means that
@@ -142,8 +133,8 @@ public protocol Synchronizer: AnyObject {
     ///     - Some other `ZcashError` thrown by lower layer of the SDK.
     func prepare(
         with seed: [UInt8]?,
-        viewingKeys: [UnifiedFullViewingKey],
-        walletBirthday: BlockHeight
+        walletBirthday: BlockHeight,
+        for walletMode: WalletInitMode
     ) async throws -> Initializer.InitializationResult
 
     /// Starts this synchronizer within the given scope.
@@ -199,9 +190,6 @@ public protocol Synchronizer: AnyObject {
         shieldingThreshold: Zatoshi
     ) async throws -> ZcashTransaction.Overview
 
-    /// all outbound pending transactions that have been sent but are awaiting confirmations
-    var pendingTransactions: [ZcashTransaction.Overview] { get async }
-
     /// all the transactions that are on the blockchain
     var transactions: [ZcashTransaction.Overview] { get async }
 
@@ -242,10 +230,6 @@ public protocol Synchronizer: AnyObject {
     /// - Returns: an array with the given Transactions or an empty array
     func allTransactions(from transaction: ZcashTransaction.Overview, limit: Int) async throws -> [ZcashTransaction.Overview]
 
-    /// Fetch all pending transactions
-    /// - Returns: an array of transactions which are considered pending confirmation. can be empty
-    func allPendingTransactions() async throws -> [ZcashTransaction.Overview]
-
     /// Returns the latest block height from the provided Lightwallet endpoint
     func latestHeight() async throws -> BlockHeight
 
@@ -333,20 +317,32 @@ public enum SyncStatus: Equatable {
     /// When set, a UI element may want to turn green.
     case upToDate
 
+    /// Indicates that this Synchronizer was succesfully stopped via `stop()` method.
+    case stopped
+    
     case error(_ error: Error)
     
     public var isSyncing: Bool {
-        guard case .syncing = self else { return true }
+        if case .syncing = self {
+            return true
+        }
+        
         return false
     }
     
     public var isSynced: Bool {
-        guard case .upToDate = self else { return true }
+        if case .upToDate = self {
+            return true
+        }
+        
         return false
     }
 
     public var isPrepared: Bool {
-        guard case .unprepared = self else { return false }
+        if case .unprepared = self {
+            return false
+        }
+        
         return true
     }
 
@@ -354,6 +350,7 @@ public enum SyncStatus: Equatable {
         switch self {
         case .unprepared: return "unprepared"
         case .syncing: return "syncing"
+        case .stopped: return "stopped"
         case .upToDate: return "up to date"
         case .error: return "error"
         }
@@ -366,15 +363,9 @@ enum InternalSyncStatus: Equatable {
     /// taking other maintenance steps that need to occur after an upgrade.
     case unprepared
 
-    case syncing(_ progress: BlockProgress)
-
-    /// Indicates that this Synchronizer is actively enhancing newly scanned blocks
-    /// with additional transaction details, fetched from the server.
-    case enhancing(_ progress: EnhancementProgress)
-
-    /// fetches the transparent balance and stores it locally
-    case fetching(_ progress: Float)
-
+    /// Indicates that this Synchronizer is actively processing new blocks (consists of fetch, scan and enhance operations)
+    case syncing(Float)
+    
     /// Indicates that this Synchronizer is fully up to date and ready for all wallet functions.
     /// When set, a UI element may want to turn green.
     case synced
@@ -389,35 +380,33 @@ enum InternalSyncStatus: Equatable {
     case error(_ error: Error)
     
     public var isSyncing: Bool {
-        switch self {
-        case .syncing, .enhancing, .fetching:
+        if case .syncing = self {
             return true
-        default:
-            return false
         }
+        
+        return false
     }
     
     public var isSynced: Bool {
-        switch self {
-        case .synced:   return true
-        default:        return false
+        if case .synced = self {
+            return true
         }
+        
+        return false
     }
 
     public var isPrepared: Bool {
         if case .unprepared = self {
             return false
-        } else {
-            return true
         }
+        
+        return true
     }
 
     public var briefDebugDescription: String {
         switch self {
         case .unprepared: return "unprepared"
         case .syncing: return "syncing"
-        case .enhancing: return "enhancing"
-        case .fetching: return "fetching"
         case .synced: return "synced"
         case .stopped: return "stopped"
         case .disconnected: return "disconnected"
@@ -426,6 +415,16 @@ enum InternalSyncStatus: Equatable {
     }
 }
 
+/// Mode of the Synchronizer's initialization for the wallet.
+public enum WalletInitMode: Equatable {
+    /// For brand new wallet - typically when users creates a new wallet.
+    case newWallet
+    /// For a wallet that is about to be restored. Typically when a user wants to restore a wallet from a seed.
+    case restoreWallet
+    /// All other cases - typically when clients just start the process e.g. every regular app start for mobile apps.
+    case existingWallet
+}
+
 /// Kind of transactions handled by a Synchronizer
 public enum TransactionKind {
     case sent
@@ -449,8 +448,6 @@ extension InternalSyncStatus {
         switch (lhs, rhs) {
         case (.unprepared, .unprepared): return true
         case let (.syncing(lhsProgress), .syncing(rhsProgress)): return lhsProgress == rhsProgress
-        case let (.enhancing(lhsProgress), .enhancing(rhsProgress)): return lhsProgress == rhsProgress
-        case (.fetching, .fetching): return true
         case (.synced, .synced): return true
         case (.stopped, .stopped): return true
         case (.disconnected, .disconnected): return true
@@ -461,15 +458,8 @@ extension InternalSyncStatus {
 }
 
 extension InternalSyncStatus {
-    init(_ blockProcessorProgress: CompactBlockProgress) {
-        switch blockProcessorProgress {
-        case .syncing(let progressReport):
-            self = .syncing(progressReport)
-        case .enhance(let enhancingReport):
-            self = .enhancing(enhancingReport)
-        case .fetch(let fetchingProgress):
-            self = .fetching(fetchingProgress)
-        }
+    init(_ blockProcessorProgress: Float) {
+        self = .syncing(blockProcessorProgress)
     }
 }
 
@@ -479,15 +469,11 @@ extension InternalSyncStatus {
         case .unprepared:
             return .unprepared
         case .syncing(let progress):
-            return .syncing(0.9 * progress.progress)
-        case .enhancing(let progress):
-            return .syncing(0.9 + 0.08 * progress.progress)
-        case .fetching(let progress):
-            return .syncing(0.98 + 0.02 * progress)
+            return .syncing(progress)
         case .synced:
             return .upToDate
         case .stopped:
-            return .upToDate
+            return .stopped
         case .disconnected:
             return .error(ZcashError.synchronizerDisconnected)
         case .error(let error):

package/ios/ZCashLightClientKit/Transaction/TransactionEncoder.swift

@@ -10,8 +10,8 @@ import Foundation
 typealias TransactionEncoderResultBlock = (_ result: Result<EncodedTransaction, Error>) -> Void
 
 public enum TransactionEncoderError: Error {
-    case notFound(transactionId: Int)
-    case notEncoded(transactionId: Int)
+    case notFound(txId: Data)
+    case notEncoded(txId: Data)
     case missingParams
     case spendingKeyWrongNetwork
     case couldNotExpand(txId: Data)

package/ios/ZCashLightClientKit/Transaction/WalletTransactionEncoder.swift

@@ -71,7 +71,7 @@ class WalletTransactionEncoder: TransactionEncoder {
         )
 
         logger.debug("transaction id: \(txId)")
-        return try await repository.find(id: txId)
+        return try await repository.find(rawID: txId)
     }
     
     func createSpend(
@@ -80,7 +80,7 @@ class WalletTransactionEncoder: TransactionEncoder {
         to address: String,
         memoBytes: MemoBytes?,
         from accountIndex: Int
-    ) async throws -> Int {
+    ) async throws -> Data {
         guard ensureParams(spend: self.spendParamsURL, output: self.outputParamsURL) else {
             throw ZcashError.walletTransEncoderCreateTransactionMissingSaplingParams
         }
@@ -92,7 +92,7 @@ class WalletTransactionEncoder: TransactionEncoder {
             memo: memoBytes
         )
 
-        return Int(txId)
+        return txId
     }
     
     func createShieldingTransaction(
@@ -109,7 +109,7 @@ class WalletTransactionEncoder: TransactionEncoder {
         )
         
         logger.debug("transaction id: \(txId)")
-        return try await repository.find(id: txId)
+        return try await repository.find(rawID: txId)
     }
 
     func createShieldingSpend(
@@ -117,7 +117,7 @@ class WalletTransactionEncoder: TransactionEncoder {
         shieldingThreshold: Zatoshi,
         memo: MemoBytes?,
         accountIndex: Int
-    ) async throws -> Int {
+    ) async throws -> Data {
         guard ensureParams(spend: self.spendParamsURL, output: self.outputParamsURL) else {
             throw ZcashError.walletTransEncoderShieldFundsMissingSaplingParams
         }
@@ -128,7 +128,7 @@ class WalletTransactionEncoder: TransactionEncoder {
             shieldingThreshold: shieldingThreshold
         )
                 
-        return Int(txId)
+        return txId
     }
 
     func submit(
@@ -157,7 +157,7 @@ class WalletTransactionEncoder: TransactionEncoder {
 extension ZcashTransaction.Overview {
     func encodedTransaction() throws -> EncodedTransaction {
         guard let raw else {
-            throw TransactionEncoderError.notEncoded(transactionId: self.id)
+            throw TransactionEncoderError.notEncoded(txId: self.rawID)
         }
 
         return EncodedTransaction(transactionId: self.rawID, raw: raw)

package/ios/ZCashLightClientKit/Utils/OSLogger.swift

@@ -13,10 +13,10 @@ public class OSLogger: Logger {
     
     public enum LogLevel: Int {
         case debug
-        case error
-        case warning
-        case event
         case info
+        case event
+        case warning
+        case error
     }
 
     public let oslog: OSLog?

package/ios/ZCashLightClientKit/Utils/ZcashFileManager.swift

@@ -0,0 +1,16 @@
+//
+//  ZcashFileManager.swift
+//  
+//
+//  Created by Lukáš Korba on 23.05.2023.
+//
+
+import Foundation
+
+protocol ZcashFileManager {
+    func isReadableFile(atPath path: String) -> Bool
+    func removeItem(at URL: URL) throws
+    func isDeletableFile(atPath path: String) -> Bool
+}
+
+extension FileManager: ZcashFileManager { }

package/ios/libzcashlc.xcframework/Info.plist

@@ -5,31 +5,35 @@
 	<key>AvailableLibraries</key>
 	<array>
 		<dict>
+			<key>BinaryPath</key>
+			<string>libzcashlc.a</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>libzcashlc.a</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
+				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 		<dict>
+			<key>BinaryPath</key>
+			<string>libzcashlc.a</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>libzcashlc.a</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
-				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-zcash",
-  "version": "0.6.11",
+  "version": "0.6.12",
   "description": "Zcash library for React Native",
   "homepage": "https://github.com/EdgeApp/react-native-zcash",
   "repository": {