Fix witness per version call

- The fix witness addressing note commitment tree bug API is called each version

CHANGELOG.md

@@ -6,6 +6,10 @@ and this library adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # Unreleased
 
+## Fixed
+- Adopted `zcashlc_fix_witnesses` for the note commitment tree fix.
+- Transparent gap limit handling. SDK can find all transparent funds and shield them. This has been tested to successfully recover Ledger funds.
+
 # 2.2.9 - 2025-03-06
 
 ## Added

Example/ZcashLightClientSample/ZcashLightClientSample.xcodeproj/project.pbxproj

@@ -734,6 +734,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_STYLE = Automatic;
+				CURRENT_PROJECT_VERSION = 3;
 				ENABLE_BITCODE = NO;
 				"EXCLUDED_ARCHS[sdk=iphonesimulator*]" = "$(inherited)";
 				INFOPLIST_FILE = ZcashLightClientSample/Info.plist;
@@ -742,6 +743,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
+				MARKETING_VERSION = 0.1.2;
 				OTHER_SWIFT_FLAGS = "$(inherited)";
 				PRODUCT_BUNDLE_IDENTIFIER = "co.electriccoin.ZcashLightClientSample-Testnet";
 				PRODUCT_MODULE_NAME = ZcashLightClientSample;
@@ -756,6 +758,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_STYLE = Automatic;
+				CURRENT_PROJECT_VERSION = 3;
 				ENABLE_BITCODE = NO;
 				"EXCLUDED_ARCHS[sdk=iphonesimulator*]" = "$(inherited)";
 				INFOPLIST_FILE = ZcashLightClientSample/Info.plist;
@@ -764,6 +767,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
+				MARKETING_VERSION = 0.1.2;
 				OTHER_SWIFT_FLAGS = "$(inherited)";
 				PRODUCT_BUNDLE_IDENTIFIER = "co.electriccoin.ZcashLightClientSample-Testnet";
 				PRODUCT_MODULE_NAME = ZcashLightClientSample;

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

@@ -176,8 +176,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/Electric-Coin-Company/zcash-light-client-ffi",
       "state" : {
-        "branch" : "preview/feature/transparent_gap_limit_handling",
-        "revision" : "be84ad9c2ed99432fd964902fe3f31af29a81448"
+        "branch" : "preview/feature/note_commitment_tree_fix",
+        "revision" : "c6cfebbdecaef25c53082ad536a1eed33489401a"
       }
     }
   ],

Example/ZcashLightClientSample/ZcashLightClientSample/Info.plist

@@ -15,9 +15,9 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0</string>
+	<string>0.1.2</string>
 	<key>CFBundleVersion</key>
-	<string>1</string>
+	<string>5</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>NSAppTransportSecurity</key>

Package.swift

@@ -17,7 +17,7 @@ let package = Package(
         .package(url: "https://github.com/grpc/grpc-swift.git", from: "1.24.2"),
         .package(url: "https://github.com/stephencelis/SQLite.swift.git", from: "0.15.3"),
 //        .package(url: "https://github.com/Electric-Coin-Company/zcash-light-client-ffi", exact: "0.13.0")
-        .package(url: "https://github.com/Electric-Coin-Company/zcash-light-client-ffi", branch: "preview/feature/transparent_gap_limit_handling")
+        .package(url: "https://github.com/Electric-Coin-Company/zcash-light-client-ffi", branch: "preview/feature/note_commitment_tree_fix")
     ],
     targets: [
         .target(

Sources/ZcashLightClientKit/Rust/ZcashRustBackend.swift

@@ -1130,6 +1130,11 @@ struct ZcashRustBackend: ZcashRustBackendWelding {
             transactionStatus
         )
     }
+    
+    @DBActor
+    func fixWitnesses() async {
+        zcashlc_fix_witnesses(dbData.0, dbData.1, networkType.networkId)
+    }
 }
 
 private extension ZcashRustBackend {

Sources/ZcashLightClientKit/Rust/ZcashRustBackendWelding.swift

@@ -379,4 +379,8 @@ protocol ZcashRustBackendWelding {
     /// scanning; as a consequence, the wallet must actively query to determine whether such
     /// transactions have been mined.
     func setTransactionStatus(txId: Data, status: TransactionStatus) async throws
+    
+    /// Fix witnesses - addressing note commitment tree bug.
+    /// This function is supposed to be called occasionaly. It's handled by the SDK Synchronizer and called only once per version.
+    func fixWitnesses() async
 }

Sources/ZcashLightClientKit/Synchronizer/SDKSynchronizer.swift

@@ -12,6 +12,10 @@ import Combine
 /// Synchronizer implementation for UIKit and iOS 13+
 // swiftlint:disable type_body_length
 public class SDKSynchronizer: Synchronizer {
+    private enum Constants {
+        static let fixWitnessesLastVersionCall = "ud_fixWitnessesLastVersionCall"
+    }
+    
     public var alias: ZcashSynchronizerAlias { initializer.alias }
 
     private lazy var streamsUpdateQueue = { DispatchQueue(label: "streamsUpdateQueue_\(initializer.alias.description)") }()
@@ -150,6 +154,8 @@ public class SDKSynchronizer: Synchronizer {
         
         await updateStatus(.disconnected, updateExternalStatus: false)
 
+        await resolveWitnessesFix()
+        
         return .success
     }
 
@@ -189,6 +195,24 @@ public class SDKSynchronizer: Synchronizer {
         }
     }
 
+    // MARK: Witnesses Fix
+    
+    private func resolveWitnessesFix() async {
+        let appVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? ""
+        
+        guard let lastVersionCall = UserDefaults.standard.object(forKey: Constants.fixWitnessesLastVersionCall) as? String else {
+            UserDefaults.standard.set(appVersion, forKey: Constants.fixWitnessesLastVersionCall)
+            await initializer.rustBackend.fixWitnesses()
+            return
+        }
+        
+        guard lastVersionCall < appVersion else {
+            return
+        }
+
+        await initializer.rustBackend.fixWitnesses()
+    }
+
     // MARK: Connectivity State
 
     func connectivityStateChanged(oldState: ConnectionState, newState: ConnectionState) {