feat: add balance formatting across the app [#issue 307]

Author: r1b2ns

BDKSwiftExampleWallet/Model/BalanceDisplayFormat.swift

@@ -15,6 +15,14 @@ enum BalanceDisplayFormat: String, CaseIterable, Codable {
     case fiat = "usd"
     case bip177 = "bip177"
 
+    var displayPrefix: String {
+        switch self {
+        case .bitcoinSats, .bitcoin, .bip177: return "₿"
+        case .fiat: return "$"
+        default : return ""
+        }
+    }
+    
     var displayText: String {
         switch self {
         case .sats, .bitcoinSats: return "sats"
@@ -23,6 +31,22 @@ enum BalanceDisplayFormat: String, CaseIterable, Codable {
         case .fiat: return "USD"
         }
     }
+    
+    func formatted(_ btcAmount: UInt64, fiatPrice: Double) -> String {
+        switch self {
+        case .sats:
+            return btcAmount.formatted(.number)
+        case .bitcoin:
+            return String(format: "%.8f", Double(btcAmount) / 100_000_000)
+        case .bitcoinSats:
+            return btcAmount.formattedSatoshis()
+        case .fiat:
+            let satsPrice = Double(btcAmount).valueInUSD(price: fiatPrice)
+            return satsPrice.formatted(.number.precision(.fractionLength(2)))
+        case .bip177:
+            return btcAmount.formattedBip177()
+        }
+    }
 }
 
 extension BalanceDisplayFormat {

BDKSwiftExampleWallet/Resources/Localizable.xcstrings

@@ -204,12 +204,12 @@
         }
       }
     },
