stack_wallet/lib/services/coins/bitcoincash/bitcoincash_wallet.dart

3021 lines
100 KiB
Dart
Raw Normal View History

2022-09-26 20:32:53 +00:00
import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'package:bech32/bech32.dart';
import 'package:bip32/bip32.dart' as bip32;
import 'package:bip39/bip39.dart' as bip39;
import 'package:bitbox/bitbox.dart' as bitbox;
2022-09-26 20:32:53 +00:00
import 'package:bitcoindart/bitcoindart.dart';
import 'package:bs58check/bs58check.dart' as bs58check;
import 'package:decimal/decimal.dart';
import 'package:flutter/foundation.dart';
import 'package:isar/isar.dart';
2022-09-26 20:32:53 +00:00
import 'package:stackwallet/electrumx_rpc/cached_electrumx.dart';
import 'package:stackwallet/electrumx_rpc/electrumx.dart';
import 'package:stackwallet/models/balance.dart';
import 'package:stackwallet/models/isar/models/address/address.dart';
import 'package:stackwallet/models/isar/models/isar_models.dart' as isar_models;
2022-09-26 20:32:53 +00:00
import 'package:stackwallet/models/paymint/fee_object_model.dart';
import 'package:stackwallet/services/coins/coin_service.dart';
import 'package:stackwallet/services/event_bus/events/global/node_connection_status_changed_event.dart';
import 'package:stackwallet/services/event_bus/events/global/refresh_percent_changed_event.dart';
import 'package:stackwallet/services/event_bus/events/global/updated_in_background_event.dart';
import 'package:stackwallet/services/event_bus/events/global/wallet_sync_status_changed_event.dart';
import 'package:stackwallet/services/event_bus/global_event_bus.dart';
import 'package:stackwallet/services/mixins/wallet_cache.dart';
2023-01-12 18:46:01 +00:00
import 'package:stackwallet/services/mixins/wallet_db.dart';
2022-09-26 20:32:53 +00:00
import 'package:stackwallet/services/node_service.dart';
import 'package:stackwallet/services/notifications_api.dart';
import 'package:stackwallet/services/transaction_notification_tracker.dart';
import 'package:stackwallet/utilities/address_utils.dart';
2022-09-26 20:32:53 +00:00
import 'package:stackwallet/utilities/assets.dart';
import 'package:stackwallet/utilities/constants.dart';
import 'package:stackwallet/utilities/default_nodes.dart';
import 'package:stackwallet/utilities/enums/coin_enum.dart';
import 'package:stackwallet/utilities/enums/fee_rate_type_enum.dart';
import 'package:stackwallet/utilities/flutter_secure_storage_interface.dart';
import 'package:stackwallet/utilities/format.dart';
import 'package:stackwallet/utilities/logger.dart';
import 'package:stackwallet/utilities/prefs.dart';
import 'package:tuple/tuple.dart';
import 'package:uuid/uuid.dart';
2022-10-19 20:21:48 +00:00
const int MINIMUM_CONFIRMATIONS = 1;
2022-09-26 20:32:53 +00:00
const int DUST_LIMIT = 546;
const String GENESIS_HASH_MAINNET =
"000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f";
const String GENESIS_HASH_TESTNET =
"000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943";
2022-09-23 12:31:14 +00:00
enum DerivePathType { bip44, bip49 }
2022-09-26 20:32:53 +00:00
bip32.BIP32 getBip32Node(int chain, int index, String mnemonic,
NetworkType network, DerivePathType derivePathType) {
final root = getBip32Root(mnemonic, network);
final node = getBip32NodeFromRoot(chain, index, root, derivePathType);
return node;
}
/// wrapper for compute()
bip32.BIP32 getBip32NodeWrapper(
Tuple5<int, int, String, NetworkType, DerivePathType> args,
) {
return getBip32Node(
args.item1,
args.item2,
args.item3,
args.item4,
args.item5,
);
}
bip32.BIP32 getBip32NodeFromRoot(
int chain, int index, bip32.BIP32 root, DerivePathType derivePathType) {
String coinType;
switch (root.network.wif) {
case 0x80: // bch mainnet wif
coinType = "145"; // bch mainnet
break;
case 0xef: // bch testnet wif
coinType = "1"; // bch testnet
break;
default:
throw Exception("Invalid Bitcoincash network type used!");
}
switch (derivePathType) {
case DerivePathType.bip44:
return root.derivePath("m/44'/$coinType'/0'/$chain/$index");
2022-09-23 12:31:14 +00:00
case DerivePathType.bip49:
return root.derivePath("m/49'/$coinType'/0'/$chain/$index");
2022-09-26 20:32:53 +00:00
default:
throw Exception("DerivePathType must not be null.");
}
}
/// wrapper for compute()
bip32.BIP32 getBip32NodeFromRootWrapper(
Tuple4<int, int, bip32.BIP32, DerivePathType> args,
) {
return getBip32NodeFromRoot(
args.item1,
args.item2,
args.item3,
args.item4,
);
}
bip32.BIP32 getBip32Root(String mnemonic, NetworkType network) {
final seed = bip39.mnemonicToSeed(mnemonic);
final networkType = bip32.NetworkType(
wif: network.wif,
bip32: bip32.Bip32Type(
public: network.bip32.public,
private: network.bip32.private,
),
);
final root = bip32.BIP32.fromSeed(seed, networkType);
return root;
}
/// wrapper for compute()
bip32.BIP32 getBip32RootWrapper(Tuple2<String, NetworkType> args) {
return getBip32Root(args.item1, args.item2);
}
2023-01-12 18:46:01 +00:00
class BitcoinCashWallet extends CoinServiceAPI with WalletCache, WalletDB {
2022-09-26 20:32:53 +00:00
static const integrationTestFlag =
bool.fromEnvironment("IS_INTEGRATION_TEST");
final _prefs = Prefs.instance;
Timer? timer;
late final Coin _coin;
2022-09-26 20:32:53 +00:00
late final TransactionNotificationTracker txTracker;
NetworkType get _network {
switch (coin) {
case Coin.bitcoincash:
return bitcoincash;
case Coin.bitcoincashTestnet:
return bitcoincashtestnet;
default:
throw Exception("Bitcoincash network type not set!");
}
}
@override
2023-01-16 21:04:03 +00:00
Future<List<isar_models.UTXO>> get utxos => db.getUTXOs(walletId).findAll();
2022-09-26 20:32:53 +00:00
@override
Future<List<isar_models.Transaction>> get transactions =>
2023-01-16 21:04:03 +00:00
db.getTransactions(walletId).sortByTimestampDesc().findAll();
2022-09-26 20:32:53 +00:00
@override
Coin get coin => _coin;
2022-09-26 20:32:53 +00:00
@override
Future<String> get currentReceivingAddress async =>
(await _currentReceivingAddress).value;
2023-01-16 21:04:03 +00:00
Future<isar_models.Address> get _currentReceivingAddress async => (await db
.getAddresses(walletId)
.filter()
.typeEqualTo(isar_models.AddressType.p2pkh)
.subTypeEqualTo(isar_models.AddressSubType.receiving)
.sortByDerivationIndexDesc()
.findFirst())!;
Future<String> get currentChangeAddress async =>
(await _currentChangeAddress).value;
2023-01-16 21:04:03 +00:00
Future<isar_models.Address> get _currentChangeAddress async => (await db
.getAddresses(walletId)
.filter()
.typeEqualTo(isar_models.AddressType.p2pkh)
.subTypeEqualTo(isar_models.AddressSubType.change)
.sortByDerivationIndexDesc()
.findFirst())!;
2022-09-23 12:31:14 +00:00
2022-09-26 20:32:53 +00:00
@override
Future<void> exit() async {
_hasCalledExit = true;
timer?.cancel();
timer = null;
stopNetworkAlivePinging();
}
bool _hasCalledExit = false;
@override
bool get hasCalledExit => _hasCalledExit;
@override
Future<FeeObject> get fees => _feeObject ??= _getFees();
Future<FeeObject>? _feeObject;
@override
Future<int> get maxFee async {
final fee = (await fees).fast;
final satsFee = Format.satoshisToAmount(fee, coin: coin) *
Decimal.fromInt(Constants.satsPerCoin(coin));
2022-09-26 20:32:53 +00:00
return satsFee.floor().toBigInt().toInt();
}
@override
Future<List<String>> get mnemonic => _getMnemonicList();
Future<int> get chainHeight async {
try {
final result = await _electrumXClient.getBlockHeadTip();
final height = result["height"] as int;
await updateCachedChainHeight(height);
return height;
2022-09-26 20:32:53 +00:00
} catch (e, s) {
Logging.instance.log("Exception caught in chainHeight: $e\n$s",
level: LogLevel.Error);
return storedChainHeight;
2022-09-26 20:32:53 +00:00
}
}
2023-01-10 23:50:22 +00:00
@override
int get storedChainHeight => getCachedChainHeight();
2022-09-26 20:32:53 +00:00
DerivePathType addressType({required String address}) {
Uint8List? decodeBase58;
Segwit? decodeBech32;
2022-10-19 22:16:00 +00:00
try {
if (bitbox.Address.detectFormat(address) ==
bitbox.Address.formatCashAddr) {
if (validateCashAddr(address)) {
address = bitbox.Address.toLegacyAddress(address);
} else {
throw ArgumentError('$address is not currently supported');
}
2022-10-19 22:16:00 +00:00
}
} catch (e, s) {}
2022-09-26 20:32:53 +00:00
try {
decodeBase58 = bs58check.decode(address);
} catch (err) {
// Base58check decode fail
}
if (decodeBase58 != null) {
if (decodeBase58[0] == _network.pubKeyHash) {
// P2PKH
return DerivePathType.bip44;
}
2022-09-23 12:31:14 +00:00
if (decodeBase58[0] == _network.scriptHash) {
// P2SH
return DerivePathType.bip49;
}
2022-09-26 20:32:53 +00:00
throw ArgumentError('Invalid version or Network mismatch');
} else {
try {
decodeBech32 = segwit.decode(address);
} catch (err) {
// Bech32 decode fail
}
if (decodeBech32 != null) {
if (_network.bech32 != decodeBech32.hrp) {
throw ArgumentError('Invalid prefix or Network mismatch');
}
if (decodeBech32.version != 0) {
throw ArgumentError('Invalid address version');
}
2022-09-26 20:32:53 +00:00
}
}
throw ArgumentError('$address has no matching Script');
}
bool longMutex = false;
@override
Future<void> recoverFromMnemonic({
required String mnemonic,
required int maxUnusedAddressGap,
required int maxNumberOfIndexesToCheck,
required int height,
}) async {
longMutex = true;
final start = DateTime.now();
try {
Logging.instance.log("IS_INTEGRATION_TEST: $integrationTestFlag",
level: LogLevel.Info);
if (!integrationTestFlag) {
final features = await electrumXClient.getServerFeatures();
Logging.instance.log("features: $features", level: LogLevel.Info);
switch (coin) {
case Coin.bitcoincash:
if (features['genesis_hash'] != GENESIS_HASH_MAINNET) {
throw Exception("genesis hash does not match main net!");
}
break;
case Coin.bitcoincashTestnet:
if (features['genesis_hash'] != GENESIS_HASH_TESTNET) {
throw Exception("genesis hash does not match test net!");
}
break;
default:
throw Exception(
"Attempted to generate a BitcoinCashWallet using a non bch coin type: ${coin.name}");
}
}
// check to make sure we aren't overwriting a mnemonic
// this should never fail
if ((await _secureStore.read(key: '${_walletId}_mnemonic')) != null) {
longMutex = false;
throw Exception("Attempted to overwrite mnemonic on restore!");
}
await _secureStore.write(
key: '${_walletId}_mnemonic', value: mnemonic.trim());
await _recoverWalletFromBIP32SeedPhrase(
mnemonic: mnemonic.trim(),
maxUnusedAddressGap: maxUnusedAddressGap,
maxNumberOfIndexesToCheck: maxNumberOfIndexesToCheck,
);
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from recoverFromMnemonic(): $e\n$s",
level: LogLevel.Error);
longMutex = false;
rethrow;
}
longMutex = false;
final end = DateTime.now();
Logging.instance.log(
"$walletName recovery time: ${end.difference(start).inMilliseconds} millis",
level: LogLevel.Info);
}
Future<Map<String, dynamic>> _checkGaps(
int maxNumberOfIndexesToCheck,
int maxUnusedAddressGap,
int txCountBatchSize,
bip32.BIP32 root,
DerivePathType type,
int chain) async {
List<isar_models.Address> addressArray = [];
int returningIndex = -1;
Map<String, Map<String, String>> derivations = {};
int gapCounter = 0;
for (int index = 0;
index < maxNumberOfIndexesToCheck && gapCounter < maxUnusedAddressGap;
index += txCountBatchSize) {
List<String> iterationsAddressArray = [];
Logging.instance.log(
"index: $index, \t GapCounter $chain ${type.name}: $gapCounter",
level: LogLevel.Info);
final _id = "k_$index";
Map<String, String> txCountCallArgs = {};
final Map<String, dynamic> receivingNodes = {};
for (int j = 0; j < txCountBatchSize; j++) {
final node = await compute(
getBip32NodeFromRootWrapper,
Tuple4(
chain,
index + j,
root,
type,
),
);
String addressString;
final data = PaymentData(pubkey: node.publicKey);
isar_models.AddressType addrType;
switch (type) {
case DerivePathType.bip44:
addressString = P2PKH(data: data, network: _network).data.address!;
addrType = isar_models.AddressType.p2pkh;
2023-01-17 14:04:30 +00:00
addressString = bitbox.Address.toCashAddress(addressString);
break;
case DerivePathType.bip49:
addressString = P2SH(
data: PaymentData(
redeem: P2WPKH(data: data, network: _network).data),
network: _network)
.data
.address!;
addrType = isar_models.AddressType.p2sh;
break;
default:
throw Exception("No Path type $type exists");
}
2023-01-16 22:37:00 +00:00
final address = isar_models.Address(
walletId: walletId,
value: addressString,
publicKey: node.publicKey,
type: addrType,
derivationIndex: index + j,
subType: chain == 0
? isar_models.AddressSubType.receiving
2023-01-16 22:37:00 +00:00
: isar_models.AddressSubType.change,
);
receivingNodes.addAll({
"${_id}_$j": {
"node": node,
"address": address,
}
});
txCountCallArgs.addAll({
"${_id}_$j": addressString,
});
}
// get address tx counts
final counts = await _getBatchTxCount(addresses: txCountCallArgs);
if (kDebugMode) {
print("Counts $counts");
}
// check and add appropriate addresses
for (int k = 0; k < txCountBatchSize; k++) {
int count = counts["${_id}_$k"]!;
if (count > 0) {
final node = receivingNodes["${_id}_$k"];
final address = node["address"] as isar_models.Address;
// add address to array
addressArray.add(address);
iterationsAddressArray.add(address.value);
// set current index
returningIndex = index + k;
// reset counter
gapCounter = 0;
// add info to derivations
2023-01-13 15:26:37 +00:00
derivations[address.value] = {
"pubKey": Format.uint8listToString(
(node["node"] as bip32.BIP32).publicKey),
"wif": (node["node"] as bip32.BIP32).toWIF(),
};
}
// increase counter when no tx history found
if (count == 0) {
gapCounter++;
}
}
// cache all the transactions while waiting for the current function to finish.
unawaited(getTransactionCacheEarly(iterationsAddressArray));
}
return {
"addressArray": addressArray,
"index": returningIndex,
"derivations": derivations
};
}
Future<void> getTransactionCacheEarly(List<String> allAddresses) async {
try {
final List<Map<String, dynamic>> allTxHashes =
await _fetchHistory(allAddresses);
for (final txHash in allTxHashes) {
try {
unawaited(cachedElectrumXClient.getTransaction(
txHash: txHash["tx_hash"] as String,
verbose: true,
coin: coin,
));
} catch (e) {
continue;
}
}
} catch (e) {
//
}
}
2022-09-26 20:32:53 +00:00
Future<void> _recoverWalletFromBIP32SeedPhrase({
required String mnemonic,
int maxUnusedAddressGap = 20,
int maxNumberOfIndexesToCheck = 1000,
}) async {
longMutex = true;
Map<String, Map<String, String>> p2pkhReceiveDerivations = {};
2022-09-23 12:31:14 +00:00
Map<String, Map<String, String>> p2shReceiveDerivations = {};
2022-09-26 20:32:53 +00:00
Map<String, Map<String, String>> p2pkhChangeDerivations = {};
2022-09-23 12:31:14 +00:00
Map<String, Map<String, String>> p2shChangeDerivations = {};
2022-09-26 20:32:53 +00:00
final root = await compute(getBip32RootWrapper, Tuple2(mnemonic, _network));
List<isar_models.Address> p2pkhReceiveAddressArray = [];
List<isar_models.Address> p2shReceiveAddressArray = [];
2022-09-26 20:32:53 +00:00
int p2pkhReceiveIndex = -1;
2022-09-23 12:31:14 +00:00
int p2shReceiveIndex = -1;
2022-09-26 20:32:53 +00:00
List<isar_models.Address> p2pkhChangeAddressArray = [];
List<isar_models.Address> p2shChangeAddressArray = [];
2022-09-26 20:32:53 +00:00
int p2pkhChangeIndex = -1;
2022-09-23 12:31:14 +00:00
int p2shChangeIndex = -1;
2022-09-26 20:32:53 +00:00
// The gap limit will be capped at [maxUnusedAddressGap]
2022-09-23 12:31:14 +00:00
// int receivingGapCounter = 0;
// int changeGapCounter = 0;
2022-09-26 20:32:53 +00:00
2022-09-23 12:31:14 +00:00
// actual size is 24 due to p2pkh and p2sh so 12x2
2022-09-26 20:32:53 +00:00
const txCountBatchSize = 12;
try {
// receiving addresses
Logging.instance
.log("checking receiving addresses...", level: LogLevel.Info);
2022-09-23 12:31:14 +00:00
final resultReceive44 = _checkGaps(maxNumberOfIndexesToCheck,
maxUnusedAddressGap, txCountBatchSize, root, DerivePathType.bip44, 0);
2022-09-26 20:32:53 +00:00
2022-09-23 12:31:14 +00:00
final resultReceive49 = _checkGaps(maxNumberOfIndexesToCheck,
maxUnusedAddressGap, txCountBatchSize, root, DerivePathType.bip49, 0);
2022-09-26 20:32:53 +00:00
Logging.instance
.log("checking change addresses...", level: LogLevel.Info);
// change addresses
2022-09-23 12:31:14 +00:00
final resultChange44 = _checkGaps(maxNumberOfIndexesToCheck,
maxUnusedAddressGap, txCountBatchSize, root, DerivePathType.bip44, 1);
2022-09-06 14:17:45 +00:00
2022-09-23 12:31:14 +00:00
final resultChange49 = _checkGaps(maxNumberOfIndexesToCheck,
maxUnusedAddressGap, txCountBatchSize, root, DerivePathType.bip49, 1);
2022-09-06 14:17:45 +00:00
await Future.wait([
resultReceive44,
resultReceive49,
resultChange44,
resultChange49,
]);
2022-09-06 14:17:45 +00:00
2022-09-23 12:31:14 +00:00
p2pkhReceiveAddressArray =
(await resultReceive44)['addressArray'] as List<isar_models.Address>;
2022-09-23 12:31:14 +00:00
p2pkhReceiveIndex = (await resultReceive44)['index'] as int;
p2pkhReceiveDerivations = (await resultReceive44)['derivations']
as Map<String, Map<String, String>>;
2022-09-06 14:17:45 +00:00
2022-09-23 12:31:14 +00:00
p2shReceiveAddressArray =
(await resultReceive49)['addressArray'] as List<isar_models.Address>;
2022-09-23 12:31:14 +00:00
p2shReceiveIndex = (await resultReceive49)['index'] as int;
p2shReceiveDerivations = (await resultReceive49)['derivations']
as Map<String, Map<String, String>>;
p2pkhChangeAddressArray =
(await resultChange44)['addressArray'] as List<isar_models.Address>;
2022-09-23 12:31:14 +00:00
p2pkhChangeIndex = (await resultChange44)['index'] as int;
p2pkhChangeDerivations = (await resultChange44)['derivations']
as Map<String, Map<String, String>>;
p2shChangeAddressArray =
(await resultChange49)['addressArray'] as List<isar_models.Address>;
2022-09-23 12:31:14 +00:00
p2shChangeIndex = (await resultChange49)['index'] as int;
p2shChangeDerivations = (await resultChange49)['derivations']
as Map<String, Map<String, String>>;
2022-09-26 20:32:53 +00:00
// save the derivations (if any)
if (p2pkhReceiveDerivations.isNotEmpty) {
await addDerivations(
chain: 0,
derivePathType: DerivePathType.bip44,
derivationsToAdd: p2pkhReceiveDerivations);
}
2022-09-23 12:31:14 +00:00
if (p2shReceiveDerivations.isNotEmpty) {
await addDerivations(
chain: 0,
derivePathType: DerivePathType.bip49,
derivationsToAdd: p2shReceiveDerivations);
}
2022-09-26 20:32:53 +00:00
if (p2pkhChangeDerivations.isNotEmpty) {
await addDerivations(
chain: 1,
derivePathType: DerivePathType.bip44,
derivationsToAdd: p2pkhChangeDerivations);
}
2022-09-23 12:31:14 +00:00
if (p2shChangeDerivations.isNotEmpty) {
await addDerivations(
chain: 1,
derivePathType: DerivePathType.bip49,
derivationsToAdd: p2shChangeDerivations);
}
2022-09-26 20:32:53 +00:00
// If restoring a wallet that never received any funds, then set receivingArray manually
// If we didn't do this, it'd store an empty array
if (p2pkhReceiveIndex == -1) {
final address =
await _generateAddressForChain(0, 0, DerivePathType.bip44);
p2pkhReceiveAddressArray.add(address);
}
2022-09-23 12:31:14 +00:00
if (p2shReceiveIndex == -1) {
final address =
await _generateAddressForChain(0, 0, DerivePathType.bip49);
p2shReceiveAddressArray.add(address);
}
2022-09-26 20:32:53 +00:00
// If restoring a wallet that never sent any funds with change, then set changeArray
// manually. If we didn't do this, it'd store an empty array.
if (p2pkhChangeIndex == -1) {
final address =
await _generateAddressForChain(1, 0, DerivePathType.bip44);
p2pkhChangeAddressArray.add(address);
}
2022-09-23 12:31:14 +00:00
if (p2shChangeIndex == -1) {
final address =
await _generateAddressForChain(1, 0, DerivePathType.bip49);
p2shChangeAddressArray.add(address);
}
2023-01-12 18:46:01 +00:00
await isarInit(walletId);
2023-01-16 21:04:03 +00:00
await db.putAddresses([
...p2pkhReceiveAddressArray,
...p2pkhChangeAddressArray,
...p2shReceiveAddressArray,
...p2shChangeAddressArray,
]);
await _updateUTXOs();
await Future.wait([
updateCachedId(walletId),
updateCachedIsFavorite(false),
]);
2022-09-26 20:32:53 +00:00
longMutex = false;
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from _recoverWalletFromBIP32SeedPhrase(): $e\n$s",
level: LogLevel.Info);
longMutex = false;
rethrow;
}
}
Future<bool> refreshIfThereIsNewData() async {
if (longMutex) return false;
if (_hasCalledExit) return false;
Logging.instance.log("refreshIfThereIsNewData", level: LogLevel.Info);
try {
bool needsRefresh = false;
Logging.instance.log(
"notified unconfirmed transactions: ${txTracker.pendings}",
level: LogLevel.Info);
Set<String> txnsToCheck = {};
for (final String txid in txTracker.pendings) {
if (!txTracker.wasNotifiedConfirmed(txid)) {
txnsToCheck.add(txid);
}
}
for (String txid in txnsToCheck) {
final txn = await electrumXClient.getTransaction(txHash: txid);
var confirmations = txn["confirmations"];
if (confirmations is! int) continue;
bool isUnconfirmed = confirmations < MINIMUM_CONFIRMATIONS;
if (!isUnconfirmed) {
// unconfirmedTxs = {};
needsRefresh = true;
break;
}
}
if (!needsRefresh) {
var allOwnAddresses = await _fetchAllOwnAddresses();
List<Map<String, dynamic>> allTxs = await _fetchHistory(
allOwnAddresses.map((e) => e.value).toList(growable: false));
2022-09-26 20:32:53 +00:00
for (Map<String, dynamic> transaction in allTxs) {
final txid = transaction['tx_hash'] as String;
2023-01-16 21:04:03 +00:00
if ((await db
.getTransactions(walletId)
.filter()
.txidMatches(txid)
.findFirst()) ==
2022-09-26 20:32:53 +00:00
null) {
Logging.instance.log(
" txid not found in address history already ${transaction['tx_hash']}",
level: LogLevel.Info);
needsRefresh = true;
break;
}
}
}
return needsRefresh;
} catch (e, s) {
Logging.instance.log(
"Exception caught in refreshIfThereIsNewData: $e\n$s",
level: LogLevel.Info);
rethrow;
}
}
Future<void> getAllTxsToWatch() async {
2022-09-26 20:32:53 +00:00
if (_hasCalledExit) return;
List<isar_models.Transaction> unconfirmedTxnsToNotifyPending = [];
List<isar_models.Transaction> unconfirmedTxnsToNotifyConfirmed = [];
final currentChainHeight = await chainHeight;
2022-09-26 20:32:53 +00:00
2023-01-16 21:04:03 +00:00
final txCount = await db.getTransactions(walletId).count();
const paginateLimit = 50;
for (int i = 0; i < txCount; i += paginateLimit) {
2023-01-16 21:04:03 +00:00
final transactions = await db
.getTransactions(walletId)
.offset(i)
.limit(paginateLimit)
.findAll();
for (final tx in transactions) {
if (tx.isConfirmed(currentChainHeight, MINIMUM_CONFIRMATIONS)) {
2022-09-26 20:32:53 +00:00
if (txTracker.wasNotifiedPending(tx.txid) &&
!txTracker.wasNotifiedConfirmed(tx.txid)) {
unconfirmedTxnsToNotifyConfirmed.add(tx);
}
} else {
if (!txTracker.wasNotifiedPending(tx.txid)) {
unconfirmedTxnsToNotifyPending.add(tx);
}
}
}
}
// notify on new incoming transaction
for (final tx in unconfirmedTxnsToNotifyPending) {
final confirmations = tx.getConfirmations(currentChainHeight);
if (tx.type == isar_models.TransactionType.incoming) {
unawaited(
NotificationApi.showNotification(
title: "Incoming transaction",
body: walletName,
walletId: walletId,
iconAssetName: Assets.svg.iconFor(coin: coin),
date: DateTime.now(),
shouldWatchForUpdates: confirmations < MINIMUM_CONFIRMATIONS,
coinName: coin.name,
txid: tx.txid,
confirmations: confirmations,
requiredConfirmations: MINIMUM_CONFIRMATIONS,
),
2022-09-26 20:32:53 +00:00
);
await txTracker.addNotifiedPending(tx.txid);
} else if (tx.type == isar_models.TransactionType.outgoing) {
unawaited(
NotificationApi.showNotification(
title: "Sending transaction",
body: walletName,
walletId: walletId,
iconAssetName: Assets.svg.iconFor(coin: coin),
date: DateTime.fromMillisecondsSinceEpoch(tx.timestamp * 1000),
shouldWatchForUpdates: confirmations < MINIMUM_CONFIRMATIONS,
coinName: coin.name,
txid: tx.txid,
confirmations: confirmations,
requiredConfirmations: MINIMUM_CONFIRMATIONS,
),
2022-09-26 20:32:53 +00:00
);
await txTracker.addNotifiedPending(tx.txid);
}
}
// notify on confirmed
for (final tx in unconfirmedTxnsToNotifyConfirmed) {
if (tx.type == isar_models.TransactionType.incoming) {
unawaited(
NotificationApi.showNotification(
title: "Incoming transaction confirmed",
body: walletName,
walletId: walletId,
iconAssetName: Assets.svg.iconFor(coin: coin),
date: DateTime.now(),
shouldWatchForUpdates: false,
coinName: coin.name,
),
2022-09-26 20:32:53 +00:00
);
await txTracker.addNotifiedConfirmed(tx.txid);
} else if (tx.type == isar_models.TransactionType.outgoing) {
unawaited(
NotificationApi.showNotification(
title: "Outgoing transaction confirmed",
body: walletName,
walletId: walletId,
iconAssetName: Assets.svg.iconFor(coin: coin),
date: DateTime.now(),
shouldWatchForUpdates: false,
coinName: coin.name,
),
2022-09-26 20:32:53 +00:00
);
await txTracker.addNotifiedConfirmed(tx.txid);
}
}
}
bool refreshMutex = false;
bool _shouldAutoSync = false;
@override
bool get shouldAutoSync => _shouldAutoSync;
@override
set shouldAutoSync(bool shouldAutoSync) {
if (_shouldAutoSync != shouldAutoSync) {
_shouldAutoSync = shouldAutoSync;
if (!shouldAutoSync) {
timer?.cancel();
timer = null;
stopNetworkAlivePinging();
} else {
startNetworkAlivePinging();
refresh();
}
}
}
//TODO Show percentages properly/more consistently
/// Refreshes display data for the wallet
@override
Future<void> refresh() async {
if (refreshMutex) {
Logging.instance.log("$walletId $walletName refreshMutex denied",
level: LogLevel.Info);
return;
} else {
refreshMutex = true;
}
try {
GlobalEventBus.instance.fire(
WalletSyncStatusChangedEvent(
WalletSyncStatus.syncing,
walletId,
coin,
),
);
GlobalEventBus.instance.fire(RefreshPercentChangedEvent(0.0, walletId));
GlobalEventBus.instance.fire(RefreshPercentChangedEvent(0.1, walletId));
final currentHeight = await chainHeight;
const storedHeight = 1; //await storedChainHeight;
Logging.instance
.log("chain height: $currentHeight", level: LogLevel.Info);
Logging.instance
.log("cached height: $storedHeight", level: LogLevel.Info);
if (currentHeight != storedHeight) {
GlobalEventBus.instance.fire(RefreshPercentChangedEvent(0.2, walletId));
await _checkChangeAddressForTransactions();
2022-09-26 20:32:53 +00:00
GlobalEventBus.instance.fire(RefreshPercentChangedEvent(0.3, walletId));
await _checkCurrentReceivingAddressesForTransactions();
final fetchFuture = _refreshTransactions();
final utxosRefreshFuture = _updateUTXOs();
2022-09-26 20:32:53 +00:00
GlobalEventBus.instance
.fire(RefreshPercentChangedEvent(0.50, walletId));
final feeObj = _getFees();
GlobalEventBus.instance
.fire(RefreshPercentChangedEvent(0.60, walletId));
GlobalEventBus.instance
.fire(RefreshPercentChangedEvent(0.70, walletId));
_feeObject = Future(() => feeObj);
await utxosRefreshFuture;
2022-09-26 20:32:53 +00:00
GlobalEventBus.instance
.fire(RefreshPercentChangedEvent(0.80, walletId));
await fetchFuture;
await getAllTxsToWatch();
2022-09-26 20:32:53 +00:00
GlobalEventBus.instance
.fire(RefreshPercentChangedEvent(0.90, walletId));
}
GlobalEventBus.instance.fire(RefreshPercentChangedEvent(1.0, walletId));
GlobalEventBus.instance.fire(
WalletSyncStatusChangedEvent(
WalletSyncStatus.synced,
walletId,
coin,
),
);
refreshMutex = false;
if (shouldAutoSync) {
timer ??= Timer.periodic(const Duration(seconds: 150), (timer) async {
// chain height check currently broken
// if ((await chainHeight) != (await storedChainHeight)) {
if (await refreshIfThereIsNewData()) {
await refresh();
GlobalEventBus.instance.fire(UpdatedInBackgroundEvent(
"New data found in $walletId $walletName in background!",
walletId));
}
// }
});
}
} catch (error, strace) {
refreshMutex = false;
GlobalEventBus.instance.fire(
NodeConnectionStatusChangedEvent(
NodeConnectionStatus.disconnected,
walletId,
coin,
),
);
GlobalEventBus.instance.fire(
WalletSyncStatusChangedEvent(
WalletSyncStatus.unableToSync,
walletId,
coin,
),
);
Logging.instance.log(
"Caught exception in refreshWalletData(): $error\n$strace",
level: LogLevel.Error);
}
}
@override
Future<Map<String, dynamic>> prepareSend({
required String address,
required int satoshiAmount,
Map<String, dynamic>? args,
}) async {
try {
final feeRateType = args?["feeRate"];
final feeRateAmount = args?["feeRateAmount"];
if (feeRateType is FeeRateType || feeRateAmount is int) {
late final int rate;
if (feeRateType is FeeRateType) {
int fee = 0;
final feeObject = await fees;
switch (feeRateType) {
case FeeRateType.fast:
fee = feeObject.fast;
break;
case FeeRateType.average:
fee = feeObject.medium;
break;
case FeeRateType.slow:
fee = feeObject.slow;
break;
}
rate = fee;
} else {
rate = feeRateAmount as int;
}
// check for send all
bool isSendAll = false;
if (satoshiAmount == balance.spendable) {
2022-09-26 20:32:53 +00:00
isSendAll = true;
}
final result =
await coinSelection(satoshiAmount, rate, address, isSendAll);
Logging.instance.log("SEND RESULT: $result", level: LogLevel.Info);
if (result is int) {
switch (result) {
case 1:
throw Exception("Insufficient balance!");
case 2:
throw Exception("Insufficient funds to pay for transaction fee!");
default:
throw Exception("Transaction failed with error code $result");
}
} else {
final hex = result["hex"];
if (hex is String) {
final fee = result["fee"] as int;
final vSize = result["vSize"] as int;
Logging.instance.log("txHex: $hex", level: LogLevel.Info);
Logging.instance.log("fee: $fee", level: LogLevel.Info);
Logging.instance.log("vsize: $vSize", level: LogLevel.Info);
// fee should never be less than vSize sanity check
if (fee < vSize) {
throw Exception(
"Error in fee calculation: Transaction fee cannot be less than vSize");
}
return result as Map<String, dynamic>;
} else {
throw Exception("sent hex is not a String!!!");
}
}
} else {
throw ArgumentError("Invalid fee rate argument provided!");
}
} catch (e, s) {
Logging.instance.log("Exception rethrown from prepareSend(): $e\n$s",
level: LogLevel.Error);
rethrow;
}
}
@override
Future<String> confirmSend({dynamic txData}) async {
try {
Logging.instance.log("confirmSend txData: $txData", level: LogLevel.Info);
final txHash = await _electrumXClient.broadcastTransaction(
rawTx: txData["hex"] as String);
Logging.instance.log("Sent txHash: $txHash", level: LogLevel.Info);
return txHash;
} catch (e, s) {
Logging.instance.log("Exception rethrown from confirmSend(): $e\n$s",
level: LogLevel.Error);
rethrow;
}
}
@override
Future<bool> testNetworkConnection() async {
try {
final result = await _electrumXClient.ping();
return result;
} catch (_) {
return false;
}
}
Timer? _networkAliveTimer;
void startNetworkAlivePinging() {
// call once on start right away
_periodicPingCheck();
// then periodically check
_networkAliveTimer = Timer.periodic(
Constants.networkAliveTimerDuration,
(_) async {
_periodicPingCheck();
},
);
}
void _periodicPingCheck() async {
bool hasNetwork = await testNetworkConnection();
_isConnected = hasNetwork;
if (_isConnected != hasNetwork) {
NodeConnectionStatus status = hasNetwork
? NodeConnectionStatus.connected
: NodeConnectionStatus.disconnected;
GlobalEventBus.instance
.fire(NodeConnectionStatusChangedEvent(status, walletId, coin));
}
}
void stopNetworkAlivePinging() {
_networkAliveTimer?.cancel();
_networkAliveTimer = null;
}
bool _isConnected = false;
@override
bool get isConnected => _isConnected;
@override
Future<void> initializeNew() async {
Logging.instance
.log("Generating new ${coin.prettyName} wallet.", level: LogLevel.Info);
if (getCachedId() != null) {
2022-09-26 20:32:53 +00:00
throw Exception(
"Attempted to initialize a new wallet using an existing wallet ID!");
}
await _prefs.init();
try {
await _generateNewWallet();
} catch (e, s) {
Logging.instance.log("Exception rethrown from initializeNew(): $e\n$s",
level: LogLevel.Fatal);
rethrow;
}
await Future.wait([
updateCachedId(walletId),
updateCachedIsFavorite(false),
2022-09-26 20:32:53 +00:00
]);
}
@override
Future<void> initializeExisting() async {
Logging.instance.log("Opening existing ${coin.prettyName} wallet.",
level: LogLevel.Info);
if (getCachedId() == null) {
2022-09-26 20:32:53 +00:00
throw Exception(
"Attempted to initialize an existing wallet using an unknown wallet ID!");
}
2022-09-26 20:32:53 +00:00
await _prefs.init();
2023-01-12 18:46:01 +00:00
await isarInit(walletId);
2022-09-26 20:32:53 +00:00
}
// hack to add tx to txData before refresh completes
// required based on current app architecture where we don't properly store
// transactions locally in a good way
@override
Future<void> updateSentCachedTxData(Map<String, dynamic> txData) async {
// final priceData =
// await _priceAPI.getPricesAnd24hChange(baseCurrency: _prefs.currency);
// Decimal currentPrice = priceData[coin]?.item1 ?? Decimal.zero;
// final locale =
// Platform.isWindows ? "en_US" : await Devicelocale.currentLocale;
// final String worthNow = Format.localizedStringAsFixed(
// value:
// ((currentPrice * Decimal.fromInt(txData["recipientAmt"] as int)) /
// Decimal.fromInt(Constants.satsPerCoin(coin)))
// .toDecimal(scaleOnInfinitePrecision: 2),
// decimalPlaces: 2,
// locale: locale!);
//
// final tx = models.Transaction(
// txid: txData["txid"] as String,
// confirmedStatus: false,
// timestamp: DateTime.now().millisecondsSinceEpoch ~/ 1000,
// txType: "Sent",
// amount: txData["recipientAmt"] as int,
// worthNow: worthNow,
// worthAtBlockTimestamp: worthNow,
// fees: txData["fee"] as int,
// inputSize: 0,
// outputSize: 0,
// inputs: [],
// outputs: [],
// address: txData["address"] as String,
// height: -1,
// confirmations: 0,
// );
//
// if (cachedTxData == null) {
// final data = await _fetchTransactionData();
// _transactionData = Future(() => data);
// }
//
// final transactions = cachedTxData!.getAllTransactions();
// transactions[tx.txid] = tx;
// cachedTxData = models.TransactionData.fromMap(transactions);
// _transactionData = Future(() => cachedTxData!);
}
bool validateCashAddr(String cashAddr) {
String addr = cashAddr;
if (cashAddr.contains(":")) {
addr = cashAddr.split(":").last;
}
return addr.startsWith("q");
}
2022-09-26 20:32:53 +00:00
@override
bool validateAddress(String address) {
try {
// 0 for bitcoincash: address scheme, 1 for legacy address
final format = bitbox.Address.detectFormat(address);
if (kDebugMode) {
print("format $format");
}
2022-11-04 23:22:22 +00:00
if (_coin == Coin.bitcoincashTestnet) {
return true;
}
2022-11-04 23:22:22 +00:00
if (format == bitbox.Address.formatCashAddr) {
return validateCashAddr(address);
2022-11-04 23:22:22 +00:00
} else {
return address.startsWith("1");
}
} catch (e) {
2022-09-26 20:32:53 +00:00
return false;
}
}
@override
String get walletId => _walletId;
late final String _walletId;
2022-09-26 20:32:53 +00:00
@override
String get walletName => _walletName;
late String _walletName;
// setter for updating on rename
@override
set walletName(String newName) => _walletName = newName;
late ElectrumX _electrumXClient;
ElectrumX get electrumXClient => _electrumXClient;
late CachedElectrumX _cachedElectrumXClient;
CachedElectrumX get cachedElectrumXClient => _cachedElectrumXClient;
late SecureStorageInterface _secureStore;
2022-09-26 20:32:53 +00:00
BitcoinCashWallet({
required String walletId,
required String walletName,
required Coin coin,
required ElectrumX client,
required CachedElectrumX cachedClient,
required TransactionNotificationTracker tracker,
required SecureStorageInterface secureStore,
2022-09-26 20:32:53 +00:00
}) {
txTracker = tracker;
_walletId = walletId;
_walletName = walletName;
_coin = coin;
_electrumXClient = client;
_cachedElectrumXClient = cachedClient;
2022-11-09 22:43:26 +00:00
_secureStore = secureStore;
initCache(walletId, coin);
2022-09-26 20:32:53 +00:00
}
@override
Future<void> updateNode(bool shouldRefresh) async {
2022-11-09 22:43:26 +00:00
final failovers = NodeService(secureStorageInterface: _secureStore)
2022-09-26 20:32:53 +00:00
.failoverNodesFor(coin: coin)
.map((e) => ElectrumXNode(
address: e.host,
port: e.port,
name: e.name,
id: e.id,
useSSL: e.useSSL,
))
.toList();
final newNode = await getCurrentNode();
_cachedElectrumXClient = CachedElectrumX.from(
node: newNode,
prefs: _prefs,
failovers: failovers,
);
_electrumXClient = ElectrumX.from(
node: newNode,
prefs: _prefs,
failovers: failovers,
);
if (shouldRefresh) {
unawaited(refresh());
2022-09-26 20:32:53 +00:00
}
}
Future<List<String>> _getMnemonicList() async {
final mnemonicString =
await _secureStore.read(key: '${_walletId}_mnemonic');
if (mnemonicString == null) {
return [];
}
final List<String> data = mnemonicString.split(' ');
return data;
}
Future<ElectrumXNode> getCurrentNode() async {
2022-11-09 22:43:26 +00:00
final node = NodeService(secureStorageInterface: _secureStore)
.getPrimaryNodeFor(coin: coin) ??
2022-09-26 20:32:53 +00:00
DefaultNodes.getNodeFor(coin);
return ElectrumXNode(
address: node.host,
port: node.port,
name: node.name,
useSSL: node.useSSL,
id: node.id,
);
}
Future<List<isar_models.Address>> _fetchAllOwnAddresses() async {
2023-01-16 21:04:03 +00:00
final allAddresses = await db
.getAddresses(walletId)
.filter()
2023-01-18 23:20:23 +00:00
.not()
.typeEqualTo(isar_models.AddressType.nonWallet)
.and()
.group((q) => q
.subTypeEqualTo(isar_models.AddressSubType.receiving)
.or()
.subTypeEqualTo(isar_models.AddressSubType.change))
.findAll();
2022-09-26 20:32:53 +00:00
// for (var i = 0; i < receivingAddressesP2PKH.length; i++) {
// if (!allAddresses.contains(receivingAddressesP2PKH[i])) {
// allAddresses.add(receivingAddressesP2PKH[i] as String);
2022-09-26 20:32:53 +00:00
// }
// }
// for (var i = 0; i < changeAddressesP2PKH.length; i++) {
// if (!allAddresses.contains(changeAddressesP2PKH[i])) {
// allAddresses.add(changeAddressesP2PKH[i] as String);
2022-09-26 20:32:53 +00:00
// }
// }
return allAddresses;
}
Future<FeeObject> _getFees() async {
try {
//TODO adjust numbers for different speeds?
const int f = 1, m = 5, s = 20;
final fast = await electrumXClient.estimateFee(blocks: f);
final medium = await electrumXClient.estimateFee(blocks: m);
final slow = await electrumXClient.estimateFee(blocks: s);
final feeObject = FeeObject(
numberOfBlocksFast: f,
numberOfBlocksAverage: m,
numberOfBlocksSlow: s,
fast: Format.decimalAmountToSatoshis(fast, coin),
medium: Format.decimalAmountToSatoshis(medium, coin),
slow: Format.decimalAmountToSatoshis(slow, coin),
2022-09-26 20:32:53 +00:00
);
Logging.instance.log("fetched fees: $feeObject", level: LogLevel.Info);
return feeObject;
} catch (e) {
Logging.instance
.log("Exception rethrown from _getFees(): $e", level: LogLevel.Error);
rethrow;
}
}
Future<void> _generateNewWallet() async {
Logging.instance
.log("IS_INTEGRATION_TEST: $integrationTestFlag", level: LogLevel.Info);
if (!integrationTestFlag) {
try {
final features = await electrumXClient
.getServerFeatures()
.timeout(const Duration(seconds: 3));
Logging.instance.log("features: $features", level: LogLevel.Info);
switch (coin) {
case Coin.bitcoincash:
if (features['genesis_hash'] != GENESIS_HASH_MAINNET) {
throw Exception("genesis hash does not match main net!");
}
break;
case Coin.bitcoincashTestnet:
if (features['genesis_hash'] != GENESIS_HASH_TESTNET) {
throw Exception("genesis hash does not match test net!");
}
break;
default:
throw Exception(
"Attempted to generate a BitcoinWallet using a non bitcoin coin type: ${coin.name}");
}
} catch (e, s) {
Logging.instance.log("$e/n$s", level: LogLevel.Info);
}
}
2022-09-26 20:32:53 +00:00
// this should never fail
if ((await _secureStore.read(key: '${_walletId}_mnemonic')) != null) {
throw Exception(
"Attempted to overwrite mnemonic on generate new wallet!");
}
await _secureStore.write(
key: '${_walletId}_mnemonic',
value: bip39.generateMnemonic(strength: 256));
// Generate and add addresses to relevant arrays
final initialAddresses = await Future.wait([
// P2PKH
_generateAddressForChain(0, 0, DerivePathType.bip44),
_generateAddressForChain(1, 0, DerivePathType.bip44),
// P2SH
_generateAddressForChain(0, 0, DerivePathType.bip49),
_generateAddressForChain(1, 0, DerivePathType.bip49),
]);
2022-09-23 12:31:14 +00:00
2023-01-12 18:46:01 +00:00
await isarInit(walletId);
2022-10-19 20:21:48 +00:00
2023-01-16 21:04:03 +00:00
await db.putAddresses(initialAddresses);
2022-09-26 20:32:53 +00:00
Logging.instance.log("_generateNewWalletFinished", level: LogLevel.Info);
}
2022-09-23 12:31:14 +00:00
/// Generates a new internal or external chain address for the wallet using a BIP44 or BIP49 derivation path.
2022-09-26 20:32:53 +00:00
/// [chain] - Use 0 for receiving (external), 1 for change (internal). Should not be any other value!
/// [index] - This can be any integer >= 0
Future<isar_models.Address> _generateAddressForChain(
2022-09-26 20:32:53 +00:00
int chain,
int index,
DerivePathType derivePathType,
) async {
final mnemonic = await _secureStore.read(key: '${_walletId}_mnemonic');
final node = await compute(
getBip32NodeWrapper,
Tuple5(
chain,
index,
mnemonic!,
_network,
derivePathType,
),
);
final data = PaymentData(pubkey: node.publicKey);
String address;
isar_models.AddressType addrType;
2022-09-26 20:32:53 +00:00
switch (derivePathType) {
case DerivePathType.bip44:
address = P2PKH(data: data, network: _network).data.address!;
addrType = isar_models.AddressType.p2pkh;
2023-01-17 14:04:30 +00:00
address = bitbox.Address.toCashAddress(address);
2022-09-26 20:32:53 +00:00
break;
2022-09-23 12:31:14 +00:00
case DerivePathType.bip49:
address = P2SH(
data: PaymentData(
redeem: P2WPKH(data: data, network: _network).data),
network: _network)
.data
.address!;
addrType = isar_models.AddressType.p2sh;
2022-09-23 12:31:14 +00:00
break;
2022-09-26 20:32:53 +00:00
// default:
// // should never hit this due to all enum cases handled
// return null;
}
// add generated address & info to derivations
await addDerivation(
chain: chain,
address: address,
pubKey: Format.uint8listToString(node.publicKey),
wif: node.toWIF(),
derivePathType: derivePathType,
);
2023-01-16 22:37:00 +00:00
return isar_models.Address(
walletId: walletId,
value: address,
publicKey: node.publicKey,
type: addrType,
derivationIndex: index,
subType: chain == 0
? isar_models.AddressSubType.receiving
2023-01-16 22:37:00 +00:00
: isar_models.AddressSubType.change,
);
2022-09-26 20:32:53 +00:00
}
/// Returns the latest receiving/change (external/internal) address for the wallet depending on [chain]
/// and
/// [chain] - Use 0 for receiving (external), 1 for change (internal). Should not be any other value!
Future<String> _getCurrentAddressForChain(
int chain,
DerivePathType derivePathType,
) async {
final subType = chain == 0 // Here, we assume that chain == 1 if it isn't 0
? isar_models.AddressSubType.receiving
: isar_models.AddressSubType.change;
isar_models.AddressType type;
2022-09-26 20:32:53 +00:00
switch (derivePathType) {
case DerivePathType.bip44:
type = isar_models.AddressType.p2pkh;
2022-09-26 20:32:53 +00:00
break;
2022-09-23 12:31:14 +00:00
case DerivePathType.bip49:
type = isar_models.AddressType.p2sh;
2022-09-23 12:31:14 +00:00
break;
2022-09-26 20:32:53 +00:00
}
2022-09-23 15:14:22 +00:00
2023-01-16 21:04:03 +00:00
final address = await db
.getAddresses(walletId)
.filter()
.typeEqualTo(type)
.subTypeEqualTo(subType)
.sortByDerivationIndexDesc()
.findFirst();
return address!.value;
2022-09-26 20:32:53 +00:00
}
String _buildDerivationStorageKey({
required int chain,
required DerivePathType derivePathType,
}) {
2022-09-26 20:32:53 +00:00
String key;
String chainId = chain == 0 ? "receive" : "change";
switch (derivePathType) {
case DerivePathType.bip44:
key = "${walletId}_${chainId}DerivationsP2PKH";
break;
2022-09-23 12:31:14 +00:00
case DerivePathType.bip49:
key = "${walletId}_${chainId}DerivationsP2SH";
break;
2022-09-26 20:32:53 +00:00
}
return key;
}
Future<Map<String, dynamic>> _fetchDerivations(
{required int chain, required DerivePathType derivePathType}) async {
// build lookup key
final key = _buildDerivationStorageKey(
chain: chain, derivePathType: derivePathType);
// fetch current derivations
final derivationsString = await _secureStore.read(key: key);
return Map<String, dynamic>.from(
jsonDecode(derivationsString ?? "{}") as Map);
}
/// Add a single derivation to the local secure storage for [chain] and
/// [derivePathType] where [chain] must either be 1 for change or 0 for receive.
/// This will overwrite a previous entry where the address of the new derivation
/// matches a derivation currently stored.
Future<void> addDerivation({
required int chain,
required String address,
required String pubKey,
required String wif,
required DerivePathType derivePathType,
}) async {
// build lookup key
final key = _buildDerivationStorageKey(
chain: chain, derivePathType: derivePathType);
// fetch current derivations
final derivationsString = await _secureStore.read(key: key);
final derivations =
Map<String, dynamic>.from(jsonDecode(derivationsString ?? "{}") as Map);
// add derivation
derivations[address] = {
"pubKey": pubKey,
"wif": wif,
};
// save derivations
final newReceiveDerivationsString = jsonEncode(derivations);
await _secureStore.write(key: key, value: newReceiveDerivationsString);
}
/// Add multiple derivations to the local secure storage for [chain] and
/// [derivePathType] where [chain] must either be 1 for change or 0 for receive.
/// This will overwrite any previous entries where the address of the new derivation
/// matches a derivation currently stored.
/// The [derivationsToAdd] must be in the format of:
/// {
/// addressA : {
/// "pubKey": <the pubKey string>,
/// "wif": <the wif string>,
/// },
/// addressB : {
/// "pubKey": <the pubKey string>,
/// "wif": <the wif string>,
/// },
/// }
Future<void> addDerivations({
required int chain,
required DerivePathType derivePathType,
required Map<String, dynamic> derivationsToAdd,
}) async {
// build lookup key
final key = _buildDerivationStorageKey(
chain: chain, derivePathType: derivePathType);
// fetch current derivations
final derivationsString = await _secureStore.read(key: key);
final derivations =
Map<String, dynamic>.from(jsonDecode(derivationsString ?? "{}") as Map);
// add derivation
derivations.addAll(derivationsToAdd);
// save derivations
final newReceiveDerivationsString = jsonEncode(derivations);
await _secureStore.write(key: key, value: newReceiveDerivationsString);
}
Future<void> _updateUTXOs() async {
final allAddresses = await _fetchAllOwnAddresses();
2022-09-26 20:32:53 +00:00
try {
final fetchedUtxoList = <List<Map<String, dynamic>>>[];
final Map<int, Map<String, List<dynamic>>> batches = {};
const batchSizeMax = 10;
int batchNumber = 0;
for (int i = 0; i < allAddresses.length; i++) {
if (batches[batchNumber] == null) {
batches[batchNumber] = {};
}
final scripthash =
_convertToScriptHash(allAddresses[i].value, _network);
if (kDebugMode) {
print("SCRIPT_HASH_FOR_ADDRESS ${allAddresses[i]} IS $scripthash");
}
2022-09-26 20:32:53 +00:00
batches[batchNumber]!.addAll({
scripthash: [scripthash]
});
if (i % batchSizeMax == batchSizeMax - 1) {
batchNumber++;
}
}
for (int i = 0; i < batches.length; i++) {
final response =
await _electrumXClient.getBatchUTXOs(args: batches[i]!);
for (final entry in response.entries) {
if (entry.value.isNotEmpty) {
fetchedUtxoList.add(entry.value);
}
}
}
final currentChainHeight = await chainHeight;
final List<isar_models.UTXO> outputArray = [];
int satoshiBalanceTotal = 0;
2022-09-26 20:32:53 +00:00
int satoshiBalancePending = 0;
int satoshiBalanceSpendable = 0;
int satoshiBalanceBlocked = 0;
2022-09-26 20:32:53 +00:00
for (int i = 0; i < fetchedUtxoList.length; i++) {
for (int j = 0; j < fetchedUtxoList[i].length; j++) {
final txn = await cachedElectrumXClient.getTransaction(
txHash: fetchedUtxoList[i][j]["tx_hash"] as String,
verbose: true,
coin: coin,
);
// todo check here if we should mark as blocked
2023-01-16 22:37:00 +00:00
final utxo = isar_models.UTXO(
walletId: walletId,
txid: txn["txid"] as String,
vout: fetchedUtxoList[i][j]["tx_pos"] as int,
value: fetchedUtxoList[i][j]["value"] as int,
name: "",
isBlocked: false,
blockedReason: null,
isCoinbase: txn["is_coinbase"] as bool? ?? false,
blockHash: txn["blockhash"] as String?,
blockHeight: fetchedUtxoList[i][j]["height"] as int?,
blockTime: txn["blocktime"] as int?,
);
satoshiBalanceTotal += utxo.value;
if (utxo.isBlocked) {
satoshiBalanceBlocked += utxo.value;
} else {
if (utxo.isConfirmed(currentChainHeight, MINIMUM_CONFIRMATIONS)) {
satoshiBalanceSpendable += utxo.value;
} else {
satoshiBalancePending += utxo.value;
}
2022-09-26 20:32:53 +00:00
}
outputArray.add(utxo);
}
}
Logging.instance
.log('Outputs fetched: $outputArray', level: LogLevel.Info);
2022-09-26 20:32:53 +00:00
2023-01-16 21:04:03 +00:00
// TODO move this out of here and into IDB
await db.isar.writeTxn(() async {
await db.isar.utxos.clear();
await db.isar.utxos.putAll(outputArray);
});
2022-09-26 20:32:53 +00:00
// finally update balance
_balance = Balance(
coin: coin,
total: satoshiBalanceTotal,
spendable: satoshiBalanceSpendable,
blockedTotal: satoshiBalanceBlocked,
pendingSpendable: satoshiBalancePending,
);
await updateCachedBalance(_balance!);
2022-09-26 20:32:53 +00:00
} catch (e, s) {
Logging.instance
.log("Output fetch unsuccessful: $e\n$s", level: LogLevel.Error);
}
}
@override
Balance get balance => _balance ??= getCachedBalance();
Balance? _balance;
2022-09-26 20:32:53 +00:00
Future<int> getTxCount({required String address}) async {
String? scripthash;
try {
scripthash = _convertToScriptHash(address, _network);
final transactions =
await electrumXClient.getHistory(scripthash: scripthash);
return transactions.length;
} catch (e) {
Logging.instance.log(
"Exception rethrown in _getTxCount(address: $address, scripthash: $scripthash): $e",
level: LogLevel.Error);
rethrow;
}
}
Future<Map<String, int>> _getBatchTxCount({
required Map<String, String> addresses,
}) async {
try {
final Map<String, List<dynamic>> args = {};
if (kDebugMode) {
print("Address $addresses");
}
2022-09-26 20:32:53 +00:00
for (final entry in addresses.entries) {
args[entry.key] = [_convertToScriptHash(entry.value, _network)];
}
if (kDebugMode) {
print("Args ${jsonEncode(args)}");
}
2022-09-26 20:32:53 +00:00
final response = await electrumXClient.getBatchHistory(args: args);
if (kDebugMode) {
print("Response ${jsonEncode(response)}");
}
2022-09-26 20:32:53 +00:00
final Map<String, int> result = {};
for (final entry in response.entries) {
result[entry.key] = entry.value.length;
}
if (kDebugMode) {
print("result ${jsonEncode(result)}");
}
2022-09-26 20:32:53 +00:00
return result;
} catch (e, s) {
Logging.instance.log(
"Exception rethrown in _getBatchTxCount(address: $addresses: $e\n$s",
level: LogLevel.Error);
rethrow;
}
}
Future<void> _checkReceivingAddressForTransactions() async {
2022-09-26 20:32:53 +00:00
try {
final currentReceiving = await _currentReceivingAddress;
final int txCount = await getTxCount(address: currentReceiving.value);
2022-09-26 20:32:53 +00:00
Logging.instance.log(
'Number of txs for current receiving address $currentReceiving: $txCount',
2022-09-26 20:32:53 +00:00
level: LogLevel.Info);
if (txCount >= 1) {
// First increment the receiving index
final newReceivingIndex = currentReceiving.derivationIndex + 1;
2022-09-26 20:32:53 +00:00
// Use new index to derive a new receiving address
final newReceivingAddress = await _generateAddressForChain(
0, newReceivingIndex, DerivePathType.bip44);
2022-09-26 20:32:53 +00:00
final existing = await db
.getAddresses(walletId)
.filter()
.valueEqualTo(newReceivingAddress.value)
.findFirst();
if (existing == null) {
// Add that new change address
await db.putAddress(newReceivingAddress);
} else {
// we need to update the address
await db.updateAddress(existing, newReceivingAddress);
// since we updated an existing address there is a chance it has
// some tx history. To prevent address reuse we will call check again
// recursively
await _checkReceivingAddressForTransactions();
}
2022-09-26 20:32:53 +00:00
}
} on SocketException catch (se, s) {
Logging.instance.log(
"SocketException caught in _checkReceivingAddressForTransactions(${DerivePathType.bip44}): $se\n$s",
2022-09-26 20:32:53 +00:00
level: LogLevel.Error);
return;
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from _checkReceivingAddressForTransactions(${DerivePathType.bip44}): $e\n$s",
2022-09-26 20:32:53 +00:00
level: LogLevel.Error);
rethrow;
}
}
Future<void> _checkChangeAddressForTransactions() async {
2022-09-26 20:32:53 +00:00
try {
final currentChange = await _currentChangeAddress;
final int txCount = await getTxCount(address: currentChange.value);
2022-09-26 20:32:53 +00:00
Logging.instance.log(
'Number of txs for current change address $currentChange: $txCount',
2022-09-26 20:32:53 +00:00
level: LogLevel.Info);
if (txCount >= 1) {
// First increment the change index
final newChangeIndex = currentChange.derivationIndex + 1;
2022-09-26 20:32:53 +00:00
// Use new index to derive a new change address
final newChangeAddress = await _generateAddressForChain(
1, newChangeIndex, DerivePathType.bip44);
2022-09-26 20:32:53 +00:00
final existing = await db
.getAddresses(walletId)
.filter()
.valueEqualTo(newChangeAddress.value)
.findFirst();
if (existing == null) {
// Add that new change address
await db.putAddress(newChangeAddress);
} else {
// we need to update the address
await db.updateAddress(existing, newChangeAddress);
// since we updated an existing address there is a chance it has
// some tx history. To prevent address reuse we will call check again
// recursively
await _checkChangeAddressForTransactions();
}
2022-09-26 20:32:53 +00:00
}
} on SocketException catch (se, s) {
Logging.instance.log(
"SocketException caught in _checkReceivingAddressForTransactions(${DerivePathType.bip44}): $se\n$s",
level: LogLevel.Error);
return;
2022-09-26 20:32:53 +00:00
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from _checkReceivingAddressForTransactions(${DerivePathType.bip44}): $e\n$s",
2022-09-26 20:32:53 +00:00
level: LogLevel.Error);
rethrow;
}
}
Future<void> _checkCurrentReceivingAddressesForTransactions() async {
try {
// for (final type in DerivePathType.values) {
await _checkReceivingAddressForTransactions();
// }
2022-09-26 20:32:53 +00:00
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from _checkCurrentReceivingAddressesForTransactions(): $e\n$s",
level: LogLevel.Info);
rethrow;
}
}
/// public wrapper because dart can't test private...
Future<void> checkCurrentReceivingAddressesForTransactions() async {
if (Platform.environment["FLUTTER_TEST"] == "true") {
try {
return _checkCurrentReceivingAddressesForTransactions();
} catch (_) {
rethrow;
}
}
}
Future<void> _checkCurrentChangeAddressesForTransactions() async {
try {
// for (final type in DerivePathType.values) {
await _checkChangeAddressForTransactions();
// }
2022-09-26 20:32:53 +00:00
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from _checkCurrentChangeAddressesForTransactions(): $e\n$s",
level: LogLevel.Error);
rethrow;
}
}
/// public wrapper because dart can't test private...
Future<void> checkCurrentChangeAddressesForTransactions() async {
if (Platform.environment["FLUTTER_TEST"] == "true") {
try {
return _checkCurrentChangeAddressesForTransactions();
} catch (_) {
rethrow;
}
}
}
/// attempts to convert a string to a valid scripthash
///
/// Returns the scripthash or throws an exception on invalid bch address
String _convertToScriptHash(String bchAddress, NetworkType network) {
try {
if (bitbox.Address.detectFormat(bchAddress) ==
bitbox.Address.formatCashAddr &&
validateCashAddr(bchAddress)) {
bchAddress = bitbox.Address.toLegacyAddress(bchAddress);
2022-10-19 20:21:48 +00:00
}
return AddressUtils.convertToScriptHash(bchAddress, network);
2022-09-26 20:32:53 +00:00
} catch (e) {
rethrow;
}
}
Future<List<Map<String, dynamic>>> _fetchHistory(
List<String> allAddresses) async {
try {
List<Map<String, dynamic>> allTxHashes = [];
final Map<int, Map<String, List<dynamic>>> batches = {};
final Map<String, String> requestIdToAddressMap = {};
const batchSizeMax = 10;
int batchNumber = 0;
for (int i = 0; i < allAddresses.length; i++) {
if (batches[batchNumber] == null) {
batches[batchNumber] = {};
}
final scripthash = _convertToScriptHash(allAddresses[i], _network);
final id = Logger.isTestEnv ? "$i" : const Uuid().v1();
requestIdToAddressMap[id] = allAddresses[i];
batches[batchNumber]!.addAll({
id: [scripthash]
});
if (i % batchSizeMax == batchSizeMax - 1) {
batchNumber++;
}
}
for (int i = 0; i < batches.length; i++) {
final response =
await _electrumXClient.getBatchHistory(args: batches[i]!);
for (final entry in response.entries) {
for (int j = 0; j < entry.value.length; j++) {
entry.value[j]["address"] = requestIdToAddressMap[entry.key];
if (!allTxHashes.contains(entry.value[j])) {
allTxHashes.add(entry.value[j]);
}
}
}
}
return allTxHashes;
} catch (e, s) {
Logging.instance.log("_fetchHistory: $e\n$s", level: LogLevel.Error);
rethrow;
}
}
bool _duplicateTxCheck(
List<Map<String, dynamic>> allTransactions, String txid) {
for (int i = 0; i < allTransactions.length; i++) {
if (allTransactions[i]["txid"] == txid) {
return true;
}
}
return false;
}
Future<void> _refreshTransactions() async {
List<isar_models.Address> allAddressesOld = await _fetchAllOwnAddresses();
Set<String> receivingAddresses = allAddressesOld
.where((e) => e.subType == isar_models.AddressSubType.receiving)
.map((e) {
if (bitbox.Address.detectFormat(e.value) == bitbox.Address.formatLegacy &&
addressType(address: e.value) == DerivePathType.bip44) {
return bitbox.Address.toCashAddress(e.value);
2022-10-19 20:21:48 +00:00
} else {
return e.value;
2022-10-19 20:21:48 +00:00
}
}).toSet();
2022-09-26 20:32:53 +00:00
Set<String> changeAddresses = allAddressesOld
.where((e) => e.subType == isar_models.AddressSubType.change)
.map((e) {
if (bitbox.Address.detectFormat(e.value) == bitbox.Address.formatLegacy &&
addressType(address: e.value) == DerivePathType.bip44) {
return bitbox.Address.toCashAddress(e.value);
2022-10-19 20:21:48 +00:00
} else {
return e.value;
2022-10-19 20:21:48 +00:00
}
}).toSet();
2022-09-26 20:32:53 +00:00
final List<Map<String, dynamic>> allTxHashes =
await _fetchHistory([...receivingAddresses, ...changeAddresses]);
2022-09-26 20:32:53 +00:00
List<Map<String, dynamic>> allTransactions = [];
final currentHeight = await chainHeight;
2022-09-26 20:32:53 +00:00
for (final txHash in allTxHashes) {
2023-01-16 21:04:03 +00:00
final storedTx = await db
.getTransactions(walletId)
.filter()
.txidEqualTo(txHash["tx_hash"] as String)
.findFirst();
if (storedTx == null ||
!storedTx.isConfirmed(currentHeight, MINIMUM_CONFIRMATIONS)) {
final tx = await cachedElectrumXClient.getTransaction(
txHash: txHash["tx_hash"] as String,
verbose: true,
coin: coin,
);
2022-09-26 20:32:53 +00:00
// Logging.instance.log("TRANSACTION: ${jsonEncode(tx)}");
if (!_duplicateTxCheck(allTransactions, tx["txid"] as String)) {
2023-01-16 21:04:03 +00:00
tx["address"] = await db
.getAddresses(walletId)
.filter()
.valueEqualTo(txHash["address"] as String)
.findFirst();
tx["height"] = txHash["height"];
allTransactions.add(tx);
}
2022-09-26 20:32:53 +00:00
}
}
//
// Logging.instance.log("addAddresses: $allAddresses", level: LogLevel.Info);
// Logging.instance.log("allTxHashes: $allTxHashes", level: LogLevel.Info);
//
// Logging.instance.log("allTransactions length: ${allTransactions.length}",
// level: LogLevel.Info);
2022-09-26 20:32:53 +00:00
final List<
Tuple4<isar_models.Transaction, List<isar_models.Output>,
List<isar_models.Input>, isar_models.Address?>> txns = [];
2022-09-26 20:32:53 +00:00
for (final txData in allTransactions) {
Set<String> inputAddresses = {};
Set<String> outputAddresses = {};
2022-09-26 20:32:53 +00:00
int totalInputValue = 0;
int totalOutputValue = 0;
2022-09-26 20:32:53 +00:00
int amountSentFromWallet = 0;
int amountReceivedInWallet = 0;
int changeAmount = 0;
2022-09-26 20:32:53 +00:00
// parse inputs
for (final input in txData["vin"] as List) {
2022-09-26 20:32:53 +00:00
final prevTxid = input["txid"] as String;
final prevOut = input["vout"] as int;
// fetch input tx to get address
final inputTx = await cachedElectrumXClient.getTransaction(
txHash: prevTxid,
coin: coin,
);
for (final output in inputTx["vout"] as List) {
// check matching output
if (prevOut == output["n"]) {
// get value
final value = Format.decimalAmountToSatoshis(
Decimal.parse(output["value"].toString()),
coin,
);
// add value to total
totalInputValue += value;
// get input(prevOut) address
final address =
output["scriptPubKey"]?["addresses"]?[0] as String? ??
output["scriptPubKey"]?["address"] as String?;
2022-09-26 20:32:53 +00:00
if (address != null) {
inputAddresses.add(address);
// if input was from my wallet, add value to amount sent
if (receivingAddresses.contains(address) ||
changeAddresses.contains(address)) {
amountSentFromWallet += value;
}
2022-09-26 20:32:53 +00:00
}
}
}
}
// parse outputs
for (final output in txData["vout"] as List) {
// get value
final value = Format.decimalAmountToSatoshis(
Decimal.parse(output["value"].toString()),
coin,
);
2022-09-26 20:32:53 +00:00
// add value to total
totalOutputValue += value;
2022-09-26 20:32:53 +00:00
// get output address
final address = output["scriptPubKey"]?["addresses"]?[0] as String? ??
output["scriptPubKey"]?["address"] as String?;
if (address != null) {
outputAddresses.add(address);
2022-09-26 20:32:53 +00:00
// if output was to my wallet, add value to amount received
if (receivingAddresses.contains(address)) {
amountReceivedInWallet += value;
} else if (changeAddresses.contains(address)) {
changeAmount += value;
2022-09-26 20:32:53 +00:00
}
}
}
2022-09-26 20:32:53 +00:00
final mySentFromAddresses = [
...receivingAddresses.intersection(inputAddresses),
...changeAddresses.intersection(inputAddresses)
];
final myReceivedOnAddresses =
receivingAddresses.intersection(outputAddresses);
final myChangeReceivedOnAddresses =
changeAddresses.intersection(outputAddresses);
2022-09-26 20:32:53 +00:00
final fee = totalInputValue - totalOutputValue;
2022-09-26 20:32:53 +00:00
// this is the address initially used to fetch the txid
isar_models.Address transactionAddress =
txData["address"] as isar_models.Address;
2023-01-16 22:37:00 +00:00
isar_models.TransactionType type;
int amount;
if (mySentFromAddresses.isNotEmpty && myReceivedOnAddresses.isNotEmpty) {
// tx is sent to self
2023-01-16 22:37:00 +00:00
type = isar_models.TransactionType.sentToSelf;
amount =
amountSentFromWallet - amountReceivedInWallet - fee - changeAmount;
} else if (mySentFromAddresses.isNotEmpty) {
// outgoing tx
2023-01-16 22:37:00 +00:00
type = isar_models.TransactionType.outgoing;
amount = amountSentFromWallet - changeAmount - fee;
final possible =
outputAddresses.difference(myChangeReceivedOnAddresses).first;
if (transactionAddress.value != possible) {
2023-01-16 22:37:00 +00:00
transactionAddress = isar_models.Address(
walletId: walletId,
value: possible,
publicKey: [],
type: AddressType.nonWallet,
derivationIndex: -1,
subType: AddressSubType.nonWallet,
);
}
2022-09-26 20:32:53 +00:00
} else {
// incoming tx
2023-01-16 22:37:00 +00:00
type = isar_models.TransactionType.incoming;
amount = amountReceivedInWallet;
}
2023-01-16 22:37:00 +00:00
final tx = isar_models.Transaction(
walletId: walletId,
txid: txData["txid"] as String,
timestamp: txData["blocktime"] as int? ??
(DateTime.now().millisecondsSinceEpoch ~/ 1000),
type: type,
subType: isar_models.TransactionSubType.none,
amount: amount,
fee: fee,
height: txData["height"] as int?,
isCancelled: false,
isLelantus: false,
slateId: null,
otherData: null,
);
List<isar_models.Input> inputs = [];
List<isar_models.Output> outputs = [];
for (final json in txData["vin"] as List) {
bool isCoinBase = json['coinbase'] != null;
2023-01-16 22:37:00 +00:00
final input = isar_models.Input(
walletId: walletId,
txid: json['txid'] as String,
vout: json['vout'] as int? ?? -1,
scriptSig: json['scriptSig']?['hex'] as String?,
scriptSigAsm: json['scriptSig']?['asm'] as String?,
isCoinbase: isCoinBase ? isCoinBase : json['is_coinbase'] as bool?,
sequence: json['sequence'] as int?,
innerRedeemScriptAsm: json['innerRedeemscriptAsm'] as String?,
);
inputs.add(input);
}
for (final json in txData["vout"] as List) {
2023-01-16 22:37:00 +00:00
final output = isar_models.Output(
walletId: walletId,
scriptPubKey: json['scriptPubKey']?['hex'] as String?,
scriptPubKeyAsm: json['scriptPubKey']?['asm'] as String?,
scriptPubKeyType: json['scriptPubKey']?['type'] as String?,
scriptPubKeyAddress:
json["scriptPubKey"]?["addresses"]?[0] as String? ??
json['scriptPubKey']['type'] as String,
value: Format.decimalAmountToSatoshis(
Decimal.parse(json["value"].toString()),
coin,
),
);
outputs.add(output);
2022-09-26 20:32:53 +00:00
}
txns.add(Tuple4(tx, outputs, inputs, transactionAddress));
}
2022-09-26 20:32:53 +00:00
2023-01-16 21:04:03 +00:00
await addNewTransactionData(txns, walletId);
2022-09-26 20:32:53 +00:00
}
int estimateTxFee({required int vSize, required int feeRatePerKB}) {
return vSize * (feeRatePerKB / 1000).ceil();
}
/// The coinselection algorithm decides whether or not the user is eligible to make the transaction
/// with [satoshiAmountToSend] and [selectedTxFeeRate]. If so, it will call buildTrasaction() and return
/// a map containing the tx hex along with other important information. If not, then it will return
/// an integer (1 or 2)
dynamic coinSelection(
int satoshiAmountToSend,
int selectedTxFeeRate,
String _recipientAddress,
bool isSendAll, {
int additionalOutputs = 0,
List<isar_models.UTXO>? utxos,
}) async {
2022-09-26 20:32:53 +00:00
Logging.instance
.log("Starting coinSelection ----------", level: LogLevel.Info);
final List<isar_models.UTXO> availableOutputs = utxos ?? await this.utxos;
final currentChainHeight = await chainHeight;
final List<isar_models.UTXO> spendableOutputs = [];
2022-09-26 20:32:53 +00:00
int spendableSatoshiValue = 0;
// Build list of spendable outputs and totaling their satoshi amount
for (var i = 0; i < availableOutputs.length; i++) {
if (availableOutputs[i].isBlocked == false &&
availableOutputs[i]
.isConfirmed(currentChainHeight, MINIMUM_CONFIRMATIONS) ==
true) {
2022-09-26 20:32:53 +00:00
spendableOutputs.add(availableOutputs[i]);
spendableSatoshiValue += availableOutputs[i].value;
}
}
// sort spendable by age (oldest first)
spendableOutputs.sort((a, b) => b.blockTime!.compareTo(a.blockTime!));
2022-09-26 20:32:53 +00:00
Logging.instance.log("spendableOutputs.length: ${spendableOutputs.length}",
level: LogLevel.Info);
Logging.instance
.log("spendableOutputs: $spendableOutputs", level: LogLevel.Info);
Logging.instance.log("spendableSatoshiValue: $spendableSatoshiValue",
level: LogLevel.Info);
Logging.instance
.log("satoshiAmountToSend: $satoshiAmountToSend", level: LogLevel.Info);
// If the amount the user is trying to send is smaller than the amount that they have spendable,
// then return 1, which indicates that they have an insufficient balance.
if (spendableSatoshiValue < satoshiAmountToSend) {
return 1;
// If the amount the user wants to send is exactly equal to the amount they can spend, then return
// 2, which indicates that they are not leaving enough over to pay the transaction fee
} else if (spendableSatoshiValue == satoshiAmountToSend && !isSendAll) {
return 2;
}
// If neither of these statements pass, we assume that the user has a spendable balance greater
// than the amount they're attempting to send. Note that this value still does not account for
// the added transaction fee, which may require an extra input and will need to be checked for
// later on.
// Possible situation right here
int satoshisBeingUsed = 0;
int inputsBeingConsumed = 0;
List<isar_models.UTXO> utxoObjectsToUse = [];
2022-09-26 20:32:53 +00:00
for (var i = 0;
satoshisBeingUsed < satoshiAmountToSend && i < spendableOutputs.length;
i++) {
utxoObjectsToUse.add(spendableOutputs[i]);
satoshisBeingUsed += spendableOutputs[i].value;
inputsBeingConsumed += 1;
}
for (int i = 0;
i < additionalOutputs && inputsBeingConsumed < spendableOutputs.length;
i++) {
utxoObjectsToUse.add(spendableOutputs[inputsBeingConsumed]);
satoshisBeingUsed += spendableOutputs[inputsBeingConsumed].value;
inputsBeingConsumed += 1;
}
Logging.instance
.log("satoshisBeingUsed: $satoshisBeingUsed", level: LogLevel.Info);
Logging.instance
.log("inputsBeingConsumed: $inputsBeingConsumed", level: LogLevel.Info);
Logging.instance
.log('utxoObjectsToUse: $utxoObjectsToUse', level: LogLevel.Info);
Logging.instance
.log('satoshiAmountToSend $satoshiAmountToSend', level: LogLevel.Info);
// numberOfOutputs' length must always be equal to that of recipientsArray and recipientsAmtArray
List<String> recipientsArray = [_recipientAddress];
List<int> recipientsAmtArray = [satoshiAmountToSend];
// gather required signing data
final utxoSigningData = await fetchBuildTxData(utxoObjectsToUse);
if (isSendAll) {
Logging.instance
.log("Attempting to send all $coin", level: LogLevel.Info);
final int vSizeForOneOutput = (await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: [_recipientAddress],
satoshiAmounts: [satoshisBeingUsed - 1],
))["vSize"] as int;
int feeForOneOutput = estimateTxFee(
vSize: vSizeForOneOutput,
feeRatePerKB: selectedTxFeeRate,
);
if (feeForOneOutput < (vSizeForOneOutput + 1)) {
feeForOneOutput = (vSizeForOneOutput + 1);
}
final int amount = satoshiAmountToSend - feeForOneOutput;
dynamic txn = await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: recipientsArray,
satoshiAmounts: [amount],
);
Map<String, dynamic> transactionObject = {
"hex": txn["hex"],
"recipient": recipientsArray[0],
"recipientAmt": amount,
"fee": feeForOneOutput,
"vSize": txn["vSize"],
};
return transactionObject;
}
final int vSizeForOneOutput = (await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: [_recipientAddress],
satoshiAmounts: [satoshisBeingUsed - 1],
))["vSize"] as int;
final int vSizeForTwoOutPuts = (await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: [
_recipientAddress,
await _getCurrentAddressForChain(1, DerivePathType.bip44),
],
satoshiAmounts: [
satoshiAmountToSend,
satoshisBeingUsed - satoshiAmountToSend - 1,
], // dust limit is the minimum amount a change output should be
))["vSize"] as int;
2022-12-13 00:17:02 +00:00
//todo: check if print needed
2022-12-19 16:29:47 +00:00
// debugPrint("vSizeForOneOutput $vSizeForOneOutput");
// debugPrint("vSizeForTwoOutPuts $vSizeForTwoOutPuts");
2022-09-26 20:32:53 +00:00
// Assume 1 output, only for recipient and no change
var feeForOneOutput = estimateTxFee(
vSize: vSizeForOneOutput,
feeRatePerKB: selectedTxFeeRate,
);
// Assume 2 outputs, one for recipient and one for change
var feeForTwoOutputs = estimateTxFee(
vSize: vSizeForTwoOutPuts,
feeRatePerKB: selectedTxFeeRate,
);
Logging.instance
.log("feeForTwoOutputs: $feeForTwoOutputs", level: LogLevel.Info);
Logging.instance
.log("feeForOneOutput: $feeForOneOutput", level: LogLevel.Info);
if (feeForOneOutput < (vSizeForOneOutput + 1)) {
feeForOneOutput = (vSizeForOneOutput + 1);
}
if (feeForTwoOutputs < ((vSizeForTwoOutPuts + 1))) {
feeForTwoOutputs = ((vSizeForTwoOutPuts + 1));
}
Logging.instance
.log("feeForTwoOutputs: $feeForTwoOutputs", level: LogLevel.Info);
Logging.instance
.log("feeForOneOutput: $feeForOneOutput", level: LogLevel.Info);
if (satoshisBeingUsed - satoshiAmountToSend > feeForOneOutput) {
if (satoshisBeingUsed - satoshiAmountToSend >
feeForOneOutput + DUST_LIMIT) {
// Here, we know that theoretically, we may be able to include another output(change) but we first need to
// factor in the value of this output in satoshis.
int changeOutputSize =
satoshisBeingUsed - satoshiAmountToSend - feeForTwoOutputs;
// We check to see if the user can pay for the new transaction with 2 outputs instead of one. If they can and
// the second output's size > 546 satoshis, we perform the mechanics required to properly generate and use a new
// change address.
if (changeOutputSize > DUST_LIMIT &&
satoshisBeingUsed - satoshiAmountToSend - changeOutputSize ==
feeForTwoOutputs) {
// generate new change address if current change address has been used
await _checkChangeAddressForTransactions();
2022-09-26 20:32:53 +00:00
final String newChangeAddress =
await _getCurrentAddressForChain(1, DerivePathType.bip44);
int feeBeingPaid =
satoshisBeingUsed - satoshiAmountToSend - changeOutputSize;
recipientsArray.add(newChangeAddress);
recipientsAmtArray.add(changeOutputSize);
// At this point, we have the outputs we're going to use, the amounts to send along with which addresses
// we intend to send these amounts to. We have enough to send instructions to build the transaction.
Logging.instance.log('2 outputs in tx', level: LogLevel.Info);
Logging.instance
.log('Input size: $satoshisBeingUsed', level: LogLevel.Info);
Logging.instance.log('Recipient output size: $satoshiAmountToSend',
level: LogLevel.Info);
Logging.instance.log('Change Output Size: $changeOutputSize',
level: LogLevel.Info);
Logging.instance.log(
'Difference (fee being paid): $feeBeingPaid sats',
level: LogLevel.Info);
Logging.instance
.log('Estimated fee: $feeForTwoOutputs', level: LogLevel.Info);
dynamic txn = await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: recipientsArray,
satoshiAmounts: recipientsAmtArray,
);
// make sure minimum fee is accurate if that is being used
if (txn["vSize"] - feeBeingPaid == 1) {
int changeOutputSize =
satoshisBeingUsed - satoshiAmountToSend - (txn["vSize"] as int);
feeBeingPaid =
satoshisBeingUsed - satoshiAmountToSend - changeOutputSize;
recipientsAmtArray.removeLast();
recipientsAmtArray.add(changeOutputSize);
Logging.instance.log('Adjusted Input size: $satoshisBeingUsed',
level: LogLevel.Info);
Logging.instance.log(
'Adjusted Recipient output size: $satoshiAmountToSend',
level: LogLevel.Info);
Logging.instance.log(
'Adjusted Change Output Size: $changeOutputSize',
level: LogLevel.Info);
Logging.instance.log(
'Adjusted Difference (fee being paid): $feeBeingPaid sats',
level: LogLevel.Info);
Logging.instance.log('Adjusted Estimated fee: $feeForTwoOutputs',
level: LogLevel.Info);
txn = await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: recipientsArray,
satoshiAmounts: recipientsAmtArray,
);
}
Map<String, dynamic> transactionObject = {
"hex": txn["hex"],
"recipient": recipientsArray[0],
"recipientAmt": recipientsAmtArray[0],
"fee": feeBeingPaid,
"vSize": txn["vSize"],
};
return transactionObject;
} else {
// Something went wrong here. It either overshot or undershot the estimated fee amount or the changeOutputSize
// is smaller than or equal to [DUST_LIMIT]. Revert to single output transaction.
Logging.instance.log('1 output in tx', level: LogLevel.Info);
Logging.instance
.log('Input size: $satoshisBeingUsed', level: LogLevel.Info);
Logging.instance.log('Recipient output size: $satoshiAmountToSend',
level: LogLevel.Info);
Logging.instance.log(
'Difference (fee being paid): ${satoshisBeingUsed - satoshiAmountToSend} sats',
level: LogLevel.Info);
Logging.instance
.log('Estimated fee: $feeForOneOutput', level: LogLevel.Info);
dynamic txn = await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: recipientsArray,
satoshiAmounts: recipientsAmtArray,
);
Map<String, dynamic> transactionObject = {
"hex": txn["hex"],
"recipient": recipientsArray[0],
"recipientAmt": recipientsAmtArray[0],
"fee": satoshisBeingUsed - satoshiAmountToSend,
"vSize": txn["vSize"],
};
return transactionObject;
}
} else {
// No additional outputs needed since adding one would mean that it'd be smaller than 546 sats
// which makes it uneconomical to add to the transaction. Here, we pass data directly to instruct
// the wallet to begin crafting the transaction that the user requested.
Logging.instance.log('1 output in tx', level: LogLevel.Info);
Logging.instance
.log('Input size: $satoshisBeingUsed', level: LogLevel.Info);
Logging.instance.log('Recipient output size: $satoshiAmountToSend',
level: LogLevel.Info);
Logging.instance.log(
'Difference (fee being paid): ${satoshisBeingUsed - satoshiAmountToSend} sats',
level: LogLevel.Info);
Logging.instance
.log('Estimated fee: $feeForOneOutput', level: LogLevel.Info);
dynamic txn = await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: recipientsArray,
satoshiAmounts: recipientsAmtArray,
);
Map<String, dynamic> transactionObject = {
"hex": txn["hex"],
"recipient": recipientsArray[0],
"recipientAmt": recipientsAmtArray[0],
"fee": satoshisBeingUsed - satoshiAmountToSend,
"vSize": txn["vSize"],
};
return transactionObject;
}
} else if (satoshisBeingUsed - satoshiAmountToSend == feeForOneOutput) {
// In this scenario, no additional change output is needed since inputs - outputs equal exactly
// what we need to pay for fees. Here, we pass data directly to instruct the wallet to begin
// crafting the transaction that the user requested.
Logging.instance.log('1 output in tx', level: LogLevel.Info);
Logging.instance
.log('Input size: $satoshisBeingUsed', level: LogLevel.Info);
Logging.instance.log('Recipient output size: $satoshiAmountToSend',
level: LogLevel.Info);
Logging.instance.log(
'Fee being paid: ${satoshisBeingUsed - satoshiAmountToSend} sats',
level: LogLevel.Info);
Logging.instance
.log('Estimated fee: $feeForOneOutput', level: LogLevel.Info);
dynamic txn = await buildTransaction(
utxosToUse: utxoObjectsToUse,
utxoSigningData: utxoSigningData,
recipients: recipientsArray,
satoshiAmounts: recipientsAmtArray,
);
Map<String, dynamic> transactionObject = {
"hex": txn["hex"],
"recipient": recipientsArray[0],
"recipientAmt": recipientsAmtArray[0],
"fee": feeForOneOutput,
"vSize": txn["vSize"],
};
return transactionObject;
} else {
// Remember that returning 2 indicates that the user does not have a sufficient balance to
// pay for the transaction fee. Ideally, at this stage, we should check if the user has any
// additional outputs they're able to spend and then recalculate fees.
Logging.instance.log(
'Cannot pay tx fee - checking for more outputs and trying again',
level: LogLevel.Warning);
// try adding more outputs
if (spendableOutputs.length > inputsBeingConsumed) {
return coinSelection(satoshiAmountToSend, selectedTxFeeRate,
_recipientAddress, isSendAll,
additionalOutputs: additionalOutputs + 1, utxos: utxos);
}
return 2;
}
}
Future<Map<String, dynamic>> fetchBuildTxData(
List<isar_models.UTXO> utxosToUse,
2022-09-26 20:32:53 +00:00
) async {
// return data
Map<String, dynamic> results = {};
Map<String, List<String>> addressTxid = {};
// addresses to check
List<String> addressesP2PKH = [];
2022-09-23 12:31:14 +00:00
List<String> addressesP2SH = [];
2022-09-26 20:32:53 +00:00
try {
// Populating the addresses to check
for (var i = 0; i < utxosToUse.length; i++) {
final txid = utxosToUse[i].txid;
final tx = await _cachedElectrumXClient.getTransaction(
txHash: txid,
coin: coin,
);
for (final output in tx["vout"] as List) {
final n = output["n"];
if (n != null && n == utxosToUse[i].vout) {
2022-10-19 20:21:48 +00:00
String address = output["scriptPubKey"]["addresses"][0] as String;
if (bitbox.Address.detectFormat(address) ==
bitbox.Address.formatCashAddr) {
if (validateCashAddr(address)) {
address = bitbox.Address.toLegacyAddress(address);
} else {
throw Exception(
"Unsupported address found during fetchBuildTxData(): $address");
}
2022-10-19 20:21:48 +00:00
}
2022-09-26 20:32:53 +00:00
if (!addressTxid.containsKey(address)) {
addressTxid[address] = <String>[];
}
(addressTxid[address] as List).add(txid);
switch (addressType(address: address)) {
case DerivePathType.bip44:
addressesP2PKH.add(address);
break;
2022-09-23 12:31:14 +00:00
case DerivePathType.bip49:
addressesP2SH.add(address);
break;
2022-09-26 20:32:53 +00:00
}
}
}
}
// p2pkh / bip44
final p2pkhLength = addressesP2PKH.length;
if (p2pkhLength > 0) {
final receiveDerivations = await _fetchDerivations(
chain: 0,
derivePathType: DerivePathType.bip44,
);
final changeDerivations = await _fetchDerivations(
chain: 1,
derivePathType: DerivePathType.bip44,
);
for (int i = 0; i < p2pkhLength; i++) {
2022-10-19 20:21:48 +00:00
String address = addressesP2PKH[i];
2022-09-26 20:32:53 +00:00
// receives
2022-10-19 20:21:48 +00:00
final receiveDerivation = receiveDerivations[address];
2022-09-26 20:32:53 +00:00
// if a match exists it will not be null
if (receiveDerivation != null) {
final data = P2PKH(
data: PaymentData(
pubkey: Format.stringToUint8List(
receiveDerivation["pubKey"] as String)),
network: _network,
).data;
2022-10-19 20:21:48 +00:00
for (String tx in addressTxid[address]!) {
2022-09-26 20:32:53 +00:00
results[tx] = {
"output": data.output,
"keyPair": ECPair.fromWIF(
receiveDerivation["wif"] as String,
network: _network,
),
};
}
} else {
// if its not a receive, check change
2022-10-19 20:21:48 +00:00
final changeDerivation = changeDerivations[address];
2022-09-26 20:32:53 +00:00
// if a match exists it will not be null
if (changeDerivation != null) {
final data = P2PKH(
data: PaymentData(
pubkey: Format.stringToUint8List(
changeDerivation["pubKey"] as String)),
network: _network,
).data;
2022-10-19 20:21:48 +00:00
for (String tx in addressTxid[address]!) {
2022-09-26 20:32:53 +00:00
results[tx] = {
"output": data.output,
"keyPair": ECPair.fromWIF(
changeDerivation["wif"] as String,
network: _network,
),
};
}
}
}
}
}
2022-09-23 12:31:14 +00:00
// p2sh / bip49
final p2shLength = addressesP2SH.length;
if (p2shLength > 0) {
final receiveDerivations = await _fetchDerivations(
chain: 0,
derivePathType: DerivePathType.bip49,
);
final changeDerivations = await _fetchDerivations(
chain: 1,
derivePathType: DerivePathType.bip49,
);
for (int i = 0; i < p2shLength; i++) {
// receives
final receiveDerivation = receiveDerivations[addressesP2SH[i]];
// if a match exists it will not be null
if (receiveDerivation != null) {
final p2wpkh = P2WPKH(
data: PaymentData(
pubkey: Format.stringToUint8List(
receiveDerivation["pubKey"] as String)),
network: _network)
.data;
final redeemScript = p2wpkh.output;
final data =
P2SH(data: PaymentData(redeem: p2wpkh), network: _network).data;
for (String tx in addressTxid[addressesP2SH[i]]!) {
results[tx] = {
"output": data.output,
"keyPair": ECPair.fromWIF(
receiveDerivation["wif"] as String,
network: _network,
),
"redeemScript": redeemScript,
};
}
} else {
// if its not a receive, check change
final changeDerivation = changeDerivations[addressesP2SH[i]];
// if a match exists it will not be null
if (changeDerivation != null) {
final p2wpkh = P2WPKH(
data: PaymentData(
pubkey: Format.stringToUint8List(
changeDerivation["pubKey"] as String)),
network: _network)
.data;
final redeemScript = p2wpkh.output;
final data =
P2SH(data: PaymentData(redeem: p2wpkh), network: _network)
.data;
for (String tx in addressTxid[addressesP2SH[i]]!) {
results[tx] = {
"output": data.output,
"keyPair": ECPair.fromWIF(
changeDerivation["wif"] as String,
network: _network,
),
"redeemScript": redeemScript,
};
}
}
}
}
}
2022-09-26 20:32:53 +00:00
return results;
} catch (e, s) {
Logging.instance
.log("fetchBuildTxData() threw: $e,\n$s", level: LogLevel.Error);
rethrow;
}
}
/// Builds and signs a transaction
Future<Map<String, dynamic>> buildTransaction({
required List<isar_models.UTXO> utxosToUse,
2022-09-26 20:32:53 +00:00
required Map<String, dynamic> utxoSigningData,
required List<String> recipients,
required List<int> satoshiAmounts,
}) async {
final builder = bitbox.Bitbox.transactionBuilder();
2022-09-26 20:32:53 +00:00
// retrieve address' utxos from the rest api
List<bitbox.Utxo> _utxos =
2022-09-26 20:32:53 +00:00
[]; // await Bitbox.Address.utxo(address) as List<Bitbox.Utxo>;
for (var element in utxosToUse) {
_utxos.add(bitbox.Utxo(
2022-09-26 20:32:53 +00:00
element.txid,
element.vout,
bitbox.BitcoinCash.fromSatoshi(element.value),
2022-09-26 20:32:53 +00:00
element.value,
0,
MINIMUM_CONFIRMATIONS + 1));
}
Logger.print("bch utxos: $_utxos");
2022-09-26 20:32:53 +00:00
// placeholder for input signatures
final List<Map<dynamic, dynamic>> signatures = [];
2022-09-26 20:32:53 +00:00
// placeholder for total input balance
// int totalBalance = 0;
2022-09-26 20:32:53 +00:00
// iterate through the list of address _utxos and use them as inputs for the
// withdrawal transaction
for (var utxo in _utxos) {
2022-09-26 20:32:53 +00:00
// add the utxo as an input for the transaction
builder.addInput(utxo.txid, utxo.vout);
final ec = utxoSigningData[utxo.txid]["keyPair"] as ECPair;
final bitboxEC = bitbox.ECPair.fromWIF(ec.toWIF());
2022-09-26 20:32:53 +00:00
// add a signature to the list to be used later
signatures.add({
"vin": signatures.length,
"key_pair": bitboxEC,
"original_amount": utxo.satoshis
});
// totalBalance += utxo.satoshis;
}
2022-09-26 20:32:53 +00:00
// calculate the fee based on number of inputs and one expected output
// final fee =
// bitbox.BitcoinCash.getByteCount(signatures.length, recipients.length);
2022-09-26 20:32:53 +00:00
// calculate how much balance will be left over to spend after the fee
// final sendAmount = totalBalance - fee;
2022-09-26 20:32:53 +00:00
// add the output based on the address provided in the testing data
for (int i = 0; i < recipients.length; i++) {
String recipient = recipients[i];
int satoshiAmount = satoshiAmounts[i];
builder.addOutput(recipient, satoshiAmount);
}
// sign all inputs
for (var signature in signatures) {
2022-09-26 20:32:53 +00:00
builder.sign(
signature["vin"] as int,
signature["key_pair"] as bitbox.ECPair,
2022-09-26 20:32:53 +00:00
signature["original_amount"] as int);
}
2022-09-26 20:32:53 +00:00
// build the transaction
final tx = builder.build();
final txHex = tx.toHex();
final vSize = tx.virtualSize();
2022-12-13 00:17:02 +00:00
//todo: check if print needed
2022-09-26 20:32:53 +00:00
Logger.print("bch raw hex: $txHex");
return {"hex": txHex, "vSize": vSize};
}
@override
Future<void> fullRescan(
int maxUnusedAddressGap,
int maxNumberOfIndexesToCheck,
) async {
Logging.instance.log("Starting full rescan!", level: LogLevel.Info);
longMutex = true;
GlobalEventBus.instance.fire(
WalletSyncStatusChangedEvent(
WalletSyncStatus.syncing,
walletId,
coin,
),
);
// clear cache
await _cachedElectrumXClient.clearSharedTransactionCache(coin: coin);
2022-09-26 20:32:53 +00:00
// clear blockchain info
2023-01-16 21:04:03 +00:00
await db.deleteWalletBlockchainData(walletId);
await _deleteDerivations();
2022-09-26 20:32:53 +00:00
try {
final mnemonic = await _secureStore.read(key: '${_walletId}_mnemonic');
await _recoverWalletFromBIP32SeedPhrase(
mnemonic: mnemonic!,
maxUnusedAddressGap: maxUnusedAddressGap,
maxNumberOfIndexesToCheck: maxNumberOfIndexesToCheck,
);
longMutex = false;
Logging.instance.log("Full rescan complete!", level: LogLevel.Info);
GlobalEventBus.instance.fire(
WalletSyncStatusChangedEvent(
WalletSyncStatus.synced,
walletId,
coin,
),
);
} catch (e, s) {
GlobalEventBus.instance.fire(
WalletSyncStatusChangedEvent(
WalletSyncStatus.unableToSync,
walletId,
coin,
),
);
longMutex = false;
Logging.instance.log("Exception rethrown from fullRescan(): $e\n$s",
level: LogLevel.Error);
rethrow;
}
}
Future<void> _deleteDerivations() async {
// P2PKH derivations
await _secureStore.delete(key: "${walletId}_receiveDerivationsP2PKH");
await _secureStore.delete(key: "${walletId}_changeDerivationsP2PKH");
// P2SH derivations
await _secureStore.delete(key: "${walletId}_receiveDerivationsP2SH");
await _secureStore.delete(key: "${walletId}_changeDerivationsP2SH");
}
2022-09-26 20:32:53 +00:00
@override
set isFavorite(bool markFavorite) {
_isFavorite = markFavorite;
updateCachedIsFavorite(markFavorite);
2022-09-26 20:32:53 +00:00
}
@override
bool get isFavorite => _isFavorite ??= getCachedIsFavorite();
bool? _isFavorite;
2022-09-26 20:32:53 +00:00
@override
bool get isRefreshing => refreshMutex;
bool isActive = false;
@override
void Function(bool)? get onIsActiveWalletChanged =>
(isActive) => this.isActive = isActive;
@override
Future<int> estimateFeeFor(int satoshiAmount, int feeRate) async {
final available = balance.spendable;
2022-09-26 20:32:53 +00:00
if (available == satoshiAmount) {
return satoshiAmount - (await sweepAllEstimate(feeRate));
2022-09-26 20:32:53 +00:00
} else if (satoshiAmount <= 0 || satoshiAmount > available) {
return roughFeeEstimate(1, 2, feeRate);
}
int runningBalance = 0;
int inputCount = 0;
for (final output in (await utxos)) {
if (!output.isBlocked) {
runningBalance += output.value;
inputCount++;
if (runningBalance > satoshiAmount) {
break;
}
2022-09-26 20:32:53 +00:00
}
}
final oneOutPutFee = roughFeeEstimate(inputCount, 1, feeRate);
final twoOutPutFee = roughFeeEstimate(inputCount, 2, feeRate);
if (runningBalance - satoshiAmount > oneOutPutFee) {
if (runningBalance - satoshiAmount > oneOutPutFee + DUST_LIMIT) {
final change = runningBalance - satoshiAmount - twoOutPutFee;
if (change > DUST_LIMIT &&
runningBalance - satoshiAmount - change == twoOutPutFee) {
return runningBalance - satoshiAmount - change;
} else {
return runningBalance - satoshiAmount;
}
} else {
return runningBalance - satoshiAmount;
}
} else if (runningBalance - satoshiAmount == oneOutPutFee) {
return oneOutPutFee;
} else {
return twoOutPutFee;
}
}
// TODO: correct formula for bch?
int roughFeeEstimate(int inputCount, int outputCount, int feeRatePerKB) {
return ((181 * inputCount) + (34 * outputCount) + 10) *
(feeRatePerKB / 1000).ceil();
}
Future<int> sweepAllEstimate(int feeRate) async {
2022-09-26 20:32:53 +00:00
int available = 0;
int inputCount = 0;
for (final output in (await utxos)) {
if (!output.isBlocked &&
output.isConfirmed(storedChainHeight, MINIMUM_CONFIRMATIONS)) {
2022-09-26 20:32:53 +00:00
available += output.value;
inputCount++;
}
}
// transaction will only have 1 output minus the fee
final estimatedFee = roughFeeEstimate(inputCount, 1, feeRate);
return available - estimatedFee;
}
@override
Future<bool> generateNewAddress() async {
try {
final currentReceiving = await _currentReceivingAddress;
final newReceivingIndex = currentReceiving.derivationIndex + 1;
// Use new index to derive a new receiving address
2022-09-26 20:32:53 +00:00
final newReceivingAddress = await _generateAddressForChain(
0, newReceivingIndex, DerivePathType.bip44);
// Add that new receiving address
2023-01-16 21:04:03 +00:00
await db.putAddress(newReceivingAddress);
2022-09-26 20:32:53 +00:00
return true;
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from generateNewAddress(): $e\n$s",
level: LogLevel.Error);
return false;
}
}
}
// Bitcoincash Network
final bitcoincash = NetworkType(
messagePrefix: '\x18Bitcoin Signed Message:\n',
bech32: 'bc',
bip32: Bip32Type(public: 0x0488b21e, private: 0x0488ade4),
pubKeyHash: 0x00,
scriptHash: 0x05,
wif: 0x80);
final bitcoincashtestnet = NetworkType(
messagePrefix: '\x18Bitcoin Signed Message:\n',
bech32: 'tb',
bip32: Bip32Type(public: 0x043587cf, private: 0x04358394),
pubKeyHash: 0x6f,
scriptHash: 0xc4,
wif: 0xef);