feat(lightning): Implement Reorg Checks

Implements reorg checks where needed.
Sets tx as unconfirmed when a reorg or missing tx is detected.
Adds unconfirmedTxs to lightning-manager.ts.
Removes confirmedTxs from lightning-manager.ts.
Removes leftover payWithRoute methods.
Bumps version to 0.0.98.

Author: coreyphillips

example/App.tsx

@@ -508,19 +508,6 @@ const App = (): ReactElement => {
 						}}
 					/>
 
-					<Button
-						title={'Build route and pay'}
-						onPress={async (): Promise<void> => {
-							const paymentRequest = await Clipboard.getString();
-							const payRes = await ldk.payWithRoute({ paymentRequest });
-							if (payRes.isErr()) {
-								return setMessage(payRes.error.message);
-							}
-
-							setMessage(payRes.value);
-						}}
-					/>
-
 					<Button
 						title={'Get network graph nodes'}
 						onPress={async (): Promise<void> => {

example/ios/Podfile.lock

@@ -302,7 +302,7 @@ PODS:
   - React-jsinspector (0.70.6)
   - React-logger (0.70.6):
     - glog
-  - react-native-ldk (0.0.97):
+  - react-native-ldk (0.0.98):
     - React
   - react-native-randombytes (3.6.1):
     - React-Core
@@ -593,7 +593,7 @@ SPEC CHECKSUMS:
   React-jsiexecutor: b4a65947391c658450151275aa406f2b8263178f
   React-jsinspector: 60769e5a0a6d4b32294a2456077f59d0266f9a8b
   React-logger: 1623c216abaa88974afce404dc8f479406bbc3a0
-  react-native-ldk: 38eb5291779f3ef181fd6472e7cd5ebf15797f8d
+  react-native-ldk: 0b2b9c3e57c80b19d94ec306f49765b29530758e
   react-native-randombytes: 421f1c7d48c0af8dbcd471b0324393ebf8fe7846
   react-native-tcp-socket: c1b7297619616b4c9caae6889bcb0aba78086989
   React-perflogger: 8c79399b0500a30ee8152d0f9f11beae7fc36595
@@ -618,4 +618,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 686e912f33d09c328c075738266ee797003d369e
 
-COCOAPODS: 1.12.0
+COCOAPODS: 1.12.1

example/ldk/index.ts

@@ -176,7 +176,7 @@ export const setupLdk = async (): Promise<Result<string>> => {
  */
 export const getTransactionData = async (
 	txId: string = '',
-): Promise<TTransactionData> => {
+): Promise<TTransactionData | undefined> => {
 	let transactionData = DefaultTransactionDataShape;
 	const data = {
 		key: 'tx_hash',
@@ -190,6 +190,22 @@ export const getTransactionData = async (
 		txHashes: data,
 		network: selectedNetwork,
 	});
+	if (
+		//TODO: Update types for electrum response.
+		// @ts-ignore
+		response?.error &&
+		//TODO: Update types for electrum response.
+		// @ts-ignore
+		response?.error?.message &&
+		/No such mempool or blockchain transaction|Invalid tx hash/.test(
+			//TODO: Update types for electrum response.
+			// @ts-ignore
+			response?.error?.message,
+		)
+	) {
+		//Transaction may have been removed/bumped from the mempool or potentially reorg'd out.
+		return undefined;
+	}
 
 	if (response.error || !response.data || response.data[0].error) {
 		return transactionData;
@@ -321,31 +337,3 @@ export const importAccount = async (
 	await syncLdk();
 	return ok(importResponse.value);
 };
-
-/**
- * Iterates over watch transactions for spends. Sets them as confirmed as needed.
- * @returns {Promise<boolean>}
- */
-export const checkWatchTxs = async (): Promise<boolean> => {
-	const checkedScriptPubKeys: string[] = [];
-	const watchTransactionIds = lm.watchTxs.map((tx) => tx.txid);
-	for (const watchTx of lm.watchTxs) {
-		if (!checkedScriptPubKeys.includes(watchTx.script_pubkey)) {
-			const scriptPubKeyHistory: { txid: string; height: number }[] =
-				await getScriptPubKeyHistory(watchTx.script_pubkey);
-			for (const data of scriptPubKeyHistory) {
-				if (!watchTransactionIds.includes(data?.txid)) {
-					const txData = await getTransactionData(data?.txid);
-					await ldk.setTxConfirmed({
-						header: txData.header,
-						height: txData.height,
-						txData: [{ transaction: txData.transaction, pos: 0 }],
-					});
-					return true;
-				}
-			}
-			checkedScriptPubKeys.push(watchTx.script_pubkey);
-		}
-	}
-	return false;
-};

lib/ios/Ldk.m

@@ -112,17 +112,6 @@ @interface RCT_EXTERN_MODULE(Ldk, NSObject)
                   timeoutSeconds:(NSInteger *)timeoutSeconds
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
-RCT_EXTERN_METHOD(payWithRoute:(NSArray *)route
-                  destinationNodeId:(NSString *)destinationNodeId
-                  amountSats:(NSInteger *)amountSats
-                  cltvExpiryDelta:(NSInteger *)cltvExpiryDelta
-                  paymentHash:(NSString *)paymentHash
-                  paymentSecret:(NSString *)paymentSecret
-                  resolve:(RCTPromiseResolveBlock)resolve
-                  reject:(RCTPromiseRejectBlock)reject)
-RCT_EXTERN_METHOD(payWithRoute2:(NSString *)payReq
-                  resolve:(RCTPromiseResolveBlock)resolve
-                  reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(abandonPayment:(NSString *)paymentId
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)

lib/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synonymdev/react-native-ldk",
   "title": "React Native LDK",
-  "version": "0.0.97",
+  "version": "0.0.98",
   "description": "React Native wrapper for LDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

lib/src/ldk.ts

@@ -17,7 +17,6 @@ import {
 	TPaymentReq,
 	TCreatePaymentReq,
 	TSetTxConfirmedReq,
-	TSetTxUnconfirmedReq,
 	TInitNetworkGraphReq,
 	TCloseChannelReq,
 	TSpendOutputsReq,
@@ -166,11 +165,8 @@ class LDK {
 	 * Accepts array of hex encoded channel manager and channel monitors from storage.
 	 * NOTE: If empty channelManagerSerialized string then initChannelManager will create a new channel manager.
 	 * https://docs.rs/lightning/latest/lightning/ln/channelmanager/index.html
-	 * @param network
-	 * @param channelManagerSerialized
-	 * @param channelMonitorsSerialized
-	 * @param bestBlock
-	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 * @param {TInitChannelManagerReq} data
+	 * @returns {Promise<Result<string>>}
 	 */
 	async initChannelManager(
 		data: TInitChannelManagerReq,
@@ -243,9 +239,8 @@ class LDK {
 
 	/**
 	 * If set will write all LDK logging to file.
-	 * @param level
-	 * @param active
-	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 * @param {string} path
+	 * @returns {Promise<Result<string>>}
 	 */
 	async setLogFilePath(path: string): Promise<Result<string>> {
 		try {
@@ -258,8 +253,9 @@ class LDK {
 
 	/**
 	 * Write a line to current LDK log file
-	 * @param line
-	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 * @param {'error' | 'info' | 'debug'} type
+	 * @param {string} line
+	 * @returns {Promise<Result<string>>}
 	 */
 	async writeToLogFile(
 		type: 'error' | 'info' | 'debug',
@@ -325,9 +321,8 @@ class LDK {
 
 	/**
 	 * Sets current best block on channelManager and chainMonitor
-	 * @param header
-	 * @param height
-	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 * @param {THeader} tip
+	 * @returns {Promise<Result<string>>}
 	 */
 	async syncToTip(tip: THeader): Promise<Result<string>> {
 		const { hex, hash, height } = tip;
@@ -343,11 +338,8 @@ class LDK {
 
 	/**
 	 * Connect to remote peer
-	 * @param pubKey
-	 * @param address
-	 * @param port
-	 * @param timeout (Android only)
-	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 * @param {TAddPeerReq} peer
+	 * @returns {Promise<Result<string>>}
 	 */
 	async addPeer(peer: TAddPeerReq): Promise<Result<string>> {
 		const { pubKey, address, port, timeout } = peer;
@@ -363,10 +355,9 @@ class LDK {
 
 	/**
 	 * Updates a watched transaction as confirmed
-	 * @param txId
-	 * @param transaction
+	 * @param header
+	 * @param txData
 	 * @param height
-	 * @param pos
 	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
 	 */
 	async setTxConfirmed({
@@ -386,14 +377,12 @@ class LDK {
 
 	/**
 	 * Updates a watched transaction as unconfirmed in the event of a reorg
-	 * @param txId
-	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 * @param {string} txid
+	 * @returns {Promise<Result<string>>}
 	 */
-	async setTxUnconfirmed({
-		txId,
-	}: TSetTxUnconfirmedReq): Promise<Result<string>> {
+	async setTxUnconfirmed(txid: string): Promise<Result<string>> {
 		try {
-			const res = await NativeLDK.setTxUnconfirmed(txId);
+			const res = await NativeLDK.setTxUnconfirmed(txid);
 			this.writeDebugToLog('setTxUnconfirmed');
 			return ok(res);
 		} catch (e) {
@@ -480,7 +469,7 @@ class LDK {
 	/**
 	 * Decodes a bolt11 payment request
 	 * @param paymentRequest
-	 * @returns {Promise<Ok<any> | Err<unknown>>}
+	 * @returns {Promise<Result<TInvoice>>}
 	 */
 	async decode({ paymentRequest }: TPaymentReq): Promise<Result<TInvoice>> {
 		const cleanedPaymentRequest = extractPaymentRequest(paymentRequest);
@@ -496,8 +485,9 @@ class LDK {
 
 	/**
 	 * Creates bolt11 payment request
-	 * @param amountSats
-	 * @param description
+	 * @param {number | undefined} amountSats
+	 * @param {string} description
+	 * @param {number} expiryDeltaSeconds
 	 * @returns {Promise<Ok<Ok<TInvoice> | Err<TInvoice>> | Err<unknown>>}
 	 */
 	async createPaymentRequest({
@@ -915,8 +905,7 @@ class LDK {
 
 	/**
 	 * Fetches full list of nodes and their details
-	 * @param nodeId
-	 * @returns {Promise<Ok<Ok<TNetworkGraphChannelInfo> | Err<string>> | Err<unknown>>}
+	 * @returns {Promise<Result<TNetworkGraphNodeInfo[]>>}
 	 */
 	async completeGraphNodes(): Promise<Result<TNetworkGraphNodeInfo[]>> {
 		try {
@@ -982,8 +971,7 @@ class LDK {
 
 	/**
 	 * Fetches full list of channels and their details
-	 * @param shortChannelId
-	 * @returns {Promise<Ok<Ok<TNetworkGraphChannelInfo> | Err<string>> | Err<unknown>>}
+	 * @returns {Promise<Result<TNetworkGraphChannelInfo[]>>}
 	 */
 	async completeGraphChannels(): Promise<Result<TNetworkGraphChannelInfo[]>> {
 		try {