-    "%@%lld sats" : {
+    "%@%@ %@" : {
       "localizations" : {
         "en" : {
           "stringUnit" : {
             "state" : "new",
-            "value" : "%1$@%2$lld sats"
+            "value" : "%1$@%2$@ %3$@"
           }
         }
       }

BDKSwiftExampleWallet/View Model/Activity/ActivityListViewModel.swift

@@ -22,6 +22,7 @@ class ActivityListViewModel {
     var totalScripts: UInt64 = 0
     var walletSyncState: WalletSyncState
     var walletViewError: AppError?
+    var fiatPrice: Double
 
     private var updateProgress: @Sendable (UInt64, UInt64) -> Void {
         { [weak self] inspected, total in
@@ -41,11 +42,13 @@ class ActivityListViewModel {
     init(
         bdkClient: BDKClient = .live,
         transactions: [CanonicalTx] = [],
-        walletSyncState: WalletSyncState = .notStarted
+        walletSyncState: WalletSyncState = .notStarted,
+        fiatPrice: Double
     ) {
         self.bdkClient = bdkClient
         self.transactions = transactions
         self.walletSyncState = walletSyncState
+        self.fiatPrice = fiatPrice
 
         // Preload cached data synchronously so UI has content before first render
         // transactions + listUnspent items are available from the persisted wallet db

BDKSwiftExampleWallet/View/Activity/ActivityListView.swift

@@ -9,6 +9,8 @@ import BitcoinDevKit
 import SwiftUI
 
 struct ActivityListView: View {
+    @AppStorage("balanceDisplayFormat") private var balanceFormat: BalanceDisplayFormat =
+        .bitcoinSats
     @Bindable var viewModel: ActivityListViewModel
 
     var body: some View {
@@ -26,7 +28,9 @@ struct ActivityListView: View {
                     TransactionListView(
                         viewModel: .init(),
                         transactions: viewModel.transactions,
-                        walletSyncState: viewModel.walletSyncState
+                        walletSyncState: viewModel.walletSyncState,
+                        format: balanceFormat,
+                        fiatPrice: viewModel.fiatPrice
                     )
                     .transition(.blurReplace)
                 } else {
@@ -80,5 +84,5 @@ struct CustomSegmentedControl: View {
 }
 
 #Preview {
-    ActivityListView(viewModel: .init())
+    ActivityListView(viewModel: .init(fiatPrice: 714.23))
 }

BDKSwiftExampleWallet/View/Activity/TransactionItemView.swift

@@ -13,6 +13,20 @@ struct TransactionItemView: View {
     @Environment(\.dynamicTypeSize) var dynamicTypeSize
     let txDetails: TxDetails
     let isRedacted: Bool
+    private let format: BalanceDisplayFormat
+    private var fiatPrice: Double
+    
+    init(
+        txDetails: TxDetails,
+        isRedacted: Bool,
+        format: BalanceDisplayFormat,
+        fiatPrice: Double
+    ) {
+        self.txDetails = txDetails
+        self.isRedacted = isRedacted
+        self.format = format
+        self.fiatPrice = fiatPrice
+    }
 
     var body: some View {
 
@@ -98,10 +112,11 @@ struct TransactionItemView: View {
             Spacer()
 
             let delta = txDetails.balanceDelta
-            let prefix = delta >= 0 ? "+ " : "- "
-            let amount = abs(delta)
+            let prefix = (delta >= 0 ? "+ " : "- ").appending("\(format.displayPrefix) ")
+            let amount = format.formatted(UInt64(abs(delta)), fiatPrice: fiatPrice)
+            let suffix = format.displayText
 
-            Text("\(prefix)\(amount) sats")
+            Text("\(prefix)\(amount) \(suffix)")
                 .font(.subheadline)
                 .fontWeight(.semibold)
                 .fontDesign(.rounded)
@@ -120,7 +135,9 @@ struct TransactionItemView: View {
     #Preview {
         TransactionItemView(
             txDetails: .mock,
-            isRedacted: false
+            isRedacted: false,
+            format: .bip177,
+            fiatPrice: 714.23
         )
     }
 #endif

BDKSwiftExampleWallet/View/Activity/TransactionListView.swift

@@ -13,14 +13,32 @@ struct TransactionListView: View {
     @Bindable var viewModel: TransactionListViewModel
     let transactions: [CanonicalTx]
     let walletSyncState: WalletSyncState
-
+    private let format: BalanceDisplayFormat
+    private let fiatPrice: Double
+
+    init(
+        viewModel: TransactionListViewModel,
+        transactions: [CanonicalTx],
+        walletSyncState: WalletSyncState,
+        format: BalanceDisplayFormat,
+        fiatPrice: Double
+    ) {
+        self.viewModel = viewModel
+        self.transactions = transactions
+        self.walletSyncState = walletSyncState
+        self.format = format
+        self.fiatPrice = fiatPrice
+    }
+    
     var body: some View {
 
         List {
             if transactions.isEmpty && walletSyncState == .syncing {
                 TransactionItemView(
                     txDetails: .mock,
-                    isRedacted: true
+                    isRedacted: true,
+                    format: format,
+                    fiatPrice: fiatPrice
                 )
                 .listRowInsets(EdgeInsets())
                 .listRowSeparator(.hidden)
@@ -99,7 +117,9 @@ struct TransactionListView: View {
                         ) {
                             TransactionItemView(
                                 txDetails: txDetails,
-                                isRedacted: false
+                                isRedacted: false,
+                                format: format,
+                                fiatPrice: fiatPrice
                             )
                         }
 
@@ -139,7 +159,9 @@ struct TransactionListView: View {
             transactions: [
                 .mock
             ],
-            walletSyncState: .synced
+            walletSyncState: .synced,
+            format: .bip177,
+            fiatPrice: 714.23
         )
     }
     #Preview {
@@ -148,7 +170,9 @@ struct TransactionListView: View {
                 bdkClient: .mock
             ),
             transactions: [],
-            walletSyncState: .synced
+            walletSyncState: .synced,
+            format: .bip177,
+            fiatPrice: 714.23
         )
     }
 #endif

BDKSwiftExampleWallet/View/Home/BalanceView.swift

@@ -14,10 +14,6 @@ struct BalanceView: View {
     private var format: BalanceDisplayFormat
     private let balance: UInt64
     private var fiatPrice: Double
-    private var satsPrice: Double {
-        let usdValue = Double(balance).valueInUSD(price: fiatPrice)
-        return usdValue
-    }
 
     private var currencySymbol: some View {
         Image(systemName: format == .fiat ? "dollarsign" : "bitcoinsign")
@@ -37,34 +33,23 @@ struct BalanceView: View {
 
     @MainActor
     private var formattedBalance: String {
-        switch format {
-        case .sats:
-            return balance.formatted(.number)
-        case .bitcoin:
-            return String(format: "%.8f", Double(balance) / 100_000_000)
-        case .bitcoinSats:
-            return balance.formattedSatoshis()
-        case .fiat:
-            return satsPrice.formatted(.number.precision(.fractionLength(2)))
-        case .bip177:
-            return balance.formattedBip177()
-        }
+        return format.formatted(balance, fiatPrice: fiatPrice)
     }
 
     @MainActor
     var balanceText: some View {
-        Text(format == .fiat && satsPrice == 0 ? "00.00" : formattedBalance)
+        Text(format == .fiat && fiatPrice == 0 ? "00.00" : formattedBalance)
             .contentTransition(.numericText(countsDown: true))
             .fontWeight(.semibold)
             .fontDesign(.rounded)
             .foregroundStyle(
-                format == .fiat && satsPrice == 0 ? .secondary : .primary
+                format == .fiat && fiatPrice == 0 ? .secondary : .primary
             )
             .opacity(
-                format == .fiat && satsPrice == 0 ? balanceTextPulsingOpacity : 1
+                format == .fiat && fiatPrice == 0 ? balanceTextPulsingOpacity : 1
             )
             .animation(.spring(response: 0.4, dampingFraction: 0.8), value: format)
-            .animation(.easeInOut, value: satsPrice)
+            .animation(.easeInOut, value: fiatPrice)
             .onAppear {
                 withAnimation(.easeInOut(duration: 1.5).repeatForever(autoreverses: true)) {
                     balanceTextPulsingOpacity = 0.3

BDKSwiftExampleWallet/View/WalletView.swift

@@ -59,7 +59,9 @@ struct WalletView: View {
                     TransactionListView(
                         viewModel: .init(),
                         transactions: viewModel.recentTransactions,
-                        walletSyncState: viewModel.walletSyncState
+                        walletSyncState: viewModel.walletSyncState,
+                        format: balanceFormat,
+                        fiatPrice: viewModel.price
                     )
                     .refreshable {
                         if viewModel.isKyotoClient {
@@ -151,7 +153,7 @@ struct WalletView: View {
 
         }
         .navigationDestination(isPresented: $showAllTransactions) {
-            ActivityListView(viewModel: .init())
+            ActivityListView(viewModel: .init(fiatPrice: viewModel.price))
         }
         .navigationDestination(for: NavigationDestination.self) { destination in
             switch destination {