feat: add allowances for automatic paykit payments

Bitkit/AppScene.swift

@@ -199,6 +199,7 @@ enum IncomingPaykitPaymentRequestPresentationDispatcher {
         sheets: SheetViewModel,
         canRetryPreparation: Bool,
         handleSubscriptionNotification: () async -> Void,
+        allowanceProposal: () -> PaykitAllowanceEntry? = { nil },
         presentPaymentRequest: () async -> Void
     ) async {
         guard sheets.activeSheetConfiguration == nil || canRetryPreparation,
@@ -219,6 +220,10 @@ enum IncomingPaykitPaymentRequestPresentationDispatcher {
             sheets.showSheet(.subscription, data: SubscriptionSheetItem(route: .review(subscription)))
             return
         }
+        if let allowance = allowanceProposal() {
+            sheets.showSheet(.subscription, data: SubscriptionSheetItem(route: .allowanceReview(allowance)))
+            return
+        }
         await presentPaymentRequest()
     }
 
@@ -359,6 +364,7 @@ struct AppScene: View {
     @State private var receivedPaymentBackfillCache = PaykitReceivedPaymentBackfillCache(
         activityChanges: CoreService.shared.activity.activitiesChangedPublisher
     )
+    @State private var paykitAllowanceManager = PaykitAllowanceManager()
 
     @State private var hideSplash = false
     @State private var removeSplash = false
@@ -594,6 +600,7 @@ struct AppScene: View {
             .environment(wallet.usdtWallet)
             .environment(calculatorInputManager)
             .environment(paykitPaymentRequestManager)
+            .environment(paykitAllowanceManager)
     }
 
     private var paykitEventContent: some View {
@@ -606,6 +613,7 @@ struct AppScene: View {
                         guard let session = pubkyProfile.automaticPaykitSession,
                               PubkyPublicKeyFormat.matches(pk, session.publicKey)
                         else { return }
+                        await paykitAllowanceManager.activate(identity: pk)
                         await handlePendingPaykitSubscriptionNotification()
                         guard pubkyProfile.automaticPaykitSession == session else { return }
                         try? await contactsManager.loadContacts(for: pk)
@@ -624,6 +632,7 @@ struct AppScene: View {
                 } else if authState == .idle {
                     contactsManager.reset()
                     paykitPaymentRequestManager.clear()
+                    paykitAllowanceManager.deactivate()
                 }
             }
             .onReceive(contactsManager.savedContactsChangedPublisher) { contacts in
@@ -664,6 +673,9 @@ struct AppScene: View {
                 guard !Task.isCancelled else { return }
                 paykitProofRefresh.complete(request)
             }
+            .onReceive(PaykitAllowanceExecutor.eventPublisher.receive(on: DispatchQueue.main)) { event in
+                handlePaykitAllowanceEvent(event)
+            }
             .onReceive(PaykitPaymentProofService.onchainPaymentResolutionPublisher) { resolution in
                 Task { @MainActor in
                     app.retainPaykitOnchainPaymentResolution(resolution, identity: pubkyProfile.publicKey)
@@ -701,6 +713,12 @@ struct AppScene: View {
                     Task { await presentNextIncomingPaykitItem() }
                 }
             }
+            .onChange(of: paykitAllowanceManager.isUpdating) { _, isUpdating in
+                // A request held back while allowances were updating is presented as soon as they settle.
+                if !isUpdating {
+                    Task { await presentNextIncomingPaykitItem() }
+                }
+            }
             .onChange(of: incomingPaykitPaymentRequestPresentationState) { previous, current in
                 handleIncomingPaykitPaymentRequestPresentationStateChange(from: previous, to: current)
             }
@@ -1407,6 +1425,19 @@ struct AppScene: View {
         let refreshed = await paykitPaymentRequestManager.refresh(
             mode: mode, forceFresh: forceFresh, messagePriority: messagePriority, canRefresh: canRefresh
         )
+        // Deleting the profile withdraws the payment lists an automatic payment would consume.
+        if canRefresh(), pubkyProfile.automaticPaykitSession == session, !pubkyProfile.isDeletingProfile {
+            await paykitAllowanceManager.refresh()
+            // A request whose manual sheet is already open stays with the user.
+            let manualRequestId = incomingPaymentRequestPreparation.flatMap { $0.ownsSheet(sheets) ? $0.request?.id : nil }
+            let handledAutomatically = await paykitAllowanceManager.processIncomingRequests(
+                paykitPaymentRequestManager.pendingRequests.filter { $0.id != manualRequestId }
+            )
+            let adoptedAcceptances = paykitPaymentRequestManager.reloadAcceptedRequestIds()
+            if handledAutomatically || adoptedAcceptances, canRefresh() {
+                await paykitPaymentRequestManager.refresh(mode: .stored, canRefresh: canRefresh)
+            }
+        }
         guard pubkyProfile.authState == .authenticated,
               PubkyPublicKeyFormat.matches(identity, pubkyProfile.publicKey)
         else { return false }
@@ -1566,6 +1597,20 @@ struct AppScene: View {
             else { return }
             for request in requests {
                 guard paykitPaymentRequestManager.isCurrentPresentation(request) else { return }
+                if await paykitAllowanceManager.isAutomaticallyHandling(request) {
+                    // The next refresh presents it if the allowance flow hands it back; presenting again now would spin on it.
+                    if paykitPaymentRequestManager.requestedPresentationId == request.id {
+                        app.toast(type: .info, title: t("subscriptions__allowance_payment_in_progress"))
+                        paykitPaymentRequestManager.releaseRequestedPresentation(request)
+                    }
+                    shouldPresentNextRequest = false
+                    continue
+                }
+                // A refresh or pass still running may hand this request to the allowance flow; a later round presents it.
+                if paykitAllowanceManager.isUpdating, paykitAllowanceManager.mayCover(request) {
+                    shouldPresentNextRequest = false
+                    continue
+                }
                 let preparation: IncomingPaykitPaymentRequestPreparation
                 if let current = incomingPaymentRequestPreparation, current.ownsSheet(sheets) {
                     guard current.request?.id == request.id else { continue }
@@ -1898,6 +1943,44 @@ struct AppScene: View {
         await presentNextIncomingPaykitPaymentRequest()
     }
 
+    private func handlePaykitAllowanceEvent(_ event: PaykitAllowanceEvent) {
+        switch event {
+        case let .paidAutomatically(counterparty, amountSats, paymentId):
+            let title = t("subscriptions__allowance_executed_title")
+            let description = t(
+                "subscriptions__allowance_executed_description",
+                variables: ["amount": AllowanceAmountText.fiat(sats: amountSats, currency: currency), "name": contactName(counterparty)]
+            )
+            PaykitAllowanceNotifier.post(title: title, body: description, fallback: {
+                app.toast(type: .lightning, title: title, description: description, accessibilityIdentifier: "AllowancePaidToast")
+            })
+            Task {
+                await paykitAllowanceManager.refresh()
+                do {
+                    try await activity.setContact(counterparty, forPaymentId: paymentId)
+                } catch {
+                    Logger.warn("Failed to set contact for an automatic allowance payment: \(error)", context: "AppScene")
+                }
+            }
+        case let .limitReached(counterparty, amountSats):
+            let title = t("subscriptions__allowance_limit_title")
+            let description = t(
+                "subscriptions__allowance_limit_description",
+                variables: ["amount": AllowanceAmountText.fiat(sats: amountSats, currency: currency), "name": contactName(counterparty)]
+            )
+            PaykitAllowanceNotifier.post(title: title, body: description, fallback: {
+                app.toast(type: .warning, title: title, description: description, accessibilityIdentifier: "AllowanceLimitToast")
+            })
+        case .ledgerChanged:
+            Task { await paykitAllowanceManager.refresh() }
+        }
+    }
+
+    private func contactName(_ publicKey: String) -> String {
+        contactsManager.contacts.first { PubkyPublicKeyFormat.matches($0.publicKey, publicKey) }?.displayName
+            ?? PubkyPublicKeyFormat.displayTruncated(publicKey)
+    }
+
     private func presentNextIncomingPaykitItem() async {
         guard scenePhase == .active,
               pubkyProfile.automaticPaykitSession != nil,
@@ -1908,6 +1991,7 @@ struct AppScene: View {
             sheets: sheets,
             canRetryPreparation: canRetryIncomingPaymentRequestPreparation,
             handleSubscriptionNotification: handlePendingPaykitSubscriptionNotification,
+            allowanceProposal: paykitAllowanceManager.proposalForPresentation,
             presentPaymentRequest: presentNextIncomingPaykitPaymentRequest
         )
     }

Bitkit/Models/PaykitPaymentStateBackup.swift

@@ -77,6 +77,7 @@ struct PaykitPaymentStateBackup: Codable {
         let proofData: String?
         let conversionQuoteId: String?
         let billingPeriod: Period?
+        let allowanceId: String?
         let onchainAddress: String?
         let onchainAmountSats: UInt64?
         let onchainWalletId: String?
@@ -101,6 +102,7 @@ struct PaykitPaymentStateBackup: Codable {
             proofData = proof.proofData
             conversionQuoteId = proof.conversionQuoteId
             billingPeriod = proof.billingPeriod.map { Period(startsAt: $0.sdkValue.startsAt, endsAt: $0.sdkValue.endsAt) }
+            allowanceId = proof.allowanceId
             onchainAddress = proof.onchainAddress
             onchainAmountSats = proof.onchainAmountSats
             onchainWalletId = proof.onchainWalletId
@@ -129,6 +131,7 @@ struct PaykitPaymentStateBackup: Codable {
                 paymentEndpointIdentifier: paymentEndpointIdentifier,
                 kind: kind,
                 billingPeriod: period,
+                allowanceId: allowanceId,
                 paymentStarted: paymentStarted,
                 paymentIdentifier: paymentIdentifier,
                 proofData: proofData,

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

@@ -1580,3 +1580,50 @@
 "wallet__receive_liquidity__label_additional" = "سيولة رصيد إنفاق إضافية";
 "wallet__receive_cjit_error_max__title" = "الحد الأقصى لسعة الاستلام";
 "wallet__receive_cjit_error_max__description" = "الحد الأقصى الذي يمكنك استلامه في رصيد الإنفاق الآن هو ₿ {amount}.";
+"subscriptions__allowances" = "المخصصات";
+"subscriptions__allowances_empty_headline" = "أعدّ\n<accent>المخصصات</accent>";
+"subscriptions__allowances_empty_description" = "يمكنك تعيين حدود إنفاق لتلبية طلبات الدفع من جهات الاتصال الموثوقة تلقائيًا.";
+"subscriptions__allowance_add" = "إضافة مخصص";
+"subscriptions__allowance_title" = "المخصص";
+"subscriptions__allowance_choose_contact" = "اختر جهة اتصال";
+"subscriptions__allowance_no_contacts" = "أضف جهة اتصال أولًا. تغطي المخصصات طلبات الدفع من جهات اتصالك.";
+"subscriptions__allowance_set_title" = "تعيين المخصص";
+"subscriptions__allowance_set_explanation" = "وافق تلقائيًا على طلبات الدفع من {name} ضمن هذه الحدود:";
+"subscriptions__allowance_payment_limit" = "حد الدفعة";
+"subscriptions__allowance_monthly_allowance" = "المخصص الشهري";
+"subscriptions__allowance_set_summary" = "ستُدفع الطلبات حتى {perPayment} تلقائيًا، بحد أقصى {monthly} شهريًا، دون سؤالك في كل مرة.";
+"subscriptions__allowance_save" = "حفظ المخصص";
+"subscriptions__allowance_monthly_limit" = "الحد الشهري";
+"subscriptions__allowance_per_payment_short" = "{amount} للدفعة";
+"subscriptions__allowance_per_payment" = "لكل دفعة";
+"subscriptions__allowance_each_month" = "كل شهر";
+"subscriptions__allowance_up_to" = "حتى {amount}";
+"subscriptions__allowance_status_active" = "نشط";
+"subscriptions__allowance_status_waiting" = "بانتظار الرد";
+"subscriptions__allowance_status_needs_answer" = "بانتظار ردك";
+"subscriptions__allowance_status_scheduled" = "غير نشط بعد";
+"subscriptions__allowance_status_expired" = "منتهي الصلاحية";
+"subscriptions__allowance_status_declined" = "مرفوض";
+"subscriptions__allowance_status_conflicted" = "يحتاج إلى انتباه";
+"subscriptions__allowance_status_ended" = "منتهٍ";
+"subscriptions__allowance_paid_automatically" = "تم دفع {amount} تلقائيًا";
+"subscriptions__allowance_paid_so_far" = "مدفوع تلقائيًا";
+"subscriptions__allowance_offer_headline" = "{name} يعرض\n<accent>مخصصًا</accent>";
+"subscriptions__allowance_request_headline" = "{name} يطلب\n<accent>مخصصًا</accent>";
+"subscriptions__allowance_offer_explanation" = "ستدفع محفظة {name} طلباتك ضمن هذه الحدود دون السؤال في كل مرة. يمكن لأي منكما إنهاؤه.";
+"subscriptions__allowance_request_explanation" = "ستدفع محفظتك طلبات {name} ضمن هذه الحدود دون سؤالك في كل مرة. يمكن لأي منكما إنهاؤه.";
+"subscriptions__allowance_accept" = "قبول";
+"subscriptions__allowance_decline" = "رفض";
+"subscriptions__allowance_swipe_end" = "اسحب لإنهاء المخصص";
+"subscriptions__allowance_swipe_withdraw" = "اسحب للتراجع";
+"subscriptions__allowance_detail_active_allower" = "تُدفع الطلبات ضمن هذه الحدود تلقائيًا. أي طلب يتجاوزها يحتاج إلى موافقتك أولًا.";
+"subscriptions__allowance_detail_active_allowee" = "تُدفع طلباتك ضمن هذه الحدود تلقائيًا.";
+"subscriptions__allowance_detail_ended" = "انتهى هذا المخصص. سيتطلب كل طلب موافقتك من جديد.";
+"subscriptions__allowance_error_not_linked" = "جهة الاتصال هذه غير متصلة بعد. حاول مرة أخرى بعد قليل.";
+"subscriptions__allowance_error_unavailable" = "هذا المخصص غير متاح حاليًا.";
+"subscriptions__allowance_payment_in_progress" = "يجري دفع هذا الطلب بالفعل.";
+"subscriptions__allowance_executed_title" = "تم تنفيذ الدفع";
+"subscriptions__allowance_executed_description" = "أرسل الدفع التلقائي {amount} إلى {name}";
+"subscriptions__allowance_limit_title" = "تم بلوغ الحد";
+"subscriptions__allowance_limit_description" = "طلب بقيمة {amount} من {name} يتجاوز مخصصك. راجعه للدفع.";
+"subscriptions__allowance_auto_paid" = "مدفوع تلقائيًا";

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

@@ -1764,3 +1764,50 @@
 "usdt__deposit_tron_refund_note" = "Les devolucions de TRON poden requerir l'assistència d'un operador d'Orchestra.";
 "usdt__deposit_refund_address_network" = "Adreça USDT a {network}";
 "wallet__send_error_support" = "Contacta amb el suport";
+"subscriptions__allowances" = "Assignacions";
+"subscriptions__allowances_empty_headline" = "Configura\n<accent>assignacions</accent>";
+"subscriptions__allowances_empty_description" = "Pots establir límits de despesa per pagar automàticament les sol·licituds de pagament de contactes de confiança.";
+"subscriptions__allowance_add" = "Afegir assignació";
+"subscriptions__allowance_title" = "Assignació";
+"subscriptions__allowance_choose_contact" = "Triar contacte";
+"subscriptions__allowance_no_contacts" = "Afegeix primer un contacte. Les assignacions cobreixen les sol·licituds de pagament dels teus contactes.";
+"subscriptions__allowance_set_title" = "Establir assignació";
+"subscriptions__allowance_set_explanation" = "Aprova automàticament les sol·licituds de pagament de {name} per sota d'aquests límits:";
+"subscriptions__allowance_payment_limit" = "Límit per pagament";
+"subscriptions__allowance_monthly_allowance" = "Assignació mensual";
+"subscriptions__allowance_set_summary" = "Les sol·licituds de fins a {perPayment} es pagaran automàticament, fins a {monthly} al mes, sense preguntar-te cada vegada.";
+"subscriptions__allowance_save" = "Desar assignació";
+"subscriptions__allowance_monthly_limit" = "Límit mensual";
+"subscriptions__allowance_per_payment_short" = "{amount} per pagament";
+"subscriptions__allowance_per_payment" = "Per pagament";
+"subscriptions__allowance_each_month" = "Cada mes";
+"subscriptions__allowance_up_to" = "Fins a {amount}";
+"subscriptions__allowance_status_active" = "Activa";
+"subscriptions__allowance_status_waiting" = "Esperant resposta";
+"subscriptions__allowance_status_needs_answer" = "Esperant la teva resposta";
+"subscriptions__allowance_status_scheduled" = "Encara no activa";
+"subscriptions__allowance_status_expired" = "Caducada";
+"subscriptions__allowance_status_declined" = "Rebutjada";
+"subscriptions__allowance_status_conflicted" = "Requereix atenció";
+"subscriptions__allowance_status_ended" = "Finalitzada";
+"subscriptions__allowance_paid_automatically" = "{amount} pagat automàticament";
+"subscriptions__allowance_paid_so_far" = "Pagat automàticament";
+"subscriptions__allowance_offer_headline" = "{name} t'ofereix\n<accent>una assignació</accent>";
+"subscriptions__allowance_request_headline" = "{name} demana\n<accent>una assignació</accent>";
+"subscriptions__allowance_offer_explanation" = "La cartera de {name} pagarà les teves sol·licituds dins d'aquests límits sense preguntar cada vegada. Qualsevol de vosaltres hi pot posar fi.";
+"subscriptions__allowance_request_explanation" = "La teva cartera pagarà les sol·licituds de {name} dins d'aquests límits sense preguntar-te cada vegada. Qualsevol de vosaltres hi pot posar fi.";
+"subscriptions__allowance_accept" = "Acceptar";
+"subscriptions__allowance_decline" = "Rebutjar";
+"subscriptions__allowance_swipe_end" = "Desplaça per finalitzar l'assignació";
+"subscriptions__allowance_swipe_withdraw" = "Desplaça per retirar";
+"subscriptions__allowance_detail_active_allower" = "Les sol·licituds dins d'aquests límits es paguen automàticament. Qualsevol import superior et demanarà confirmació abans.";
+"subscriptions__allowance_detail_active_allowee" = "Les teves sol·licituds dins d'aquests límits es paguen automàticament.";
+"subscriptions__allowance_detail_ended" = "Aquesta assignació ha finalitzat. Cada sol·licitud tornarà a demanar confirmació.";
+"subscriptions__allowance_error_not_linked" = "Aquest contacte encara no està connectat. Torna-ho a provar d'aquí a un moment.";
+"subscriptions__allowance_error_unavailable" = "Aquesta assignació no està disponible ara mateix.";
+"subscriptions__allowance_payment_in_progress" = "Aquesta sol·licitud ja s'està pagant.";
+"subscriptions__allowance_executed_title" = "Pagament executat";
+"subscriptions__allowance_executed_description" = "El pagament automàtic ha enviat {amount} a {name}";
+"subscriptions__allowance_limit_title" = "Límit assolit";
+"subscriptions__allowance_limit_description" = "Una sol·licitud de {amount} de {name} supera la teva assignació. Revisa-la per pagar.";
+"subscriptions__allowance_auto_paid" = "Pagat automàticament";