Migrate to first pre-release of FFI 0.9.0

Includes:
- Initialization changes to enable log filter customization. We now
  connect the Rust log level to the Swift log level, and always run
  other Rust initialization steps.
- Fetching the ZEC-USD exchange rate over Tor.

CHANGELOG.md

@@ -6,6 +6,11 @@ and this library adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # Unreleased
 
+## Added
+- `Synchronizer.getExchangeRateUSD() -> NSDecimalNumber`, which fetches the latest USD/ZEC
+  exchange rate. Prices are queried over Tor (to hide the wallet's IP address) on Binance,
+  Coinbase, and Gemini.
+
 # 2.1.9 - 2024-06-05
 
 ## Fixed

Example/ZcashLightClientSample/ZcashLightClientSample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -176,8 +176,7 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/zcash-hackworks/zcash-light-client-ffi",
       "state" : {
-        "revision" : "9314c83d7a09d88e1c0bd3ff3738a50833325059",
-        "version" : "0.8.0"
+        "revision" : "5919afaa2c37fa11946d43b5c1e66b8463867f98"
       }
     }
   ],

Example/ZcashLightClientSample/ZcashLightClientSample/AppDelegate.swift

@@ -48,12 +48,12 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                 fsBlockDbRoot: try! fsBlockDbRootURLHelper(),
                 generalStorageURL: try! generalStorageURLHelper(),
                 dataDbURL: try! dataDbURLHelper(),
+                torDirURL: try! torDirURLHelper(),
                 endpoint: DemoAppConfig.endpoint,
                 network: kZcashNetwork,
                 spendParamsURL: try! spendParamsURLHelper(),
                 outputParamsURL: try! outputParamsURLHelper(),
-                saplingParamsSourceURL: SaplingParamsSourceURL.default,
-                enableBackendTracing: true
+                saplingParamsSourceURL: SaplingParamsSourceURL.default
             )
 
             self.wallet = wallet
@@ -199,6 +199,15 @@ func dataDbURLHelper() throws -> URL {
         )
 }
 
+func torDirURLHelper() throws -> URL {
+    try documentsDirectoryHelper()
+        .appendingPathComponent(kZcashNetwork.networkType.chainName)
+        .appendingPathComponent(
+            ZcashSDK.defaultTorDirName,
+            isDirectory: true
+        )
+}
+
 func spendParamsURLHelper() throws -> URL {
     try documentsDirectoryHelper().appendingPathComponent("sapling-spend.params")
 }

Example/ZcashLightClientSample/ZcashLightClientSample/Get Balance/GetBalanceViewController.swift

@@ -19,10 +19,14 @@ class GetBalanceViewController: UIViewController {
         self.title = "Account 0 Balance"
 
         Task { @MainActor in
-            let balanceText = (try? await synchronizer.getAccountBalance()?.saplingBalance.total().formattedString) ?? "0.0"
-            let verifiedText = (try? await synchronizer.getAccountBalance()?.saplingBalance.spendableValue.formattedString) ?? "0.0"
-            self.balance.text = "\(balanceText) ZEC"
-            self.verified.text = "\(verifiedText) ZEC"
+            let balance = try? await synchronizer.getAccountBalance()
+            let balanceText = (balance?.saplingBalance.total().formattedString) ?? "0.0"
+            let verifiedText = (balance?.saplingBalance.spendableValue.formattedString) ?? "0.0"
+            let usdZecRate = try await synchronizer.getExchangeRateUSD()
+            let usdBalance = (balance?.saplingBalance.total().decimalValue ?? 0).multiplying(by: usdZecRate)
+            let usdVerified = (balance?.saplingBalance.spendableValue.decimalValue ?? 0).multiplying(by: usdZecRate)
+            self.balance.text = "\(balanceText) ZEC\n\(usdBalance) USD\n\n(\(usdZecRate) USD/ZEC)"
+            self.verified.text = "\(verifiedText) ZEC\n\(usdVerified) USD"
         }
     }
 }

Example/ZcashLightClientSample/ZcashLightClientSample/Sync Blocks/SyncBlocksListViewController.swift

