Merge pull request #242 from synonymdev/broadcast-tx-cleanup

Broadcasted transactions cleanup

Author: Jasonvdb

lib/android/src/main/java/com/reactnativeldk/LdkModule.kt

@@ -1244,7 +1244,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
             logDump.add("Open channel:")
 
             channel._funding_txo?._txid?.let { txId ->
-                logDump.add("Funding txid: ${txId.hexEncodedString()}")
+                logDump.add("Funding txid: ${txId.reversedArray().hexEncodedString()}")
             }
 
             logDump.add("Ready: ${if (channel._is_channel_ready) "YES" else "NO"}")

lib/ios/Helpers.swift

@@ -127,7 +127,7 @@ extension ChannelDetails {
             "confirmations_required": getConfirmationsRequired() as Any, // Optional number
             "short_channel_id": shortChannelId,
             "inbound_scid_alias": getInboundScidAlias() != nil ? String(getInboundScidAlias()!) : shortChannelId, //String
-            "inbound_payment_scid": getInboundPaymentScid() as Any, //Optional number,
+            "inbound_payment_scid": getInboundPaymentScid() != nil ? String(getInboundPaymentScid()!) : "", //String,
             "inbound_capacity_sat": getInboundCapacityMsat() / 1000,
             "outbound_capacity_sat": getOutboundCapacityMsat() / 1000,
             "channel_value_satoshis": getChannelValueSatoshis(),

lib/src/lightning-manager.ts

@@ -61,6 +61,7 @@ import {
 import {
 	appendPath,
 	findOutputsFromRawTxs,
+	getTxIdFromRawTx,
 	isValidBech32mEncodedString,
 	parseData,
 	promiseTimeout,
@@ -510,6 +511,8 @@ class LightningManager {
 		//Writes node state to log files
 		ldk.nodeStateDump().catch(console.error);
 
+		this.cleanupBroadcastedTxs().catch(console.error);
+
 		this.isStarting = false;
 		const result = ok('Node started');
 		this.resolveAllPendingStartPromises(result);
@@ -1586,6 +1589,102 @@ class LightningManager {
 		return [];
 	}
 
+	async cleanupBroadcastedTxs(): Promise<void> {
+		const savedTxs = await this.getLdkBroadcastedTxs();
+		if (savedTxs.length === 0) {
+			await ldk.writeToLogFile(
+				'debug',
+				'No broadcasted transactions found to cleanup.',
+			);
+			return;
+		}
+
+		const txsToCleanup: string[] = [];
+		for (const rawTx of savedTxs) {
+			const txid = getTxIdFromRawTx(rawTx);
+			const txData = await this.getTransactionData(txid);
+			if (!txData) {
+				await ldk.writeToLogFile(
+					'error',
+					`No txData found for tx: ${txid}. Skip cleanup.`,
+				);
+				//TODO maybe try broadcast and depending on the error, remove it if invalid inputs or something we expect from an invalid tx.
+				continue;
+			}
+
+			if (!txData.height) {
+				await ldk.writeToLogFile(
+					'error',
+					`Tx: ${txid} has no height (not in block). Skipping cleanup.`,
+				);
+				continue;
+			}
+
+			const numberOfConfirmations =
+				this.currentBlock.height - txData.height + 1;
+			if (numberOfConfirmations >= 6) {
+				await ldk.writeToLogFile(
+					'debug',
+					`Cleaning up tx: ${txid} with ${numberOfConfirmations} confirmations.`,
+				);
+				txsToCleanup.push(rawTx);
+			} else {
+				await ldk.writeToLogFile(
+					'debug',
+					`Tx: ${txid} with ${numberOfConfirmations} confirmations. Skipping cleanup.`,
+				);
+			}
+		}
+
+		if (txsToCleanup.length === 0) {
+			await ldk.writeToLogFile(
+				'debug',
+				'No broadcasted transactions found to cleanup.',
+			);
+			return;
+		}
+
+		//Fetch again in case of another process writing to the file since last lookup.
+		const latestSavedTxs = await this.getLdkBroadcastedTxs();
+		const txsToKeep = latestSavedTxs.filter((tx) => !txsToCleanup.includes(tx));
+
+		const saveRes = await ldk.writeToFile({
+			fileName: ELdkFiles.broadcasted_transactions,
+			content: JSON.stringify(txsToKeep),
+			remotePersist: false,
+		});
+		if (saveRes.isErr()) {
+			await ldk.writeToLogFile(
+				'error',
+				`Failed saving cleaned up txs: ${saveRes.error}`,
+			);
+			return;
+		}
+
+		//Save the cleanup up txs just in case. They won't ever be loaded automatically.
+		let currentConfirmedRawTxs: string[] = [];
+		const currentConfirmedRawTxsRes = await ldk.readFromFile({
+			fileName: ELdkFiles.confirmed_broadcasted_transactions,
+		});
+		if (currentConfirmedRawTxsRes.isOk()) {
+			currentConfirmedRawTxs = parseData(
+				currentConfirmedRawTxsRes.value.content,
+				[],
+			);
+		}
+
+		await ldk.writeToFile({
+			fileName: ELdkFiles.confirmed_broadcasted_transactions,
+			content: JSON.stringify(currentConfirmedRawTxs.concat(txsToCleanup)),
+			remotePersist: false,
+		});
+
+		await ldk.writeToLogFile(
+			'info',
+			`Cleaned up ${txsToCleanup.length} broadcasted transactions.`,
+		);
+	}
+
 	async rebroadcastAllKnownTransactions(): Promise<any[]> {
 		const broadcastedTransactions = await this.getLdkBroadcastedTxs();
 		const results = [];

lib/src/utils/helpers.ts

@@ -301,6 +301,11 @@ export const findOutputsFromRawTxs = (
 	return result;
 };
 
+export const getTxIdFromRawTx = (rawTx: string): string => {
+	const tx = bitcoin.Transaction.fromHex(rawTx);
+	return tx.getId();
+};
+
 /**
  * Pauses execution of a function.
  * @param {number} ms The time to wait in milliseconds.

lib/src/utils/types.ts

@@ -481,6 +481,7 @@ export enum ELdkFiles {
 	peers = 'peers.json', //File saved from JS
 	unconfirmed_transactions = 'unconfirmed_transactions.json',
 	broadcasted_transactions = 'broadcasted_transactions.json',
+	confirmed_broadcasted_transactions = 'confirmed_broadcasted_transactions.json',
 	payment_ids = 'payment_ids.json',
 	spendable_outputs = 'spendable_outputs.json',
 	payments_claimed = 'payments_claimed.json', // Written in swift/kotlin and read from JS