Merge pull request #183 from synonymdev/backup-retries

Remote persist retries

Author: Jasonvdb

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

@@ -45,11 +45,10 @@ enum class EventTypes {
     channel_manager_channel_closed,
     channel_manager_discard_funding,
     channel_manager_payment_claimed,
-    emergency_force_close_channel,
     new_channel,
     network_graph_updated,
     channel_manager_restarted,
-    backup_failed
+    backup_sync_persist_error
 }
 //*****************************************************************
 
@@ -69,7 +68,6 @@ enum class LdkErrors {
     add_peer_fail,
     init_channel_manager,
     decode_invoice_fail,
-    init_invoice_payer,
     invoice_payment_fail_unknown,
     invoice_payment_fail_must_specify_amount,
     invoice_payment_fail_must_not_specify_amount,
@@ -103,7 +101,6 @@ enum class LdkCallbackResponses {
     log_level_updated,
     log_path_updated,
     log_write_success,
-    chain_monitor_init_success,
     keys_manager_init_success,
     channel_manager_init_success,
     config_init_success,
@@ -226,23 +223,6 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
         handleResolve(promise, LdkCallbackResponses.log_write_success)
     }
 
-    @ReactMethod
-    fun initChainMonitor(promise: Promise) {
-        if (chainMonitor !== null) {
-            return handleReject(promise, LdkErrors.already_init)
-        }
-
-        chainMonitor = ChainMonitor.of(
-            Option_FilterZ.some(filter.filter),
-            broadcaster.broadcaster,
-            logger.logger,
-            feeEstimator.feeEstimator,
-            persister.persister
-        )
-
-        handleResolve(promise, LdkCallbackResponses.chain_monitor_init_success)
-    }
-
     @ReactMethod
     fun initKeysManager(seed: String, promise: Promise) {
         if (keysManager !== null) {
@@ -359,7 +339,6 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
             return handleReject(promise, LdkErrors.already_init)
         }
 
-        chainMonitor ?: return handleReject(promise, LdkErrors.init_chain_monitor)
         keysManager ?: return handleReject(promise, LdkErrors.init_keys_manager)
         userConfig ?: return handleReject(promise, LdkErrors.init_user_config)
         networkGraph ?: return handleReject(promise, LdkErrors.init_network_graph)
@@ -393,6 +372,14 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
         val scoringParams = ProbabilisticScoringDecayParameters.with_default()
         val scoringFeeParams = ProbabilisticScoringFeeParameters.with_default()
 
+        chainMonitor = ChainMonitor.of(
+            Option_FilterZ.some(filter.filter),
+            broadcaster.broadcaster,
+            logger.logger,
+            feeEstimator.feeEstimator,
+            persister.persister
+        )
+
         try {
             if (channelManagerSerialized != null) {
                 //Restoring node

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

@@ -174,6 +174,36 @@ class BackupClient {
             }
         }
 
+        @Throws(BackupError::class)
+        fun persist(label: Label, bytes: ByteArray, retry: Int) {
+            var attempts = 0
+            var persistError: Exception? = null
+
+            while (attempts < retry) {
+                try {
+                    persist(label, bytes)
+
+                    LdkEventEmitter.send(
+                        EventTypes.native_log,
+                        "Remote persist success for ${label.string} after ${attempts+1} attempts"
+                    )
+                    return
+                } catch (error: Exception) {
+                    persistError = error
+                    attempts += 1
+                    LdkEventEmitter.send(
+                        EventTypes.native_log,
+                        "Remote persist failed for ${label.string} ($attempts attempts)"
+                    )
+                    Thread.sleep(attempts.toLong()) // Ease off with each attempt
+                }
+            }
+
+            if (persistError != null) {
+                throw persistError
+            }
+        }
+
         @Throws(BackupError::class)
         fun persist(label: Label, bytes: ByteArray) {
             if (skipRemoteBackup) {
@@ -214,6 +244,10 @@ class BackupClient {
                     EventTypes.native_log,
                     "Remote persist failed for ${label.string} with response code ${urlConnection.responseCode}"
                 )
+                LdkEventEmitter.send(
+                    EventTypes.backup_sync_persist_error,
+                    "Response: ${urlConnection.responseMessage}"
+                )
 
                 throw InvalidServerResponse(urlConnection.responseCode)
             }

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

@@ -173,10 +173,9 @@ class LdkChannelManagerPersister: ChannelManagerConstructor.EventHandler {
 
     override fun persist_manager(channel_manager_bytes: ByteArray?) {
         if (channel_manager_bytes != null && LdkModule.accountStoragePath != "") {
+            BackupClient.persist(BackupClient.Label.CHANNEL_MANAGER(), channel_manager_bytes, retry = 100)
             File(LdkModule.accountStoragePath + "/" + LdkFileNames.channel_manager.fileName).writeBytes(channel_manager_bytes)
 
-            BackupClient.persist(BackupClient.Label.CHANNEL_MANAGER(), channel_manager_bytes)
-
             LdkEventEmitter.send(EventTypes.native_log, "Persisted channel manager to disk")
             LdkEventEmitter.send(EventTypes.backup, "")
         }

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

@@ -24,8 +24,8 @@ class LdkPersister {
 
             val isNew = !file.exists()
 
+            BackupClient.persist(BackupClient.Label.CHANNEL_MONITOR(channelId=channelId), data.write(), retry = 100)
             file.writeBytes(data.write())
-            BackupClient.persist(BackupClient.Label.CHANNEL_MONITOR(channelId=channelId), data.write())
 
             LdkEventEmitter.send(EventTypes.native_log, "Persisted channel (${id.to_channel_id().hexEncodedString()}) to disk")
             LdkEventEmitter.send(EventTypes.backup, "")

lib/ios/Classes/BackupClient.swift

@@ -186,6 +186,28 @@ class BackupClient {
             }
         }
     }
+    
+    static func persist(_ label: Label, _ bytes: [UInt8], retry: Int) throws {
+        var attempts: UInt32 = 0
+        
+        var persistError: Error?
+        while attempts < retry {
+            do {
+                try persist(label, bytes)
+                LdkEventEmitter.shared.send(withEvent: .native_log, body: "Remote persist success for \(label.string) after \(attempts+1) attempts")
+                return
+            } catch {
+                persistError = error
+                attempts += 1
+                LdkEventEmitter.shared.send(withEvent: .native_log, body: "Remote persist failed for \(label.string) (\(attempts) attempts)")
+                sleep(attempts) //Ease off with each attempt
+            }
+        }
+        
+        if let persistError {
+            throw persistError
+        }
+    }
 
     static func persist(_ label: Label, _ bytes: [UInt8]) throws {
         struct PersistResponse: Codable {

lib/ios/Classes/LdkChannelManagerPersister.swift

@@ -267,10 +267,10 @@ class LdkChannelManagerPersister: Persister, ExtendedChannelManagerPersister {
         }
 
         do {
+            try BackupClient.persist(.channelManager, channelManager.write(), retry: 100)
+
             try Data(channelManager.write()).write(to: managerStorage)
-            LdkEventEmitter.shared.send(withEvent: .native_log, body: "Persisted channel manager to disk")
-            
-            try BackupClient.persist(.channelManager, channelManager.write())
+            LdkEventEmitter.shared.send(withEvent: .native_log, body: "Persisted channel manager to disk")            
 
             LdkEventEmitter.shared.send(withEvent: .backup, body: "")
 

lib/ios/Classes/LdkPersist.swift

@@ -23,13 +23,12 @@ class LdkPersister: Persist {
 
             let isNew = !FileManager().fileExists(atPath: channelStoragePath.path)
 
+            try BackupClient.persist(.channelMonitor(id: channelId), data.write(), retry: 100)
             try Data(data.write()).write(to: channelStoragePath)
-            try BackupClient.persist(.channelMonitor(id: channelId), data.write())
 
             LdkEventEmitter.shared.send(withEvent: .native_log, body: "Persisted channel (\(channelId)) to disk")
             LdkEventEmitter.shared.send(withEvent: .backup, body: "")
 
-            
             if isNew {
                 LdkEventEmitter.shared.send(
                     withEvent: .new_channel,

lib/ios/Ldk.swift

@@ -25,7 +25,7 @@ enum EventTypes: String, CaseIterable {
     case new_channel = "new_channel"
     case network_graph_updated = "network_graph_updated"
     case channel_manager_restarted = "channel_manager_restarted"
-    case backup_sync_persist_error = "backup_failed"
+    case backup_sync_persist_error = "backup_sync_persist_error"
 }
 //*****************************************************************
 
@@ -45,7 +45,6 @@ enum LdkErrors: String {
     case add_peer_fail = "add_peer_fail"
     case init_channel_manager = "init_channel_manager"
     case decode_invoice_fail = "decode_invoice_fail"
-    case init_invoice_payer = "init_invoice_payer"
     case invoice_payment_fail_unknown = "invoice_payment_fail_unknown"
     case invoice_payment_fail_must_specify_amount = "invoice_payment_fail_must_specify_amount"
     case invoice_payment_fail_must_not_specify_amount = "invoice_payment_fail_must_not_specify_amount"
@@ -82,7 +81,6 @@ enum LdkCallbackResponses: String {
     case log_level_updated = "log_level_updated"
     case log_path_updated = "log_path_updated"
     case log_write_success = "log_write_success"
-    case chain_monitor_init_success = "chain_monitor_init_success"
     case keys_manager_init_success = "keys_manager_init_success"
     case channel_manager_init_success = "channel_manager_init_success"
     case config_init_success = "config_init_success"
@@ -198,23 +196,6 @@ class Ldk: NSObject {
         return handleResolve(resolve, .log_write_success)
     }
 
-    @objc
-    func initChainMonitor(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
-        guard chainMonitor == nil else {
-            return handleReject(reject, .already_init)
-        }
-        
-        chainMonitor = ChainMonitor(
-            chainSource: filter,
-            broadcaster: broadcaster,
-            logger: logger,
-            feeest: feeEstimator,
-            persister: persister
-        )
-        
-        return handleResolve(resolve, .chain_monitor_init_success)
-    }
-    
     @objc
     func initKeysManager(_ seed: NSString, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
         if keysManager != nil {
@@ -344,10 +325,6 @@ class Ldk: NSObject {
             return handleReject(reject, .already_init)
         }
 
-        guard let chainMonitor = chainMonitor else {
-            return handleReject(reject, .init_chain_monitor)
-        }
-        
         guard let keysManager = keysManager else {
             return handleReject(reject, .init_keys_manager)
         }
@@ -392,6 +369,14 @@ class Ldk: NSObject {
         let score = probabilisticScorer.asScore()
         let scorer = MultiThreadedLockableScore(score: score)
 
+        chainMonitor = ChainMonitor(
+            chainSource: filter,
+            broadcaster: broadcaster,
+            logger: logger,
+            feeest: feeEstimator,
+            persister: persister
+        )
+        
         LdkEventEmitter.shared.send(withEvent: .native_log, body: "Enabled P2P gossip: \(enableP2PGossip)")
 
         //        print("\(String(cString: strerror(22)))")
@@ -402,7 +387,7 @@ class Ldk: NSObject {
             nodeSigner: keysManager.asNodeSigner(),
             signerProvider: keysManager.asSignerProvider(),
             feeEstimator: feeEstimator,
-            chainMonitor: chainMonitor,
+            chainMonitor: chainMonitor!,
             txBroadcaster: broadcaster,
             logger: logger,
             enableP2PGossip: enableP2PGossip,
@@ -500,14 +485,6 @@ class Ldk: NSObject {
         channelManager = nil
         peerManager = nil
         peerHandler = nil
-        
-        chainMonitor = ChainMonitor(
-            chainSource: filter,
-            broadcaster: broadcaster,
-            logger: logger,
-            feeest: feeEstimator,
-            persister: persister
-        )
 
         LdkEventEmitter.shared.send(withEvent: .native_log, body: "Starting LDK background tasks again")
         initChannelManager(currentNetwork, blockHash: currentBlockchainTipHash, blockHeight: currentBlockchainHeight) { success in

lib/src/ldk.ts

@@ -80,22 +80,6 @@ class LDK {
 		}
 	}
 
-	/**
-	 * Connected and disconnected blocks must be provided
-	 * https://docs.rs/lightning/latest/lightning/chain/chainmonitor/struct.ChainMonitor.html
-	 * @returns {Promise<Err<unknown> | Ok<Ok<string> | Err<string>>>}
-	 */
-	async initChainMonitor(): Promise<Result<string>> {
-		try {
-			const res = await NativeLDK.initChainMonitor();
-			this.writeDebugToLog('initChainMonitor');
-			return ok(res);
-		} catch (e) {
-			this.writeErrorToLog('initChainMonitor', e);
-			return err(e);
-		}
-	}
-
 	/**
 	 * Private key for node. Used to derive node public key. 32-byte entropy.
 	 * https://docs.rs/lightning/latest/lightning/chain/keysinterface/struct.KeysManager.html
@@ -1129,7 +1113,9 @@ class LDK {
 			this.writeDebugToLog('readFromFile', fileName);
 			return ok({ ...res, timestamp: Math.round(res.timestamp) });
 		} catch (e) {
-			this.writeErrorToLog('readFromFile', e);
+			if (JSON.stringify(e).indexOf('Could not locate file') < 0) {
+				this.writeErrorToLog('readFromFile', e);
+			}
 			return err(e);
 		}
 	}

lib/src/lightning-manager.ts

@@ -435,11 +435,7 @@ class LightningManager {
 		// Lazy loaded in native code
 		// https://docs.rs/lightning/latest/lightning/chain/chainmonitor/trait.Persist.html
 
-		// Step 5: Initialize the ChainMonitor
-		const chainMonitorRes = await ldk.initChainMonitor();
-		if (chainMonitorRes.isErr()) {
-			return this.handleStartError(chainMonitorRes);
-		}
+		// Step 5: Initialize the ChainMonitor (happens when we init the ChannelManager)
 
 		// Step 6: Initialize the KeysManager
 		const keysManager = await ldk.initKeysManager(this.account.seed);