@@ -102,14 +102,14 @@ class SyncBlocksListViewController: UIViewController {
             fsBlockDbRoot: try! fsBlockDbRootURLHelper(),
             generalStorageURL: try! generalStorageURLHelper(),
             dataDbURL: try! dataDbURLHelper(),
+            torDirURL: try! torDirURLHelper(),
             endpoint: DemoAppConfig.endpoint,
             network: kZcashNetwork,
             spendParamsURL: try! spendParamsURLHelper(),
             outputParamsURL: try! outputParamsURLHelper(),
             saplingParamsSourceURL: SaplingParamsSourceURL.default,
             alias: data.alias,
-            loggingPolicy: .default(.debug),
-            enableBackendTracing: true
+            loggingPolicy: .default(.debug)
         )
 
         return SDKSynchronizer(initializer: initializer)

Package.resolved

@@ -122,8 +122,7 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/zcash-hackworks/zcash-light-client-ffi",
       "state" : {
-        "revision" : "9314c83d7a09d88e1c0bd3ff3738a50833325059",
-        "version" : "0.8.0"
+        "revision" : "5919afaa2c37fa11946d43b5c1e66b8463867f98"
       }
     }
   ],

Package.swift

@@ -16,7 +16,9 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/grpc/grpc-swift.git", from: "1.19.1"),
         .package(url: "https://github.com/stephencelis/SQLite.swift.git", from: "0.14.1"),
