fix: save addresses only when used for closing a channel

Author: Jasonvdb

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

@@ -54,7 +54,8 @@ enum class EventTypes {
     network_graph_updated,
     channel_manager_restarted,
     backup_state_update,
-    lsp_log
+    lsp_log,
+    used_close_address
 }
 //*****************************************************************
 
@@ -242,7 +243,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
     }
 
     @ReactMethod
-    fun initKeysManager(seed: String, destinationScriptPublicKey: String, witnessProgram: String, witnessProgramVersion: Double, promise: Promise) {
+    fun initKeysManager(seed: String, address: String, destinationScriptPublicKey: String, witnessProgram: String, witnessProgramVersion: Double, promise: Promise) {
         if (keysManager != null) {
             return handleResolve(promise, LdkCallbackResponses.keys_manager_init_success)
         }
@@ -259,11 +260,11 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
             seedBytes,
             seconds,
             nanoSeconds.toInt(),
+            address,
             destinationScriptPublicKey.hexa(),
             witnessProgram.hexa(),
             witnessProgramVersion.toInt().toByte()
         )
-        //keysManager = KeysManager.of(seedBytes, seconds, nanoSeconds.toInt())
 
         handleResolve(promise, LdkCallbackResponses.keys_manager_init_success)
     }

lib/android/src/main/java/com/reactnativeldk/classes/CustomKeysManager.kt

