feat: add spark via breez sdk

.agents/commands/release.md

@@ -289,6 +289,8 @@ Print the path to the local draft. Store it for the summary. Slack posting is de
 
 ### 7. Build & Upload to TestFlight (optional)
 
+Before archiving, `Secrets.xcconfig` must exist at the repo root with `BREEZ_API_KEY` set (copy `Secrets.xcconfig.template`). Release builds fail without it. Check with `grep -q '^BREEZ_API_KEY = .\+' Secrets.xcconfig`; if it fails, stop and ask the releaser for the key. Never print the key.
+
 Use `AskUserQuestion`:
 
 **Question:** `"Archive and upload to TestFlight?"`

.gitignore

@@ -27,5 +27,5 @@ buildServer.json
 # XcodeBuildMCP
 .xcodebuildmcp/config.yaml
 
-# Local build secrets
+# Local build secrets (see Secrets.xcconfig.template)
 Secrets.xcconfig

Bitkit.xcconfig

@@ -0,0 +1,4 @@
+// Base settings for the Bitkit app target.
+// Local secrets stay out of git: copy Secrets.xcconfig.template to Secrets.xcconfig and fill it in.
+// Without it the app builds with Spark (Lightning without channels) off on mainnet.
+#include? "Secrets.xcconfig"

Bitkit.xcodeproj/project.pbxproj

@@ -19,6 +19,7 @@
 		4AAB08CA2E1FE77600BA63DF /* Lottie in Frameworks */ = {isa = PBXBuildFile; productRef = 4AAB08C92E1FE77600BA63DF /* Lottie */; };
 		961058E32C355B5500E1F1D8 /* BitkitNotification.appex in Embed Foundation Extensions */ = {isa = PBXBuildFile; fileRef = 961058DC2C355B5500E1F1D8 /* BitkitNotification.appex */; settings = {ATTRIBUTES = (RemoveHeadersOnCopy, ); }; };
 		968FDF162DFAFE230053CD7F /* LDKNode in Frameworks */ = {isa = PBXBuildFile; productRef = 9613018B2C5022D700878183 /* LDKNode */; };
+		72B5EE0000000000000000A3 /* BreezSdkSpark in Frameworks */ = {isa = PBXBuildFile; productRef = 72B5EE0000000000000000A2 /* BreezSdkSpark */; };
 		968FE1402DFB016B0053CD7F /* LDKNode in Frameworks */ = {isa = PBXBuildFile; productRef = 968FE13F2DFB016B0053CD7F /* LDKNode */; };
 		96DEA03A2DE8BBA1009932BF /* BitkitCore in Frameworks */ = {isa = PBXBuildFile; productRef = 96DEA0392DE8BBA1009932BF /* BitkitCore */; };
 		96DEA03C2DE8BBAB009932BF /* BitkitCore in Frameworks */ = {isa = PBXBuildFile; productRef = 96DEA03B2DE8BBAB009932BF /* BitkitCore */; };
@@ -77,6 +78,7 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		B17C0F1A2EAE000000000001 /* Bitkit.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Bitkit.xcconfig; sourceTree = "<group>"; };
 		3D76260E4C9C4A53B1E4A001 /* CoreBluetooth.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreBluetooth.framework; path = System/Library/Frameworks/CoreBluetooth.framework; sourceTree = SDKROOT; };
 		4A319B4F2E8F24F2002B9AC9 /* BitkitWidgetExtension.appex */ = {isa = PBXFileReference; explicitFileType = "wrapper.app-extension"; includeInIndex = 0; path = BitkitWidgetExtension.appex; sourceTree = BUILT_PRODUCTS_DIR; };
 		4A319B502E8F24F2002B9AC9 /* WidgetKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WidgetKit.framework; path = System/Library/Frameworks/WidgetKit.framework; sourceTree = SDKROOT; };
@@ -266,6 +268,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				182817C12F59A7F10055A441 /* Paykit in Frameworks */,
+				72B5EE0000000000000000A3 /* BreezSdkSpark in Frameworks */,
 				3D76260F4C9C4A53B1E4A001 /* CoreBluetooth.framework in Frameworks */,
 				968FDF162DFAFE230053CD7F /* LDKNode in Frameworks */,
 				18D65E002EB964B500252335 /* VssRustClientFfi in Frameworks */,