-        .package(url: "https://github.com/zcash-hackworks/zcash-light-client-ffi", exact: "0.8.0")
+        //.package(url: "https://github.com/zcash-hackworks/zcash-light-client-ffi", exact: "0.8.0")
+        // Compiled from 7c7b797211a7bd0b847df6315faa9ae13c32a0f6
+        .package(url: "https://github.com/zcash-hackworks/zcash-light-client-ffi", revision: "5919afaa2c37fa11946d43b5c1e66b8463867f98")
     ],
     targets: [
         .target(

Sources/ZcashLightClientKit/Block/CompactBlockProcessor.swift

@@ -56,6 +56,7 @@ actor CompactBlockProcessor {
         let saplingParamsSourceURL: SaplingParamsSourceURL
         let fsBlockCacheRoot: URL
         let dataDb: URL
+        let torDir: URL
         let spendParamsURL: URL
         let outputParamsURL: URL
         let enhanceBatchSize: Int
@@ -79,6 +80,7 @@ actor CompactBlockProcessor {
             cacheDbURL: URL? = nil,
             fsBlockCacheRoot: URL,
             dataDb: URL,
+            torDir: URL,
             spendParamsURL: URL,
             outputParamsURL: URL,
             saplingParamsSourceURL: SaplingParamsSourceURL,
@@ -94,6 +96,7 @@ actor CompactBlockProcessor {
             self.alias = alias
             self.fsBlockCacheRoot = fsBlockCacheRoot
             self.dataDb = dataDb
+            self.torDir = torDir
             self.spendParamsURL = spendParamsURL
             self.outputParamsURL = outputParamsURL
             self.saplingParamsSourceURL = saplingParamsSourceURL
@@ -112,6 +115,7 @@ actor CompactBlockProcessor {
             alias: ZcashSynchronizerAlias,
             fsBlockCacheRoot: URL,
             dataDb: URL,
+            torDir: URL,
             spendParamsURL: URL,
             outputParamsURL: URL,
             saplingParamsSourceURL: SaplingParamsSourceURL,
@@ -126,6 +130,7 @@ actor CompactBlockProcessor {
             self.alias = alias
             self.fsBlockCacheRoot = fsBlockCacheRoot
             self.dataDb = dataDb
+            self.torDir = torDir
             self.spendParamsURL = spendParamsURL
             self.outputParamsURL = outputParamsURL
             self.saplingParamsSourceURL = saplingParamsSourceURL
@@ -151,6 +156,7 @@ actor CompactBlockProcessor {
                 alias: initializer.alias,
                 fsBlockCacheRoot: initializer.fsBlockDbRoot,
                 dataDb: initializer.dataDbURL,
+                torDir: initializer.torDirURL,
                 spendParamsURL: initializer.spendParamsURL,
                 outputParamsURL: initializer.outputParamsURL,
                 saplingParamsSourceURL: initializer.saplingParamsSourceURL,

Sources/ZcashLightClientKit/ClosureSynchronizer.swift

@@ -128,7 +128,10 @@ public protocol ClosureSynchronizer {
     func refreshUTXOs(address: TransparentAddress, from height: BlockHeight, completion: @escaping (Result<RefreshedUTXOs, Error>) -> Void)
 
     func getAccountBalance(accountIndex: Int, completion: @escaping (Result<AccountBalance?, Error>) -> Void)
-
+
+    /// Fetches the latest ZEC-USD exchange rate.
+    func getExchangeRateUSD(completion: @escaping (Result<NSDecimalNumber, Error>) -> Void)
+
     /*
      It can be missleading that these two methods are returning Publisher even this protocol is closure based. Reason is that Synchronizer doesn't
      provide different implementations for these two methods. So Combine it is even here.

Sources/ZcashLightClientKit/CombineSynchronizer.swift

@@ -131,6 +131,9 @@ public protocol CombineSynchronizer {
 
     func getAccountBalance(accountIndex: Int) -> SinglePublisher<AccountBalance?, Error>
 
+    /// Fetches the latest ZEC-USD exchange rate.
+    func getExchangeRateUSD() -> SinglePublisher<NSDecimalNumber, Error>
+
     func rewind(_ policy: RewindPolicy) -> CompletablePublisher<Error>
     func wipe() -> CompletablePublisher<Error>
 }

Sources/ZcashLightClientKit/Constants/ZcashSDK.swift

@@ -124,6 +124,9 @@ public enum ZcashSDK {
     /// Default Name for LibRustZcash data.db
     public static let defaultDataDbName = "data.db"
 
+    /// Default Name for Tor data directory
+    public static let defaultTorDirName = "tor"
+
     /// Default Name for Compact Block file system based db
     public static let defaultFsCacheName = "fs_cache"
 
@@ -154,6 +157,9 @@ public protocol NetworkConstants {
     /// Default Name for LibRustZcash data.db
     static var defaultDataDbName: String { get }
 
+    /// Default Name for Tor data directory
+    static var defaultTorDirName: String { get }
+
     static var defaultFsBlockDbRootName: String { get }
 
     /// Default Name for Compact Block caches db
@@ -181,6 +187,9 @@ public enum ZcashSDKMainnetConstants: NetworkConstants {
     /// Default Name for LibRustZcash data.db
     public static let defaultDataDbName = "data.db"
 
+    /// Default Name for Tor data directory
+    public static let defaultTorDirName = "tor"
+
     public static let defaultFsBlockDbRootName = "fs_cache"
 
     /// Default Name for Compact Block caches db
@@ -197,6 +206,9 @@ public enum ZcashSDKTestnetConstants: NetworkConstants {
     /// Default Name for LibRustZcash data.db
     public static let defaultDataDbName = "data.db"
 
+    /// Default Name for Tor data directory
+    public static let defaultTorDirName = "tor"
+
     /// Default Name for Compact Block caches db
     public static let defaultCacheDbName = "caches.db"
 

Sources/ZcashLightClientKit/Error/Sourcery/generateErrorCode.sh

@@ -3,11 +3,11 @@
 scriptDir=${0:a:h}
 cd "${scriptDir}"
 
-sourcery_version=2.1.7
+sourcery_version=2.2.4
 
 if which sourcery >/dev/null; then
     if [[ $(sourcery --version) != $sourcery_version ]]; then
-        echo "warning: Compatible sourcer version not installed. Install sourcer $sourcery_version. Currently installed version is $(sourcer --version)"
+        echo "warning: Compatible sourcer version not installed. Install sourcer $sourcery_version. Currently installed version is $(sourcery --version)"
         exit 1
     fi
 

Sources/ZcashLightClientKit/Error/ZcashError.swift

@@ -1,4 +1,4 @@
-// Generated using Sourcery 2.1.7 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 2.2.4 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 /*
@@ -342,6 +342,16 @@ public enum ZcashError: Equatable, Error {
     /// sourcery: code="ZRUST0061"
     /// ZRUST0061
     case rustPutOrchardSubtreeRoots(_ rustError: String)
+    /// Error from rust layer when calling TorClient.init
+    /// - `rustError` contains error generated by the rust layer.
+    /// sourcery: code="ZRUST0062"
+    /// ZRUST0062
+    case rustTorClientInit(_ rustError: String)
+    /// Error from rust layer when calling TorClient.get
+    /// - `rustError` contains error generated by the rust layer.
+    /// sourcery: code="ZRUST0063"
+    /// ZRUST0063
+    case rustTorClientGet(_ rustError: String)
     /// SQLite query failed when fetching all accounts from the database.
     /// - `sqliteError` is error produced by SQLite library.
     /// ZADAO0001
@@ -705,6 +715,8 @@ public enum ZcashError: Equatable, Error {
         case .rustIsSeedRelevantToAnyDerivedAccount: return "Error from rust layer when calling ZcashRustBackend.rustIsSeedRelevantToAnyDerivedAccount"
         case .rustPutOrchardSubtreeRootsAllocationProblem: return "Unable to allocate memory required to write blocks when calling ZcashRustBackend.putOrchardSubtreeRoots"
         case .rustPutOrchardSubtreeRoots: return "Error from rust layer when calling ZcashRustBackend.putOrchardSubtreeRoots"
+        case .rustTorClientInit: return "Error from rust layer when calling TorClient.init"
+        case .rustTorClientGet: return "Error from rust layer when calling TorClient.get"
         case .accountDAOGetAll: return "SQLite query failed when fetching all accounts from the database."
         case .accountDAOGetAllCantDecode: return "Fetched accounts from SQLite but can't decode them."
         case .accountDAOFindBy: return "SQLite query failed when seaching for accounts in the database."
@@ -885,6 +897,8 @@ public enum ZcashError: Equatable, Error {
         case .rustIsSeedRelevantToAnyDerivedAccount: return .rustIsSeedRelevantToAnyDerivedAccount
         case .rustPutOrchardSubtreeRootsAllocationProblem: return .rustPutOrchardSubtreeRootsAllocationProblem
         case .rustPutOrchardSubtreeRoots: return .rustPutOrchardSubtreeRoots
+        case .rustTorClientInit: return .rustTorClientInit
+        case .rustTorClientGet: return .rustTorClientGet
         case .accountDAOGetAll: return .accountDAOGetAll
         case .accountDAOGetAllCantDecode: return .accountDAOGetAllCantDecode
         case .accountDAOFindBy: return .accountDAOFindBy

Sources/ZcashLightClientKit/Error/ZcashErrorCode.swift

@@ -1,4 +1,4 @@
-// Generated using Sourcery 2.1.7 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 2.2.4 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 /*
@@ -185,6 +185,10 @@ public enum ZcashErrorCode: String {
     case rustPutOrchardSubtreeRootsAllocationProblem = "ZRUST0060"
     /// Error from rust layer when calling ZcashRustBackend.putOrchardSubtreeRoots
     case rustPutOrchardSubtreeRoots = "ZRUST0061"
+    /// Error from rust layer when calling TorClient.init
+    case rustTorClientInit = "ZRUST0062"
+    /// Error from rust layer when calling TorClient.get
+    case rustTorClientGet = "ZRUST0063"
     /// SQLite query failed when fetching all accounts from the database.
     case accountDAOGetAll = "ZADAO0001"
     /// Fetched accounts from SQLite but can't decode them.

Sources/ZcashLightClientKit/Error/ZcashErrorCodeDefinition.swift

@@ -367,6 +367,14 @@ enum ZcashErrorDefinition {
     /// - `rustError` contains error generated by the rust layer.
     /// sourcery: code="ZRUST0061"
     case rustPutOrchardSubtreeRoots(_ rustError: String)
+    /// Error from rust layer when calling TorClient.init
+    /// - `rustError` contains error generated by the rust layer.
+    /// sourcery: code="ZRUST0062"
+    case rustTorClientInit(_ rustError: String)
+    /// Error from rust layer when calling TorClient.get
+    /// - `rustError` contains error generated by the rust layer.
+    /// sourcery: code="ZRUST0063"
+    case rustTorClientGet(_ rustError: String)
 
     // MARK: - Account DAO