@@ -22,6 +22,7 @@ class CustomKeysManager(
     seed: ByteArray,
     startingTimeSecs: Long,
     startingTimeNanos: Int,
+    val address: String,
     val destinationScriptPublicKey: ByteArray,
     val witnessProgram: ByteArray,
     val witnessProgramVersion: Byte
@@ -68,6 +69,7 @@ class CustomSignerProvider : SignerProviderInterface {
         val res = ShutdownScript.new_witness_program(witness)
 
         return if (res.is_ok) {
+            LdkEventEmitter.send(EventTypes.used_close_address, customKeysManager.address)
             Result_ShutdownScriptNoneZ.ok((res as Result_ShutdownScriptInvalidShutdownScriptZ.Result_ShutdownScriptInvalidShutdownScriptZ_OK).res)
         } else {
             Result_ShutdownScriptNoneZ.err()

lib/ios/Classes/CustomKeysManager.swift

@@ -11,12 +11,14 @@ import LightningDevKit
 class CustomKeysManager {
     let inner: KeysManager
     let signerProvider: CustomSignerProvider
+    let address: String
     let destinationScriptPublicKey: [UInt8]
     let witnessProgram: [UInt8]
     let witnessProgramVersion: UInt8
 
-    init(seed: [UInt8], startingTimeSecs: UInt64, startingTimeNanos: UInt32, destinationScriptPublicKey: [UInt8], witnessProgram: [UInt8], witnessProgramVersion: UInt8) {
+    init(seed: [UInt8], startingTimeSecs: UInt64, startingTimeNanos: UInt32, address: String, destinationScriptPublicKey: [UInt8], witnessProgram: [UInt8], witnessProgramVersion: UInt8) {
         self.inner = KeysManager(seed: seed, startingTimeSecs: startingTimeSecs, startingTimeNanos: startingTimeNanos)
+        self.address = address
         self.destinationScriptPublicKey = destinationScriptPublicKey
         self.witnessProgram = witnessProgram
         self.witnessProgramVersion = witnessProgramVersion
@@ -61,6 +63,8 @@ class CustomSignerProvider: SignerProvider {
     override func getShutdownScriptpubkey() -> Bindings.Result_ShutdownScriptNoneZ {
         let res = ShutdownScript.newWitnessProgram(witnessProgram: .init(version: customKeysManager!.witnessProgramVersion, program: customKeysManager!.witnessProgram))
         if res.isOk() {
+            //To record which addresses should be watched for close channel funds
+            LdkEventEmitter.shared.send(withEvent: .used_close_address, body: customKeysManager!.address)
             return Bindings.Result_ShutdownScriptNoneZ.initWithOk(o: res.getValue()!)
         }
 

lib/ios/Ldk.m

@@ -16,6 +16,7 @@ @interface RCT_EXTERN_MODULE(Ldk, NSObject)
 RCT_EXTERN_METHOD(initChainMonitor:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(initKeysManager:(NSString *)seed
+                  address:(NSString *)address
                   destinationScriptPublicKey:(NSString *)destinationScriptPublicKey
                   witnessProgram:(NSString *)witnessProgram
                   witnessProgramVersion:(NSInteger *)witnessProgramVersion                  

lib/ios/Ldk.swift

@@ -26,6 +26,7 @@ enum EventTypes: String, CaseIterable {
     case channel_manager_restarted = "channel_manager_restarted"
     case backup_state_update = "backup_state_update"
     case lsp_log = "lsp_log"
+    case used_close_address = "used_close_address"
 }
 //*****************************************************************
 
@@ -210,7 +211,7 @@ class Ldk: NSObject {
     }
 
     @objc
-    func initKeysManager(_ seed: NSString, destinationScriptPublicKey: NSString, witnessProgram: NSString, witnessProgramVersion: NSInteger, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    func initKeysManager(_ seed: NSString, address: NSString, destinationScriptPublicKey: NSString, witnessProgram: NSString, witnessProgramVersion: NSInteger, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
         if keysManager != nil {
             //If previously started with the same key (by backup client) return success.
             return handleResolve(resolve, .keys_manager_init_success)
@@ -228,6 +229,7 @@ class Ldk: NSObject {
             seed: String(seed).hexaBytes,
             startingTimeSecs: seconds,
             startingTimeNanos: nanoSeconds,
+            address: String(address),
             destinationScriptPublicKey: String(destinationScriptPublicKey).hexaBytes,
             witnessProgram: String(witnessProgram).hexaBytes,
             witnessProgramVersion: UInt8(witnessProgramVersion)

lib/package.json

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

lib/src/ldk.ts

@@ -95,13 +95,15 @@ class LDK {
 	 */
 	async initKeysManager({
 		seed,
+		address,
 		channelCloseDestinationScriptPublicKey,
 		channelCloseWitnessProgram,
 		channelCloseWitnessProgramVersion,
 	}: TInitKeysManager): Promise<Result<string>> {
 		try {
 			const res = await NativeLDK.initKeysManager(
 				seed,
+				address,
 				channelCloseDestinationScriptPublicKey,
 				channelCloseWitnessProgram,
 				channelCloseWitnessProgramVersion,

lib/src/lightning-manager.ts

@@ -232,6 +232,9 @@ class LightningManager {
 			this.onChannelManagerRestarted.bind(this),
 		);
 		ldk.onEvent(EEventTypes.lsp_log, this.onLspLogEvent.bind(this));
+		ldk.onEvent(EEventTypes.used_close_address, (address: string) => {
+			this.saveAddressToFile(address).catch(console.error);
+		});
 	}
 
 	/**
@@ -364,14 +367,7 @@ class LightningManager {
 		this.account = account;
 		this.network = network;
 		this.addresses = await this.readAddressesFromFile();
-		this.getAddress = async () => {
-			const addressObj = await getAddress();
-			const address = addressObj?.address;
-			if (address) {
-				this.saveAddressToFile(address).then();
-			}
-			return addressObj;
-		};
+		this.getAddress = getAddress;
 		this.getScriptPubKeyHistory = getScriptPubKeyHistory;
 		this.getFees = getFees;
 		this.broadcastTransaction = broadcastTransaction;
@@ -452,6 +448,7 @@ class LightningManager {
 			// ldk.setLogLevel(ELdkLogLevels.trace, true),
 			ldk.initKeysManager({
 				seed: this.account.seed,
+				address: closeAddress.address,
 				channelCloseDestinationScriptPublicKey: closeAddress.publicKey,
 				channelCloseWitnessProgram: witnessProgram,
 				channelCloseWitnessProgramVersion: witnessProgramVersion,
@@ -513,6 +510,7 @@ class LightningManager {
 		ldk.nodeStateDump().catch(console.error);
 
 		this.cleanupBroadcastedTxs().catch(console.error);
+		this.resetAddressFileIfUnused().catch(console.error);
 
 		this.isStarting = false;
 		const result = ok('Node started');
@@ -769,6 +767,37 @@ class LightningManager {
 		return ok('Watch transactions checked');
 	};
 
+	/*
+	 * Previously we were writing all addresses to file even
+	 * if they may not have been used in a channel shutdown script or
+	 * force close sweeping. So reset the file if there is no evidence of prior channels.
+	 * */
+	resetAddressFileIfUnused = async (): Promise<void> => {
+		//If no channel files found and no addresses are being used, reset the address file.
+		const channelFilesRes = await ldk.listChannelFiles();
+		if (channelFilesRes.isErr()) {
+			return;
+		}
+
+		if (channelFilesRes.value.length > 0) {
+			return;
+		}
+
+		const accountPath = appendPath(this.baseStoragePath, this.account.name);
+		const writeRes = await ldk.writeToFile({
+			fileName: ELdkFiles.addresses,
+			path: accountPath,
+			content: JSON.stringify([]),
+			remotePersist: false,
+		});
+
+		this.addresses = [];
+
+		if (writeRes.isErr()) {
+			console.error(writeRes.error);
+		}
+	};
+
 	saveAddressToFile = async (address: string): Promise<Result<boolean>> => {
 		if (!address) {
 			return err('No address provided');
@@ -1822,6 +1851,7 @@ class LightningManager {
 					changeDestinationScript: changeDestinationScript,
 				};
 				const res = await ldk.reconstructAndSpendOutputs(req);
+				await this.saveAddressToFile(address.address);
 
 				if (res.isOk()) {
 					reconstructedTxs++;
@@ -2127,6 +2157,7 @@ class LightningManager {
 		res: TChannelManagerSpendableOutputs,
 	): Promise<void> {
 		const spendableOutputs = await this.getLdkSpendableOutputs();
+
 		res.outputsSerialized.forEach((o) => {
 			if (!spendableOutputs.includes(o)) {
 				spendableOutputs.push(o);
@@ -2172,6 +2203,9 @@ class LightningManager {
 			return;
 		}
 
+		//Address was used to sweep to so wallet needs to watch it
+		await this.saveAddressToFile(address.address);
+
 		await ldk.writeToLogFile(
 			'info',
 			`Created tx spending outputs: ${spendRes.value}`,

lib/src/utils/types.ts

@@ -35,6 +35,7 @@ export enum EEventTypes {
 	channel_manager_restarted = 'channel_manager_restarted',
 	backup_state_update = 'backup_state_update',
 	lsp_log = 'lsp_log',
+	used_close_address = 'used_close_address',
 }
 
 //LDK event responses
@@ -326,6 +327,7 @@ export type TDownloadScorer = {
 
 export type TInitKeysManager = {
 	seed: string;
+	address: string;
 	channelCloseDestinationScriptPublicKey: string;
 	channelCloseWitnessProgram: string;
 	channelCloseWitnessProgramVersion: number;