import 'dart:io' show Platform; import 'package:bitcoin_base/bitcoin_base.dart'; import 'package:blockchain_utils/blockchain_utils.dart'; import 'package:cw_bitcoin/bitcoin_address_record.dart'; import 'package:cw_bitcoin/bitcoin_unspent.dart'; import 'package:cw_core/wallet_addresses.dart'; import 'package:cw_core/wallet_info.dart'; import 'package:cw_core/wallet_type.dart'; import 'package:mobx/mobx.dart'; part 'electrum_wallet_addresses.g.dart'; class ElectrumWalletAddresses = ElectrumWalletAddressesBase with _$ElectrumWalletAddresses; const List BITCOIN_ADDRESS_TYPES = [ SegwitAddresType.p2wpkh, P2pkhAddressType.p2pkh, SegwitAddresType.p2tr, SegwitAddresType.p2wsh, P2shAddressType.p2wpkhInP2sh, ]; const List LITECOIN_ADDRESS_TYPES = [ SegwitAddresType.p2wpkh, SegwitAddresType.mweb, ]; const List BITCOIN_CASH_ADDRESS_TYPES = [ P2pkhAddressType.p2pkh, ]; abstract class ElectrumWalletAddressesBase extends WalletAddresses with Store { ElectrumWalletAddressesBase( WalletInfo walletInfo, { required this.mainHd, required this.sideHd, required this.network, required this.isHardwareWallet, List? initialAddresses, Map? initialRegularAddressIndex, Map? initialChangeAddressIndex, List? initialSilentAddresses, int initialSilentAddressIndex = 0, List? initialMwebAddresses, Bip32Slip10Secp256k1? masterHd, BitcoinAddressType? initialAddressPageType, }) : _addresses = ObservableList.of((initialAddresses ?? []).toSet()), addressesByReceiveType = ObservableList.of(([]).toSet()), receiveAddresses = ObservableList.of((initialAddresses ?? []) .where((addressRecord) => !addressRecord.isHidden && !addressRecord.isUsed) .toSet()), changeAddresses = ObservableList.of((initialAddresses ?? []) .where((addressRecord) => addressRecord.isHidden && !addressRecord.isUsed) .toSet()), currentReceiveAddressIndexByType = initialRegularAddressIndex ?? {}, currentChangeAddressIndexByType = initialChangeAddressIndex ?? {}, _addressPageType = initialAddressPageType ?? (walletInfo.addressPageType != null ? BitcoinAddressType.fromValue(walletInfo.addressPageType!) : SegwitAddresType.p2wpkh), silentAddresses = ObservableList.of( (initialSilentAddresses ?? []).toSet()), currentSilentAddressIndex = initialSilentAddressIndex, mwebAddresses = ObservableList.of((initialMwebAddresses ?? []).toSet()), super(walletInfo) { if (masterHd != null) { silentAddress = SilentPaymentOwner.fromPrivateKeys( b_scan: ECPrivate.fromHex(masterHd.derivePath(SCAN_PATH).privateKey.toHex()), b_spend: ECPrivate.fromHex(masterHd.derivePath(SPEND_PATH).privateKey.toHex()), network: network, ); if (silentAddresses.length == 0) { silentAddresses.add(BitcoinSilentPaymentAddressRecord( silentAddress.toString(), index: 0, isHidden: false, name: "", silentPaymentTweak: null, network: network, type: SilentPaymentsAddresType.p2sp, )); silentAddresses.add(BitcoinSilentPaymentAddressRecord( silentAddress!.toLabeledSilentPaymentAddress(0).toString(), index: 0, isHidden: true, name: "", silentPaymentTweak: BytesUtils.toHexString(silentAddress!.generateLabel(0)), network: network, type: SilentPaymentsAddresType.p2sp, )); } } updateAddressesByMatch(); } static const defaultReceiveAddressesCount = 22; static const defaultChangeAddressesCount = 17; static const gap = 20; final ObservableList _addresses; final ObservableList addressesByReceiveType; final ObservableList receiveAddresses; final ObservableList changeAddresses; // TODO: add this variable in `bitcoin_wallet_addresses` and just add a cast in cw_bitcoin to use it final ObservableList silentAddresses; // TODO: add this variable in `litecoin_wallet_addresses` and just add a cast in cw_bitcoin to use it final ObservableList mwebAddresses; final BasedUtxoNetwork network; final Bip32Slip10Secp256k1 mainHd; final Bip32Slip10Secp256k1 sideHd; final bool isHardwareWallet; @observable SilentPaymentOwner? silentAddress; @observable late BitcoinAddressType _addressPageType; @computed BitcoinAddressType get addressPageType => _addressPageType; @observable String? activeSilentAddress; @computed List get allAddresses => _addresses; @override @computed String get address { if (addressPageType == SilentPaymentsAddresType.p2sp) { if (activeSilentAddress != null) { return activeSilentAddress!; } return silentAddress.toString(); } String receiveAddress; final typeMatchingReceiveAddresses = receiveAddresses.where(_isAddressPageTypeMatch).where((addr) => !addr.isUsed); if ((isEnabledAutoGenerateSubaddress && receiveAddresses.isEmpty) || typeMatchingReceiveAddresses.isEmpty) { receiveAddress = generateNewAddress().address; } else { final previousAddressMatchesType = previousAddressRecord != null && previousAddressRecord!.type == addressPageType; if (previousAddressMatchesType && typeMatchingReceiveAddresses.first.address != addressesByReceiveType.first.address) { receiveAddress = previousAddressRecord!.address; } else { receiveAddress = typeMatchingReceiveAddresses.first.address; } } return receiveAddress; } @observable bool isEnabledAutoGenerateSubaddress = true; @override set address(String addr) { if (addr == "Silent Payments" && SilentPaymentsAddresType.p2sp != addressPageType) { return; } if (addressPageType == SilentPaymentsAddresType.p2sp) { final selected = silentAddresses.firstWhere((addressRecord) => addressRecord.address == addr); if (selected.silentPaymentTweak != null && silentAddress != null) { activeSilentAddress = silentAddress!.toLabeledSilentPaymentAddress(selected.index).toString(); } else { activeSilentAddress = silentAddress!.toString(); } return; } try { final addressRecord = _addresses.firstWhere( (addressRecord) => addressRecord.address == addr, ); previousAddressRecord = addressRecord; receiveAddresses.remove(addressRecord); receiveAddresses.insert(0, addressRecord); } catch (e) { print("ElectrumWalletAddressBase: set address ($addr): $e"); } } @override String get primaryAddress => getAddress(index: 0, hd: mainHd, addressType: addressPageType); Map currentReceiveAddressIndexByType; int get currentReceiveAddressIndex => currentReceiveAddressIndexByType[_addressPageType.toString()] ?? 0; void set currentReceiveAddressIndex(int index) => currentReceiveAddressIndexByType[_addressPageType.toString()] = index; Map currentChangeAddressIndexByType; int get currentChangeAddressIndex => currentChangeAddressIndexByType[_addressPageType.toString()] ?? 0; void set currentChangeAddressIndex(int index) => currentChangeAddressIndexByType[_addressPageType.toString()] = index; int currentSilentAddressIndex; @observable BitcoinAddressRecord? previousAddressRecord; @computed int get totalCountOfReceiveAddresses => addressesByReceiveType.fold(0, (acc, addressRecord) { if (!addressRecord.isHidden) { return acc + 1; } return acc; }); @computed int get totalCountOfChangeAddresses => addressesByReceiveType.fold(0, (acc, addressRecord) { if (addressRecord.isHidden) { return acc + 1; } return acc; }); @override Future init() async { if (walletInfo.type == WalletType.bitcoinCash) { await _generateInitialAddresses(type: P2pkhAddressType.p2pkh); } else if (walletInfo.type == WalletType.litecoin) { await _generateInitialAddresses(type: SegwitAddresType.p2wpkh); if ((Platform.isAndroid || Platform.isIOS) && !isHardwareWallet) { await _generateInitialAddresses(type: SegwitAddresType.mweb); } } else if (walletInfo.type == WalletType.bitcoin) { await _generateInitialAddresses(); if (!isHardwareWallet) { await _generateInitialAddresses(type: P2pkhAddressType.p2pkh); await _generateInitialAddresses(type: P2shAddressType.p2wpkhInP2sh); await _generateInitialAddresses(type: SegwitAddresType.p2tr); await _generateInitialAddresses(type: SegwitAddresType.p2wsh); } } updateAddressesByMatch(); updateReceiveAddresses(); updateChangeAddresses(); _validateAddresses(); await updateAddressesInBox(); if (currentReceiveAddressIndex >= receiveAddresses.length) { currentReceiveAddressIndex = 0; } if (currentChangeAddressIndex >= changeAddresses.length) { currentChangeAddressIndex = 0; } } @action Future getChangeAddress({List? inputs, List? outputs, bool isPegIn = false}) async { updateChangeAddresses(); if (changeAddresses.isEmpty) { final newAddresses = await _createNewAddresses(gap, startIndex: totalCountOfChangeAddresses > 0 ? totalCountOfChangeAddresses - 1 : 0, isHidden: true); addAddresses(newAddresses); } if (currentChangeAddressIndex >= changeAddresses.length) { currentChangeAddressIndex = 0; } updateChangeAddresses(); final address = changeAddresses[currentChangeAddressIndex]; currentChangeAddressIndex += 1; return address; } Map get labels { final G = ECPublic.fromBytes(BigintUtils.toBytes(Curves.generatorSecp256k1.x, length: 32)); final labels = {}; for (int i = 0; i < silentAddresses.length; i++) { final silentAddressRecord = silentAddresses[i]; final silentPaymentTweak = silentAddressRecord.silentPaymentTweak; if (silentPaymentTweak != null && SilentPaymentAddress.regex.hasMatch(silentAddressRecord.address)) { labels[G .tweakMul(BigintUtils.fromBytes(BytesUtils.fromHexString(silentPaymentTweak))) .toHex()] = silentPaymentTweak; } } return labels; } @action BaseBitcoinAddressRecord generateNewAddress({String label = ''}) { if (addressPageType == SilentPaymentsAddresType.p2sp && silentAddress != null) { final currentSilentAddressIndex = silentAddresses .where((addressRecord) => addressRecord.type != SegwitAddresType.p2tr) .length - 1; this.currentSilentAddressIndex = currentSilentAddressIndex; final address = BitcoinSilentPaymentAddressRecord( silentAddress!.toLabeledSilentPaymentAddress(currentSilentAddressIndex).toString(), index: currentSilentAddressIndex, isHidden: false, name: label, silentPaymentTweak: BytesUtils.toHexString(silentAddress!.generateLabel(currentSilentAddressIndex)), network: network, type: SilentPaymentsAddresType.p2sp, ); silentAddresses.add(address); Future.delayed(Duration.zero, () => updateAddressesByMatch()); return address; } final newAddressIndex = addressesByReceiveType.fold( 0, (int acc, addressRecord) => addressRecord.isHidden == false ? acc + 1 : acc); final address = BitcoinAddressRecord( getAddress(index: newAddressIndex, hd: mainHd, addressType: addressPageType), index: newAddressIndex, isHidden: false, name: label, type: addressPageType, network: network, ); _addresses.add(address); Future.delayed(Duration.zero, () => updateAddressesByMatch()); return address; } String getAddress({ required int index, required Bip32Slip10Secp256k1 hd, BitcoinAddressType? addressType, }) => ''; Future getAddressAsync({ required int index, required Bip32Slip10Secp256k1 hd, BitcoinAddressType? addressType, }) async => getAddress(index: index, hd: hd, addressType: addressType); void addBitcoinAddressTypes() { final lastP2wpkh = _addresses .where((addressRecord) => _isUnusedReceiveAddressByType(addressRecord, SegwitAddresType.p2wpkh)) .toList() .last; if (lastP2wpkh.address != address) { addressesMap[lastP2wpkh.address] = 'P2WPKH'; } else { addressesMap[address] = 'Active - P2WPKH'; } final lastP2pkh = _addresses.firstWhere( (addressRecord) => _isUnusedReceiveAddressByType(addressRecord, P2pkhAddressType.p2pkh)); if (lastP2pkh.address != address) { addressesMap[lastP2pkh.address] = 'P2PKH'; } else { addressesMap[address] = 'Active - P2PKH'; } final lastP2sh = _addresses.firstWhere((addressRecord) => _isUnusedReceiveAddressByType(addressRecord, P2shAddressType.p2wpkhInP2sh)); if (lastP2sh.address != address) { addressesMap[lastP2sh.address] = 'P2SH'; } else { addressesMap[address] = 'Active - P2SH'; } final lastP2tr = _addresses.firstWhere( (addressRecord) => _isUnusedReceiveAddressByType(addressRecord, SegwitAddresType.p2tr)); if (lastP2tr.address != address) { addressesMap[lastP2tr.address] = 'P2TR'; } else { addressesMap[address] = 'Active - P2TR'; } final lastP2wsh = _addresses.firstWhere( (addressRecord) => _isUnusedReceiveAddressByType(addressRecord, SegwitAddresType.p2wsh)); if (lastP2wsh.address != address) { addressesMap[lastP2wsh.address] = 'P2WSH'; } else { addressesMap[address] = 'Active - P2WSH'; } silentAddresses.forEach((addressRecord) { if (addressRecord.type != SilentPaymentsAddresType.p2sp || addressRecord.isHidden) { return; } if (addressRecord.address != address) { addressesMap[addressRecord.address] = addressRecord.name.isEmpty ? "Silent Payments" : "Silent Payments - " + addressRecord.name; } else { addressesMap[address] = 'Active - Silent Payments'; } }); } void addLitecoinAddressTypes() { final lastP2wpkh = _addresses .where((addressRecord) => _isUnusedReceiveAddressByType(addressRecord, SegwitAddresType.p2wpkh)) .toList() .last; if (lastP2wpkh.address != address) { addressesMap[lastP2wpkh.address] = 'P2WPKH'; } else { addressesMap[address] = 'Active - P2WPKH'; } final lastMweb = _addresses.firstWhere( (addressRecord) => _isUnusedReceiveAddressByType(addressRecord, SegwitAddresType.mweb)); if (lastMweb.address != address) { addressesMap[lastMweb.address] = 'MWEB'; } else { addressesMap[address] = 'Active - MWEB'; } } void addBitcoinCashAddressTypes() { final lastP2pkh = _addresses.firstWhere( (addressRecord) => _isUnusedReceiveAddressByType(addressRecord, P2pkhAddressType.p2pkh)); if (lastP2pkh.address != address) { addressesMap[lastP2pkh.address] = 'P2PKH'; } else { addressesMap[address] = 'Active - P2PKH'; } } @override Future updateAddressesInBox() async { try { addressesMap.clear(); addressesMap[address] = 'Active'; allAddressesMap.clear(); _addresses.forEach((addressRecord) { allAddressesMap[addressRecord.address] = addressRecord.name; }); switch (walletInfo.type) { case WalletType.bitcoin: addBitcoinAddressTypes(); break; case WalletType.litecoin: addLitecoinAddressTypes(); break; case WalletType.bitcoinCash: addBitcoinCashAddressTypes(); break; default: break; } await saveAddressesInBox(); } catch (e) { print("updateAddresses $e"); } } @action void updateAddress(String address, String label) { BaseBitcoinAddressRecord? foundAddress; _addresses.forEach((addressRecord) { if (addressRecord.address == address) { foundAddress = addressRecord; } }); silentAddresses.forEach((addressRecord) { if (addressRecord.address == address) { foundAddress = addressRecord; } }); mwebAddresses.forEach((addressRecord) { if (addressRecord.address == address) { foundAddress = addressRecord; } }); if (foundAddress != null) { foundAddress!.setNewName(label); if (foundAddress is BitcoinAddressRecord) { final index = _addresses.indexOf(foundAddress); _addresses.remove(foundAddress); _addresses.insert(index, foundAddress as BitcoinAddressRecord); } else { final index = silentAddresses.indexOf(foundAddress as BitcoinSilentPaymentAddressRecord); silentAddresses.remove(foundAddress); silentAddresses.insert(index, foundAddress as BitcoinSilentPaymentAddressRecord); } } } @action void updateAddressesByMatch() { if (addressPageType == SilentPaymentsAddresType.p2sp) { addressesByReceiveType.clear(); addressesByReceiveType.addAll(silentAddresses); return; } addressesByReceiveType.clear(); addressesByReceiveType.addAll(_addresses.where(_isAddressPageTypeMatch).toList()); } @action void updateReceiveAddresses() { receiveAddresses.removeRange(0, receiveAddresses.length); final newAddresses = _addresses.where((addressRecord) => !addressRecord.isHidden && !addressRecord.isUsed); receiveAddresses.addAll(newAddresses); } @action void updateChangeAddresses() { changeAddresses.removeRange(0, changeAddresses.length); final newAddresses = _addresses.where((addressRecord) => addressRecord.isHidden && !addressRecord.isUsed && // TODO: feature to change change address type. For now fixed to p2wpkh, the cheapest type (walletInfo.type != WalletType.bitcoin || addressRecord.type == SegwitAddresType.p2wpkh)); changeAddresses.addAll(newAddresses); } @action Future discoverAddresses(List addressList, bool isHidden, Future Function(BitcoinAddressRecord) getAddressHistory, {BitcoinAddressType type = SegwitAddresType.p2wpkh}) async { final newAddresses = await _createNewAddresses(gap, startIndex: addressList.length, isHidden: isHidden, type: type); addAddresses(newAddresses); final addressesWithHistory = await Future.wait(newAddresses.map(getAddressHistory)); final isLastAddressUsed = addressesWithHistory.last == addressList.last.address; if (isLastAddressUsed) { discoverAddresses(addressList, isHidden, getAddressHistory, type: type); } } Future _generateInitialAddresses( {BitcoinAddressType type = SegwitAddresType.p2wpkh}) async { var countOfReceiveAddresses = 0; var countOfHiddenAddresses = 0; _addresses.forEach((addr) { if (addr.type == type) { if (addr.isHidden) { countOfHiddenAddresses += 1; return; } countOfReceiveAddresses += 1; } }); if (countOfReceiveAddresses < defaultReceiveAddressesCount) { final addressesCount = defaultReceiveAddressesCount - countOfReceiveAddresses; final newAddresses = await _createNewAddresses(addressesCount, startIndex: countOfReceiveAddresses, isHidden: false, type: type); addAddresses(newAddresses); } if (countOfHiddenAddresses < defaultChangeAddressesCount) { final addressesCount = defaultChangeAddressesCount - countOfHiddenAddresses; final newAddresses = await _createNewAddresses(addressesCount, startIndex: countOfHiddenAddresses, isHidden: true, type: type); addAddresses(newAddresses); } } Future> _createNewAddresses(int count, {int startIndex = 0, bool isHidden = false, BitcoinAddressType? type}) async { final list = []; for (var i = startIndex; i < count + startIndex; i++) { final address = BitcoinAddressRecord( await getAddressAsync(index: i, hd: _getHd(isHidden), addressType: type ?? addressPageType), index: i, isHidden: isHidden, type: type ?? addressPageType, network: network, ); list.add(address); } return list; } @action void addAddresses(Iterable addresses) { final addressesSet = this._addresses.toSet(); addressesSet.addAll(addresses); this._addresses.clear(); this._addresses.addAll(addressesSet); updateAddressesByMatch(); } @action void addSilentAddresses(Iterable addresses) { final addressesSet = this.silentAddresses.toSet(); addressesSet.addAll(addresses); this.silentAddresses.clear(); this.silentAddresses.addAll(addressesSet); updateAddressesByMatch(); } @action void addMwebAddresses(Iterable addresses) { final addressesSet = this.mwebAddresses.toSet(); addressesSet.addAll(addresses); this.mwebAddresses.clear(); this.mwebAddresses.addAll(addressesSet); updateAddressesByMatch(); } void _validateAddresses() { _addresses.forEach((element) async { if (element.type == SegwitAddresType.mweb) { // this would add a ton of startup lag for mweb addresses since we have 1000 of them return; } if (!element.isHidden && element.address != await getAddressAsync(index: element.index, hd: mainHd, addressType: element.type)) { element.isHidden = true; } else if (element.isHidden && element.address != await getAddressAsync(index: element.index, hd: sideHd, addressType: element.type)) { element.isHidden = false; } }); } @action Future setAddressType(BitcoinAddressType type) async { _addressPageType = type; updateAddressesByMatch(); walletInfo.addressPageType = addressPageType.toString(); await walletInfo.save(); } bool _isAddressPageTypeMatch(BitcoinAddressRecord addressRecord) { return _isAddressByType(addressRecord, addressPageType); } Bip32Slip10Secp256k1 _getHd(bool isHidden) => isHidden ? sideHd : mainHd; bool _isAddressByType(BitcoinAddressRecord addr, BitcoinAddressType type) => addr.type == type; bool _isUnusedReceiveAddressByType(BitcoinAddressRecord addr, BitcoinAddressType type) => !addr.isHidden && !addr.isUsed && addr.type == type; @action void deleteSilentPaymentAddress(String address) { final addressRecord = silentAddresses.firstWhere((addressRecord) => addressRecord.type == SilentPaymentsAddresType.p2sp && addressRecord.address == address); silentAddresses.remove(addressRecord); updateAddressesByMatch(); } }