react-native-zcash 0.3.5 → 0.4.0

package/ios/ZCashLightClientKit/Utils/OSLogger.swift

@@ -0,0 +1,109 @@
+//
+//  OSLogger.swift
+//  
+//
+//  Created by Lukáš Korba on 26.01.2023.
+//
+
+import Foundation
+import os
+
+public class OSLogger: Logger {
+    public let alias: ZcashSynchronizerAlias?
+    
+    public enum LogLevel: Int {
+        case debug
+        case error
+        case warning
+        case event
+        case info
+    }
+
+    public let oslog: OSLog?
+    
+    var level: LogLevel
+    
+    public init(logLevel: LogLevel, category: String = "logs", alias: ZcashSynchronizerAlias? = nil) {
+        self.alias = alias
+        self.level = logLevel
+        if let bundleName = Bundle.main.bundleIdentifier {
+            var postfix = ""
+            if let alias { postfix = "_\(alias.description)" }
+            self.oslog = OSLog(subsystem: bundleName, category: "\(category)\(postfix)")
+        } else {
+            oslog = nil
+        }
+    }
+
+    public func debug(
+        _ message: String,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: Int = #line
+    ) {
+        guard level.rawValue == LogLevel.debug.rawValue else { return }
+        log(level: "DEBUG 🐞", message: message, file: file, function: function, line: line)
+    }
+    
+    public func error(
+        _ message: String,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: Int = #line
+    ) {
+        guard level.rawValue <= LogLevel.error.rawValue else { return }
+        log(level: "ERROR 💥", message: message, file: file, function: function, line: line)
+    }
+    
+    public func warn(
+        _ message: String,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: Int = #line
+    ) {
+        guard level.rawValue <= LogLevel.warning.rawValue else { return }
+        log(level: "WARNING ⚠️", message: message, file: file, function: function, line: line)
+    }
+
+    public func event(
+        _ message: String,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: Int = #line
+    ) {
+        guard level.rawValue <= LogLevel.event.rawValue else { return }
+        log(level: "EVENT ⏱", message: message, file: file, function: function, line: line)
+    }
+    
+    public func info(
+        _ message: String,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: Int = #line
+    ) {
+        guard level.rawValue <= LogLevel.info.rawValue else { return }
+        log(level: "INFO ℹ️", message: message, file: file, function: function, line: line)
+    }
+    
+    private func log(
+        level: String,
+        message: String,
+        file: StaticString = #file,
+        function: StaticString = #function,
+        line: Int = #line
+    ) {
+        guard let oslog else { return }
+        
+        let fileName = (String(describing: file) as NSString).lastPathComponent
+        
+        os_log(
+            "[%{public}@] %{public}@ - %{public}@ - Line: %{public}d -> %{public}@",
+            log: oslog,
+            level,
+            fileName,
+            String(describing: function),
+            line,
+            message
+        )
+    }
+}

package/ios/ZCashLightClientKit/Utils/SaplingParameterDownloader.swift

@@ -6,107 +6,87 @@
 //
 
 import Foundation
