feat: ios create pending channel

Author: Jasonvdb

example/ios/Podfile.lock

@@ -316,7 +316,7 @@ PODS:
   - React-jsinspector (0.72.4)
   - React-logger (0.72.4):
     - glog
-  - react-native-ldk (0.0.148):
+  - react-native-ldk (0.0.150):
     - React
   - react-native-randombytes (3.6.1):
     - React-Core
@@ -621,7 +621,7 @@ SPEC CHECKSUMS:
   React-jsiexecutor: c7f826e40fa9cab5d37cab6130b1af237332b594
   React-jsinspector: aaed4cf551c4a1c98092436518c2d267b13a673f
   React-logger: da1ebe05ae06eb6db4b162202faeafac4b435e77
-  react-native-ldk: fda4d4381d40401bdc5c3a9965937d19b232ed08
+  react-native-ldk: 2b19de9eb94dcfd46f3f2a7191502292b75a5d7a
   react-native-randombytes: 421f1c7d48c0af8dbcd471b0324393ebf8fe7846
   react-native-tcp-socket: c1b7297619616b4c9caae6889bcb0aba78086989
   React-NativeModulesApple: edb5ace14f73f4969df6e7b1f3e41bef0012740f

lib/ios/Classes/LdkChannelManagerPersister.swift

@@ -25,7 +25,7 @@ class LdkChannelManagerPersister: Persister, ExtendedChannelManagerPersister {
             guard let fundingGeneration = event.getValueAsFundingGenerationReady() else {
                 return handleEventError(event)
             }
-
+            
             LdkEventEmitter.shared.send(
                 withEvent: .channel_manager_funding_generation_ready,
                 body: [

lib/ios/Ldk.m

@@ -86,6 +86,11 @@ @interface RCT_EXTERN_MODULE(Ldk, NSObject)
                   force:(BOOL *)force
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(createChannel:(NSString *)counterPartyNodeId
+                  channelValueSats:(NSInteger *)channelValueSats
+                  pushSats:(NSInteger *)pushSats
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(forceCloseAllChannels:(BOOL *)broadcastLatestTx
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)

lib/ios/Ldk.swift

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

lib/package.json

@@ -39,6 +39,7 @@ import {
 	TInitKeysManager,
 	TSpendRecoveredForceCloseOutputsReq,
 	TChannelMonitor,
+	TCreateChannelReq,
 } from './utils/types';
 import { extractPaymentRequest } from './utils/helpers';
 
@@ -480,6 +481,25 @@ class LDK {
 		}
 	}
 
+	/**
+	 * Start create channel process and returns channel ID that can be used when funding the channel.
+	 * https://docs.rs/lightning/latest/lightning/ln/channelmanager/struct.ChannelManager.html#method.create_channel
+	 * @param counterPartyNodeId
+	 * @param channelValueSats
+	 * @param pushSats
+	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
+	 */
+	async createChannel({counterPartyNodeId, channelValueSats, pushSats}: TCreateChannelReq): Promise<Result<string>> {
+		try {
+			const res = await NativeLDK.createChannel(counterPartyNodeId, channelValueSats, pushSats);
+			this.writeDebugToLog('createChannel');
+			return ok(res);
+		} catch (e) {
+			this.writeErrorToLog('createChannel', e);
+			return err(e);
+		}
+	}
+
 	/**
 	 * Force close all channels
 	 * @param broadcastLatestTx

lib/src/ldk.ts

@@ -58,6 +58,7 @@ import {
 	TLspLogPayload,
 	TLspLogEvent,
 	TChannelMonitor,
+	TCreateChannelReq,
 } from './utils/types';
 import {
 	appendPath,
@@ -170,10 +171,10 @@ class LightningManager {
 			this.onBroadcastTransaction.bind(this),
 		);
 		//Channel manager handle events:
-		ldk.onEvent(
-			EEventTypes.channel_manager_funding_generation_ready,
-			this.onChannelManagerFundingGenerationReady.bind(this),
-		);
+		// ldk.onEvent(
+		// 	EEventTypes.channel_manager_funding_generation_ready,
+		// 	this.onChannelManagerFundingGenerationReady.bind(this),
+		// );
 		ldk.onEvent(
 			EEventTypes.channel_manager_payment_claimable,
 			this.onChannelManagerPaymentClaimable.bind(this),
@@ -2050,13 +2051,13 @@ class LightningManager {
 	//LDK channel manager events
 	//All events and their values: https://docs.rs/lightning/latest/lightning/util/events/enum.Event.html
 	//Sample node for examples on how to handle events: https://github.com/lightningdevkit/ldk-sample/blob/c0a722430b8fbcb30310d64487a32aae839da3e8/src/main.rs#L600
-	private onChannelManagerFundingGenerationReady(
-		res: TChannelManagerFundingGenerationReady,
-	): void {
-		console.log(
-			`onChannelManagerFundingGenerationReady: ${JSON.stringify(res)}`,
-		); //TODO
-	}
+	// private onChannelManagerFundingGenerationReady(
+	// 	res: TChannelManagerFundingGenerationReady,
+	// ): void {
+	// 	console.log(
+	// 		`onChannelManagerFundingGenerationReady: ${JSON.stringify(res)}`,
+	// 	); //TODO
+	// }
 
 	private async onChannelManagerPaymentClaimable(
 		res: TChannelManagerClaim,
@@ -2437,6 +2438,39 @@ class LightningManager {
 			remotePersist: true,
 		});
 	}
+
+	/**
+	 * Creates a new channel with the provided peer and then listens for the channel manager funding generation ready event.
+	 * Once event is triggered, those details can be used to create the funding transaction.
+	 */
+	async createChannel(req: TCreateChannelReq): Promise<Result<TChannelManagerFundingGenerationReady>> {
+		const res = await ldk.createChannel(req);
+		if (res.isErr()) {
+			return err(res.error);
+		}
+	
+		return new Promise((resolve, reject) => {
+			// Channel funding ready event should be instant but if it fails and we don't get the event, we should reject.
+			const timeout = setTimeout(() => {
+				reject(err(new Error("Event not triggered within 5 seconds")));
+			}, 5000);
+	
+			// Listen for the event for the channel funding details
+			ldk.onEvent(EEventTypes.channel_manager_funding_generation_ready, (eventRes: TChannelManagerFundingGenerationReady) => {
+				clearTimeout(timeout);
+				resolve(ok(eventRes)); 
+			});
+
+			ldk.onEvent(EEventTypes.channel_manager_channel_closed, (eventRes: TChannelManagerChannelClosed) => {
+				if (eventRes.channel_id === res.value) {
+					clearTimeout(timeout);
+					reject(err("Channel closed before funding"));
+				}
+			});
+		});
+	}
+
+	//TODO: fund channel
 }
 
 export default new LightningManager();

lib/src/lightning-manager.ts

@@ -281,6 +281,12 @@ export type TCloseChannelReq = {
 	force?: boolean;
 };
 
+export type TCreateChannelReq = {
+	counterPartyNodeId: string;
+	channelValueSats: number;
+	pushSats: number;
+};
+
 export type TAcceptChannelReq = {
 	temporaryChannelId: string;
 	counterPartyNodeId: string;