Function for setting tx as confirmed or unconfirmed (in event of re-org)

Author: Jasonvdb

ios/Ldk.m

@@ -47,6 +47,16 @@ @interface RCT_EXTERN_MODULE(Ldk, NSObject)
                   pubKey:(NSString *)pubKey
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(setTxConfirmed:(NSString *)header
+                  transaction:(NSString *)transaction
+                  pos:(NSInteger *)pos
+                  height:(NSInteger *)height
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(setTxUnconfirmed:(NSString *)txId
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+
 //MARK: Fetch methods
 RCT_EXTERN_METHOD(version:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)

ios/Ldk.swift

@@ -64,6 +64,8 @@ enum LdkCallbackResponses: String {
     case add_peer_success = "add_peer_success"
     case chain_sync_success = "chain_sync_success"
     case invoice_payment_success = "invoice_payment_success"
+    case tx_set_confirmed = "tx_set_confirmed"
+    case tx_set_unconfirmed = "tx_set_unconfirmed"
 }
 
 @objc(Ldk)
@@ -329,6 +331,48 @@ class Ldk: NSObject {
         handleResolve(resolve, .add_peer_success)
     }
 
+    @objc
+    func setTxConfirmed(_ header: NSString, transaction: NSString, pos: NSInteger, height: NSInteger, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+        guard let channelManager = channelManager else {
+            return handleReject(reject, .init_channel_manager)
+        }
+        
+        guard let chainMonitor = chainMonitor else {
+            return handleReject(reject, .init_chain_monitor)
+        }
+        
+        let txData = [C2Tuple_usizeTransactionZ.new(a: UInt(pos), b: String(transaction).hexaBytes)]
+        
+        channelManager.as_Confirm().transactions_confirmed(
+            header: String(header).hexaBytes,
+            txdata: txData,
+            height: UInt32(height)
+        )
+        chainMonitor.as_Confirm().transactions_confirmed(
+            header: String(header).hexaBytes,
+            txdata: txData,
+            height: UInt32(height)
+        )
+        
+        handleResolve(resolve, .tx_set_confirmed)
+    }
+    
+    @objc
+    func setTxUnconfirmed(_ txId: NSString, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+        guard let channelManager = channelManager else {
+            return handleReject(reject, .init_channel_manager)
+        }
+        
+        guard let chainMonitor = chainMonitor else {
+            return handleReject(reject, .init_chain_monitor)
+        }
+        
+        channelManager.as_Confirm().transaction_unconfirmed(txid: String(txId).hexaBytes)
+        chainMonitor.as_Confirm().transaction_unconfirmed(txid: String(txId).hexaBytes)
+        
+        handleResolve(resolve, .tx_set_unconfirmed)
+    }
+    
     //MARK: Payments
     @objc
     func decode(_ paymentRequest: NSString, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {

src/ldk.ts

@@ -12,7 +12,9 @@ import {
 	TLogListener,
 	TPaymentReq,
 	TSyncTipReq,
-	TCreatePaymentReq
+	TCreatePaymentReq,
+	TSetTxConfirmedReq,
+	TSetTxUnconfirmedReq
 } from './utils/types';
 
 const LINKING_ERROR =
@@ -204,6 +206,13 @@ class LDK {
 		}
 	}
 
+	/**
+	 * Connect to remote peer
+	 * @param pubKey
+	 * @param address
+	 * @param port
+	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 */
 	async addPeer({ pubKey, address, port }: TAddPeerReq): Promise<Result<string>> {
 		try {
 			const res = await NativeLDK.addPeer(address, port, pubKey);
@@ -213,6 +222,42 @@ class LDK {
 		}
 	}
 
+	/**
+	 * Updates a watched transaction as confirmed
+	 * @param txId
+	 * @param transaction
+	 * @param height
+	 * @param pos
+	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 */
+	async setTxConfirmed({
+		header,
+		transaction,
+		height,
+		pos
+	}: TSetTxConfirmedReq): Promise<Result<string>> {
+		try {
+			const res = await NativeLDK.setTxConfirmed(header, transaction, pos, height);
+			return ok(res);
+		} catch (e) {
+			return err(e);
+		}
+	}
+
+	/**
+	 * Updates a watched transaction as unconfirmed in the event of a reorg
+	 * @param txId
+	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 */
+	async setTxUnconfirmed({ txId }: TSetTxUnconfirmedReq): Promise<Result<string>> {
+		try {
+			const res = await NativeLDK.setTxUnconfirmed(txId);
+			return ok(res);
+		} catch (e) {
+			return err(e);
+		}
+	}
+
 	/**
 	 * Decodes a bolt11 payment request
 	 * @param paymentRequest
@@ -244,7 +289,6 @@ class LDK {
 			return err(e);
 		}
 	}
-	//createPaymentRequest
 
 	/**
 	 * Pays a bolt11 payment request
@@ -262,6 +306,9 @@ class LDK {
 		}
 	}
 
+	//TODO pay_zero_value_invoice
+	//TODO pay_pubkey
+
 	/**
 	 * Listen on LDK events
 	 * @param event
@@ -389,6 +436,7 @@ class LDK {
 	 * @returns {Promise<Err<unknown> | Ok<string[]>>}
 	 */
 	async getLogFileContent(limit: number = 100): Promise<Result<string[]>> {
+		//TODO
 		// try {
 		// 	const content: string[] = await this.ldk.logFileContent(network, limit);
 		// 	return ok(content);

src/lightning-manager.ts

@@ -45,7 +45,7 @@ import {
 // Step 13: Initialize networking ✅
 // Step 14: Connect and Disconnect Blocks ✅
 // Step 15: Handle LDK Events [WIP]
-// Step 16: Initialize routing ProbabilisticScorer
+// Step 16: Initialize routing ProbabilisticScorer [Not sure if required]
 // Step 17: Create InvoicePayer ✅
 // Step 18: Persist ChannelManager and NetworkGraph
 // Step 19: Background Processing
@@ -231,29 +231,35 @@ class LightningManager {
 	}
 
 	/**
-	 * Fetches current best block and sends to LDK.
-	 * Updates both channelManager and chainMonitor.
+	 * Fetches current best block and sends to LDK to update both channelManager and chainMonitor.
+	 * Also watches transactions and outputs for confirmed and unconfirmed transactions and updated LDK.
 	 * @returns {Promise<Err<string> | Ok<string>>}
 	 */
 	async syncLdk() {
 		const { bestblockhash, blocks } = await regtestBestBlock();
 
-		if (this.currentBlockHash === bestblockhash) {
-			return; //No need to update
-		}
+		//Don't update unnecessarily
+		if (this.currentBlockHash !== bestblockhash) {
+			const header = await regtestBlockHeaderHex(bestblockhash);
+			const syncToTip = await ldk.syncToTip({
+				header,
+				height: blocks
+			});
+			if (syncToTip.isErr()) {
+				return syncToTip;
+			}
 
-		const header = await regtestBlockHeaderHex(bestblockhash);
-		const syncToTip = await ldk.syncToTip({
-			header,
-			height: blocks
-		});
-		if (syncToTip.isErr()) {
-			return syncToTip;
+			this.currentBlockHash = bestblockhash;
 		}
 
-		this.currentBlockHash = bestblockhash;
-
-		//TODO fetch latest data for watchTxs and watchOutputs. Feed to transactions_confirmed() and transactions_confirmed()
+		//TODO fetch latest data for watchTxs and watchOutputs. Feed any updates to LDK.
+		// const setRes = await ldk.setTxConfirmed({
+		// 	header: 'hex_encoded_header',
+		// 	height: 1,
+		// 	transaction: 'hex_encoded_tx',
+		// 	pos: 1
+		// });
+		// const unsetRes = await ldk.setTxUnconfirmed({ txId: 'set_me' });
 
 		return ok(`Synced to block ${blocks}`);
 	}
@@ -314,7 +320,7 @@ class LightningManager {
 	}
 
 	private onChannelManagerPaymentPathSuccessful(res: TChannelManagerPaymentPathSuccessful) {
-		//Nothing to here. Optionally notify user?
+		//Nothing to do here. Optionally notify user?
 		console.log(`onChannelManagerPaymentPathSuccessful: ${JSON.stringify(res)}`); //TODO
 	}
 

src/utils/types.ts

@@ -160,6 +160,17 @@ export type TAddPeerReq = {
 	pubKey: string;
 };
 
+export type TSetTxConfirmedReq = {
+	header: string;
+	transaction: string;
+	pos: number;
+	height: number;
+};
+
+export type TSetTxUnconfirmedReq = {
+	txId: string;
+};
+
 export type TPaymentReq = {
 	paymentRequest: string;
 };