feat: show spark in lightning connections

Author: ovitrif

Bitkit/MainNavView.swift

@@ -750,6 +750,7 @@ struct MainNavView: View {
                 case .addressTypePreference: AddressTypePreferenceView()
                 case .connections: LightningConnectionsView()
                 case let .connectionDetail(channelId): LightningConnectionDetailView(channelId: channelId)
+                case .sparkConnectionDetail: SparkConnectionDetailView()
                 case let .closeConnection(channel: channel): CloseConnectionConfirmation(channel: channel)
                 case .node: NodeStateView()
                 case .electrumSettings: ElectrumSettingsScreen()

Bitkit/Managers/SparkManager.swift

@@ -23,6 +23,8 @@ final class SparkManager: ChannelFreeLightningRail {
     /// Deposits seen on-chain that Spark claims into `balanceSats` after 3 confirmations.
     private(set) var pendingDepositSats: UInt64 = 0
     private(set) var recoverableFundsSats: UInt64 = 0
+    /// On-chain deposits into Spark, pending ones first, for the Lightning Connections screens.
+    private(set) var deposits: [SparkDeposit] = []
     /// Called when Spark claims on-chain deposits, which completes a Savings to Spending transfer.
     var onDepositsClaimed: (() -> Void)?
     /// Called after the Spark balance or readiness was read again, so balances and the receive invoice can follow.
@@ -38,6 +40,12 @@ final class SparkManager: ChannelFreeLightningRail {
         Self.sparkNetwork != nil
     }
 
+    /// Spark's regtest has no Lightning network, so there a Lightning invoice from another Spark wallet is paid as a
+    /// Spark transfer, which lets two dev builds pay each other's invoices.
+    nonisolated static var prefersSpark: Bool {
+        Env.network == .regtest
+    }
+
     private static var sparkNetwork: BreezSdkSpark.Network? {
         switch Env.network {
         case .bitcoin: Env.breezApiKey == nil ? nil : .mainnet
@@ -106,6 +114,7 @@ final class SparkManager: ChannelFreeLightningRail {
         balanceSats = 0
         pendingDepositSats = 0
         recoverableFundsSats = 0
+        deposits = []
         try? FileManager.default.removeItem(at: Env.sparkStorage(walletIndex: walletIndex))
     }
 
@@ -129,15 +138,18 @@ final class SparkManager: ChannelFreeLightningRail {
         }
         let response = try await requireSdk().sendPayment(request: SendPaymentRequest(
             prepareResponse: prepared,
-            options: .bolt11Invoice(preferSpark: false, completionTimeoutSecs: Self.sendCompletionTimeoutSecs)
+            options: .bolt11Invoice(preferSpark: Self.prefersSpark, completionTimeoutSecs: Self.sendCompletionTimeoutSecs)
         ))
         Logger.info("Sent Spark payment '\(response.payment.id)' with status '\(response.payment.status)'", context: "SparkManager")
         return invoiceDetails.paymentHash
     }
 
     nonisolated func estimateRoutingFees(bolt11: String, amountSats: UInt64?) async throws -> UInt64 {
         let prepared = try await prepareSend(paymentRequest: bolt11, amountSats: amountSats)
-        guard case let .bolt11Invoice(_, _, lightningFeeSats) = prepared.paymentMethod else { return 0 }
+        guard case let .bolt11Invoice(_, sparkTransferFeeSats, lightningFeeSats) = prepared.paymentMethod else { return 0 }
+        if Self.prefersSpark, let sparkTransferFeeSats {
+            return sparkTransferFeeSats
+        }
         return lightningFeeSats
     }
 
@@ -187,21 +199,69 @@ final class SparkManager: ChannelFreeLightningRail {
         return sdk
     }
 
+    /// Reads the Spark balance and deposits again, for pull to refresh.
+    func refreshState() async {
+        guard sdk != nil else { return }
+        do {
+            try await refresh()
+        } catch {
+            Logger.warn("Failed to refresh Spark state: \(error)", context: "SparkManager")
+        }
+    }
+
     private func refresh() async throws {
         let sdk = try await requireSdk()
         let info = try await sdk.getInfo(request: GetInfoRequest(ensureSynced: false))
-        let deposits = try await sdk.listUnclaimedDeposits(request: ListUnclaimedDepositsRequest())
-        let pending = deposits.deposits.reduce(0) { $0 + $1.amountSats }
+        let unclaimed = try await sdk.listUnclaimedDeposits(request: ListUnclaimedDepositsRequest()).deposits
+        let claimed = try await sdk.listPayments(request: ListPaymentsRequest()).payments
+            .filter { $0.method == .deposit && $0.status == .completed }
+        let pending = unclaimed.reduce(0) { $0 + $1.amountSats }
         let changed = !isReady || balanceSats != info.balanceSats || pendingDepositSats != pending
         isReady = true
         balanceSats = info.balanceSats
         pendingDepositSats = pending
         recoverableFundsSats = info.recoverableFundsSats
+        deposits = await Self.deposits(unclaimed: unclaimed, claimed: claimed)
         if changed {
             onStateChanged?()
         }
     }
 
+    private static func deposits(unclaimed: [DepositInfo], claimed: [Payment]) async -> [SparkDeposit] {
+        let confirmations = await onchainConfirmations()
+        let pending = unclaimed.map {
+            SparkDeposit(txid: $0.txid, amountSats: $0.amountSats, isClaimed: false, confirmations: confirmations[$0.txid] ?? nil)
+        }
+        let done: [SparkDeposit] = claimed.compactMap { payment in
+            guard case let .deposit(txId, _) = payment.details else { return nil }
+            return SparkDeposit(
+                txid: txId,
+                amountSats: sats(payment.amount),
+                isClaimed: true,
+                feeSats: sats(payment.fees),
+                claimedAt: payment.timestamp
+            )
+        }
+        return pending + done
+    }
+
+    /// Confirmations of the on-chain transactions this wallet sent or received, 0 while unconfirmed.
+    private static func onchainConfirmations() async -> [String: UInt32?] {
+        let tip = LightningService.shared.status?.currentBestBlock.height
+        let payments = await LightningService.shared.listPayments() ?? []
+        var result: [String: UInt32?] = [:]
+        for payment in payments {
+            guard case let .onchain(txid, status) = payment.kind else { continue }
+            switch status {
+            case .unconfirmed:
+                result[txid] = 0
+            case let .confirmed(_, height, _):
+                result[txid] = tip.map { $0 >= height ? $0 - height + 1 : 0 }
+            }
+        }
+        return result
+    }
+
     private func syncActivities() async throws {
         let payments = try await requireSdk().listPayments(request: ListPaymentsRequest()).payments
         for payment in payments {
@@ -293,6 +353,21 @@ final class SparkManager: ChannelFreeLightningRail {
     }
 }
 
+/// An on-chain deposit into Spark: pending until Spark claims it after 3 confirmations.
+struct SparkDeposit: Identifiable, Equatable {
+    let txid: String
+    let amountSats: UInt64
+    let isClaimed: Bool
+    var feeSats: UInt64 = 0
+    var claimedAt: UInt64?
+    /// On-chain confirmations, known for deposits this wallet sent.
+    var confirmations: UInt32?
+
+    var id: String {
+        "\(txid)-\(isClaimed)"
+    }
+}
+
 private final class SparkEventListener: BreezSdkSpark.EventListener, @unchecked Sendable {
     private let handler: @Sendable (SdkEvent) async -> Void
 

Bitkit/Resources/Localization/ar.lproj/Localizable.strings

@@ -305,6 +305,15 @@
 "lightning__transaction" = "المعاملة";
 "lightning__order_fee" = "رسوم الطلب";
 "lightning__balance" = "الرصيد";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "رسوم المطالبة";
+"lightning__spark_confirmations" = "{count}/3 تأكيدات";
+"lightning__spark_deposit" = "إيداع";
+"lightning__spark_deposits_claimed" = "إيداعات تمت المطالبة بها";
+"lightning__spark_deposits_pending" = "إيداعات قيد التنفيذ";
+"lightning__spark_provider" = "المزوّد";
+"lightning__spark_provider_value" = "Spark عبر Breez";
+"lightning__spark_trust" = "يُحفظ هذا الرصيد على Spark الذي تديره Lightspark وBreez وFlashnet. يبقى آمنًا ما دام أحدهم على الأقل يتصرف بأمانة. يمكنهم إيقاف الوصول مؤقتًا، والخروج من دونهم يتطلب خروجًا على السلسلة.";
 "lightning__reserve_balance" = "رصيد الاحتياطي (غير قابل للإنفاق)";
 "lightning__total_size" = "الحجم الإجمالي للقناة";
 "lightning__fees" = "الرسوم";

Bitkit/Resources/Localization/ca.lproj/Localizable.strings

@@ -342,6 +342,15 @@
 "lightning__transaction" = "Transacció";
 "lightning__order_fee" = "Comissió de comanda";
 "lightning__balance" = "Saldo";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "Comissió de reclamació";
+"lightning__spark_confirmations" = "{count}/3 confirmacions";
+"lightning__spark_deposit" = "Dipòsit";
+"lightning__spark_deposits_claimed" = "Dipòsits reclamats";
+"lightning__spark_deposits_pending" = "Dipòsits en curs";
+"lightning__spark_provider" = "Proveïdor";
+"lightning__spark_provider_value" = "Spark mitjançant Breez";
+"lightning__spark_trust" = "Aquest saldo es guarda a Spark, gestionat per Lightspark, Breez i Flashnet. Està segur mentre almenys un d’ells actuï amb honestedat. Poden pausar l’accés, i sortir-ne sense ells requereix una sortida on-chain.";
 "lightning__reserve_balance" = "Saldo de reserva (no gastable)";
 "lightning__total_size" = "Mida total del canal";
 "lightning__fees" = "Comissions";

Bitkit/Resources/Localization/cs.lproj/Localizable.strings

@@ -358,6 +358,15 @@
 "lightning__transaction" = "Transakce";
 "lightning__order_fee" = "Poplatek za objednávku";
 "lightning__balance" = "Zůstatek";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "Poplatek za připsání";
+"lightning__spark_confirmations" = "{count}/3 potvrzení";
+"lightning__spark_deposit" = "Vklad";
+"lightning__spark_deposits_claimed" = "Připsané vklady";
+"lightning__spark_deposits_pending" = "Probíhající vklady";
+"lightning__spark_provider" = "Poskytovatel";
+"lightning__spark_provider_value" = "Spark přes Breez";
+"lightning__spark_trust" = "Tento zůstatek je uložen na Spark, který provozují Lightspark, Breez a Flashnet. Je v bezpečí, dokud alespoň jeden z nich jedná poctivě. Mohou pozastavit přístup a odchod bez nich vyžaduje on-chain výstup.";
 "lightning__reserve_balance" = "Rezervní zůstatek";
 "lightning__total_size" = "Celková velikost kanálu";
 "lightning__fees" = "Poplatky";

Bitkit/Resources/Localization/de.lproj/Localizable.strings

@@ -356,6 +356,15 @@
 "lightning__transaction" = "Transaktion";
 "lightning__order_fee" = "Auftragsgebühr";
 "lightning__balance" = "Guthaben";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "Einlösegebühr";
+"lightning__spark_confirmations" = "{count}/3 Bestätigungen";
+"lightning__spark_deposit" = "Einzahlung";
+"lightning__spark_deposits_claimed" = "Eingelöste Einzahlungen";
+"lightning__spark_deposits_pending" = "Laufende Einzahlungen";
+"lightning__spark_provider" = "Anbieter";
+"lightning__spark_provider_value" = "Spark über Breez";
+"lightning__spark_trust" = "Dieses Guthaben liegt auf Spark, betrieben von Lightspark, Breez und Flashnet. Es ist sicher, solange mindestens einer von ihnen ehrlich handelt. Sie können den Zugang sperren, und ein Ausstieg ohne sie erfordert einen On-Chain-Exit.";
 "lightning__reserve_balance" = "Reserveguthaben";
 "lightning__total_size" = "Gesamtgröße des Channels";
 "lightning__fees" = "Gebühren";

Bitkit/Resources/Localization/el.lproj/Localizable.strings

@@ -329,6 +329,15 @@
 "lightning__transaction" = "Συναλλαγή";
 "lightning__order_fee" = "Τέλος παραγγελίας";
 "lightning__balance" = "Υπόλοιπο";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "Χρέωση εξαργύρωσης";
+"lightning__spark_confirmations" = "{count}/3 επιβεβαιώσεις";
+"lightning__spark_deposit" = "Κατάθεση";
+"lightning__spark_deposits_claimed" = "Εξαργυρωμένες καταθέσεις";
+"lightning__spark_deposits_pending" = "Καταθέσεις σε εξέλιξη";
+"lightning__spark_provider" = "Πάροχος";
+"lightning__spark_provider_value" = "Spark μέσω Breez";
+"lightning__spark_trust" = "Αυτό το υπόλοιπο φυλάσσεται στο Spark, που λειτουργούν οι Lightspark, Breez και Flashnet. Είναι ασφαλές όσο τουλάχιστον ένας από αυτούς ενεργεί έντιμα. Μπορούν να αναστείλουν την πρόσβαση, και η έξοδος χωρίς αυτούς απαιτεί έξοδο on-chain.";
 "lightning__reserve_balance" = "Υπόλοιπο αποθεματικού (μη δαπανήσιμο)";
 "lightning__total_size" = "Συνολικό μέγεθος καναλιού";
 "lightning__fees" = "Τέλη";

Bitkit/Resources/Localization/en.lproj/Localizable.strings

@@ -351,6 +351,15 @@
 "lightning__transaction" = "Transaction";
 "lightning__order_fee" = "Order fee";
 "lightning__balance" = "Balance";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "Claim fee";
+"lightning__spark_confirmations" = "{count}/3 confirmations";
+"lightning__spark_deposit" = "Deposit";
+"lightning__spark_deposits_claimed" = "Claimed deposits";
+"lightning__spark_deposits_pending" = "Deposits in progress";
+"lightning__spark_provider" = "Provider";
+"lightning__spark_provider_value" = "Spark via Breez";
+"lightning__spark_trust" = "This balance is held on Spark, run by Lightspark, Breez and Flashnet. It is safe while at least one of them acts honestly. They can pause access, and leaving without them takes an on-chain exit.";
 "lightning__reserve_balance" = "Reserve balance (not spendable)";
 "lightning__total_size" = "Total channel size";
 "lightning__fees" = "Fees";

Bitkit/Resources/Localization/es-419.lproj/Localizable.strings

@@ -359,6 +359,15 @@
 "lightning__transaction" = "Transacción";
 "lightning__order_fee" = "Tarifa de pedido";
 "lightning__balance" = "Saldo";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "Comisión de reclamo";
+"lightning__spark_confirmations" = "{count}/3 confirmaciones";
+"lightning__spark_deposit" = "Depósito";
+"lightning__spark_deposits_claimed" = "Depósitos reclamados";
+"lightning__spark_deposits_pending" = "Depósitos en curso";
+"lightning__spark_provider" = "Proveedor";
+"lightning__spark_provider_value" = "Spark mediante Breez";
+"lightning__spark_trust" = "Este saldo se guarda en Spark, operado por Lightspark, Breez y Flashnet. Está seguro mientras al menos uno de ellos actúe con honestidad. Pueden pausar el acceso, y salir sin ellos requiere una salida on-chain.";
 "lightning__reserve_balance" = "Saldo de reserva (no gastable)";
 "lightning__total_size" = "Tamaño total del canal";
 "lightning__fees" = "Tarifa";

Bitkit/Resources/Localization/es.lproj/Localizable.strings

@@ -343,6 +343,15 @@
 "lightning__transaction" = "Transacción";
 "lightning__order_fee" = "Tarifa de pedido";
 "lightning__balance" = "Saldo";
+"lightning__spark" = "Spark";
+"lightning__spark_claim_fee" = "Comisión de reclamo";
+"lightning__spark_confirmations" = "{count}/3 confirmaciones";
+"lightning__spark_deposit" = "Depósito";
+"lightning__spark_deposits_claimed" = "Depósitos reclamados";
+"lightning__spark_deposits_pending" = "Depósitos en curso";
+"lightning__spark_provider" = "Proveedor";
+"lightning__spark_provider_value" = "Spark mediante Breez";
+"lightning__spark_trust" = "Este saldo se guarda en Spark, operado por Lightspark, Breez y Flashnet. Está seguro mientras al menos uno de ellos actúe con honestidad. Pueden pausar el acceso, y salir sin ellos requiere una salida on-chain.";
 "lightning__reserve_balance" = "Saldo de reserva";
 "lightning__total_size" = "Tamaño total del canal";
 "lightning__fees" = "Comisiones";