Merge pull request #4 from synonymdev/pending-htlcs-forwardable

Swift pending HTLCs forwardable

Author: coreyphillips

ios/Classes/LdkChannelManagerPersister.swift

@@ -139,7 +139,16 @@ class LdkChannelManagerPersister: Persister, ExtendedChannelManagerPersister {
             //Unused on mobile
             return
         case .PendingHTLCsForwardable:
-            //TODO not sure if required.
+            guard let pendingHTLCsForwardable = event.getValueAsPendingHTLCsForwardable() else {
+                return handleEventError(event)
+            }
+                        
+            LdkEventEmitter.shared.send(
+                withEvent: .channel_manager_pending_htlcs_forwardable,
+                body: [
+                    "time_forwardable": pendingHTLCsForwardable.getTime_forwardable(),
+                ]
+            )
             return
         case .SpendableOutputs:
             guard let spendableOutputs = event.getValueAsSpendableOutputs() else {

ios/Classes/LdkFilter.swift

@@ -17,7 +17,7 @@ class LdkFilter: Filter {
         LdkEventEmitter.shared.send(
             withEvent: .register_tx,
             body: [
-                "txid": Data(txid ?? []).hexEncodedString(),
+                "txid": Data(Data(txid ?? []).reversed()).hexEncodedString(),
                 "script_pubkey": Data(script_pubkey).hexEncodedString()
             ]
         )

ios/Ldk.m

@@ -80,6 +80,11 @@ @interface RCT_EXTERN_MODULE(Ldk, NSObject)
                   description:(NSString *)description
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(processPendingHtlcForwards:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(claimFunds:(NSString *)paymentPreimage
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
 @end
 
 //MARK: Events

ios/Ldk.swift

@@ -21,6 +21,7 @@ enum EventTypes: String, CaseIterable {
     case channel_manager_payment_path_successful = "channel_manager_payment_path_successful"
     case channel_manager_payment_path_failed = "channel_manager_payment_path_failed"
     case channel_manager_payment_failed = "channel_manager_payment_failed"
+    case channel_manager_pending_htlcs_forwardable = "channel_manager_pending_htlcs_forwardable"
     case channel_manager_spendable_outputs = "channel_manager_spendable_outputs"
     case channel_manager_channel_closed = "channel_manager_channel_closed"
     case channel_manager_discard_funding = "channel_manager_discard_funding"
@@ -48,6 +49,7 @@ enum LdkErrors: String {
     case invoice_payment_fail = "invoice_payment_fail"
     case init_ldk_currency = "init_ldk_currency"
     case invoice_create_failed = "invoice_create_failed"
+    case claim_funds_failed = "claim_funds_failed"
 }
 
 enum LdkCallbackResponses: String {
@@ -66,6 +68,8 @@ enum LdkCallbackResponses: String {
     case invoice_payment_success = "invoice_payment_success"
     case tx_set_confirmed = "tx_set_confirmed"
     case tx_set_unconfirmed = "tx_set_unconfirmed"
+    case process_pending_htlc_forwards_success = "process_pending_htlc_forwards_success"
+    case claim_funds_success = "claim_funds_success"
 }
 
 @objc(Ldk)
@@ -179,9 +183,8 @@ class Ldk: NSObject {
 
     @objc
     func initNetworkGraph(_ genesisHash: NSString, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
-        networkGraph = NetworkGraph(genesis_hash: String(genesisHash).hexaBytes.reversed())
+        networkGraph = NetworkGraph(genesis_hash: String(genesisHash).hexaBytes)
         //TODO load cached version if exists instead. NetworkGraph.read(ser: serialized_backup)
-        
         handleResolve(resolve, .network_graph_init_success)
     }
 
@@ -251,7 +254,7 @@ class Ldk: NSObject {
                     fee_estimator: feeEstimator,
                     chain_monitor: chainMonitor,
                     filter: filter,
-                    net_graph_serialized: nil, //TODO
+                    net_graph_serialized: networkGraph.write(),
                     tx_broadcaster: broadcaster,
                     logger: logger
                 )
@@ -397,7 +400,7 @@ class Ldk: NSObject {
 
         let res = invoicePayer.pay_invoice(invoice: invoice)
         if res.isOk() {
-            handleResolve(resolve, .invoice_payment_success)
+            return handleResolve(resolve, .invoice_payment_success)
         }
 
         guard let error = res.getError() else {
@@ -467,6 +470,31 @@ class Ldk: NSObject {
         return handleReject(reject, .invoice_create_failed, nil, "Invoice creation error: \(creationError.rawValue)")
     }
 
+    @objc
+    func processPendingHtlcForwards(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+        guard let channelManager = channelManager else {
+            return handleReject(reject, .init_channel_manager)
+        }
+        
+        channelManager.process_pending_htlc_forwards()
+        
+        handleResolve(resolve, .process_pending_htlc_forwards_success)
+    }
+    
+    @objc
+    func claimFunds(_ paymentPreimage: NSString, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+        guard let channelManager = channelManager else {
+            return handleReject(reject, .init_channel_manager)
+        }
+        
+        let res = channelManager.claim_funds(payment_preimage: String(paymentPreimage).hexaBytes)
+        if res == false {
+            handleReject(reject, .claim_funds_failed)
+        }
+        
+        handleResolve(resolve, .claim_funds_success)
+    }
+    
     //MARK: Fetch methods
     @objc
     func version(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {

src/ldk.ts

@@ -310,6 +310,33 @@ class LDK {
 		}
 	}
 
+	/**
+	 * https://docs.rs/lightning/latest/lightning/ln/channelmanager/struct.ChannelManager.html#method.process_pending_htlc_forwards
+	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 */
+	async processPendingHtlcForwards(): Promise<Result<string>> {
+		try {
+			const res = await NativeLDK.processPendingHtlcForwards();
+			return ok(res);
+		} catch (e) {
+			return err(e);
+		}
+	}
+
+	/**
+	 * https://docs.rs/lightning/latest/lightning/ln/channelmanager/struct.ChannelManager.html#method.claim_funds
+	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 * @param paymentPreimage
+	 */
+	async claimFunds(paymentPreimage: string): Promise<Result<string>> {
+		try {
+			const res = await NativeLDK.claimFunds(paymentPreimage);
+			return ok(res);
+		} catch (e) {
+			return err(e);
+		}
+	}
+
 	/**
 	 * Pays a bolt11 payment request
 	 * @param paymentRequest

src/lightning-manager.ts

@@ -20,6 +20,7 @@ import {
 	TPersistManagerEvent,
 	TRegisterOutputEvent,
 	TRegisterTxEvent,
+	TChannelManagerPendingHtlcsForwardable,
 } from './utils/types';
 import {
 	dummyRandomSeed,
@@ -105,6 +106,10 @@ class LightningManager {
 			EEventTypes.channel_manager_payment_failed,
 			this.onChannelManagerPaymentFailed.bind(this),
 		);
+		ldk.onEvent(
+			EEventTypes.channel_manager_pending_htlcs_forwardable,
+			this.onChannelManagerPendingHtlcsForwardable.bind(this),
+		);
 		ldk.onEvent(
 			EEventTypes.channel_manager_spendable_outputs,
 			this.onChannelManagerSpendableOutputs.bind(this),
@@ -330,10 +335,12 @@ class LightningManager {
 	private onChannelManagerPaymentReceived(
 		res: TChannelManagerPaymentReceived,
 	): void {
-		//TODO call channelManager.claim_funds(payment_preimage: paymentPreimage) if spontaneous_payment_preimage is not a blank string as
-		//https://docs.rs/lightning/latest/lightning/util/events/enum.PaymentPurpose.html#variant.SpontaneousPayment
-		//If not a spontaneous payment then nothing to do but notify user invoice was paid
-		console.log(`onChannelManagerPaymentReceived: ${JSON.stringify(res)}`); //TODO
+		if (res.spontaneous_payment_preimage) {
+			//https://docs.rs/lightning/latest/lightning/util/events/enum.PaymentPurpose.html#variant.SpontaneousPayment
+			ldk.claimFunds(res.spontaneous_payment_preimage).catch(console.error);
+		} else {
+			ldk.claimFunds(res.payment_preimage).catch(console.error);
+		}
 	}
 
 	private onChannelManagerPaymentSent(res: TChannelManagerPaymentSent): void {
@@ -369,6 +376,12 @@ class LightningManager {
 		console.log(`onChannelManagerPaymentFailed: ${JSON.stringify(res)}`); //TODO
 	}
 
+	private onChannelManagerPendingHtlcsForwardable(
+		res: TChannelManagerPendingHtlcsForwardable,
+	): void {
+		ldk.processPendingHtlcForwards().catch(console.error);
+	}
+
 	private onChannelManagerSpendableOutputs(
 		res: TChannelManagerSpendableOutputs,
 	): void {

src/utils/types.ts

@@ -22,6 +22,7 @@ export enum EEventTypes {
 	channel_manager_payment_path_successful = 'channel_manager_payment_path_successful',
 	channel_manager_payment_path_failed = 'channel_manager_payment_path_failed',
 	channel_manager_payment_failed = 'channel_manager_payment_failed',
+	channel_manager_pending_htlcs_forwardable = 'channel_manager_pending_htlcs_forwardable',
 	channel_manager_spendable_outputs = 'channel_manager_spendable_outputs',
 	channel_manager_channel_closed = 'channel_manager_channel_closed',
 	channel_manager_discard_funding = 'channel_manager_discard_funding',
@@ -89,6 +90,9 @@ export type TChannelManagerPaymentFailed = {
 	payment_id: string;
 	payment_hash: string;
 };
+export type TChannelManagerPendingHtlcsForwardable = {
+	time_forwardable: number;
+};
 export type TChannelManagerSpendableOutputs = {
 	outputs: string[];
 };