Files
hash-wallet/cw_bitcoin/lib/lightning/lightning_wallet.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

469 lines
17 KiB
Dart

import 'dart:async';
import 'dart:io';
import 'dart:typed_data';
import 'package:breez_sdk_spark_flutter/breez_sdk_spark.dart';
import 'package:cw_bitcoin/bitcoin_transaction_priority.dart';
import 'package:cw_bitcoin/electrum_transaction_info.dart';
import 'package:cw_bitcoin/lightning/pending_lightning_transaction.dart';
import 'package:cw_core/amount/money.dart';
import 'package:cw_core/crypto_currency.dart';
import 'package:cw_core/currency.dart';
import 'package:cw_core/transaction_direction.dart';
import 'package:cw_core/utils/print_verbose.dart';
import 'package:cw_core/wallet_type.dart';
bool _breezSdkSparkLibUninitialized = true;
Stream<LogEntry>? _logStream;
class LightningWallet {
final String mnemonic;
final String? passphrase;
final Uint8List? seedBytes;
final String apiKey;
final String lnurlDomain;
final Network network;
BreezSdk? _sdk;
String? cachedAddress;
static int MAX_RETRIES = 10;
LightningWallet({
required this.mnemonic,
this.passphrase,
this.seedBytes,
required this.apiKey,
required this.lnurlDomain,
this.network = Network.mainnet,
this.cachedAddress,
});
static bool get isAvailable => Platform.isIOS || Platform.isAndroid || Platform.isMacOS;
Currency get currency => CryptoCurrency.btcln;
BreezSdk get sdk => _sdk!;
StreamSubscription<SdkEvent>? _eventSubscription;
Stream<SdkEvent>? _eventStream;
StreamSubscription<LogEntry>? _logSubscription;
bool get isInitialized => _eventStream != null;
void _subscribeToLogStream(File logFile) {
_logSubscription = _logStream?.listen((logEntry) {
try {
// Check if file exists before writing (optional, but safer)
if (!logFile.existsSync()) {
logFile.createSync(recursive: true);
}
logFile.writeAsStringSync("[${logEntry.level}] ${logEntry.line}\n", mode: FileMode.append);
} catch (e) {
// Silently fail or use printV(e) so it doesn't crash the app
printV("Failed to write to log: $e");
}
}, onError: (e) {
try {
if (!logFile.existsSync()) {
logFile.createSync(recursive: true);
}
logFile.writeAsStringSync("[ERROR] $e\n", mode: FileMode.append);
} catch (err) {
printV("Failed to write error to log: $err");
}
});
}
Future<bool> init(String appPath) async {
try {
if (_breezSdkSparkLibUninitialized) {
await BreezSdkSparkLib.init();
_breezSdkSparkLibUninitialized = false;
}
final seed = seedBytes != null
? Seed.entropy(seedBytes!)
: Seed.mnemonic(mnemonic: mnemonic, passphrase: passphrase);
final config = defaultConfig(network: Network.mainnet).copyWith(
lnurlDomain: lnurlDomain,
apiKey: apiKey,
privateEnabledDefault: true,
maxDepositClaimFee: MaxFee.rate(satPerVbyte: BigInt.from(5))
);
final connectRequest = ConnectRequest(
config: config,
seed: seed,
storageDir: "$appPath/.breez/",
);
_sdk = await connect(request: connectRequest);
_eventStream ??= sdk.addEventListener().asBroadcastStream();
_logStream ??= initLogging().asBroadcastStream();
try {
final logFile = File("$appPath/lightning.log")
..createSync();
_subscribeToLogStream(logFile);
} catch (e) {
printV(e);
}
await sdk.syncWallet(request: SyncWalletRequest());
return true;
} catch (e) {
printV(e);
return false;
}
}
Future<void> close() async {
_eventSubscription?.cancel();
await _sdk?.disconnect();
_logSubscription?.cancel();
}
Future<String?> getAddress() async {
var retries = 0;
while (retries < MAX_RETRIES) {
try {
final address = (await sdk.getLightningAddress())?.lightningAddress;
if (address != null) {
cachedAddress = address;
return address;
}
} catch (_) {} // No need to log here since it should be in the lightning log
retries++;
await Future.delayed(Duration(milliseconds: 500));
}
return cachedAddress;
}
Future<String> getDepositAddress() async => (await sdk.receivePayment(
request: ReceivePaymentRequest(paymentMethod: ReceivePaymentMethod.bitcoinAddress())))
.paymentRequest;
Future<Money> getBalance() async {
try {
return Money((await sdk.getInfo(request: GetInfoRequest(ensureSynced: true))).balanceSats,
CryptoCurrency.btcln);
} on SdkError_Generic catch (_) {
} on SdkError_NetworkError catch (_) {}
return Money.zero(CryptoCurrency.btcln);
}
Future<String> registerAddress(String username) async {
return (await sdk.registerLightningAddress(
request: RegisterLightningAddressRequest(username: username)))
.lightningAddress;
}
Future<String?> getBolt11Invoice(BigInt? amount, String description) async {
try {
final response = await sdk.receivePayment(
request: ReceivePaymentRequest(
paymentMethod: ReceivePaymentMethod.bolt11Invoice(
description: description,
amountSats: amount,
),
),
);
return response.paymentRequest;
} on SdkError_NetworkError catch (_) {
return null;
} on SdkError_SparkError catch (e) {
if (!e.field0.contains("dns") && !e.field0.contains("TimedOut")) rethrow;
return null;
}
}
Future<bool> isCompatible(String input) async {
try {
final inputType = await sdk.parse(input: input);
return (inputType is InputType_Bolt11Invoice) ||
(inputType is InputType_LightningAddress) ||
(inputType is InputType_LnurlPay);
} catch (_) {
return false;
}
}
Future<PendingLightningTransaction> createTransaction(
String address, BigInt? amountSats, BitcoinTransactionPriority? priority, bool feesIncluded) async {
final inputType = await sdk.parse(input: address);
final feePolicy = feesIncluded ? FeePolicy.feesIncluded : FeePolicy.feesExcluded;
if (inputType is InputType_Bolt11Invoice) {
final request = PrepareSendPaymentRequest(
paymentRequest: inputType.field0.invoice.bolt11, amount: amountSats, feePolicy: feePolicy);
final prepareResponse = await sdk.prepareSendPayment(request: request);
final paymentMethod = prepareResponse.paymentMethod;
if (paymentMethod is SendPaymentMethod_Bolt11Invoice) {
final lightningFeeSats = paymentMethod.lightningFeeSats;
final sparkTransferFeeSats = paymentMethod.sparkTransferFeeSats;
final baseAmount = request.amount ?? amountSats;
final amount = baseAmount != null
? Money(baseAmount, currency)
: Money(paymentMethod.invoiceDetails.amountMsat ?? BigInt.zero, currency) /
BigInt.from(1000);
return PendingLightningTransaction(
id: paymentMethod.invoiceDetails.paymentHash,
amount: amount,
fee: Money(lightningFeeSats + (sparkTransferFeeSats ?? BigInt.zero), currency),
commitOverride: () async {
try {
final res = await sdk.sendPayment(
request: SendPaymentRequest(prepareResponse: prepareResponse));
printV(res.payment.status.name);
return res.payment.id;
} on SdkError_SparkError catch (e) {
if (e.field0.contains("AlreadyExists")) {
throw Exception("Invoice already paid");
}
rethrow;
}
},
);
}
} else if (inputType is InputType_LightningAddress || inputType is InputType_LnurlPay) {
final optionalValidateSuccessActionUrl = true;
PrepareLnurlPayRequest request;
if (inputType is InputType_LightningAddress) {
request = PrepareLnurlPayRequest(
amount: amountSats!,
payRequest: inputType.field0.payRequest,
validateSuccessActionUrl: optionalValidateSuccessActionUrl,
feePolicy: feePolicy,
);
} else {
request = PrepareLnurlPayRequest(
amount: amountSats!,
payRequest: (inputType as InputType_LnurlPay).field0,
validateSuccessActionUrl: optionalValidateSuccessActionUrl,
feePolicy: feePolicy,
);
}
final prepareResponse = await sdk.prepareLnurlPay(request: request);
return PendingLightningTransaction(
id: prepareResponse.invoiceDetails.paymentHash,
amount: Money(prepareResponse.amountSats, currency),
fee: Money(prepareResponse.feeSats, currency),
commitOverride: () async {
final res =
await sdk.lnurlPay(request: LnurlPayRequest(prepareResponse: prepareResponse));
printV(res.payment.status.name);
return res.payment.id;
},
);
} else if (inputType is InputType_BitcoinAddress) {
final request = PrepareSendPaymentRequest(
paymentRequest: inputType.field0.address,
amount: amountSats,
feePolicy: feePolicy,
);
final prepareResponse = await sdk.prepareSendPayment(request: request);
final paymentMethod = prepareResponse.paymentMethod;
if (paymentMethod is SendPaymentMethod_BitcoinAddress) {
final feeQuote = paymentMethod.feeQuote;
OnchainConfirmationSpeed onchainConfirmationSpeed;
BigInt fee;
switch (priority) {
case BitcoinTransactionPriority.fast:
fee = feeQuote.speedFast.userFeeSat + feeQuote.speedFast.l1BroadcastFeeSat;
onchainConfirmationSpeed = OnchainConfirmationSpeed.fast;
break;
case BitcoinTransactionPriority.medium:
fee = feeQuote.speedMedium.userFeeSat + feeQuote.speedMedium.l1BroadcastFeeSat;
onchainConfirmationSpeed = OnchainConfirmationSpeed.medium;
break;
case BitcoinTransactionPriority.slow:
default:
fee = feeQuote.speedSlow.userFeeSat + feeQuote.speedSlow.l1BroadcastFeeSat;
onchainConfirmationSpeed = OnchainConfirmationSpeed.slow;
}
return PendingLightningTransaction(
id: "", // ToDo: Find out where to get it
amount: Money(prepareResponse.amount, currency),
fee: Money(fee, currency),
commitOverride: () async {
final options =
SendPaymentOptions.bitcoinAddress(confirmationSpeed: onchainConfirmationSpeed);
final res = await sdk.sendPayment(
request: SendPaymentRequest(prepareResponse: prepareResponse, options: options));
return res.payment.id;
},
);
}
}
// If not returned earlier
throw UnimplementedError();
}
Future<Map<String, ElectrumTransactionInfo>> getTransactionHistory({DateTime? fromDate}) async {
final request = ListPaymentsRequest(
typeFilter: [PaymentType.send, PaymentType.receive],
// statusFilter: [PaymentStatus.completed],
fromTimestamp:
fromDate != null ? BigInt.from((fromDate.millisecondsSinceEpoch / 1000).round()) : null,
assetFilter: AssetFilter.bitcoin(),
offset: 0,
limit: 50,
sortAscending: false, // Sort order (true = oldest first, false = newest first)
);
final response = await sdk.listPayments(request: request);
final payments = response.payments;
final txHistory = <String, ElectrumTransactionInfo>{};
for (final payment in payments) {
txHistory[payment.id] = _getElectrumTransactionInfoFromPayment(payment);
}
return txHistory;
}
/// Return a list of UnclaimedDeposits including a possible reason why they where not auto-claimed
/// A unclaimed deposit is a [Map] consisting of the following datatypes
///
/// | ----------------- | --------- |--------------------------------------------------- |
/// | key-name | data-type | description |
/// | ----------------- | --------- |--------------------------------------------------- |
/// | txId | String | The txId of the deposit transaction |
/// | vout | int | The output index of the deposit |
/// | amount | BigInt | Amount of the deposit in sats. |
/// | claimError | String? | The type of Claim error |
/// | actualFee | BigInt? | The actualFee in case of a DepositClaimFeeExceeded |
/// | claimErrorMessage | String? | The claimErrorMessage in case of a Generic Error |
///
Future<List<Map<String, dynamic>>> getUnclaimedDeposits() async {
final unclaimedDeposits = <Map<String, dynamic>>[];
final response = await sdk.listUnclaimedDeposits(request: ListUnclaimedDepositsRequest());
for (final deposit in response.deposits) {
final unclaimedDeposit = {
"txId": deposit.txid,
"vout": deposit.vout,
"amount": deposit.amountSats,
};
final claimError = deposit.claimError;
if (claimError is DepositClaimError_MaxDepositClaimFeeExceeded) {
unclaimedDeposit["claimError"] = "DepositClaimError_MaxDepositClaimFeeExceeded";
unclaimedDeposit["actualFee"] = claimError.requiredFeeSats;
} else if (claimError is DepositClaimError_MissingUtxo) {
unclaimedDeposit["claimError"] = "MissingUtxo";
} else if (claimError is DepositClaimError_Generic) {
unclaimedDeposit["claimError"] = "Generic";
unclaimedDeposit["claimErrorMessage"] = claimError.message;
}
}
return unclaimedDeposits;
}
Future<ElectrumTransactionInfo> claimDeposit(String txId, int vout, BigInt newFee) async {
final response = await sdk.claimDeposit(
request: ClaimDepositRequest(
txid: txId,
vout: vout,
maxFee: MaxFee.fixed(amount: newFee),
),
);
return _getElectrumTransactionInfoFromPayment(response.payment);
}
Future<String> refundDeposit(String txId, int vout, String destinationAddress,
BigInt feeRate) async {
final response = await sdk.refundDeposit(request: RefundDepositRequest(
txid: txId,
vout: vout,
destinationAddress: destinationAddress,
fee: Fee.rate(satPerVbyte: feeRate),
),);
return response.txHex;
}
void setEventListener({
required Function(ElectrumTransactionInfo) onTransactionEvent,
required Function onBalanceChangedEvent,
required Function(Map<String, ElectrumTransactionInfo>) onCreateDepositTransactionEvent,
required Function(List<ElectrumTransactionInfo>) onUpdateDepositTransactionEvent,
}) {
_eventSubscription = _eventStream?.listen((sdkEvent) {
if (sdkEvent is SdkEvent_PaymentSucceeded) {
onTransactionEvent(_getElectrumTransactionInfoFromPayment(sdkEvent.payment));
} else if (sdkEvent is SdkEvent_PaymentPending) {
onTransactionEvent(_getElectrumTransactionInfoFromPayment(sdkEvent.payment));
} else if (sdkEvent is SdkEvent_ClaimedDeposits) {
onBalanceChangedEvent();
onUpdateDepositTransactionEvent(
sdkEvent.claimedDeposits.map(_getElectrumTransactionInfoFromDepositInfo).toList());
} else if (sdkEvent is SdkEvent_UnclaimedDeposits) {
final unclaimedDeposits = <String, ElectrumTransactionInfo>{};
for (final deposit in sdkEvent.unclaimedDeposits) {
unclaimedDeposits[deposit.txid] = _getElectrumTransactionInfoFromDepositInfo(deposit);
}
onCreateDepositTransactionEvent(unclaimedDeposits);
}
});
}
ElectrumTransactionInfo _getElectrumTransactionInfoFromPayment(Payment payment) {
var direction = TransactionDirection.outgoing;
if (payment.paymentType == PaymentType.receive) {
direction = TransactionDirection.incoming;
}
if (payment.method == PaymentMethod.deposit) {
direction = TransactionDirection.incoming;
}
return ElectrumTransactionInfo(
WalletType.bitcoin,
id: payment.id,
amount: Money(payment.amount, currency),
direction: direction,
isPending: payment.status == PaymentStatus.pending,
fee: Money(payment.fees, currency),
date: DateTime.fromMillisecondsSinceEpoch(payment.timestamp.toInt() * 1000),
confirmations: payment.status == PaymentStatus.pending ? 0 : 10,
additionalInfo: {"isLightning": true},
);
}
ElectrumTransactionInfo _getElectrumTransactionInfoFromDepositInfo(DepositInfo deposit) {
return ElectrumTransactionInfo(
WalletType.bitcoin,
id: deposit.txid,
amount: Money(deposit.amountSats, currency),
direction: TransactionDirection.incoming,
isPending: true,
fee: Money.zero(currency),
date: DateTime.now(),
confirmations: 0,
additionalInfo: {"isLightning": true, "isSparkDeposit": true},
);
}
}