@@ -308,6 +311,7 @@
 		96FE1F582C2DE6AA006D0C8B = {
 			isa = PBXGroup;
 			children = (
+				B17C0F1A2EAE000000000001 /* Bitkit.xcconfig */,
 				4A319B6E2E8F25F6002B9AC9 /* BitkitWidgetExtension.entitlements */,
 				96A44E912CEF5EA700FBACFF /* Bitkit */,
 				96A44F4A2CEF5F4B00FBACFF /* BitkitTests */,
@@ -385,6 +389,7 @@
 			isa = PBXNativeTarget;
 			buildConfigurationList = 96FE1F862C2DE6AC006D0C8B /* Build configuration list for PBXNativeTarget "Bitkit" */;
 			buildPhases = (
+				B17C0F1A2EAE000000000002 /* Check Breez API Key */,
 				96FE1F5D2C2DE6AA006D0C8B /* Sources */,
 				96FE1F5E2C2DE6AA006D0C8B /* Frameworks */,
 				96FE1F5F2C2DE6AA006D0C8B /* Resources */,
@@ -410,6 +415,7 @@
 				4AAB08C92E1FE77600BA63DF /* Lottie */,
 				18D65DFF2EB964B500252335 /* VssRustClientFfi */,
 				182817C02F59A7F10055A441 /* Paykit */,
+				72B5EE0000000000000000A2 /* BreezSdkSpark */,
 			);
 			productName = Bitkit;
 			productReference = 96FE1F612C2DE6AA006D0C8B /* Bitkit.app */;
@@ -520,6 +526,7 @@
 				4AAB08C82E1FE77600BA63DF /* XCRemoteSwiftPackageReference "lottie-ios" */,
 				18D65DFE2EB9649F00252335 /* XCRemoteSwiftPackageReference "vss-rust-client-ffi" */,
 				182817BF2F59A7F10055A441 /* XCRemoteSwiftPackageReference "paykit-rs" */,
+				72B5EE0000000000000000A1 /* XCRemoteSwiftPackageReference "breez-sdk-spark-swift" */,
 			);
 			productRefGroup = 96FE1F622C2DE6AA006D0C8B /* Products */;
 			projectDirPath = "";
@@ -574,6 +581,26 @@
 /* End PBXResourcesBuildPhase section */
 
 /* Begin PBXShellScriptBuildPhase section */
+		B17C0F1A2EAE000000000002 /* Check Breez API Key */ = {
+			isa = PBXShellScriptBuildPhase;
+			alwaysOutOfDate = 1;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+			);
+			inputPaths = (
+			);
+			name = "Check Breez API Key";
+			outputFileListPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "if [ \"$CONFIGURATION\" = \"Release\" ] && [ -z \"$(echo \"${BREEZ_API_KEY}\" | tr -d ' ')\" ]; then\n  echo \"error: BREEZ_API_KEY is empty. Copy Secrets.xcconfig.template to Secrets.xcconfig and set the key before a Release build or archive (Docs/RELEASE.md).\"\n  exit 1\nfi\n";
+			showEnvVarsInLog = 0;
+		};
 		751000000000000000000001 /* Generate Plural Localizations */ = {
 			isa = PBXShellScriptBuildPhase;
 			alwaysOutOfDate = 1;
@@ -953,6 +980,7 @@
 		};
 		96FE1F872C2DE6AC006D0C8B /* Debug */ = {
 			isa = XCBuildConfiguration;
+			baseConfigurationReference = B17C0F1A2EAE000000000001 /* Bitkit.xcconfig */;
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
@@ -1006,6 +1034,7 @@
 		};
 		96FE1F882C2DE6AC006D0C8B /* Release */ = {
 			isa = XCBuildConfiguration;
+			baseConfigurationReference = B17C0F1A2EAE000000000001 /* Bitkit.xcconfig */;
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
@@ -1228,6 +1257,14 @@
 				version = 4.6.1;
 			};
 		};
