Use net amount calculations with clear names

SatoshiPortal · Dec 21, 2024 · 5dff85b · 5dff85b
1 parent ff8e42d
commit 5dff85b
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 18 deletions.
diff --git a/lib/_model/transaction.dart b/lib/_model/transaction.dart
@@ -154,9 +154,19 @@ class Transaction with _$Transaction {
     }
   }
 
-  int getAmount({bool sentAsTotal = false}) {
+  /// Amount paid to the recipient of the transaction
+  int getNetAmountToPayee() {
     try {
-      return sentAsTotal ? (sent! - received!) : (sent! - received! - fee!);
+      return sent! - received!;
+    } catch (e) {
+      return 0;
+    }
+  }
+
+  /// Amount spent by the wallet to effectuate the transaction
+  int getNetAmountIncludingFees() {
+    try {
+      return getNetAmountToPayee() - fee!;
     } catch (e) {
       return 0;
     }

diff --git a/lib/_model/wallet.dart b/lib/_model/wallet.dart
@@ -190,19 +190,21 @@ class Wallet with _$Wallet {
   }
 
   int totalReceived() {
-    final txs = transactions.where((tx) => tx.getAmount() > 0).toList();
+    final txs =
+        transactions.where((tx) => tx.getNetAmountToPayee() > 0).toList();
     int amt = 0;
     for (final tx in txs) {
-      amt += tx.getAmount().abs();
+      amt += tx.getNetAmountToPayee().abs();
     }
     return amt;
   }
 
   int totalSent() {
-    final txs = transactions.where((tx) => tx.getAmount() < 0).toList();
+    final txs =
+        transactions.where((tx) => tx.getNetAmountIncludingFees() < 0).toList();
     int amt = 0;
     for (final tx in txs) {
-      amt += tx.getAmount(sentAsTotal: true).abs();
+      amt += tx.getNetAmountIncludingFees().abs();
     }
     return amt;
   }

diff --git a/lib/home/transactions.dart b/lib/home/transactions.dart
@@ -290,7 +290,7 @@ class HomeTxItem2 extends StatelessWidget {
 
     final amount = context.select(
       (CurrencyCubit x) => x.state
-          .getAmountInUnits(tx.getAmount(sentAsTotal: true), removeText: true),
+          .getAmountInUnits(tx.getNetAmountIncludingFees(), removeText: true),
     );
 
     final units = context.select(

diff --git a/lib/send/psbt.dart b/lib/send/psbt.dart
@@ -38,7 +38,7 @@ class PSBTPopUp extends StatelessWidget {
 
     // final outAddresses = context.select((SendCubit cubit) => cubit.state.tx?.outAddresses ?? []);
 
-    final txamt = tx.getAmount();
+    final txamt = tx.getNetAmountToPayee();
     final isSats =
         context.select((CurrencyCubit cubit) => cubit.state.unitsInSats);
     final txfee = context.select((SendCubit cubit) => cubit.state.tx?.fee ?? 0);

diff --git a/lib/swap/receive.dart b/lib/swap/receive.dart
@@ -356,7 +356,7 @@ class _ReceivingSwapPageState extends State<ReceivingSwapPage>
       (HomeCubit cubit) => cubit.state.getTxFromSwap(swapTx),
     );
 
-    if (tx != null) amt = tx.getAmount();
+    if (tx != null) amt = tx.getNetAmountToPayee();
 
     final isSats = context.select((CurrencyCubit _) => _.state.unitsInSats);
     final amtDouble = isSats ? amt : amt / 100000000;

diff --git a/lib/swap/swap_confirmation.dart b/lib/swap/swap_confirmation.dart
@@ -55,7 +55,7 @@ class _SwapConfirmationPageState extends State<SwapConfirmationPage> {
       hiveStorage: locator<HiveStorage>(),
       bbAPI: locator<BullBitcoinAPI>(),
       defaultCurrencyCubit: context.read<CurrencyCubit>(),
-    )..updateAmountDirect(widget.send.state.tx!.getAmount(sentAsTotal: true));
+    )..updateAmountDirect(widget.send.state.tx!.getNetAmountIncludingFees());
 
     super.initState();
   }

diff --git a/lib/transaction/bump_fees.dart b/lib/transaction/bump_fees.dart
@@ -241,7 +241,7 @@ class _Screen extends StatelessWidget {
     final isSwapPending = tx.swapIdisTxid();
 
     final txid = tx.txid;
-    final amt = tx.getAmount().abs();
+    final amt = tx.getNetAmountToPayee().abs();
     final isReceived = tx.isReceived();
     final fees = tx.fee ?? 0;
     final amtStr = context.select(

diff --git a/lib/transaction/transaction_page.dart b/lib/transaction/transaction_page.dart
@@ -229,7 +229,7 @@ class _TxDetails extends StatelessWidget {
 
     final txid = tx.txid;
     final unblindedUrl = tx.unblindedUrl;
-    final amt = tx.getAmount().abs();
+    final amt = tx.getNetAmountToPayee().abs();
     final isReceived = tx.isReceived();
     final fees = tx.fee ?? 0;
     final amtStr = context.select(
@@ -699,7 +699,7 @@ class _OnchainSwapDetails extends StatelessWidget {
     final fromStatusStr = fromStatus ? 'Pending' : 'Confirmed';
     final fromAmtStr = context.select(
       (CurrencyCubit cubit) => cubit.state
-          .getAmountInUnits(tx.getAmount(sentAsTotal: true), removeText: true),
+          .getAmountInUnits(tx.getNetAmountIncludingFees(), removeText: true),
     );
     final fromUnits = context.select(
       (CurrencyCubit cubit) => cubit.state.getUnitString(isLiquid: isLiq),
@@ -728,7 +728,7 @@ class _OnchainSwapDetails extends StatelessWidget {
       if (receiveTx != null) {
         toAmtStr = context.select(
           (CurrencyCubit cubit) => cubit.state.getAmountInUnits(
-            receiveTx!.getAmount(sentAsTotal: true),
+            receiveTx!.getNetAmountIncludingFees(),
             removeText: true,
           ),
         );

diff --git a/lib/wallet/wallet_txs.dart b/lib/wallet/wallet_txs.dart
@@ -138,9 +138,7 @@ class HomeTxItem extends StatelessWidget {
 
     final amount = context.select(
       (CurrencyCubit x) => x.state.getAmountInUnits(
-        tx.getAmount(
-          sentAsTotal: true,
-        ),
+        tx.getNetAmountIncludingFees(),
         isLiquid: tx.isLiquid,
       ),
     );
@@ -175,7 +173,7 @@ class HomeTxItem extends StatelessWidget {
                 // color: Colors.red,
                 transformAlignment: Alignment.center,
                 transform: Matrix4.identity()
-                  ..rotateZ(tx.getAmount() > 0 ? 0 : 3.16),
+                  ..rotateZ(tx.getNetAmountToPayee() > 0 ? 0 : 3.16),
                 child: Image.asset(img),
               ),
             ),