Files
hash-wallet/lib/view_model/payment/payment_view_model.dart
T
75f3fe735b Introduce Money class and refactor currency handling (#3157)
* feat: add `Money` class for precise currency handling and amount parsing

- Introduced `Money` class for handling money values with fixed-point precision.
- Added parsing and comparison methods to `CryptoCurrency` and `FiatCurrency` interfaces.
- Implemented `smartAmountSanitizer` for format normalization.

Includes extensive unit tests for validation.

* refactor: optimize Money class with new factories and string formatting improvements

* refactor: unify balance handling with `Money` refactor

* refactor: update `ElectrumBalance` and transaction logic to use `Money` for currency precision

* refactor: standardize balance handling with `Money` across `Monero`, `Wownero`, and `Zano` wallets

* refactor: migrate EVM balance and transaction handling to `Money` for consistent currency precision

* refactor: migrate Decred balance and transaction handling to `Money` for consistent currency precision

* refactor: migrate nano balance and transaction handling to `Money` for consistent currency precision

* refactor: migrate Solana balance and transaction logic to `Money` for precise currency handling

* refactor: migrate Tron balance and transaction handling to `Money` for consistent currency precision

* refactor: migrate Zcash balance and transaction handling to `Money` for consistent currency precision

* refactor: adjust lib to handle money

* refactor: remove legacy Decred amount formatting and migrate to `Money`

* refactor: migrate pending transaction amount and fee to `Money`

* refactor: migrate dEuro savings and transaction logic to `Money` for improved precision and consistency

* refactor: migrate Bitcoin and lightning transaction logic to `Money` for consistent currency precision

* refactor: migrate Wownero, EVM, Zano, and Zcash transaction logic to `Money` for consistent and precise currency handling

* refactor: standardize balance handling across wallets, migrate to `Money.zero` and refine `Balance` class for consistency

* refactor: migrate Solana transaction and wallet logic to `Money` for consistent and precise currency handling

* refactor: improve fiat balance and formatting for consistency on dashboard

* fix: fiat input mode switching and standardize crypto amount display logic

* fix: cw_evm generator

* refactor: migrate exchange amount handling to `Money` for improved precision and consistency

* test: remove redundant and commented-out tests, tidy test cases, and apply minor formatting adjustments

* fix using Money wrapper in BridgeViewModel and USDT0Service

* refactor: streamline `AmountConverter` and `LightningWallet`, add `cw_core` tests to GitHub workflow, and remove unused/deprecated logic

* refactor: enhance `changeReceiveAmount` with `isCanonical` support, improve null handling, and refine amount parsing logic

* minor fix

* try/catch the lightning log file error

* feat: add copy-to-clipboard functionality for transaction amounts, fix typo in trailing widget method name (#3219)

* Cw 1234 disallow sp and mweb addresses as refund for swaps (#3187)

* disallow SP and MWEB for swaps

* Simplify address selection in addressForExchange

Refactor addressForExchange method to simplify address selection logic.

* validate refund and receive address types

* localize address validation messages

* minor ui fix [skip ci]

* minor fix [skip ci]

* Revert "localize address validation messages"

* fix translations

---------

Co-authored-by: Omar Hatem <omarh.ismail1@gmail.com>

* refactor: replace manual amount sanitization with `sanitized()` extension across the codebase, add unit tests for `AmountSanitizer`

* fix: correct `sanitized()` test expectations for decimal handling in `amount_sanitizer_test.dart`

* refactor: fee display logic and append currency symbol in `send_confirm_sheet.dart`

* refactor: simplify `ZcashBalance` class by replacing custom fields with inherited properties, update references accordingly

* refactor: replace hardcoded USDT contract address with `DefaultTronTokens` lookup, improve maintainability

* refactor: replace `currency` with `inputAmount.currency` in Solana transaction signing methods to avoid inconsistency

* fix: handle null `fee` in `electrum_transaction_info.dart` to prevent potential runtime errors

* refactor: replace raw fee and amount handling with `Money` object for improved consistency and maintainability

* fix: limit fiat balance display to 2 decimal places in `balance_view_model.dart`

* refactor: replace raw `amount` and `fee` types with `Money` in Solana transaction methods for consistency and precision

* refactor: replace raw `amount` and `fee` handling with `Money` and improve balance calculation consistency across view models

* refactor: replace raw balance strings with `Money` and simplify `UnconfirmedBalanceModal` widget logic

* refactor: replace `print` with `printV` for better logging, add equality and hashCode overrides to `ERC20Currency` for object comparison

* feat: prepare deuro savings migration

* feat: add V1 savings migration support and improve formatting consistency in DEuro view model

* feat: add V1 savings withdrawal support and update associated UI components and logic

* refactor: replace `Image.asset` with `CakeImageWidget`, update balance string handling, and streamline address validation logic

* refactor: use `Money.tryParse` with fallback to `Money.zero` in `NanoBalance.fromRawString` for safer balance parsing

* refactor: replace `ERC20Currency` with `Erc20Token` for consistency and remove unused `evm_erc20_currency.dart` file

* refactor: add computed `hasDepositAmount` for deposit null-checks, optimize balance handling in `zano_wallet`, update Breez SDK to v0.14.0, and implement equality/hashCode for `Currency`

* refactor: rename `amountSats` to `amount` in `PrepareLnurlPayRequest` for consistency

* revert: downgrade Breez SDK to v0.11.0 in `pubspec.yaml` and update relevant references in `pubspec.lock`

* fix: use `cryptoAmount.copyWith` for currency consistency and replace `Image.asset` with `CakeImageWidget` in swap address modal

* fix: ensure currency consistency by using `cryptoAmount.copyWith` in Solana and EVM wallet transactions

* refactor: simplify CSV row generation logic by removing `_splitAmountCurrency` and streamlining amount/fee handling

* fix: LateInitializationError Field 'sdk' has not been initialized

* fix: use `Money.tryParse` for safer parsing of deposit and receive amounts

* chore: remove debug print statement

* refactor: update transaction processing to consistently use `Money` for amounts and fees

* refactor: improve currency and amount handling, simplify logic, and enhance code readability in Send and Swap pages

* refactor: integrate `DecimalInputFormatter` for consistent decimal input across Send and Swap pages, simplify input handling logic

* fix: "fiatMode" per output on sendPage

* refactor: make transaction_details_height applicable more readable

* fix: use correct base unit for deposit

* refactor: use Money in estimateFakeSendAllTxAmount method

* fix decred frozen balance
minor fixes

* fix decred frozen balance
minor fixes

* fix: automatically switch to lightning if lnurl or invoice detected

* fix: getBolt11Amount test cases

* fix: standardise crypto amount formatting and display

* fix: use base unit for Tron transaction fee parsing
* refactor: hardcode fractional digits to 8 in `AmountParsingProxy` display methods
* refactor: ensure consistent 8-decimal precision for fee formatting in `PendingTransaction`
* fix: use `AmountParsingProxy` for available balance display in exchange view model
* fix: improve amount formatting and layout in swap and send confirmation sheets
* chore: remove redundant decimal truncation in balance view model and send confirmation sheet

* fix: allow for editing text field if it is filled with "ALL"

* fix: allow for editing text field if it is filled with "ALL"

* fix: update currency detection logic for lightning mode

* avoid potential infinite loop [skip ci]

* fix: getDisplayCryptoAmount

* fix: update estimated fee calculation

* chore: simplify fee calculation logic [skip-ci]

* fix value display in hidden mode

* fix stale state in send confirm sheet

* fix decimals for mweb

* fix available balance display for sol/trx on swap

* restore proper hint text

* fix swap receive amount calculation for xno

---------

Co-authored-by: Omar Hatem <omarh.ismail1@gmail.com>
Co-authored-by: Serhii <17529954+serhii-bor@users.noreply.github.com>
Co-authored-by: Robert Malikowski <malikowskirobert@gmail.com>
2026-06-30 02:45:44 +03:00

340 lines
11 KiB
Dart

import 'dart:async';
import 'package:cake_wallet/core/universal_address_detector.dart';
import 'package:cake_wallet/evm/evm.dart';
import 'package:cake_wallet/reactions/wallet_connect.dart';
import 'package:cake_wallet/solana/solana.dart';
import 'package:cake_wallet/tron/tron.dart';
import 'package:cake_wallet/store/app_store.dart';
import 'package:cw_core/wallet_type.dart';
import 'package:cw_core/wallet_info.dart';
import 'package:cw_core/utils/print_verbose.dart';
import 'package:cw_core/currency_for_wallet_type.dart';
import 'package:cw_core/crypto_currency.dart';
import 'package:mobx/mobx.dart';
part 'payment_view_model.g.dart';
class PaymentViewModel = PaymentViewModelBase with _$PaymentViewModel;
abstract class PaymentViewModelBase with Store {
PaymentViewModelBase({required this.appStore});
final AppStore appStore;
@observable
WalletType? detectedWalletType;
@observable
AddressDetectionResult? _lastDetectionResult;
@computed
int? get detectedChainId {
if (detectedWalletType == null) return null;
if (!isEVMCompatibleChain(detectedWalletType!)) return null;
if (_lastDetectionResult?.chainId != null) {
return _lastDetectionResult!.chainId;
}
// If detected wallet type is EVM-compatible, get chainId from detected currency
if (_lastDetectionResult?.detectedCurrency != null) {
return getChainIdByCryptoCurrency(_lastDetectionResult!.detectedCurrency!);
}
return evm?.getChainIdByWalletType(detectedWalletType!);
}
@observable
bool isProcessing = false;
@computed
WalletType get currentWalletType => appStore.wallet!.type;
@computed
int? get currentChainId {
if (!isEVMCompatibleChain(currentWalletType) || evm == null) return null;
return evm!.getSelectedChainId(appStore.wallet!);
}
/// Main entry point - detect address type and check compatibility
@action
Future<PaymentFlowResult> processAddress(String addressData) async {
try {
detectedWalletType = null;
isProcessing = true;
// Detect address type
final detectionResult = UniversalAddressDetector.detectAddress(addressData);
_lastDetectionResult = detectionResult;
detectedWalletType = detectionResult.detectedWalletType;
if (!detectionResult.isValid || detectedWalletType == null) {
return PaymentFlowResult.incompatible('Unable to detect address type');
}
if (detectedWalletType == WalletType.solana && solana == null) {
return PaymentFlowResult.incompatible('Solana is not available in this app build.');
}
if (detectedWalletType == WalletType.tron && tron == null) {
return PaymentFlowResult.incompatible('Tron is not available in this app build.');
}
if (isEVMCompatibleChain(detectedWalletType!) && evm == null) {
return PaymentFlowResult.incompatible(
'Ethereum-compatible addresses are not supported in this app build.',
);
}
final currentWallet = appStore.wallet;
if (currentWallet != null &&
currentWallet.type == detectedWalletType &&
!isEVMCompatibleChain(detectedWalletType!)) {
return PaymentFlowResult.currentWalletCompatible(detectionResult);
}
if (detectedWalletType == WalletType.solana) {
final compatibleWallets = await getWalletsByType(WalletType.solana);
return PaymentFlowResult.solanaTokenSelection(
detectionResult,
compatibleWallets: compatibleWallets,
wallet: compatibleWallets.isNotEmpty ? compatibleWallets.first : null,
);
}
if (detectedWalletType == WalletType.tron) {
final compatibleWallets = await getWalletsByType(WalletType.tron);
return PaymentFlowResult.tronTokenSelection(
detectionResult,
compatibleWallets: compatibleWallets,
wallet: compatibleWallets.isNotEmpty ? compatibleWallets.first : null,
);
}
if (isEVMCompatibleChain(detectedWalletType!)) {
return PaymentFlowResult.evmNetworkSelection(detectionResult);
}
final compatibleWallets = await getWalletsByType(detectedWalletType!);
switch (compatibleWallets.length) {
case 0:
return PaymentFlowResult.noWallets(detectedWalletType!, detectionResult);
case 1:
return PaymentFlowResult.singleWallet(compatibleWallets.first, detectionResult);
default:
return PaymentFlowResult.multipleWallets(compatibleWallets, detectionResult);
}
} catch (e) {
printV('PaymentViewModel error: $e');
return PaymentFlowResult.error('Payment processing failed: $e');
} finally {
isProcessing = false;
}
}
@action
Future<void> selectChain() async {
if (detectedWalletType == null || evm == null || detectedChainId == null) return;
final node =
appStore.settingsStore.getCurrentNode(detectedWalletType!, chainId: detectedChainId);
await evm!.selectChain(appStore.wallet!, detectedChainId!, node: node);
}
Future<List<WalletInfo>> getWalletsByType(WalletType walletType) async {
return (await WalletInfo.getAll()).where((wallet) => wallet.type == walletType).toList();
}
Future<List<WalletInfo>> getEVMCompatibleWallets() async {
final allWallets = await WalletInfo.getAll();
return allWallets.where((wallet) => isEVMCompatibleChain(wallet.type)).toList();
}
}
class PaymentFlowResult {
final PaymentFlowType type;
final String? message;
final WalletInfo? wallet;
final int? chainId;
final List<WalletInfo> wallets;
final WalletType? walletType;
final AddressDetectionResult? addressDetectionResult;
PaymentFlowResult._({
required this.type,
this.message,
this.wallet,
this.chainId,
this.wallets = const [],
this.walletType,
this.addressDetectionResult,
});
/// EVM address detected - needs network selection
/// We'll also take note of the number of compatible wallets for EVM ecosystem
factory PaymentFlowResult.evmNetworkSelection(
AddressDetectionResult addressDetectionResult, {
List<WalletInfo>? compatibleWallets,
WalletInfo? wallet,
}) {
int? chainId = addressDetectionResult.chainId;
if (chainId == null && addressDetectionResult.detectedCurrency != null) {
chainId = getChainIdByCryptoCurrency(addressDetectionResult.detectedCurrency!);
}
if (chainId == null && addressDetectionResult.detectedWalletType != null) {
chainId = evm?.getChainIdByWalletType(addressDetectionResult.detectedWalletType!);
}
return PaymentFlowResult._(
type: PaymentFlowType.evmNetworkSelection,
addressDetectionResult: addressDetectionResult,
walletType: addressDetectionResult.detectedWalletType,
chainId: chainId,
wallets: compatibleWallets ?? [],
wallet: wallet,
);
}
/// Solana address detected - needs token selection
factory PaymentFlowResult.solanaTokenSelection(
AddressDetectionResult addressDetectionResult, {
List<WalletInfo>? compatibleWallets,
WalletInfo? wallet,
}) =>
PaymentFlowResult._(
type: PaymentFlowType.solanaTokenSelection,
addressDetectionResult: addressDetectionResult,
walletType: WalletType.solana,
wallets: compatibleWallets ?? [],
wallet: wallet,
);
/// Tron address detected - needs token selection
factory PaymentFlowResult.tronTokenSelection(
AddressDetectionResult addressDetectionResult, {
List<WalletInfo>? compatibleWallets,
WalletInfo? wallet,
}) =>
PaymentFlowResult._(
type: PaymentFlowType.tronTokenSelection,
addressDetectionResult: addressDetectionResult,
walletType: WalletType.tron,
wallets: compatibleWallets ?? [],
wallet: wallet,
);
/// Current wallet is compatible
factory PaymentFlowResult.currentWalletCompatible(
AddressDetectionResult addressDetectionResult) =>
PaymentFlowResult._(
type: PaymentFlowType.currentWalletCompatible,
addressDetectionResult: addressDetectionResult,
);
/// Single compatible wallet available
factory PaymentFlowResult.singleWallet(
WalletInfo wallet,
AddressDetectionResult addressDetectionResult,
) {
int? chainId = addressDetectionResult.chainId;
if (chainId == null && addressDetectionResult.detectedCurrency != null) {
chainId = getChainIdByCryptoCurrency(addressDetectionResult.detectedCurrency!);
}
if (chainId == null) {
chainId = evm?.getChainIdByWalletType(wallet.type);
}
return PaymentFlowResult._(
type: PaymentFlowType.singleWallet,
wallet: wallet,
walletType: wallet.type,
chainId: chainId,
addressDetectionResult: addressDetectionResult,
);
}
/// Multiple compatible wallets available
factory PaymentFlowResult.multipleWallets(
List<WalletInfo> wallets,
AddressDetectionResult addressDetectionResult,
) {
int? chainId = addressDetectionResult.chainId;
if (chainId == null && addressDetectionResult.detectedCurrency != null) {
chainId = getChainIdByCryptoCurrency(addressDetectionResult.detectedCurrency!);
}
if (chainId == null) {
chainId = evm?.getChainIdByWalletType(wallets.first.type);
}
return PaymentFlowResult._(
type: PaymentFlowType.multipleWallets,
wallets: wallets,
walletType: wallets.first.type,
addressDetectionResult: addressDetectionResult,
chainId: chainId,
);
}
/// No compatible wallets available
factory PaymentFlowResult.noWallets(
WalletType walletType,
AddressDetectionResult addressDetectionResult,
) {
int? chainId = addressDetectionResult.chainId;
if (chainId == null && addressDetectionResult.detectedCurrency != null) {
chainId = getChainIdByCryptoCurrency(addressDetectionResult.detectedCurrency!);
}
if (chainId == null) {
chainId = evm?.getChainIdByWalletType(walletType);
}
return PaymentFlowResult._(
type: PaymentFlowType.noWallets,
walletType: walletType,
addressDetectionResult: addressDetectionResult,
chainId: chainId,
);
}
/// Error occurred
factory PaymentFlowResult.error(String message) =>
PaymentFlowResult._(type: PaymentFlowType.error, message: message);
/// Incompatible address
factory PaymentFlowResult.incompatible(String message) =>
PaymentFlowResult._(type: PaymentFlowType.incompatible, message: message);
CryptoCurrency? get detectedCurrency {
if (type == PaymentFlowType.evmNetworkSelection ||
type == PaymentFlowType.solanaTokenSelection ||
type == PaymentFlowType.tronTokenSelection) {
return addressDetectionResult?.detectedCurrency;
}
if (walletType != null) {
if (isEVMCompatibleChain(walletType!)) {
return walletTypeToCryptoCurrency(walletType!, chainId: chainId);
}
return walletTypeToCryptoCurrency(walletType!);
}
return null;
}
}
enum PaymentFlowType {
currentWalletCompatible,
singleWallet,
multipleWallets,
noWallets,
evmNetworkSelection,
solanaTokenSelection,
tronTokenSelection,
error,
incompatible,
}