Migrate to first preview of FFI 0.13.0

CHANGELOG.md

@@ -6,6 +6,10 @@ and this library adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # Unreleased
 
+## Added
+- `SDKSynchronizer.redactPCZTForSigner`: Decrease the size of a PCZT for sending to a signer.
+- `SDKSynchronizer.PCZTRequiresSaplingProofs`: Check whether the Sapling parameters are required for a given PCZT.
+
 # 2.2.8 - 2025-01-10
 
 ## Added

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

@@ -176,8 +176,7 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/Electric-Coin-Company/zcash-light-client-ffi",
       "state" : {
-        "revision" : "11b0db058288b12ada9c5a95ed56f17f82d2868f",
-        "version" : "0.12.0"
+        "revision" : "8e7f8207b5f225cfe6b1e5cbc096fcd24b96776b"
       }
     }
   ],

Package.resolved

@@ -122,8 +122,7 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/Electric-Coin-Company/zcash-light-client-ffi",
       "state" : {
-        "revision" : "11b0db058288b12ada9c5a95ed56f17f82d2868f",
-        "version" : "0.12.0"
+        "revision" : "8e7f8207b5f225cfe6b1e5cbc096fcd24b96776b"
       }
     }
   ],

Package.swift

@@ -16,7 +16,8 @@ let package = Package(
     dependencies: [
         .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.12.0")
+        // Built from 8857a52de5ceddfbf12d3d843c0b68aafab10378
+        .package(url: "https://github.com/Electric-Coin-Company/zcash-light-client-ffi", revision: "8e7f8207b5f225cfe6b1e5cbc096fcd24b96776b")
     ],
     targets: [
         .target(

Sources/ZcashLightClientKit/ClosureSynchronizer.swift

@@ -100,7 +100,17 @@ public protocol ClosureSynchronizer {
         proposal: Proposal,
         completion: @escaping (Result<Pczt, Error>) -> Void
     )
-    
+
+    func redactPCZTForSigner(
+        pczt: Pczt,
+        completion: @escaping (Result<Pczt, Error>) -> Void
+    )
+
+    func PCZTRequiresSaplingProofs(
+        pczt: Pczt,
+        completion: @escaping (Bool) -> Void
+    )
+
     func addProofsToPCZT(
         pczt: Pczt,
         completion: @escaping (Result<Pczt, Error>) -> Void

Sources/ZcashLightClientKit/CombineSynchronizer.swift

@@ -96,6 +96,14 @@ public protocol CombineSynchronizer {
         proposal: Proposal
     ) -> SinglePublisher<Pczt, Error>
 
+    func redactPCZTForSigner(
+        pczt: Pczt
+    ) -> SinglePublisher<Pczt, Error>
+
+    func PCZTRequiresSaplingProofs(
+        pczt: Pczt
+    ) -> SinglePublisher<Bool, Never>
+
     func addProofsToPCZT(
         pczt: Pczt
     ) -> SinglePublisher<Pczt, Error>

Sources/ZcashLightClientKit/Error/ZcashError.swift

@@ -392,6 +392,10 @@ public enum ZcashError: Equatable, Error {
     /// - `rustError` contains error generated by the rust layer.
     /// ZRUST0073
     case rustTxidPtrIncorrectLength(_ rustError: String)
+    /// Error from rust layer when calling ZcashRustBackend.redactPCZTForSigner
+    /// - `rustError` contains error generated by the rust layer.
+    /// ZRUST0074
+    case rustRedactPCZTForSigner(_ rustError: String)
     /// SQLite query failed when fetching all accounts from the database.
     /// - `sqliteError` is error produced by SQLite library.
     /// ZADAO0001
@@ -767,6 +771,7 @@ public enum ZcashError: Equatable, Error {
         case .rustExtractAndStoreTxFromPCZT: return "Error from rust layer when calling ZcashRustBackend.extractAndStoreTxFromPCZT"
         case .rustUUIDAccountNotFound: return "Error from rust layer when calling ZcashRustBackend.getAccount"
         case .rustTxidPtrIncorrectLength: return "Error from rust layer when calling ZcashRustBackend.extractAndStoreTxFromPCZT"
+        case .rustRedactPCZTForSigner: return "Error from rust layer when calling ZcashRustBackend.redactPCZTForSigner"
         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."
@@ -959,6 +964,7 @@ public enum ZcashError: Equatable, Error {
         case .rustExtractAndStoreTxFromPCZT: return .rustExtractAndStoreTxFromPCZT
         case .rustUUIDAccountNotFound: return .rustUUIDAccountNotFound
         case .rustTxidPtrIncorrectLength: return .rustTxidPtrIncorrectLength
+        case .rustRedactPCZTForSigner: return .rustRedactPCZTForSigner
         case .accountDAOGetAll: return .accountDAOGetAll
         case .accountDAOGetAllCantDecode: return .accountDAOGetAllCantDecode
         case .accountDAOFindBy: return .accountDAOFindBy

Sources/ZcashLightClientKit/Error/ZcashErrorCode.swift

@@ -209,6 +209,8 @@ public enum ZcashErrorCode: String {
     case rustUUIDAccountNotFound = "ZRUST0072"
     /// Error from rust layer when calling ZcashRustBackend.extractAndStoreTxFromPCZT
     case rustTxidPtrIncorrectLength = "ZRUST0073"
+    /// Error from rust layer when calling ZcashRustBackend.redactPCZTForSigner
+    case rustRedactPCZTForSigner = "ZRUST0074"
     /// 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

@@ -414,6 +414,10 @@ enum ZcashErrorDefinition {
     /// - `rustError` contains error generated by the rust layer.
     // sourcery: code="ZRUST0073"
     case rustTxidPtrIncorrectLength(_ rustError: String)
+    /// Error from rust layer when calling ZcashRustBackend.redactPCZTForSigner
+    /// - `rustError` contains error generated by the rust layer.
+    // sourcery: code="ZRUST0074"
+    case rustRedactPCZTForSigner(_ rustError: String)
 
     // MARK: - Account DAO
 

Sources/ZcashLightClientKit/Rust/ZcashRustBackend.swift

@@ -325,7 +325,48 @@ struct ZcashRustBackend: ZcashRustBackendWelding {
             count: Int(pcztPtr.pointee.len)
         )
     }
-    
+
+    @DBActor
+    func redactPCZTForSigner(pczt: Pczt) async throws -> Pczt {
+        let pcztPtr: UnsafeMutablePointer<FfiBoxedSlice>? = pczt.withUnsafeBytes { buffer in
+            guard let bufferPtr = buffer.baseAddress?.assumingMemoryBound(to: UInt8.self) else {
+                return nil
+            }
+
+            return zcashlc_redact_pczt_for_signer(
+                bufferPtr,
+                UInt(pczt.count)
+            )
+        }
+
+        guard let pcztPtr else {
+            throw ZcashError.rustRedactPCZTForSigner(lastErrorMessage(fallback: "`redactPCZTForSigner` failed with unknown error"))
+        }
+
+        defer { zcashlc_free_boxed_slice(pcztPtr) }
+
+        return Pczt(
+            bytes: pcztPtr.pointee.ptr,
+            count: Int(pcztPtr.pointee.len)
+        )
+    }
+
+    @DBActor
+    func PCZTRequiresSaplingProofs(pczt: Pczt) async -> Bool {
+        return pczt.withUnsafeBytes { buffer in
+            guard let bufferPtr = buffer.baseAddress?.assumingMemoryBound(to: UInt8.self) else {
+                // Return `false` here so the caller proceeds to `addProofsToPCZT` and
+                // gets the same error.
+                return false
+            }
+
+            return zcashlc_pczt_requires_sapling_proofs(
+                bufferPtr,
+                UInt(pczt.count)
+            )
+        }
+    }
+
     @DBActor
     func addProofsToPCZT(
         pczt: Pczt

Sources/ZcashLightClientKit/Rust/ZcashRustBackendWelding.swift

@@ -303,7 +303,23 @@ protocol ZcashRustBackendWelding {
     ///
     /// - Throws rustCreatePCZTFromProposal as a common indicator of the operation failure
     func createPCZTFromProposal(accountUUID: AccountUUID, proposal: FfiProposal) async throws -> Pczt
-    
+
+    /// Redacts information from the given PCZT that is unnecessary for the Signer role.
+    ///
+    /// - Parameter pczt: The partially created transaction in its serialized format.
+    ///
+    /// - Returns The updated PCZT in its serialized format.
+    ///
+    /// - Throws  rustRedactPCZTForSigner as a common indicator of the operation failure
+    func redactPCZTForSigner(pczt: Pczt) async throws -> Pczt
+
+    /// Checks whether the caller needs to have downloaded the Sapling parameters.
+    ///
+    /// - Parameter pczt: The partially created transaction in its serialized format.
+    ///
+    /// - Returns `true` if this PCZT requires Sapling proofs.
+    func PCZTRequiresSaplingProofs(pczt: Pczt) async -> Bool
+
     /// Adds proofs to the given PCZT.
     ///
     /// - Parameter pczt: The partially created transaction in its serialized format.

Sources/ZcashLightClientKit/Synchronizer.swift

@@ -239,6 +239,22 @@ public protocol Synchronizer: AnyObject {
     /// - Throws rustCreatePCZTFromProposal as a common indicator of the operation failure
     func createPCZTFromProposal(accountUUID: AccountUUID, proposal: Proposal) async throws -> Pczt
 
+    /// Redacts information from the given PCZT that is unnecessary for the Signer role.
+    ///
+    /// - Parameter pczt: The partially created transaction in its serialized format.
+    ///
+    /// - Returns The updated PCZT in its serialized format.
+    ///
+    /// - Throws  rustRedactPCZTForSigner as a common indicator of the operation failure
+    func redactPCZTForSigner(pczt: Pczt) async throws -> Pczt
+
+    /// Checks whether the caller needs to have downloaded the Sapling parameters.
+    ///
+    /// - Parameter pczt: The partially created transaction in its serialized format.
+    ///
+    /// - Returns `true` if this PCZT requires Sapling proofs.
+    func PCZTRequiresSaplingProofs(pczt: Pczt) async -> Bool
+
     /// Adds proofs to the given PCZT.
     ///
     /// - Parameter pczt: The partially created transaction in its serialized format.

Sources/ZcashLightClientKit/Synchronizer/ClosureSDKSynchronizer.swift

@@ -155,6 +155,24 @@ extension ClosureSDKSynchronizer: ClosureSynchronizer {
         }
     }
 
+    public func redactPCZTForSigner(
+        pczt: Pczt,
+        completion: @escaping (Result<Pczt, Error>) -> Void
+    ) {
+        AsyncToClosureGateway.executeThrowingAction(completion) {
+            try await self.synchronizer.redactPCZTForSigner(pczt: pczt)
+        }
+    }
+
+    public func PCZTRequiresSaplingProofs(
+        pczt: Pczt,
+        completion: @escaping (Bool) -> Void
+    ) {
+        AsyncToClosureGateway.executeAction(completion) {
+            await self.synchronizer.PCZTRequiresSaplingProofs(pczt: pczt)
+        }
+    }
+
     public func addProofsToPCZT(
         pczt: Pczt,
         completion: @escaping (Result<Pczt, Error>) -> Void

Sources/ZcashLightClientKit/Synchronizer/CombineSDKSynchronizer.swift

@@ -134,6 +134,22 @@ extension CombineSDKSynchronizer: CombineSynchronizer {
         }
     }
 
+    public func redactPCZTForSigner(
+        pczt: Pczt
+    ) -> SinglePublisher<Pczt, Error> {
+        AsyncToCombineGateway.executeThrowingAction() {
+            try await self.synchronizer.redactPCZTForSigner(pczt: pczt)
+        }
+    }
+
+    public func PCZTRequiresSaplingProofs(
+        pczt: Pczt
+    ) -> SinglePublisher<Bool, Never> {
+        AsyncToCombineGateway.executeAction() {
+            await self.synchronizer.PCZTRequiresSaplingProofs(pczt: pczt)
+        }
+    }
+
     public func addProofsToPCZT(
         pczt: Pczt
     ) -> SinglePublisher<Pczt, Error> {

Sources/ZcashLightClientKit/Synchronizer/SDKSynchronizer.swift

@@ -407,7 +407,19 @@ public class SDKSynchronizer: Synchronizer {
             proposal: proposal.inner
         )
     }
-    
+
+    public func redactPCZTForSigner(pczt: Pczt) async throws -> Pczt {
+        try await initializer.rustBackend.redactPCZTForSigner(
+            pczt: pczt
+        )
+    }
+
+    public func PCZTRequiresSaplingProofs(pczt: Pczt) async -> Bool {
+        await initializer.rustBackend.PCZTRequiresSaplingProofs(
+            pczt: pczt
+        )
+    }
+
     public func addProofsToPCZT(pczt: Pczt) async throws -> Pczt {
         try await initializer.rustBackend.addProofsToPCZT(
             pczt: pczt

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

@@ -1596,6 +1596,50 @@ class SynchronizerMock: Synchronizer {
         }
     }
 
+    // MARK: - redactPCZTForSigner
+
+    var redactPCZTForSignerPcztThrowableError: Error?
+    var redactPCZTForSignerPcztCallsCount = 0
+    var redactPCZTForSignerPcztCalled: Bool {
+        return redactPCZTForSignerPcztCallsCount > 0
+    }
+    var redactPCZTForSignerPcztReceivedPczt: Pczt?
+    var redactPCZTForSignerPcztReturnValue: Pczt!
+    var redactPCZTForSignerPcztClosure: ((Pczt) async throws -> Pczt)?
+
+    func redactPCZTForSigner(pczt: Pczt) async throws -> Pczt {
+        if let error = redactPCZTForSignerPcztThrowableError {
+            throw error
+        }
+        redactPCZTForSignerPcztCallsCount += 1
+        redactPCZTForSignerPcztReceivedPczt = pczt
+        if let closure = redactPCZTForSignerPcztClosure {
+            return try await closure(pczt)
+        } else {
+            return redactPCZTForSignerPcztReturnValue
+        }
+    }
+
+    // MARK: - PCZTRequiresSaplingProofs
+
+    var pcztRequiresSaplingProofsPcztCallsCount = 0
+    var pcztRequiresSaplingProofsPcztCalled: Bool {
+        return pcztRequiresSaplingProofsPcztCallsCount > 0
+    }
+    var pcztRequiresSaplingProofsPcztReceivedPczt: Pczt?
+    var pcztRequiresSaplingProofsPcztReturnValue: Bool!
+    var pcztRequiresSaplingProofsPcztClosure: ((Pczt) async -> Bool)?
+
+    func PCZTRequiresSaplingProofs(pczt: Pczt) async -> Bool {
+        pcztRequiresSaplingProofsPcztCallsCount += 1
+        pcztRequiresSaplingProofsPcztReceivedPczt = pczt
+        if let closure = pcztRequiresSaplingProofsPcztClosure {
+            return await closure(pczt)
+        } else {
+            return pcztRequiresSaplingProofsPcztReturnValue
+        }
+    }
+
     // MARK: - addProofsToPCZT
 
     var addProofsToPCZTPcztThrowableError: Error?
@@ -3118,6 +3162,50 @@ class ZcashRustBackendWeldingMock: ZcashRustBackendWelding {
         }
     }
 
+    // MARK: - redactPCZTForSigner
+
+    var redactPCZTForSignerPcztThrowableError: Error?
+    var redactPCZTForSignerPcztCallsCount = 0
+    var redactPCZTForSignerPcztCalled: Bool {
+        return redactPCZTForSignerPcztCallsCount > 0
+    }
+    var redactPCZTForSignerPcztReceivedPczt: Pczt?
+    var redactPCZTForSignerPcztReturnValue: Pczt!
+    var redactPCZTForSignerPcztClosure: ((Pczt) async throws -> Pczt)?
+
+    func redactPCZTForSigner(pczt: Pczt) async throws -> Pczt {
+        if let error = redactPCZTForSignerPcztThrowableError {
+            throw error
+        }
+        redactPCZTForSignerPcztCallsCount += 1
+        redactPCZTForSignerPcztReceivedPczt = pczt
+        if let closure = redactPCZTForSignerPcztClosure {
+            return try await closure(pczt)
+        } else {
+            return redactPCZTForSignerPcztReturnValue
+        }
+    }
+
+    // MARK: - PCZTRequiresSaplingProofs
+
+    var pcztRequiresSaplingProofsPcztCallsCount = 0
+    var pcztRequiresSaplingProofsPcztCalled: Bool {
+        return pcztRequiresSaplingProofsPcztCallsCount > 0
+    }
+    var pcztRequiresSaplingProofsPcztReceivedPczt: Pczt?
+    var pcztRequiresSaplingProofsPcztReturnValue: Bool!
+    var pcztRequiresSaplingProofsPcztClosure: ((Pczt) async -> Bool)?
+
+    func PCZTRequiresSaplingProofs(pczt: Pczt) async -> Bool {
+        pcztRequiresSaplingProofsPcztCallsCount += 1
+        pcztRequiresSaplingProofsPcztReceivedPczt = pczt
+        if let closure = pcztRequiresSaplingProofsPcztClosure {
+            return await closure(pczt)
+        } else {
+            return pcztRequiresSaplingProofsPcztReturnValue
+        }
+    }
+
     // MARK: - addProofsToPCZT
 
     var addProofsToPCZTPcztThrowableError: Error?