fix(CW-1638): include transaction notes in history CSV export (#3623)

* fix(CW-1638): include transaction notes in history CSV export The `note` column of the transaction-history CSV export was always written as an empty string for transaction rows, so notes a user added to a transaction never appeared in the exported file. Index the `TransactionDescription` Hive box once per export and look each transaction's note up by the same keys the app writes them under (`<txHash>_<primaryAddress>`, falling back to the legacy bare `<txHash>`), then write it through the existing `escapeField` so multi-line notes and notes containing commas or quotes stay valid CSV. `CsvExportService` now takes the box, so it is resolved through `getIt` at both export entry points. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q5EdTdWZSvzbKKmd9MCEJh * perf(CW-1638): resolve the note-key address once per CSV export `_noteFor` read `balanceViewModel.wallet.walletAddresses.primaryAddress` once per transaction row. On Monero and Wownero that getter is not a field read: it calls `getAddress`, which issues an FFI `numSubaddresses` call plus four `ffiAddress` calls before its address cache is consulted. Since `buildCsvContent` runs on the main isolate, exporting a wallet with a long history meant thousands of synchronous FFI round-trips with no yield point. Every item in one export belongs to the same wallet, so the value is invariant across rows. Resolve it once in `buildCsvContent` and thread it through to `_noteFor`. An export holding no transaction rows now skips the read entirely. No change to the exported output. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q5EdTdWZSvzbKKmd9MCEJh * fix(CW-1638): neutralise spreadsheet formulas in CSV export The note column this PR adds is fed by TransactionDescription.transactionNote, which is not always authored by the user: a scanned bitcoin: URI carries tx_description / message straight through payment_request.dart into Output.note, and an address-resolution result writes Output.note too. Both are folded into the note persisted by SendViewModel. escapeField only quoted for , " and \n, so a note beginning with = + - @ TAB or CR reached the cell untouched and Excel / LibreOffice / Sheets evaluate it as a formula (=IMPORTDATA to exfiltrate a neighbouring cell, =HYPERLINK for phishing anchor text, =cmd|… for DDE). trade.memo and the provider-supplied trade/order strings had the same exposure already. Neutralise inside escapeField rather than at the two call sites so every column is covered and a future free-text column cannot forget it. Values starting with a trigger are prefixed with an apostrophe, the spreadsheet text marker, guarded by a plain-number test so negative amounts are left alone — formatFixed really can emit a leading '-'. Also quote on a bare \r, which previously passed through unquoted and splits rows in many CSV parsers. Tests cover the escaping rules, the neutralisation, a row built end to end, and the note column itself, including the two lookup keys and the payment-request injection path. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * perf(CW-1638): bound the CSV note lookup to the exported rows Review feedback: the note index copied every entry in the shared transactionDescriptionBox, including notes belonging to other wallets, so its memory scaled with the box rather than with the export. Collect the keys the exported rows can ask for first — for each transaction row both `<txHash>_<primaryAddress>` and the bare `<txHash>` — then walk the box once and keep only matching notes. Lookups stay O(1) per row and first-wins/key-preference behaviour is unchanged; a box walk is skipped entirely when the export has no transaction rows. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q5EdTdWZSvzbKKmd9MCEJh * refactor(CW-1638): simplify the CSV note lookup to a plain scan Notes are written into the TransactionDescriptions box with `add` (send_view_model.dart:1257,1263 and transaction_details_view_model.dart:299), so entries carry auto-incrementing integer keys and `box.get(descriptionKey)` cannot find them. Drop the prebuilt lookup map and the wanted-key set in favour of a per-row scan that mirrors the app's own read path in `TransactionDetailsViewModel.note`. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q5EdTdWZSvzbKKmd9MCEJh * docs(CW-1638): drop the explanatory comments from the CSV note lookup [skip ci] Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q5EdTdWZSvzbKKmd9MCEJh --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Omar <omarh.ismail1@gmail.com>
2026-10-26 06:08:40 +01:00 · 2026-09-14 14:43:12 +02:00
parent 21c73d0012
commit ef6879b617
5 changed files with 523 additions and 10 deletions
@@ -1,5 +1,6 @@
 import 'dart:io';

+import 'package:cake_wallet/entities/transaction_description.dart';
 import 'package:cake_wallet/generated/i18n.dart';
 import 'package:cake_wallet/src/screens/backup/backup_page.dart';
 import 'package:cake_wallet/src/widgets/alert_with_two_actions.dart';
@@ -13,13 +14,19 @@ import 'package:cake_wallet/view_model/dashboard/order_list_item.dart';
 import 'package:cake_wallet/view_model/dashboard/payjoin_transaction_list_item.dart';
 import 'package:cake_wallet/view_model/dashboard/trade_list_item.dart';
 import 'package:cake_wallet/view_model/dashboard/transaction_list_item.dart';
+import 'package:collection/collection.dart';
 import 'package:cw_core/transaction_direction.dart';
 import 'package:file_picker/file_picker.dart';
 import 'package:flutter/material.dart';
+import 'package:hive/hive.dart';
 import 'package:intl/intl.dart';
 import 'package:path_provider/path_provider.dart';

 class CsvExportService {
+  CsvExportService({required this.transactionDescriptionBox});
+
+  final Box<TransactionDescription> transactionDescriptionBox;
+
  static const _columns = [
    'record_type',
    'date_time',
@@ -42,23 +49,46 @@ class CsvExportService {

  static const _utf8Bom = '';

+  static const _formulaTriggers = {'=', '+', '-', '@', '\t', '\r'};
+
+  static final _plainNumber = RegExp(r'^-?\d+(\.\d+)?$');
+
  String buildCsvContent(List<ActionListItem> items) {
    final buf = StringBuffer();
    buf.write(_utf8Bom);
    buf.writeln(_columns.join(','));

+    final primaryAddress = _primaryAddressOf(items);
+
    for (final item in items) {
      if (item is DateSectionItem) continue;

-      final row = _buildRow(item);
+      final row = _buildRow(item, primaryAddress);
      if (row != null) buf.writeln(row);
    }

    return buf.toString();
  }

-  String? _buildRow(ActionListItem item) {
-    if (item is TransactionListItem) return _transactionRow(item);
+  String _primaryAddressOf(List<ActionListItem> items) {
+    for (final item in items) {
+      if (item is TransactionListItem) {
+        return item.balanceViewModel.wallet.walletAddresses.primaryAddress;
+      }
+    }
+    return '';
+  }
+
+  String _noteFor(TransactionListItem item, String primaryAddress) {
+    final txHash = item.transaction.txHash;
+    final descriptionKey = '${txHash}_$primaryAddress';
+    final description = transactionDescriptionBox.values
+        .firstWhereOrNull((val) => val.id == descriptionKey || val.id == txHash);
+    return description?.note ?? '';
+  }
+
+  String? _buildRow(ActionListItem item, String primaryAddress) {
+    if (item is TransactionListItem) return _transactionRow(item, primaryAddress);
    if (item is TradeListItem) return _tradeRow(item);
    if (item is OrderListItem) return _orderRow(item);
    if (item is AnonpayTransactionListItem) return _anonpayRow(item);
@@ -66,7 +96,7 @@ class CsvExportService {
    return null;
  }

-  String _transactionRow(TransactionListItem item) {
+  String _transactionRow(TransactionListItem item, String primaryAddress) {
    final tx = item.transaction;
    final type = tx.direction == TransactionDirection.incoming ? 'incoming' : 'outgoing';
    final status = tx.isPending ? 'pending' : 'confirmed';
@@ -88,7 +118,7 @@ class CsvExportService {
      tx.id,
      address,
      status,
-      '',
+      _noteFor(item, primaryAddress),
      '',
      '',
      '',
@@ -200,10 +230,20 @@ class CsvExportService {
  String _row(List<String> fields) => fields.map(escapeField).join(',');

  String escapeField(String field) {
-    if (field.contains(',') || field.contains('"') || field.contains('\n')) {
-      return '"${field.replaceAll('"', '""')}"';
+    final value = _neutralizeFormula(field);
+    if (value.contains(',') ||
+        value.contains('"') ||
+        value.contains('\n') ||
+        value.contains('\r')) {
+      return '"${value.replaceAll('"', '""')}"';
    }
-    return field;
+    return value;
+  }
+
+  String _neutralizeFormula(String field) {
+    if (field.isEmpty || !_formulaTriggers.contains(field[0])) return field;
+    if (_plainNumber.hasMatch(field)) return field;
+    return "'$field";
  }

  String _isoDate(DateTime dt) => dt.toUtc().toIso8601String();
@@ -22,6 +22,7 @@ import 'package:cake_wallet/cake_pay/src/services/cake_pay_api.dart';
 import 'package:cake_wallet/cake_pay/src/services/cake_pay_service.dart';
 import 'package:cake_wallet/core/auth_service.dart';
 import 'package:cake_wallet/core/backup_service_v3.dart';
+import 'package:cake_wallet/core/csv_export_service.dart';
 import 'package:cake_wallet/core/key_service.dart';
 import 'package:cake_wallet/core/new_wallet_arguments.dart';
 import 'package:cake_wallet/core/new_wallet_type_arguments.dart';
@@ -1415,6 +1416,9 @@ Future<void> setup({
            param1: derivations,
          )));

+  getIt.registerFactory<CsvExportService>(
+      () => CsvExportService(transactionDescriptionBox: _transactionDescriptionBox));
+
  getIt.registerFactoryParam<TransactionDetailsViewModel, List<dynamic>, void>((params, _) {
    final transactionInfo = params[0] as TransactionInfo;
    final canReplaceByFee = params[1] as bool? ?? false;
@@ -1,4 +1,5 @@
 import 'package:cake_wallet/core/csv_export_service.dart';
+import 'package:cake_wallet/di.dart';
 import 'package:cake_wallet/generated/i18n.dart';
 import 'package:cake_wallet/new-ui/widgets/coins_page/assets_history/history_filters_page.dart';
 import 'package:cake_wallet/new-ui/widgets/coins_page/assets_history/history_section.dart';
@@ -33,7 +34,7 @@ class HistoryModal extends StatelessWidget {
            ),
            trailingSemanticLabel: S.of(context).export_csv,
            onTrailingPressed: () =>
-                CsvExportService().exportToCsv(dashboardViewModel.items, context),
+                getIt.get<CsvExportService>().exportToCsv(dashboardViewModel.items, context),
          ),
          Expanded(
              child: Stack(
@@ -1,5 +1,6 @@
 import 'package:cake_wallet/bitcoin/bitcoin.dart';
 import 'package:cake_wallet/core/csv_export_service.dart';
+import 'package:cake_wallet/di.dart';
 import 'package:cake_wallet/entities/balance_display_mode.dart';
 import 'package:cake_wallet/order/order_source_description.dart';
 import 'package:cake_wallet/src/screens/dashboard/widgets/anonpay_transaction_row.dart';
@@ -66,7 +67,8 @@ class TransactionsPage extends StatelessWidget {
            }),
            HeaderRow(
              dashboardViewModel: dashboardViewModel,
-              onExportCsv: () => CsvExportService().exportToCsv(dashboardViewModel.items, context),
+              onExportCsv: () =>
+                  getIt.get<CsvExportService>().exportToCsv(dashboardViewModel.items, context),
              key: ValueKey('transactions_page_header_row_key'),
            ),
            Expanded(