-/**
-Helper class to handle the download of Sapling parameters
-*/
-public enum SaplingParameterDownloader {
-    public enum Errors: Error {
-        case invalidURL(url: String)
-        case failed(error: Error)
-    }
-    
-    /**
-    Download a Spend parameter from default host and stores it at given URL
-    - Parameters:
-        - at: The destination URL for the download
-        - result: block to handle the download success or error
-    */
-    public static func downloadSpendParameter(_ at: URL, result: @escaping (Result<URL, Error>) -> Void) {
-        guard let url = URL(string: spendParamsURLString) else {
-            result(.failure(Errors.invalidURL(url: spendParamsURLString)))
-            return
-        }
+import CryptoKit
 
-        downloadFileWithRequest(URLRequest(url: url), at: at, result: result)
+/// Small utility that converts Digest to the String
+extension Digest {
+    var bytes: [UInt8] { Array(makeIterator()) }
+    var data: Data { Data(bytes) }
+
+    var hexString: String {
+        bytes.map { String(format: "%02x", $0) }.joined()
     }
-    /**
-    Download an Output parameter from default host and stores it at given URL
-    - Parameters:
-        - at: The destination URL for the download
-        - result: block to handle the download success or error
-    */
-    public static func downloadOutputParameter(_ at: URL, result: @escaping (Result<URL, Error>) -> Void) {
-        guard let url = URL(string: outputParamsURLString) else {
-            result(.failure(Errors.invalidURL(url: outputParamsURLString)))
-            return
-        }
+}
 
-        downloadFileWithRequest(URLRequest(url: url), at: at, result: result)
+/// Helper class to handle the download of Sapling parameters
+public enum SaplingParameterDownloader {
+    /// Download a Spend parameter from default host and stores it at given URL
+    /// - Parameters:
+    ///     - at: The destination URL for the download
+    /// - Throws:
+    ///     - `saplingParamsDownload` if file downloading fails.
+    ///     - `saplingParamsCantMoveDownloadedFile` if file is downloaded but moving to final destination fails.
+    ///     - `saplingParamsInvalidSpendParams` if the downloaded file is invalid.
+    @discardableResult
+    public static func downloadSpendParameter(_ at: URL, sourceURL: URL, logger: Logger) async throws -> URL {
+        let resultURL = try await downloadFileWithRequestWithContinuation(sourceURL, logger: logger, at: at)
+        try isSpendParamsSHA1Valid(url: resultURL)
+        return resultURL
     }
     
-    private static func downloadFileWithRequest(_ request: URLRequest, at destination: URL, result: @escaping (Result<URL, Error>) -> Void) {
-        let task = URLSession.shared.downloadTask(with: request) { url, _, error in
-            if let error = error {
-                result(.failure(Errors.failed(error: error)))
-                return
-            } else if let localUrl = url {
-                do {
-                    try FileManager.default.moveItem(at: localUrl, to: destination)
-                    result(.success(destination))
-                } catch {
-                    result(.failure(error))
-                }
-            }
-        }
-
-        task.resume()
+    /// Download an Output parameter from default host and stores it at given URL
+    /// - Parameters:
+    ///     - at: The destination URL for the download
+    /// - Throws:
+    ///     - `saplingParamsDownload` if file downloading fails.
+    ///     - `saplingParamsCantMoveDownloadedFile` if file is downloaded but moving to final destination fails.
+    ///     - `saplingParamsInvalidOutputParams` if the downloaded file is invalid.
+    @discardableResult
+    public static func downloadOutputParameter(_ at: URL, sourceURL: URL, logger: Logger) async throws -> URL {
+        let resultURL = try await downloadFileWithRequestWithContinuation(sourceURL, logger: logger, at: at)
+        try isOutputParamsSHA1Valid(url: resultURL)
+        return resultURL
     }
-    /**
-    Downloads the parameters if not present and provides the resulting URLs for both parameters
-    - Parameters:
-        - spendURL: URL to check whether the parameter is already downloaded
-        - outputURL: URL to check whether the parameter is already downloaded
-        - result: block to handle success or error
-    */
+
+    /// Downloads the parameters if not present and provides the resulting URLs for both parameters
+    /// - Parameters:
+    ///     - spendURL: URL to check whether the parameter is already downloaded
+    ///     - outputURL: URL to check whether the parameter is already downloaded
+    /// - Throws:
+    ///     - `saplingParamsDownload` if file downloading fails.
+    ///     - `saplingParamsCantMoveDownloadedFile` if file is downloaded but moving to final destination fails.
+    ///     - `saplingParamsInvalidSpendParams` if the downloaded file is invalid.
+    ///     - `saplingParamsInvalidOutputParams` if the downloaded file is invalid.
+    @discardableResult
     public static func downloadParamsIfnotPresent(
         spendURL: URL,
+        spendSourceURL: URL,
         outputURL: URL,
-        result: @escaping (Result<(spend: URL, output: URL), Error>) -> Void
-    ) {
-        ensureSpendParameter(at: spendURL) { spendResult in
-            switch spendResult {
-            case .success(let spendResultURL):
-                ensureOutputParameter(at: outputURL) { outputResult in
-                    switch outputResult {
-                    case .success(let outputResultURL):
-                        result(.success((spendResultURL, outputResultURL)))
-                    case .failure(let outputResultError):
-                        result(.failure(Errors.failed(error: outputResultError)))
-                    }
-                }
-            case .failure(let spendResultError):
-                result(.failure(Errors.failed(error: spendResultError)))
-            }
-        }
+        outputSourceURL: URL,
+        logger: Logger
+    ) async throws -> (spend: URL, output: URL) {
+        async let spendResultURL = ensureSpendParameter(at: spendURL, sourceURL: spendSourceURL, logger: logger)
+        async let outputResultURL = ensureOutputParameter(at: outputURL, sourceURL: outputSourceURL, logger: logger)
+
+        let results = try await [spendResultURL, outputResultURL]
+        return (spend: results[0], output: results[1])
     }
-    
-    static func ensureSpendParameter(at url: URL, result: @escaping (Result<URL, Error>) -> Void) {
+        
+    static func ensureSpendParameter(at url: URL, sourceURL: URL, logger: Logger) async throws -> URL {
         if isFilePresent(url: url) {
-            DispatchQueue.global().async {
-                result(.success(url))
-            }
+            try isSpendParamsSHA1Valid(url: url)
+            return url
         } else {
-            downloadSpendParameter(url, result: result)
+            return try await downloadSpendParameter(url, sourceURL: sourceURL, logger: logger)
         }
     }
     
-    static func ensureOutputParameter(at url: URL, result: @escaping (Result<URL, Error>) -> Void) {
+    static func ensureOutputParameter(at url: URL, sourceURL: URL, logger: Logger) async throws -> URL {
         if isFilePresent(url: url) {
-            DispatchQueue.global().async {
-                result(.success(url))
-            }
+            try isOutputParamsSHA1Valid(url: url)
+            return url
         } else {
-            downloadOutputParameter(url, result: result)
+            return try await downloadOutputParameter(url, sourceURL: sourceURL, logger: logger)
         }
     }
     
@@ -114,11 +94,66 @@ public enum SaplingParameterDownloader {
         (try? FileManager.default.attributesOfItem(atPath: url.path)) != nil
     }
     
-    public static var spendParamsURLString: String {
-        return ZcashSDK.cloudParameterURL + ZcashSDK.spendParamFilename
+    static func isSpendParamsSHA1Valid(url: URL) throws {
+        if Insecure.SHA1.hash(data: try Data(contentsOf: url)).hexString != Constants.spendParamFileSHA1 {
+            try? FileManager.default.removeItem(at: url)
+            throw ZcashError.saplingParamsInvalidSpendParams
+        }
     }
-    
-    public static var outputParamsURLString: String {
-        return ZcashSDK.cloudParameterURL + ZcashSDK.outputParamFilename
+
+    static func isOutputParamsSHA1Valid(url: URL) throws {
+        if Insecure.SHA1.hash(data: try Data(contentsOf: url)).hexString != Constants.outputParamFileSHA1 {
+            try? FileManager.default.removeItem(at: url)
+            throw ZcashError.saplingParamsInvalidOutputParams
+        }
+    }
+}
+
+private extension SaplingParameterDownloader {
+    enum Constants {
+        public static let spendParamFileSHA1 = "a15ab54c2888880e53c823a3063820c728444126"
+        public static let outputParamFileSHA1 = "0ebc5a1ef3653948e1c46cf7a16071eac4b7e352"
+    }
+
+    static func downloadFileWithRequestWithContinuation(
+    _ sourceURL: URL,
+    logger: Logger,
+    at destination: URL
+    ) async throws -> URL {
+        return try await withCheckedThrowingContinuation { continuation in
+            downloadFileWithRequest(sourceURL, at: destination, logger: logger) { result in
+                switch result {
+                case .success(let outputResultURL):
+                    continuation.resume(returning: outputResultURL)
+                case .failure(let outputResultError):
+                    continuation.resume(throwing: outputResultError)
+                }
+            }
+        }
+    }
+
+    static func downloadFileWithRequest(
+        _ sourceURL: URL,
+        at destination: URL,
+        logger: Logger,
+        result: @escaping (Result<URL, Error>) -> Void
+    ) {
+        logger.debug("Downloading sapling file from \(sourceURL)")
+        let request = URLRequest(url: sourceURL)
+        let task = URLSession.shared.downloadTask(with: request) { url, _, error in
+            if let error {
+                result(.failure(ZcashError.saplingParamsDownload(error, sourceURL)))
+                return
+            } else if let localUrl = url {
+                do {
+                    try FileManager.default.moveItem(at: localUrl, to: destination)
+                    result(.success(destination))
+                } catch {
+                    result(.failure(ZcashError.saplingParamsCantMoveDownloadedFile(error, sourceURL, destination)))
+                }
+            }
+        }
+
+        task.resume()
     }
 }

package/ios/ZCashLightClientKit/Utils/SpecificCombineTypes.swift

@@ -0,0 +1,16 @@
+//
+//  SpecificCombineTypes.swift
+//  
+//
+//  Created by Michal Fousek on 03.04.2023.
+//
+
+import Combine
+import Foundation
+
+/* These aliases are here to just make the API easier to read. */
+
+// Publisher which emitts completed or error. No value is emitted.
+public typealias CompletablePublisher<E: Error> = AnyPublisher<Void, E>
+// Publisher that either emits one value and then finishes or it emits error.
+public typealias SinglePublisher = AnyPublisher

package/ios/ZCashLightClientKit/Utils/SyncSessionIDGenerator.swift

@@ -0,0 +1,32 @@
+//
+//  SyncSessionIDGenerator.swift
+//  
+//
+//  Created by Francisco Gindre on 3/31/23.
+//
+
+import Foundation
+
+protocol SyncSessionIDGenerator {
+    func nextID() -> UUID
+}
+
+struct UniqueSyncSessionIDGenerator {}
+
+extension UniqueSyncSessionIDGenerator: SyncSessionIDGenerator {
+    func nextID() -> UUID {
+        UUID()
+    }
+}
+
+typealias SyncSession = GenericActor<UUID>
+
+extension SyncSession {
+    /// updates the current sync session to a new value with the given generator
+    /// - Parameters generator: a `SyncSessionIDGenerator`
+    /// - returns: the `UUID` of the newly updated value.
+    @discardableResult
+    func newSession(with generator: SyncSessionIDGenerator) async -> UUID {
+        return await self.update(generator.nextID())
+    }
+}

package/ios/ZCashLightClientKit/Utils/Task+sleep.swift

@@ -0,0 +1,14 @@
+//
+//  Task+sleep.swift
+//  
+//
+//  Created by Michal Fousek on 28.04.2023.
+//
+
+import Foundation
+
+extension Task where Success == Never, Failure == Never {
+    static func sleep(milliseconds duration: UInt64) async throws {
+        try await Task.sleep(nanoseconds: duration * 1000_000)
+    }
+}

package/ios/ZCashLightClientKit/Utils/UsedAliasesChecker.swift

@@ -0,0 +1,41 @@
+//
+//  UsedAliasesChecker.swift
+//  
+//
+//  Created by Michal Fousek on 23.03.2023.
+//
+
+import Foundation
+
+private var usedAliases: [ZcashSynchronizerAlias: UUID] = [:]
+private let usedAliasesLock = NSLock()
+
+// Utility used to track which SDKSynchronizer aliases are already in use.
+enum UsedAliasesChecker {
+    static func tryToUse(alias: ZcashSynchronizerAlias, id: UUID) -> Bool {
+        usedAliasesLock.lock()
+        defer { usedAliasesLock.unlock() }
+
+        // Using of `id` allows one instance of the SDKSynchronizer to call is any time it wants and still pass the check. When `wipe()` is called it
+        // starts using the alias. Then when `prepare()` is also registers alias. If the check for `id` wouldn't be here one instance of the
+        // `SDKSynchronizer` couldn't call `prepare()` after wipe because this check wouldn't pass.
+        //
+        // `id` is uniquely generated for each instance of the `SDKSynchronizer`.
+        if let idUsingAlias = usedAliases[alias] {
+            return idUsingAlias == id
+        } else {
+            usedAliases[alias] = id
+            return true
+        }
+    }
+
+    static func stopUsing(alias: ZcashSynchronizerAlias, id: UUID) {
+        usedAliasesLock.lock()
+        defer { usedAliasesLock.unlock() }
+
+        // When instance "owns" the alias the alias is removed and it's no longer registered as used.
+        if let idUsingAlias = usedAliases[alias], idUsingAlias == id {
+            usedAliases.removeValue(forKey: alias)
+        }
+    }
+}

package/ios/libzcashlc.xcframework/Info.plist

@@ -6,30 +6,30 @@
 	<array>
 		<dict>
 			<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>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>