Ecosystem/stack_wallet
1
0
Fork 0
mirror of https://github.com/cypherstack/stack_wallet.git synced 2025-04-04 13:27:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WIP doge wallet scaffolding and some reworking of the way utxos are fetched and parsed via electrumx

Browse source
This commit is contained in:
julian 2023-11-06 17:10:07 -06:00
parent f7673913fb
commit 12a8b6aea8
4 changed files with 275 additions and 151 deletions

96
lib/wallets/wallet/impl/bitcoin_wallet.dart
View file

@ -1,9 +1,8 @@
import 'package:isar/isar.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/address.dart';
import 'package:stackwallet/services/event_bus/events/global/updated_in_background_event.dart';
import 'package:stackwallet/services/event_bus/global_event_bus.dart';
import 'package:stackwallet/utilities/amount/amount.dart';
import 'package:stackwallet/utilities/enums/coin_enum.dart';
import 'package:stackwallet/utilities/extensions/extensions.dart';
import 'package:stackwallet/wallets/crypto_currency/coins/bitcoin.dart';
import 'package:stackwallet/wallets/wallet/intermediate/bip39_hd_wallet.dart';
import 'package:stackwallet/wallets/wallet/mixins/electrumx_mixin.dart';
@ -17,7 +16,8 @@ class BitcoinWallet extends Bip39HDWallet with ElectrumXMixin {
// ===========================================================================
Future<List<Address>> _fetchAllOwnAddresses() async {
@override
Future<List<Address>> fetchAllOwnAddresses() async {
final allAddresses = await mainDB
.getAddresses(walletId)
.filter()
@ -34,69 +34,59 @@ class BitcoinWallet extends Bip39HDWallet with ElectrumXMixin {
// ===========================================================================
@override
Future<void> refresh() {
// TODO: implement refresh
throw UnimplementedError();
}
@override
Future<void> updateTransactions() async {
final currentChainHeight = await fetchChainHeight();
// TODO: [prio=med] switch to V2 transactions
final data = await fetchTransactionsV1(
addresses: await _fetchAllOwnAddresses(),
addresses: await fetchAllOwnAddresses(),
currentChainHeight: currentChainHeight,
);
await mainDB.addNewTransactionData(
data
.map(
(e) => Tuple2(
e.transaction,
e.address,
),
)
.map((e) => Tuple2(
e.transaction,
e.address,
))
.toList(),
walletId,
);
}
// TODO: [prio=med] get rid of this and watch isar instead
// quick hack to notify manager to call notifyListeners if
// transactions changed
if (data.isNotEmpty) {
GlobalEventBus.instance.fire(
UpdatedInBackgroundEvent(
"Transactions updated/added for: $walletId ${info.name}",
walletId,
),
);
@override
({String? blockedReason, bool blocked}) checkBlockUTXO(
Map<String, dynamic> jsonUTXO,
String? scriptPubKeyHex,
Map<String, dynamic>? jsonTX,
) {
bool blocked = false;
String? blockedReason;
if (jsonTX != null) {
// check for bip47 notification
final outputs = jsonTX["vout"] as List;
for (final output in outputs) {
List<String>? scriptChunks =
(output['scriptPubKey']?['asm'] as String?)?.split(" ");
if (scriptChunks?.length == 2 && scriptChunks?[0] == "OP_RETURN") {
final blindedPaymentCode = scriptChunks![1];
final bytes = blindedPaymentCode.toUint8ListFromHex;
// https://en.bitcoin.it/wiki/BIP_0047#Sending
if (bytes.length == 80 && bytes.first == 1) {
blocked = true;
blockedReason = "Paynym notification output. Incautious "
"handling of outputs from notification transactions "
"may cause unintended loss of privacy.";
break;
}
}
}
}
}
@override
Future<void> updateUTXOs() {
// TODO: implement updateUTXOs
throw UnimplementedError();
}
@override
Future<bool> pingCheck() async {
try {
final result = await electrumX.ping();
return result;
} catch (_) {
return false;
}
}
@override
Future<void> updateChainHeight() async {
final height = await fetchChainHeight();
await info.updateCachedChainHeight(
newHeight: height,
isar: mainDB.isar,
);
return (blockedReason: blockedReason, blocked: blocked);
}
@override
@ -108,10 +98,4 @@ class BitcoinWallet extends Bip39HDWallet with ElectrumXMixin {
fractionDigits: info.coin.decimals,
);
}
@override
Future<void> checkReceivingAddressForTransactions() {
// TODO: implement checkReceivingAddressForTransactions
throw UnimplementedError();
}
}

93
lib/wallets/wallet/impl/bitcoincash_wallet.dart
View file

@ -2,7 +2,6 @@ import 'package:bitbox/bitbox.dart' as bitbox;
import 'package:isar/isar.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/address.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/transaction.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/utxo.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/v2/input_v2.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/v2/output_v2.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/v2/transaction_v2.dart';
@ -26,7 +25,8 @@ class BitcoincashWallet extends Bip39HDWallet with ElectrumXMixin {
// ===========================================================================
Future<List<Address>> _fetchAllOwnAddresses() async {
@override
Future<List<Address>> fetchAllOwnAddresses() async {
final allAddresses = await mainDB
.getAddresses(walletId)
.filter()
@ -45,7 +45,7 @@ class BitcoincashWallet extends Bip39HDWallet with ElectrumXMixin {
@override
Future<void> updateTransactions() async {
List<Address> allAddressesOld = await _fetchAllOwnAddresses();
List<Address> allAddressesOld = await fetchAllOwnAddresses();
Set<String> receivingAddresses = allAddressesOld
.where((e) => e.subType == AddressSubType.receiving)
@ -270,8 +270,12 @@ class BitcoincashWallet extends Bip39HDWallet with ElectrumXMixin {
await mainDB.updateOrPutTransactionV2s(txns);
}
({String? blockedReason, bool blocked}) checkBlock(
Map<String, dynamic> jsonUTXO, String? scriptPubKeyHex) {
@override
({String? blockedReason, bool blocked}) checkBlockUTXO(
Map<String, dynamic> jsonUTXO,
String? scriptPubKeyHex,
Map<String, dynamic> jsonTX,
) {
bool blocked = false;
String? blockedReason;
@ -304,79 +308,6 @@ class BitcoincashWallet extends Bip39HDWallet with ElectrumXMixin {
return (blockedReason: blockedReason, blocked: blocked);
}
@override
Future<void> updateUTXOs() async {
final allAddresses = await _fetchAllOwnAddresses();
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 = cryptoCurrency.addressToScriptHash(
address: allAddresses[i].value,
);
batches[batchNumber]!.addAll({
scriptHash: [scriptHash]
});
if (i % batchSizeMax == batchSizeMax - 1) {
batchNumber++;
}
}
for (int i = 0; i < batches.length; i++) {
final response = await electrumX.getBatchUTXOs(args: batches[i]!);
for (final entry in response.entries) {
if (entry.value.isNotEmpty) {
fetchedUtxoList.add(entry.value);
}
}
}
final List<UTXO> outputArray = [];
for (int i = 0; i < fetchedUtxoList.length; i++) {
for (int j = 0; j < fetchedUtxoList[i].length; j++) {
final utxo = await parseUTXO(jsonUTXO: fetchedUtxoList[i][j]);
outputArray.add(utxo);
}
}
await mainDB.updateUTXOs(walletId, outputArray);
} catch (e, s) {
Logging.instance.log(
"Output fetch unsuccessful: $e\n$s",
level: LogLevel.Error,
);
}
}
@override
Future<bool> pingCheck() async {
try {
final result = await electrumX.ping();
return result;
} catch (_) {
return false;
}
}
@override
Future<void> updateChainHeight() async {
final height = await fetchChainHeight();
await info.updateCachedChainHeight(
newHeight: height,
isar: mainDB.isar,
);
}
// TODO: correct formula for bch?
@override
Amount roughFeeEstimate(int inputCount, int outputCount, int feeRatePerKB) {
@ -386,10 +317,4 @@ class BitcoincashWallet extends Bip39HDWallet with ElectrumXMixin {
fractionDigits: info.coin.decimals,
);
}
@override
Future<void> checkReceivingAddressForTransactions() {
// TODO: implement checkReceivingAddressForTransactions
throw UnimplementedError();
}
}

95
lib/wallets/wallet/impl/dogecoin_wallet.dart Normal file
View file

@ -0,0 +1,95 @@
import 'package:isar/isar.dart';
import 'package:stackwallet/models/isar/models/blockchain_data/address.dart';
import 'package:stackwallet/utilities/amount/amount.dart';
import 'package:stackwallet/utilities/extensions/extensions.dart';
import 'package:stackwallet/wallets/crypto_currency/coins/dogecoin.dart';
import 'package:stackwallet/wallets/crypto_currency/crypto_currency.dart';
import 'package:stackwallet/wallets/wallet/intermediate/bip39_hd_wallet.dart';
import 'package:stackwallet/wallets/wallet/mixins/electrumx_mixin.dart';
import 'package:tuple/tuple.dart';
class DogecoinWallet extends Bip39HDWallet with ElectrumXMixin {
DogecoinWallet(CryptoCurrencyNetwork network) : super(Dogecoin(network));
// ===========================================================================
@override
Future<List<Address>> fetchAllOwnAddresses() async {
final allAddresses = await mainDB
.getAddresses(walletId)
.filter()
.not()
.group(
(q) => q
.typeEqualTo(AddressType.nonWallet)
.or()
.subTypeEqualTo(AddressSubType.nonWallet),
)
.findAll();
return allAddresses;
}
// ===========================================================================
@override
Future<void> updateTransactions() async {
final currentChainHeight = await fetchChainHeight();
// TODO: [prio=med] switch to V2 transactions
final data = await fetchTransactionsV1(
addresses: await fetchAllOwnAddresses(),
currentChainHeight: currentChainHeight,
);
await mainDB.addNewTransactionData(
data
.map((e) => Tuple2(
e.transaction,
e.address,
))
.toList(),
walletId,
);
}
@override
({String? blockedReason, bool blocked}) checkBlockUTXO(
Map<String, dynamic> jsonUTXO,
String? scriptPubKeyHex,
Map<String, dynamic> jsonTX,
) {
bool blocked = false;
String? blockedReason;
// check for bip47 notification
final outputs = jsonTX["vout"] as List;
for (final output in outputs) {
List<String>? scriptChunks =
(output['scriptPubKey']?['asm'] as String?)?.split(" ");
if (scriptChunks?.length == 2 && scriptChunks?[0] == "OP_RETURN") {
final blindedPaymentCode = scriptChunks![1];
final bytes = blindedPaymentCode.toUint8ListFromHex;
// https://en.bitcoin.it/wiki/BIP_0047#Sending
if (bytes.length == 80 && bytes.first == 1) {
blocked = true;
blockedReason = "Paynym notification output. Incautious "
"handling of outputs from notification transactions "
"may cause unintended loss of privacy.";
break;
}
}
}
return (blockedReason: blockedReason, blocked: blocked);
}
@override
Amount roughFeeEstimate(int inputCount, int outputCount, int feeRatePerKB) {
return Amount(
rawValue: BigInt.from(((181 * inputCount) + (34 * outputCount) + 10) *
(feeRatePerKB / 1000).ceil()),
fractionDigits: cryptoCurrency.fractionDigits,
);
}
}

142
lib/wallets/wallet/mixins/electrumx_mixin.dart
View file

@ -27,6 +27,12 @@ mixin ElectrumXMixin on Bip39HDWallet {
}
}
Future<int> fetchTxCount({required String addressScriptHash}) async {
final transactions =
await electrumX.getHistory(scripthash: addressScriptHash);
return transactions.length;
}
Future<List<({Transaction transaction, Address address})>>
fetchTransactionsV1({
required List<Address> addresses,
@ -159,16 +165,10 @@ mixin ElectrumXMixin on Bip39HDWallet {
}
}
/// The optional (nullable) param [checkBlock] is a callback that can be used
/// to check if a utxo should be marked as blocked
Future<UTXO> parseUTXO({
required Map<String, dynamic> jsonUTXO,
({
String? blockedReason,
bool blocked,
})
Function(
Map<String, dynamic>,
String? scriptPubKeyHex,
)? checkBlock,
}) async {
final txn = await electrumXCached.getTransaction(
txHash: jsonUTXO["tx_hash"] as String,
@ -192,7 +192,7 @@ mixin ElectrumXMixin on Bip39HDWallet {
}
}
final checkBlockResult = checkBlock?.call(jsonUTXO, scriptPubKey);
final checkBlockResult = checkBlockUTXO(jsonUTXO, scriptPubKey, txn);
final utxo = UTXO(
walletId: walletId,
@ -200,8 +200,8 @@ mixin ElectrumXMixin on Bip39HDWallet {
vout: vout,
value: jsonUTXO["value"] as int,
name: "",
isBlocked: checkBlockResult?.blocked ?? false,
blockedReason: checkBlockResult?.blockedReason,
isBlocked: checkBlockResult.blocked,
blockedReason: checkBlockResult.blockedReason,
isCoinbase: txn["is_coinbase"] as bool? ?? false,
blockHash: txn["blockhash"] as String?,
blockHeight: jsonUTXO["height"] as int?,
@ -465,6 +465,25 @@ mixin ElectrumXMixin on Bip39HDWallet {
//============================================================================
@override
Future<void> updateChainHeight() async {
final height = await fetchChainHeight();
await info.updateCachedChainHeight(
newHeight: height,
isar: mainDB.isar,
);
}
@override
Future<bool> pingCheck() async {
try {
final result = await electrumX.ping();
return result;
} catch (_) {
return false;
}
}
@override
Future<void> updateNode() async {
final node = await getCurrentElectrumXNode();
@ -567,11 +586,112 @@ mixin ElectrumXMixin on Bip39HDWallet {
}
}
@override
Future<void> checkReceivingAddressForTransactions() async {
try {
final currentReceiving = await getCurrentReceivingAddress();
final bool needsGenerate;
if (currentReceiving == null) {
// no addresses in db yet for some reason.
// Should not happen at this point...
needsGenerate = true;
} else {
final txCount = await fetchTxCount(
addressScriptHash: currentReceiving.value,
);
needsGenerate = txCount > 0 || currentReceiving.derivationIndex < 0;
}
if (needsGenerate) {
await generateNewReceivingAddress();
// TODO: get rid of this? Could cause problems (long loading/infinite loop or something)
// keep checking until address with no tx history is set as current
await checkReceivingAddressForTransactions();
}
} catch (e, s) {
Logging.instance.log(
"Exception rethrown from _checkReceivingAddressForTransactions"
"($cryptoCurrency): $e\n$s",
level: LogLevel.Error,
);
rethrow;
}
}
@override
Future<void> updateUTXOs() async {
final allAddresses = await fetchAllOwnAddresses();
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 = cryptoCurrency.addressToScriptHash(
address: allAddresses[i].value,
);
batches[batchNumber]!.addAll({
scriptHash: [scriptHash]
});
if (i % batchSizeMax == batchSizeMax - 1) {
batchNumber++;
}
}
for (int i = 0; i < batches.length; i++) {
final response = await electrumX.getBatchUTXOs(args: batches[i]!);
for (final entry in response.entries) {
if (entry.value.isNotEmpty) {
fetchedUtxoList.add(entry.value);
}
}
}
final List<UTXO> outputArray = [];
for (int i = 0; i < fetchedUtxoList.length; i++) {
for (int j = 0; j < fetchedUtxoList[i].length; j++) {
final utxo = await parseUTXO(
jsonUTXO: fetchedUtxoList[i][j],
);
outputArray.add(utxo);
}
}
await mainDB.updateUTXOs(walletId, outputArray);
} catch (e, s) {
Logging.instance.log(
"Output fetch unsuccessful: $e\n$s",
level: LogLevel.Error,
);
}
}
// ===========================================================================
// ========== Interface functions ============================================
Amount roughFeeEstimate(int inputCount, int outputCount, int feeRatePerKB);
Future<List<Address>> fetchAllOwnAddresses();
/// callback to pass to [parseUTXO] to check if the utxo should be marked
/// as blocked as well as give a reason.
({String? blockedReason, bool blocked}) checkBlockUTXO(
Map<String, dynamic> jsonUTXO,
String? scriptPubKeyHex,
Map<String, dynamic> jsonTX,
);
// ===========================================================================
// ========== private helpers ================================================