mirror of
https://github.com/cypherstack/stack_wallet.git
synced 2024-12-24 12:29:37 +00:00
569 lines
19 KiB
Dart
569 lines
19 KiB
Dart
import 'dart:convert';
|
|
import 'dart:typed_data';
|
|
|
|
import 'package:bip32/bip32.dart' as bip32;
|
|
import 'package:bip47/bip47.dart';
|
|
import 'package:bip47/src/util.dart';
|
|
import 'package:bitcoindart/bitcoindart.dart' as btc_dart;
|
|
import 'package:bitcoindart/src/utils/constants/op.dart' as op;
|
|
import 'package:bitcoindart/src/utils/script.dart' as bscript;
|
|
import 'package:isar/isar.dart';
|
|
import 'package:pointycastle/digests/sha256.dart';
|
|
import 'package:stackwallet/db/main_db.dart';
|
|
import 'package:stackwallet/electrumx_rpc/cached_electrumx.dart';
|
|
import 'package:stackwallet/electrumx_rpc/electrumx.dart';
|
|
import 'package:stackwallet/exceptions/wallet/insufficient_balance_exception.dart';
|
|
import 'package:stackwallet/models/isar/models/isar_models.dart';
|
|
import 'package:stackwallet/utilities/address_utils.dart';
|
|
import 'package:stackwallet/utilities/bip32_utils.dart';
|
|
import 'package:stackwallet/utilities/enums/coin_enum.dart';
|
|
import 'package:stackwallet/utilities/format.dart';
|
|
import 'package:stackwallet/utilities/logger.dart';
|
|
import 'package:tuple/tuple.dart';
|
|
import 'package:stackwallet/exceptions/wallet/paynym_send_exception.dart';
|
|
|
|
mixin PaynymSupport {
|
|
late final btc_dart.NetworkType network;
|
|
late final MainDB db;
|
|
late final Coin coin;
|
|
late final String walletId;
|
|
void initPaynymSupport({
|
|
required btc_dart.NetworkType network,
|
|
required MainDB db,
|
|
required Coin coin,
|
|
required String walletId,
|
|
}) {
|
|
this.network = network;
|
|
this.db = db;
|
|
this.coin = coin;
|
|
this.walletId = walletId;
|
|
}
|
|
|
|
// generate bip32 payment code root
|
|
Future<bip32.BIP32> getRootNode({required List<String> mnemonic}) async {
|
|
final root = await Bip32Utils.getBip32Root(mnemonic.join(" "), network);
|
|
return root;
|
|
}
|
|
|
|
// fetch or generate this wallet's bip47 payment code
|
|
Future<PaymentCode> getPaymentCode({
|
|
required List<String> mnemonic,
|
|
}) async {
|
|
// TODO: cache elsewhere
|
|
// final paymentCodeString = DB.instance
|
|
// .get<dynamic>(boxName: walletId, key: "paymentCodeString") as String?;
|
|
PaymentCode paymentCode;
|
|
// if (paymentCodeString == null) {
|
|
final root = await getRootNode(mnemonic: mnemonic);
|
|
final node = root.derivePath("m/47'/0'/0'");
|
|
paymentCode =
|
|
PaymentCode.initFromPubKey(node.publicKey, node.chainCode, network);
|
|
// await DB.instance.put<dynamic>(
|
|
// boxName: walletId,
|
|
// key: "paymentCodeString",
|
|
// value: paymentCode.toString());
|
|
// } else {
|
|
// paymentCode = PaymentCode.fromPaymentCode(paymentCodeString, network);
|
|
// }
|
|
return paymentCode;
|
|
}
|
|
|
|
Future<Uint8List> signWithNotificationKey({
|
|
required Uint8List data,
|
|
required List<String> mnemonic,
|
|
}) async {
|
|
final root = await getRootNode(
|
|
mnemonic: mnemonic,
|
|
);
|
|
final node = root.derivePath("m/47'/0'/0'");
|
|
final pair = btc_dart.ECPair.fromPrivateKey(node.privateKey!, network: network);
|
|
final signed = pair.sign(SHA256Digest().process(data));
|
|
return signed;
|
|
}
|
|
|
|
Future<String> signStringWithNotificationKey({
|
|
required String data,
|
|
required List<String> mnemonic,
|
|
}) async {
|
|
final bytes = await signWithNotificationKey(
|
|
data: Uint8List.fromList(utf8.encode(data)),
|
|
mnemonic: mnemonic,
|
|
);
|
|
return Format.uint8listToString(bytes);
|
|
// final bytes =
|
|
// await signWithNotificationKey(Uint8List.fromList(utf8.encode(data)));
|
|
// return Format.uint8listToString(bytes);
|
|
}
|
|
|
|
/// Update cached lists of notification transaction IDs.
|
|
/// Returns true if there are new notification transactions found since last
|
|
/// checked.
|
|
Future<bool> checkForNotificationTransactions({
|
|
required Coin coin,
|
|
required PaymentCode paymentCode,
|
|
required ElectrumX electrumXClient,
|
|
required CachedElectrumX cachedElectrumXClient,
|
|
required int currentChainHeight,
|
|
}) async {
|
|
final notificationAddress = paymentCode.notificationAddress();
|
|
|
|
final receivedNotificationTransactions = await db
|
|
.getTransactions(walletId)
|
|
.filter()
|
|
.address((q) => q.valueEqualTo(notificationAddress))
|
|
.findAll();
|
|
|
|
|
|
final unconfirmedTransactions = receivedNotificationTransactions.where(
|
|
(e) => !e.isConfirmed(
|
|
currentChainHeight,
|
|
coin.requiredConfirmations,
|
|
),
|
|
);
|
|
|
|
final totalStoredCount = receivedNotificationTransactions.length;
|
|
final storedUnconfirmedCount = unconfirmedTransactions.length;
|
|
|
|
// for (final txid in transactionIds) {
|
|
// final tx = await cachedElectrumXClient.getTransaction(
|
|
// txHash: txid,
|
|
// coin: coin,
|
|
// );
|
|
//
|
|
// // check if tx is confirmed
|
|
// if ((tx["confirmations"] as int? ?? 0) > coin.requiredConfirmations) {
|
|
// // remove it from unconfirmed set
|
|
// unconfirmedNotificationTransactionIds.remove(txid);
|
|
//
|
|
// // add it to confirmed set
|
|
// confirmedNotificationTransactionIds.add(txid);
|
|
// } else {
|
|
// // otherwise add it to the unconfirmed set
|
|
// unconfirmedNotificationTransactionIds.add(txid);
|
|
// }
|
|
// }
|
|
//
|
|
// final newTotalCount = confirmedNotificationTransactionIds.length +
|
|
// unconfirmedNotificationTransactionIds.length;
|
|
//
|
|
// return newTotalCount > totalCount;
|
|
return false;
|
|
}
|
|
|
|
// bool hasConnected(String paymentCodeString) {
|
|
// return getPaynymNotificationTxInfo()
|
|
// .values
|
|
// .where((e) => e["paymentCodeString"] == paymentCodeString)
|
|
// .isNotEmpty;
|
|
// }
|
|
//
|
|
// bool hasConnectedConfirmed(String paymentCodeString) {
|
|
// return getPaynymNotificationTxInfo()
|
|
// .values
|
|
// .where((e) =>
|
|
// e["paymentCodeString"] == paymentCodeString &&
|
|
// e["confirmed"] == true)
|
|
// .isNotEmpty;
|
|
// }
|
|
//
|
|
// // fetch paynym notification tx meta data
|
|
// Map<String, dynamic> getPaynymNotificationTxInfo() {
|
|
// final map = DB.instance.get<dynamic>(
|
|
// boxName: walletId, key: "paynymNotificationTxInfo") as Map? ??
|
|
// {};
|
|
//
|
|
// return Map<String, dynamic>.from(map);
|
|
// }
|
|
|
|
// // add/update paynym notification tx meta data entry
|
|
// Future<void> updatePaynymNotificationInfo({
|
|
// required String txid,
|
|
// required bool confirmed,
|
|
// required String paymentCodeString,
|
|
// }) async {
|
|
// final data = getPaynymNotificationTxInfo();
|
|
// data[txid] = {
|
|
// "txid": txid,
|
|
// "confirmed": confirmed,
|
|
// "paymentCodeString": paymentCodeString,
|
|
// };
|
|
// await DB.instance.put<dynamic>(
|
|
// boxName: walletId,
|
|
// key: "paynymNotificationTxInfo",
|
|
// value: data,
|
|
// );
|
|
// }
|
|
|
|
Future<Transaction?> hasSentNotificationTx(PaymentCode pCode) async {
|
|
final tx = await db
|
|
.getTransactions(walletId)
|
|
.filter()
|
|
.address((q) => q.valueEqualTo(pCode.notificationAddress())).countSync()
|
|
.findFirst();
|
|
return tx;
|
|
}
|
|
|
|
void preparePaymentCodeSend(PaymentCode pCode) async {
|
|
final notifTx = await hasSentNotificationTx(pCode);
|
|
final currentHeight = await chainHeight;
|
|
|
|
if (notifTx == null) {
|
|
throw PaynymSendException("No notification transaction sent to $pCode");
|
|
} else if (!notifTx.isConfirmed(currentHeight, MINIMUM_CONFIRMATIONS)) {
|
|
throw PaynymSendException(
|
|
"Notification transaction sent to $pCode has not confirmed yet");
|
|
} else {
|
|
final node = getBip32Root((await mnemonic).join(" "), network)
|
|
.derivePath("m/47'/0'/0'");
|
|
final sendToAddress = await nextUnusedSendAddressFrom(
|
|
pCode,
|
|
node.derive(0).privateKey!,
|
|
);
|
|
|
|
// todo: Actual transaction build
|
|
}
|
|
}
|
|
|
|
/// get the next unused address to send to given the receiver's payment code
|
|
/// and your own private key
|
|
Future<String> nextUnusedSendAddressFrom(
|
|
PaymentCode pCode,
|
|
Uint8List privateKey,
|
|
) async {
|
|
// https://en.bitcoin.it/wiki/BIP_0047#Path_levels
|
|
const maxCount = 2147483647;
|
|
|
|
final paymentAddress = PaymentAddress.initWithPrivateKey(
|
|
privateKey,
|
|
pCode,
|
|
0, // initial index to check
|
|
);
|
|
|
|
for ( ;
|
|
paymentAddress.index <= maxCount;
|
|
paymentAddress.index++) {
|
|
final address = paymentAddress.getSendAddress();
|
|
|
|
final transactionIds = await electrumXClient.getHistory(
|
|
scripthash: AddressUtils.convertToScriptHash(
|
|
address,
|
|
network,
|
|
),
|
|
);
|
|
|
|
if (transactionIds.isEmpty) {
|
|
return address;
|
|
}
|
|
}
|
|
|
|
throw PaynymSendException("Exhausted unused send addresses!");
|
|
}
|
|
|
|
/// get your receiving addresses given the sender's payment code and your own
|
|
/// private key
|
|
List<String> deriveReceivingAddressesFor(
|
|
PaymentCode pCode,
|
|
Uint8List privateKey,
|
|
int count,
|
|
) {
|
|
// https://en.bitcoin.it/wiki/BIP_0047#Path_levels
|
|
const maxCount = 2147483647;
|
|
assert(count <= maxCount);
|
|
|
|
final paymentAddress = PaymentAddress.initWithPrivateKey(
|
|
privateKey,
|
|
pCode,
|
|
0, // initial index
|
|
);
|
|
|
|
final List<String> result = [];
|
|
for (paymentAddress.index = 0;
|
|
paymentAddress.index < count;
|
|
paymentAddress.index++) {
|
|
final address = paymentAddress.getReceiveAddress();
|
|
|
|
result.add(address);
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
Future<Map<String, dynamic>> buildNotificationTx({
|
|
required int selectedTxFeeRate,
|
|
required String targetPaymentCodeString,
|
|
required PaymentCode myPaymentCode,
|
|
int additionalOutputs = 0,
|
|
required List<UTXO> utxos,
|
|
required int dustLimit,
|
|
required int chainHeight,
|
|
required Future<Map<String, dynamic>> Function(
|
|
List< UTXO>
|
|
) fetchBuildTxData,
|
|
}) async {
|
|
final amountToSend = dustLimit;
|
|
final List<UTXO> availableOutputs = utxos ;
|
|
final List<UTXO> spendableOutputs = [];
|
|
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( chainHeight, coin.requiredConfirmations) ==
|
|
true) {
|
|
spendableOutputs.add(availableOutputs[i]);
|
|
spendableSatoshiValue += availableOutputs[i].value;
|
|
}
|
|
}
|
|
|
|
if (spendableSatoshiValue < amountToSend) {
|
|
// insufficient balance
|
|
throw InsufficientBalanceException(
|
|
"Spendable balance is less than the minimum required for a notification transaction.");
|
|
} else if (spendableSatoshiValue == amountToSend) {
|
|
// insufficient balance due to missing amount to cover fee
|
|
throw InsufficientBalanceException(
|
|
"Remaining balance does not cover the network fee.");
|
|
}
|
|
|
|
// sort spendable by age (oldest first)
|
|
spendableOutputs.sort((a, b) => b.blockTime!.compareTo(a.blockTime!));
|
|
|
|
int satoshisBeingUsed = 0;
|
|
int outputsBeingUsed = 0;
|
|
List<UTXO> utxoObjectsToUse = [];
|
|
|
|
for (int i = 0;
|
|
satoshisBeingUsed < amountToSend && i < spendableOutputs.length;
|
|
i++) {
|
|
utxoObjectsToUse.add(spendableOutputs[i]);
|
|
satoshisBeingUsed += spendableOutputs[i].value;
|
|
outputsBeingUsed += 1;
|
|
}
|
|
|
|
// add additional outputs if required
|
|
for (int i = 0;
|
|
i < additionalOutputs && outputsBeingUsed < spendableOutputs.length;
|
|
i++) {
|
|
utxoObjectsToUse.add(spendableOutputs[outputsBeingUsed]);
|
|
satoshisBeingUsed += spendableOutputs[outputsBeingUsed].value;
|
|
outputsBeingUsed += 1;
|
|
}
|
|
|
|
// gather required signing data
|
|
final utxoSigningData = await fetchBuildTxData(utxoObjectsToUse);
|
|
|
|
final int vSizeForNoChange = (await _createNotificationTx(
|
|
targetPaymentCodeString: targetPaymentCodeString,
|
|
utxosToUse: utxoObjectsToUse,
|
|
utxoSigningData: utxoSigningData,
|
|
change: 0, myPaymentCode: myPaymentCode, dustLimit: dustLimit, changeAddress: ))
|
|
.item2;
|
|
|
|
final int vSizeForWithChange = (await _createNotificationTx(
|
|
targetPaymentCodeString: targetPaymentCodeString,
|
|
utxosToUse: utxoObjectsToUse,
|
|
utxoSigningData: utxoSigningData,
|
|
change: satoshisBeingUsed - amountToSend, myPaymentCode: myPaymentCode, dustLimit: dustLimit, changeAddress: ch,))
|
|
.item2;
|
|
|
|
// Assume 2 outputs, for recipient and payment code script
|
|
int feeForNoChange = estimateTxFee(
|
|
vSize: vSizeForNoChange,
|
|
feeRatePerKB: selectedTxFeeRate,
|
|
);
|
|
|
|
// Assume 3 outputs, for recipient, payment code script, and change
|
|
int feeForWithChange = estimateTxFee(
|
|
vSize: vSizeForWithChange,
|
|
feeRatePerKB: selectedTxFeeRate,
|
|
);
|
|
|
|
if (feeForNoChange < vSizeForNoChange * 1000) {
|
|
feeForNoChange = vSizeForNoChange * 1000;
|
|
}
|
|
if (feeForWithChange < vSizeForWithChange * 1000) {
|
|
feeForWithChange = vSizeForWithChange * 1000;
|
|
}
|
|
|
|
if (satoshisBeingUsed - amountToSend > feeForNoChange + dustLimit) {
|
|
// try to add change output due to "left over" amount being greater than
|
|
// the estimated fee + the dust limit
|
|
int changeAmount = satoshisBeingUsed - amountToSend - feeForWithChange;
|
|
|
|
// check estimates are correct and build notification tx
|
|
if (changeAmount >= dustLimit &&
|
|
satoshisBeingUsed - amountToSend - changeAmount == feeForWithChange) {
|
|
final txn = await _createNotificationTx(
|
|
targetPaymentCodeString: targetPaymentCodeString,
|
|
utxosToUse: utxoObjectsToUse,
|
|
utxoSigningData: utxoSigningData,
|
|
change: changeAmount,
|
|
);
|
|
|
|
int feeBeingPaid = satoshisBeingUsed - amountToSend - changeAmount;
|
|
|
|
Map<String, dynamic> transactionObject = {
|
|
"hex": txn.item1,
|
|
"recipientPaynym": targetPaymentCodeString,
|
|
"amount": amountToSend,
|
|
"fee": feeBeingPaid,
|
|
"vSize": txn.item2,
|
|
};
|
|
return transactionObject;
|
|
} else {
|
|
// something broke during fee estimation or the change amount is smaller
|
|
// than the dust limit. Try without change
|
|
final txn = await _createNotificationTx(
|
|
targetPaymentCodeString: targetPaymentCodeString,
|
|
utxosToUse: utxoObjectsToUse,
|
|
utxoSigningData: utxoSigningData,
|
|
change: 0,
|
|
);
|
|
|
|
int feeBeingPaid = satoshisBeingUsed - amountToSend;
|
|
|
|
Map<String, dynamic> transactionObject = {
|
|
"hex": txn.item1,
|
|
"recipientPaynym": targetPaymentCodeString,
|
|
"amount": amountToSend,
|
|
"fee": feeBeingPaid,
|
|
"vSize": txn.item2,
|
|
};
|
|
return transactionObject;
|
|
}
|
|
} else if (satoshisBeingUsed - amountToSend >= feeForNoChange) {
|
|
// since we already checked if we need to add a change output we can just
|
|
// build without change here
|
|
final txn = await _createNotificationTx(
|
|
targetPaymentCodeString: targetPaymentCodeString,
|
|
utxosToUse: utxoObjectsToUse,
|
|
utxoSigningData: utxoSigningData,
|
|
change: 0, myPaymentCode: null,
|
|
);
|
|
|
|
int feeBeingPaid = satoshisBeingUsed - amountToSend;
|
|
|
|
Map<String, dynamic> transactionObject = {
|
|
"hex": txn.item1,
|
|
"recipientPaynym": targetPaymentCodeString,
|
|
"amount": amountToSend,
|
|
"fee": feeBeingPaid,
|
|
"vSize": txn.item2,
|
|
};
|
|
return transactionObject;
|
|
} else {
|
|
// if we get here we do not have enough funds to cover the tx total so we
|
|
// check if we have any more available outputs and try again
|
|
if (spendableOutputs.length > outputsBeingUsed) {
|
|
return buildNotificationTx(
|
|
selectedTxFeeRate: selectedTxFeeRate,
|
|
targetPaymentCodeString: targetPaymentCodeString,
|
|
additionalOutputs: additionalOutputs + 1, utxos: utxos, dustLimit: dustLimit, chainHeight: chainHeight, fetchBuildTxData: fetchBuildTxData,
|
|
);
|
|
} else {
|
|
throw InsufficientBalanceException(
|
|
"Remaining balance does not cover the network fee.");
|
|
}
|
|
}
|
|
}
|
|
|
|
// return tuple with string value equal to the raw tx hex and the int value
|
|
// equal to its vSize
|
|
Future<Tuple2<String, int>> _createNotificationTx({
|
|
required String targetPaymentCodeString,
|
|
required PaymentCode myPaymentCode,
|
|
required List<UTXO> utxosToUse,
|
|
required Map<String, dynamic> utxoSigningData,
|
|
required int change,
|
|
required int dustLimit,
|
|
required Address changeAddress,
|
|
}) async {
|
|
final targetPaymentCode =
|
|
PaymentCode.fromPaymentCode(targetPaymentCodeString, network);
|
|
|
|
final utxo = utxosToUse.first;
|
|
final txPoint = utxo.txid.fromHex.toList();
|
|
final txPointIndex = utxo.vout;
|
|
|
|
final rev = Uint8List(txPoint.length + 4);
|
|
Util.copyBytes(Uint8List.fromList(txPoint), 0, rev, 0, txPoint.length);
|
|
final buffer = rev.buffer.asByteData();
|
|
buffer.setUint32(txPoint.length, txPointIndex, Endian.little);
|
|
|
|
final myKeyPair = utxoSigningData[utxo.txid]["keyPair"] as btc_dart.ECPair;
|
|
|
|
final S = SecretPoint(
|
|
myKeyPair.privateKey!,
|
|
targetPaymentCode.notificationPublicKey(),
|
|
);
|
|
|
|
final blindingMask = PaymentCode.getMask(S.ecdhSecret(), rev);
|
|
|
|
final blindedPaymentCode = PaymentCode.blind(
|
|
myPaymentCode.getPayload(),
|
|
blindingMask,
|
|
);
|
|
|
|
final opReturnScript = bscript.compile([
|
|
(op.OPS["OP_RETURN"] as int),
|
|
blindedPaymentCode,
|
|
]);
|
|
|
|
// build a notification tx
|
|
final txb = btc_dart.TransactionBuilder(network: network);
|
|
txb.setVersion(1);
|
|
|
|
txb.addInput(
|
|
utxo.txid,
|
|
txPointIndex,
|
|
);
|
|
|
|
txb.addOutput(targetPaymentCode.notificationAddress(), dustLimit);
|
|
txb.addOutput(opReturnScript, 0);
|
|
|
|
// TODO: add possible change output and mark output as dangerous
|
|
if (change > 0) {
|
|
final String changeAddressString = changeAddress.value;
|
|
txb.addOutput(changeAddressString, change);
|
|
}
|
|
|
|
txb.sign(
|
|
vin: 0,
|
|
keyPair: myKeyPair,
|
|
);
|
|
|
|
// sign rest of possible inputs
|
|
for (var i = 1; i < utxosToUse.length - 1; i++) {
|
|
final txid = utxosToUse[i].txid;
|
|
txb.sign(
|
|
vin: i,
|
|
keyPair: utxoSigningData[txid]["keyPair"] as ECPair,
|
|
// witnessValue: utxosToUse[i].value,
|
|
);
|
|
}
|
|
|
|
final builtTx = txb.build();
|
|
|
|
return Tuple2(builtTx.toHex(), builtTx.virtualSize());
|
|
}
|
|
|
|
Future<String> confirmSendNotificationTx(
|
|
{required Map<String, dynamic> preparedTx, required ElectrumX electrumXClient,}) async {
|
|
try {
|
|
Logging.instance.log("confirmNotificationTx txData: $preparedTx",
|
|
level: LogLevel.Info);
|
|
final txHash = await electrumXClient.broadcastTransaction(
|
|
rawTx: preparedTx["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;
|
|
}
|
|
}
|
|
|
|
}
|