+		72B5EE0000000000000000A1 /* XCRemoteSwiftPackageReference "breez-sdk-spark-swift" */ = {
+			isa = XCRemoteSwiftPackageReference;
+			repositoryURL = "https://github.com/breez/breez-sdk-spark-swift";
+			requirement = {
+				kind = exactVersion;
+				version = 0.28.2;
+			};
+		};
 		968FE13E2DFB016B0053CD7F /* XCRemoteSwiftPackageReference "ldk-node" */ = {
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/synonymdev/ldk-node";
@@ -1275,6 +1312,11 @@
 			package = 4AAB08C82E1FE77600BA63DF /* XCRemoteSwiftPackageReference "lottie-ios" */;
 			productName = Lottie;
 		};
+		72B5EE0000000000000000A2 /* BreezSdkSpark */ = {
+			isa = XCSwiftPackageProductDependency;
+			package = 72B5EE0000000000000000A1 /* XCRemoteSwiftPackageReference "breez-sdk-spark-swift" */;
+			productName = BreezSdkSpark;
+		};
 		9613018B2C5022D700878183 /* LDKNode */ = {
 			isa = XCSwiftPackageProductDependency;
 			package = 968FE13E2DFB016B0053CD7F /* XCRemoteSwiftPackageReference "ldk-node" */;

Bitkit/AppScene.swift

@@ -297,6 +297,16 @@ enum IncomingPaykitPaymentRequestPresentationDispatcher {
         return IncomingPaykitPaymentRequestPresentationFeedback(paymentDetailsPendingWasRequested: wasRequested)
     }
 
+    /// Ends a presentation the user asked for once its payment details fail to resolve, so the send sheet stops loading
+    /// and the user sees why; the request stays in Payment Requests to try again. Automatic presentations keep retrying.
+    static func finishRequestedPresentationAfterResolutionFailure(
+        for request: PaykitPaymentRequest,
+        with manager: PaykitPaymentRequestManager
+    ) -> IncomingPaykitPaymentRequestPresentationFeedback? {
+        guard manager.requestedPresentationId == request.id else { return nil }
+        return finishPendingPrivateLink(for: request, with: manager)
+    }
+
     static func handleStateChange(
         from previous: IncomingPaykitPaymentRequestPresentationState,
         to current: IncomingPaykitPaymentRequestPresentationState,
@@ -599,6 +609,35 @@ struct AppScene: View {
                 await pubkyProfile.retrySessionRestoration()
             }
             .task(id: [scenePhase == .active, network.isConnected, wipeCoordinator.isGateUp]) { await pollIncomingPaykitPaymentRequests() }
+            .task(id: [scenePhase == .active, SparkExitManager.shared.needsDriving]) {
+                guard scenePhase == .active else { return }
+                await SparkExitManager.shared.runWhileActive()
+            }
+            .task(id: [
+                SparkExitManager.shared.opensProgress,
+                SparkExitManager.shared.showsResult,
+                SparkExitManager.shared.hasLoadedRecord,
+                isLockedForDeepLinks,
+                wallet.walletExists == true,
+            ]) {
+                // A tapped exit notification opens the exit once the wallet is unlocked and its record is loaded.
+                let exit = SparkExitManager.shared
+                guard exit.opensProgress, wallet.walletExists == true, !isLockedForDeepLinks else { return }
+                switch SparkExitManager.notificationOpen(
+                    opensProgress: exit.opensProgress,
+                    showsResult: exit.showsResult,
+                    hasLoadedRecord: exit.hasLoadedRecord
+                ) {
+                case .wait:
+                    return
+                case .drop:
+                    exit.opensProgress = false
+                case .open:
+                    exit.opensProgress = false
+                    navigation.reset()
+                    navigation.navigate(.sparkExitProgress)
+                }
+            }
             .task(id: foregroundContactSession) {
                 shopContactImport?.task.cancel()
                 shopContactImport = nil
@@ -1801,6 +1840,20 @@ struct AppScene: View {
                         return
                     }
                     guard case let .opened(paymentTarget, privatePaymentContext, endpoints) = result else {
+                        let isWaitingForUpdatedList = if case .waitingForUpdatedPaymentList = result {
+                            true
+                        } else {
+                            false
+                        }
+                        if !isWaitingForUpdatedList,
+                           let feedback = IncomingPaykitPaymentRequestPresentationDispatcher.finishRequestedPresentationAfterResolutionFailure(
+                               for: request,
+                               with: paykitPaymentRequestManager
+                           )
+                        {
+                            presentIncomingPaykitPaymentRequestFeedback(feedback, for: request)
+                            return
+                        }
                         deferIncomingPaykitPaymentRequestPresentation(
                             request,
                             reason: result.incomingPaymentRequestFailureReason ?? .resolutionFailed
@@ -1928,6 +1981,13 @@ struct AppScene: View {
                     return
                 } catch {
                     guard isCurrentIncomingPaymentRequestPreparation(preparation) else { return }
+                    if let feedback = IncomingPaykitPaymentRequestPresentationDispatcher.finishRequestedPresentationAfterResolutionFailure(
+                        for: request,
+                        with: paykitPaymentRequestManager
+                    ) {
+                        presentIncomingPaykitPaymentRequestFeedback(feedback, for: request)
+                        return
+                    }
                     deferIncomingPaykitPaymentRequestPresentation(request, reason: .resolutionFailed)
                     return
                 }

Bitkit/Assets.xcassets/Illustrations/coin-stack-x.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "coin-stack-x.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Bitkit/Assets.xcassets/icons/hourglass-simple.imageset/Contents.json

@@ -1,7 +1,7 @@
 {
   "images" : [
     {
-      "filename" : "hourglass-simple.pdf",
+      "filename" : "hourglass-simple.svg",
       "idiom" : "universal"
     }
   ],
@@ -10,6 +10,7 @@
     "version" : 1
   },
   "properties" : {
+    "preserves-vector-representation" : true,
     "template-rendering-intent" : "template"
   }
 }

Bitkit/BitkitApp.swift

@@ -73,6 +73,7 @@ class AppDelegate: NSObject, UIApplicationDelegate {
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool
     {
         UNUserNotificationCenter.current().delegate = self
+        SparkExitManager.registerBackgroundTask()
 
         // Check notification authorization status at launch and re-register with APN if granted
         UNUserNotificationCenter.current().getNotificationSettings { settings in
@@ -163,6 +164,8 @@ extension AppDelegate: UNUserNotificationCenterDelegate {
                 PaykitSubscriptionNotificationTargetStore.save(target)
             }
             NotificationCenter.default.post(name: .paykitSubscriptionPaymentDue, object: nil, userInfo: userInfo)
+        } else if userInfo["bitkit_action"] as? String == SparkExitManager.notificationAction {
+            Task { @MainActor in SparkExitManager.shared.opensProgress = true }
         } else {
             PushNotificationManager.shared.handleNotification(userInfo)
         }

Bitkit/Components/FeeDisplayRow.swift

@@ -3,12 +3,16 @@ import SwiftUI
 struct FeeDisplayRow: View {
     let label: String
     let amount: UInt64
+    /// Shown before the amount when it is a bound or an estimate ("±").
+    var prefix: String?
+    /// Shimmers the amount while it is being priced.
+    var isLoading = false
 
     var body: some View {
         VStack(alignment: .leading, spacing: 0) {
             CaptionMText(label)
                 .padding(.bottom, 8)
-            MoneyText(sats: Int(amount), size: .bodySSB, symbol: true)
+            MoneyText(sats: Int(amount), size: .bodySSB, symbol: true, prefix: prefix, shimmer: isLoading)
                 .padding(.bottom, 16)
             Divider()
         }