[Electric-Coin-Company#1092] Adopt proposal API

- TCA sdkSYnchronizer dependency extended with 3 new Proposal APIs - proposeTransfer tested, works as expected [Electric-Coin-Company#1092] Adopt proposal API - send transaction via new proposal API implemented [Electric-Coin-Company#1092] Adopt proposal API - code cleaned up and finished [Electric-Coin-Company#1092] Adopt proposal API - unit tests fixed [Electric-Coin-Company#1092] Adopt proposal API - Typical Fee < 0.001 localized and updated in the UI [Electric-Coin-Company#1092] Adopt proposal API - awaiting all transaction results with use of new proposal.transactionCount() method [Electric-Coin-Company#1092] Adopt proposal API - Implemented new PartialProposalError reducer and view - Contact support mail with transaction IDs logic implemented - Fallback to share logic implemented - PPE integrated into SendFlow - PPE integrated into Shielding [Electric-Coin-Company#1092] Adopt proposal API - Changelog updated [Electric-Coin-Company#1092] Adopt proposal API - SDK's fee constant removed [Electric-Coin-Company#1092] Adopt proposal API (Electric-Coin-Company#1117) - debug code reverted [Electric-Coin-Company#1092] Adopt proposal API (Electric-Coin-Company#1117) - copy change [Electric-Coin-Company#1092] Adopt proposal API (Electric-Coin-Company#1117) - code cleanup [Electric-Coin-Company#1092] Adopt proposal API (Electric-Coin-Company#1117) - proposed total fee [Electric-Coin-Company#1092] Adopt proposal API (Electric-Coin-Company#1117) - Final copy
LukasKorba · Mar 19, 2024 · 7febbd5 · 7febbd5
1 parent d3adf88
commit 7febbd5
Show file tree

Hide file tree

Showing 29 changed files with 685 additions and 143 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ directly impact users rather than highlighting other crucial architectural updat
 ## [Unreleased]
 
 ### Added
+- Proposal API integrated with error handling for multi-transaction Proposals.
 - Privacy info manifest.
 
 ### Fixed

diff --git a/modules/Package.swift b/modules/Package.swift
@@ -33,6 +33,7 @@ let package = Package(
         .library(name: "Models", targets: ["Models"]),
         .library(name: "NumberFormatter", targets: ["NumberFormatter"]),
         .library(name: "OnboardingFlow", targets: ["OnboardingFlow"]),
+        .library(name: "PartialProposalError", targets: ["PartialProposalError"]),
         .library(name: "Pasteboard", targets: ["Pasteboard"]),
         .library(name: "PrivateDataConsent", targets: ["PrivateDataConsent"]),
         .library(name: "RecoveryPhraseDisplay", targets: ["RecoveryPhraseDisplay"]),
@@ -67,7 +68,7 @@ let package = Package(
         .package(url: "https://github.com/pointfreeco/swift-case-paths", from: "1.1.0"),
         .package(url: "https://github.com/pointfreeco/swift-url-routing", from: "0.6.0"),
         .package(url: "https://github.com/zcash-hackworks/MnemonicSwift", from: "2.2.4"),
-        .package(url: "https://github.com/zcash/ZcashLightClientKit", from: "2.0.10"),
+        .package(url: "https://github.com/zcash/ZcashLightClientKit", from: "2.0.11"),
         .package(url: "https://github.com/firebase/firebase-ios-sdk", from: "10.17.0")
     ],
     targets: [
@@ -106,6 +107,7 @@ let package = Package(
                 "MnemonicClient",
                 "Models",
                 "NumberFormatter",
+                "PartialProposalError",
                 "RestoreWalletStorage",
                 "SDKSynchronizer",
                 "SyncProgress",
@@ -305,6 +307,17 @@ let package = Package(
             ],
             path: "Sources/Features/OnboardingFlow"
         ),
+        .target(
+            name: "PartialProposalError",
+            dependencies: [
+                "Generated",
+                "SupportDataGenerator",
+                "UIComponents",
+                "Utils",
+                .product(name: "ComposableArchitecture", package: "swift-composable-architecture")
+            ],
+            path: "Sources/Features/PartialProposalError"
+        ),
         .target(
             name: "Pasteboard",
             dependencies: [
@@ -462,6 +475,7 @@ let package = Package(
                 "DerivationTool",
                 "MnemonicClient",
                 "Models",
+                "PartialProposalError",
                 "Scan",
                 "SDKSynchronizer",
                 "UIComponents",

diff --git a/modules/Sources/Dependencies/SDKSynchronizer/SDKSynchronizerInterface.swift b/modules/Sources/Dependencies/SDKSynchronizer/SDKSynchronizerInterface.swift
@@ -19,6 +19,12 @@ extension DependencyValues {
 }
 
 public struct SDKSynchronizerClient {
+    public enum CreateProposedTransactionsResult: Equatable {
+        case failure
+        case partial(txIds: [String])
+        case success
+    }
+
     public let stateStream: () -> AnyPublisher<SynchronizerState, Never>
     public let eventStream: () -> AnyPublisher<SynchronizerEvent, Never>
     public let latestState: () -> SynchronizerState
@@ -43,4 +49,9 @@ public struct SDKSynchronizerClient {
     public var wipe: () -> AnyPublisher<Void, Error>?
 
     public var switchToEndpoint: (LightWalletEndpoint) async throws -> Void
+
+    // Proposals
+    public var proposeTransfer: (Int, Recipient, Zatoshi, Memo?) async throws -> Proposal
+    public var createProposedTransactions: (Proposal, UnifiedSpendingKey) async throws -> CreateProposedTransactionsResult
+    public var proposeShielding: (Int, Zatoshi, Memo, TransparentAddress?) async throws -> Proposal?
 }
diff --git a/modules/Sources/Dependencies/SDKSynchronizer/SDKSynchronizerLive.swift b/modules/Sources/Dependencies/SDKSynchronizer/SDKSynchronizerLive.swift
@@ -116,6 +116,58 @@ extension SDKSynchronizerClient: DependencyKey {
             wipe: { synchronizer.wipe() },
             switchToEndpoint: { endpoint in
                 try await synchronizer.switchTo(endpoint: endpoint)
+            },
+            proposeTransfer: { accountIndex, recipient, amount, memo in
+                try await synchronizer.proposeTransfer(
+                    accountIndex: accountIndex,
+                    recipient: recipient,
+                    amount: amount,
+                    memo: memo
+                )
+            },
+            createProposedTransactions: { proposal, spendingKey in
+                let stream = try await synchronizer.createProposedTransactions(
+                    proposal: proposal,
+                    spendingKey: spendingKey
+                )
+
+                let transactionCount = proposal.transactionCount()
+                var successCount = 0
+                var iterator = stream.makeAsyncIterator()
+
+                var txIds: [String] = []
+
+                for _ in 1...transactionCount {
+                    if let transactionSubmitResult = try await iterator.next() {
+                        switch transactionSubmitResult {
+                        case .success(txId: let id):
+                            successCount += 1
+                            txIds.append(id.toHexStringTxId())
+                        case .grpcFailure(txId: let id, error: _):
+                            txIds.append(id.toHexStringTxId())
+                        case .submitFailure(txId: let id, code: _, description: _):
+                            txIds.append(id.toHexStringTxId())
+                        case .notAttempted(txId: let id):
+                            txIds.append(id.toHexStringTxId())
+                        }
+                    }
+                }
+
+                if successCount == 0 {
+                    return .failure
+                } else if successCount == transactionCount {
+                    return .success
+                } else {
+                    return .partial(txIds: txIds)
+                }
+            },
+            proposeShielding: { accountIndex, shieldingThreshold, memo, transparentReceiver in
+                try await synchronizer.proposeShielding(
+                    accountIndex: accountIndex,
+                    shieldingThreshold: shieldingThreshold,
+                    memo: memo,
+                    transparentReceiver: transparentReceiver
+                )
             }
         )
     }

diff --git a/modules/Sources/Dependencies/SDKSynchronizer/SDKSynchronizerTest.swift b/modules/Sources/Dependencies/SDKSynchronizer/SDKSynchronizerTest.swift
@@ -30,7 +30,10 @@ extension SDKSynchronizerClient: TestDependencyKey {
         sendTransaction: XCTUnimplemented("\(Self.self).sendTransaction", placeholder: .placeholder()),
         shieldFunds: XCTUnimplemented("\(Self.self).shieldFunds", placeholder: .placeholder()),
         wipe: XCTUnimplemented("\(Self.self).wipe"),
-        switchToEndpoint: XCTUnimplemented("\(Self.self).switchToEndpoint")
+        switchToEndpoint: XCTUnimplemented("\(Self.self).switchToEndpoint"),
+        proposeTransfer: XCTUnimplemented("\(Self.self).proposeTransfer", placeholder: .testOnlyFakeProposal(totalFee: 0)),
+        createProposedTransactions: XCTUnimplemented("\(Self.self).createProposedTransactions", placeholder: .success),
+        proposeShielding: XCTUnimplemented("\(Self.self).proposeShielding", placeholder: nil)
     )
 }
 
@@ -52,7 +55,10 @@ extension SDKSynchronizerClient {
         sendTransaction: { _, _, _, _ in return .placeholder() },
         shieldFunds: { _, _, _ in return .placeholder() },
         wipe: { Empty<Void, Error>().eraseToAnyPublisher() },
-        switchToEndpoint: { _ in }
+        switchToEndpoint: { _ in },
+        proposeTransfer: { _, _, _, _ in .testOnlyFakeProposal(totalFee: 0) },
+        createProposedTransactions: { _, _ in .success },
+        proposeShielding: { _, _, _, _ in nil }
     )
 
     public static let mock = Self.mocked()
@@ -172,7 +178,13 @@ extension SDKSynchronizerClient {
             )
         },
         wipe: @escaping () -> AnyPublisher<Void, Error>? = { Fail(error: "Error").eraseToAnyPublisher() },
-        switchToEndpoint: @escaping (LightWalletEndpoint) async throws -> Void = { _ in }
+        switchToEndpoint: @escaping (LightWalletEndpoint) async throws -> Void = { _ in },
+        proposeTransfer: 
+        @escaping (Int, Recipient, Zatoshi, Memo?) async throws -> Proposal = { _, _, _, _ in .testOnlyFakeProposal(totalFee: 0) },
+        createProposedTransactions:
+        @escaping (Proposal, UnifiedSpendingKey) async throws -> CreateProposedTransactionsResult = { _, _ in .success },
+        proposeShielding:
+        @escaping (Int, Zatoshi, Memo, TransparentAddress?) async throws -> Proposal? = { _, _, _, _ in nil }
     ) -> SDKSynchronizerClient {
         SDKSynchronizerClient(
             stateStream: stateStream,
@@ -191,7 +203,10 @@ extension SDKSynchronizerClient {
             sendTransaction: sendTransaction,
             shieldFunds: shieldFunds,
             wipe: wipe,
-            switchToEndpoint: switchToEndpoint
+            switchToEndpoint: switchToEndpoint,
+            proposeTransfer: proposeTransfer,
+            createProposedTransactions: createProposedTransactions,
+            proposeShielding: proposeShielding
         )
     }
 }
diff --git a/modules/Sources/Dependencies/SupportDataGenerator/SupportDataGenerator.swift b/modules/Sources/Dependencies/SupportDataGenerator/SupportDataGenerator.swift
@@ -22,6 +22,7 @@ public enum SupportDataGenerator {
     public enum Constants {
         public static let email = "support@electriccoin.co"
         public static let subject = "Zashi"
+        public static let subjectPPE = L10n.ProposalPartial.mailSubject
     }
 
     public static func generate() -> SupportData {
@@ -43,6 +44,23 @@ public enum SupportDataGenerator {
 
         return SupportData(toAddress: Constants.email, subject: Constants.subject, message: message)
     }
+
+    public static func generatePartialProposalError(txIds: [String]) -> SupportData {
+        let data = SupportDataGenerator.generate()
+
+        let message =
+        """
+        \(L10n.ProposalPartial.mailPart1)
+
+        \(L10n.ProposalPartial.mailPart2)
+
+        \(L10n.ProposalPartial.mailPart3)
+
+        \(data.message)
+        """
+
+        return SupportData(toAddress: Constants.email, subject: Constants.subjectPPE, message: message)
+    }
 }
 
 private protocol SupportDataGeneratorItem {

diff --git a/modules/Sources/Dependencies/ZcashSDKEnvironment/ZcashSDKEnvironmentInterface.swift b/modules/Sources/Dependencies/ZcashSDKEnvironment/ZcashSDKEnvironmentInterface.swift
@@ -126,5 +126,6 @@ public struct ZcashSDKEnvironment {
     public let network: ZcashNetwork
     public let requiredTransactionConfirmations: Int
     public let sdkVersion: String
+    public let shieldingThreshold: Zatoshi
     public let tokenName: String
 }
diff --git a/modules/Sources/Dependencies/ZcashSDKEnvironment/ZcashSDKEnvironmentLiveKey.swift b/modules/Sources/Dependencies/ZcashSDKEnvironment/ZcashSDKEnvironmentLiveKey.swift
@@ -45,6 +45,7 @@ extension ZcashSDKEnvironment {
             network: network,
             requiredTransactionConfirmations: ZcashSDKConstants.requiredTransactionConfirmations,
             sdkVersion: "0.18.1-beta",
+            shieldingThreshold: Zatoshi(100_000),
             tokenName: network.networkType == .testnet ? "TAZ" : "ZEC"
         )
     }

diff --git a/modules/Sources/Dependencies/ZcashSDKEnvironment/ZcashSDKEnvironmentTestKey.swift b/modules/Sources/Dependencies/ZcashSDKEnvironment/ZcashSDKEnvironmentTestKey.swift
@@ -27,6 +27,7 @@ extension ZcashSDKEnvironment: TestDependencyKey {
         network: ZcashNetworkBuilder.network(for: .testnet),
         requiredTransactionConfirmations: ZcashSDKConstants.requiredTransactionConfirmations,
         sdkVersion: "0.18.1-beta",
+        shieldingThreshold: Zatoshi(100_000),
         tokenName: "TAZ"
     )
 }