Merge pull request #94 from synonymdev/graph-debugging

Jasonvdb · web-flow · commit 4d7e15c07ffa · 2022-12-13T10:05:52.000+02:00
Additional logging and graph debugging
diff --git a/example/App.tsx b/example/App.tsx
@@ -424,16 +424,14 @@ const App = (): ReactElement => {
 								return setMessage(decode.error.message);
 							}
 
-							const { recover_payee_pub_key, amount_satoshis } = decode.value;
+							const { amount_satoshis, description } = decode.value;
 
 							const ownAmountSats = 1000;
 							Alert.alert(
 								amount_satoshis
 									? `Pay ${amount_satoshis ?? 0}`
 									: 'Zero sat invoice found',
-								amount_satoshis
-									? `To pubkey: ${recover_payee_pub_key}`
-									: `Send ${ownAmountSats} sats (Our chosen amount) to send over?`,
+								description,
 								[
 									{
 										text: 'Cancel',
@@ -461,26 +459,33 @@ const App = (): ReactElement => {
 					/>
 
 					<Button
-						title={'Get network graph'}
+						title={'Get network graph nodes'}
 						onPress={async (): Promise<void> => {
-							const nodesRes = await ldk.completeGraphNodes();
+							const nodesRes = await ldk.networkGraphListNodeIds();
 							if (nodesRes.isErr()) {
 								return setMessage(nodesRes.error.message);
 							}
 
-							const channelRes = await ldk.completeGraphChannels();
-							if (channelRes.isErr()) {
-								return setMessage(channelRes.error.message);
+							let msg = `Nodes (${nodesRes.value.length}): \n`;
+
+							const nodes = await ldk.networkGraphNodes(nodesRes.value);
+							if (nodes.isOk()) {
+								nodes.value.forEach((node) => {
+									const {
+										id,
+										shortChannelIds,
+										lowest_inbound_channel_fees_base_sat,
+										announcement_info_last_update,
+									} = node;
+									const time = new Date(announcement_info_last_update);
+
+									msg += `\n\n${id}\nChannels: ${shortChannelIds.length}\n`;
+									msg += `Lowest inbound fee: ${lowest_inbound_channel_fees_base_sat} sat\n`;
+									msg += `Last announcement: ${time}`;
+								});
 							}
 
-							const nodes = `Nodes:\n\n${nodesRes.value.map(
-								(node) => `\n${JSON.stringify(node)}`,
-							)}`;
-							const channels = `Channels:\n\n${channelRes.value.map(
-								(channel) => `\n${JSON.stringify(channel)}`,
-							)}`;
-
-							setMessage(`${nodes}\n${channels}`);
+							setMessage(`${msg}`);
 						}}
 					/>
 
diff --git a/lib/android/src/main/java/com/reactnativeldk/Helpers.kt b/lib/android/src/main/java/com/reactnativeldk/Helpers.kt
@@ -10,7 +10,9 @@ import java.net.URL
 import java.nio.channels.Channels
 
 fun handleResolve(promise: Promise, res: LdkCallbackResponses) {
-    LdkEventEmitter.send(EventTypes.native_log, "Success: ${res}")
+    if (res != LdkCallbackResponses.log_write_success) {
+        LdkEventEmitter.send(EventTypes.native_log, "Success: ${res}")
+    }
     promise.resolve(res.toString());
 }
 
@@ -144,8 +146,10 @@ val NodeInfo.asJson: WritableMap
 
         val shortChannelIds = Arguments.createArray()
         _channels.iterator().forEach { shortChannelIds.pushString(it.toString()) }
-        result.putArray("channels", shortChannelIds)
-
+        result.putArray("shortChannelIds", shortChannelIds)
+        result.putInt("lowest_inbound_channel_fees_base_sat", (_lowest_inbound_channel_fees?._base_msat ?: 0) / 1000)
+        result.putInt("lowest_inbound_channel_fees_proportional_millionths", _lowest_inbound_channel_fees?._proportional_millionths ?: 0)
+        result.putDouble("announcement_info_last_update", (_announcement_info?._last_update ?: 0).toDouble() * 1000)
         return result
     }
 
diff --git a/lib/android/src/main/java/com/reactnativeldk/LdkModule.kt b/lib/android/src/main/java/com/reactnativeldk/LdkModule.kt
@@ -92,6 +92,7 @@ enum class LdkCallbackResponses {
     fees_updated,
     log_level_updated,
     log_path_updated,
+    log_write_success,
     chain_monitor_init_success,
     keys_manager_init_success,
     channel_manager_init_success,
@@ -200,6 +201,13 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
         handleResolve(promise, LdkCallbackResponses.log_path_updated)
     }
 
+    @ReactMethod
+    fun writeToLogFile(line: String, promise: Promise) {
+        LogFile.write(line)
+
+        handleResolve(promise, LdkCallbackResponses.log_write_success)
+    }
+
     @ReactMethod
     fun initChainMonitor(promise: Promise) {
         if (chainMonitor !== null) {
@@ -794,7 +802,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
     }
 
     @ReactMethod
-    fun networkGraphListNodes(promise: Promise) {
+    fun networkGraphListNodeIds(promise: Promise) {
         val graph = networkGraph?.read_only() ?: return handleReject(promise, LdkErrors.init_network_graph)
 
         val total = graph.list_nodes().count()
@@ -809,11 +817,24 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
     }
 
     @ReactMethod
-    fun networkGraphNode(nodeId: String, promise: Promise) {
+    fun networkGraphNodes(nodeIds: ReadableArray, promise: Promise) {
         val graph = networkGraph?.read_only() ?: return handleReject(promise, LdkErrors.init_network_graph)
 
-        val id = NodeId.from_pubkey(nodeId.hexa())
-        promise.resolve(graph.node(id)?.asJson)
+        val graphNodes = graph.list_nodes().map { it.as_slice().hexEncodedString() }
+
+        //Filter out nodes we don't know about as querying unknown nodes will cause a crash
+        val includedList: List<String> = nodeIds.toArrayList().map { it as String }.filter { graphNodes.contains(it) }
+
+        val list = Arguments.createArray()
+        includedList.forEach {
+            val node = graph.node(NodeId.from_pubkey(it.hexa()))?.asJson
+            if (node != null) {
+                node.putString("id", it)
+                list.pushMap(node)
+            }
+        }
+
+        promise.resolve(list)
     }
 
     @ReactMethod
diff --git a/lib/android/src/main/java/com/reactnativeldk/classes/LdkLogger.kt b/lib/android/src/main/java/com/reactnativeldk/classes/LdkLogger.kt
@@ -9,9 +9,23 @@ import java.io.File
 class LdkLogger {
     var activeLevels = HashMap<Int, Boolean>()
     var logger = Logger.new_impl{ record: Record ->
-        if (activeLevels[record._level.ordinal] == true) {
+        val level = record._level.ordinal
+        if (activeLevels[level] == true) {
             LdkEventEmitter.send(EventTypes.ldk_log, record._args)
-            LogFile.write(record._args)
+
+            var levelStr = "LEVEL $level"
+            when (level) {
+                0 -> levelStr = "GOSSIP"
+                1 -> levelStr = "TRACE"
+                2 -> levelStr = "DEBUG"
+                3 -> levelStr = "INFO"
+                4 -> levelStr = "WARN"
+                5 -> levelStr = "ERROR"
+            }
+
+            LogFile.write( "$levelStr (LDK): ${record._args}")
+        } else {
+            println("Skipping log level $level")
         }
     }
 
@@ -25,15 +39,18 @@ object LogFile {
     private var logFile: File? = null
 
     fun setFilePath(logFile: File) {
-        if (!logFile!!.isFile) {
-            logFile!!.createNewFile()
+        if (!logFile.isFile) {
+            logFile.createNewFile()
         }
+
+        this.logFile = logFile
     }
 
     fun write(str: String) {
         if (logFile == null) {
             return
         }
+
         logFile!!.appendText("${str}\n")
     }
 }
diff --git a/lib/ios/Classes/LdkLogger.swift b/lib/ios/Classes/LdkLogger.swift
@@ -21,7 +21,32 @@ class LdkLogger: Logger {
         //Only when the JS code has set the log level to active
         if activeLevels[level] == true {
             LdkEventEmitter.shared.send(withEvent: .ldk_log, body: record.get_args())
-            Logfile.log.write(record.get_args())
+            
+            var levelStr = ""
+            switch level {
+            case 0:
+                levelStr = "GOSSIP"
+                break
+            case 1:
+                levelStr = "TRACE"
+                break
+            case 2:
+                levelStr = "DEBUG"
+                break
+            case 3:
+                levelStr = "INFO"
+                break
+            case 4:
+                levelStr = "WARN"
+                break
+            case 5:
+                levelStr = "ERROR"
+                break
+            default:
+                levelStr = "LEVEL \(level)"
+            }
+                        
+            Logfile.log.write("\(levelStr) (LDK): \(record.get_args())")
         }
     }
     
diff --git a/lib/ios/Helpers.swift b/lib/ios/Helpers.swift
@@ -9,7 +9,9 @@ import Foundation
 import LightningDevKit
 
 func handleResolve(_ resolve: RCTPromiseResolveBlock, _ res: LdkCallbackResponses) {
-    LdkEventEmitter.shared.send(withEvent: .native_log, body: "Success: \(res.rawValue)")
+    if res != .log_write_success {
+        LdkEventEmitter.shared.send(withEvent: .native_log, body: "Success: \(res.rawValue)")
+    }
     resolve(res.rawValue)
 }
 
@@ -116,10 +118,12 @@ extension ChannelInfo {
 
 //Nodes in our network graph
 extension NodeInfo {
-    var asJson: Any {
+    var asJson: [String: Any] {
         return [
             "shortChannelIds": get_channels().map({ String($0) }),
-            //TODO gathering other details results in EXC_BAD_ACCESS. Test with next version of LDK.
+            "lowest_inbound_channel_fees_base_sat": get_lowest_inbound_channel_fees().get_base_msat() / 1000,
+            "lowest_inbound_channel_fees_proportional_millionths": get_lowest_inbound_channel_fees().get_proportional_millionths(),
+            "announcement_info_last_update": Int(get_announcement_info().get_last_update()) * 1000
         ]
     }
 }
diff --git a/lib/ios/Ldk.m b/lib/ios/Ldk.m
@@ -10,6 +10,9 @@ @interface RCT_EXTERN_MODULE(Ldk, NSObject)
 RCT_EXTERN_METHOD(setLogFilePath:(NSString *)path
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(writeToLogFile:(NSString *)line
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(initChainMonitor:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(initKeysManager:(NSString *)seed
@@ -86,14 +89,14 @@ @interface RCT_EXTERN_MODULE(Ldk, NSObject)
                   reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(listChannelFiles:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
-RCT_EXTERN_METHOD(networkGraphListNodes:(RCTPromiseResolveBlock)resolve
+RCT_EXTERN_METHOD(networkGraphListNodeIds:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(networkGraphListChannels:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(networkGraphChannel:(NSString *)shortChannelId
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
-RCT_EXTERN_METHOD(networkGraphNode:(NSString *)nodeId
+RCT_EXTERN_METHOD(networkGraphNodes:(NSArray *)nodeIds
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 RCT_EXTERN_METHOD(claimableBalances:(BOOL *)ignoreOpenChannels
diff --git a/lib/ios/Ldk.swift b/lib/ios/Ldk.swift
@@ -71,6 +71,7 @@ enum LdkCallbackResponses: String {
     case fees_updated = "fees_updated"
     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"
@@ -174,6 +175,12 @@ class Ldk: NSObject {
         return handleResolve(resolve, .log_path_updated)
     }
 
+    @objc
+    func writeToLogFile(_ line: NSString, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+        Logfile.log.write(String(line))
+        return handleResolve(resolve, .log_write_success)
+    }
+    
     @objc
     func initChainMonitor(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
         guard chainMonitor == nil else {
@@ -250,13 +257,14 @@ class Ldk: NSObject {
             if read.isOk() {
                 networkGraph = read.getValue()
                 LdkEventEmitter.shared.send(withEvent: .native_log, body: "Loaded network graph from file")
-
             }
         } catch {
             networkGraph = NetworkGraph(genesis_hash: String(genesisHash).hexaBytes, logger: logger)
             LdkEventEmitter.shared.send(withEvent: .native_log, body: "Failed to load cached network graph from disk. Will sync from scratch. \(error.localizedDescription)")
         }
         
+        print("rapidGossipSyncUrl: \(rapidGossipSyncUrl)")
+        
         //Download url passed, enable rapid gossip sync
         if rapidGossipSyncUrl != "" {
             do {
@@ -377,6 +385,8 @@ class Ldk: NSObject {
             channelMonitorsSerialized.append([UInt8](try! Data(contentsOf: channelFile.standardizedFileURL)))
         }
         
+        print("enableP2PGossip \(enableP2PGossip)")
+        
         do {
             //Only restore a node if we have existing channel monitors to restore. Else we lose our UserConfig settings when restoring.
             if let channelManagerSerialized = storedChannelManager, channelMonitorsSerialized.count > 0 {
@@ -430,6 +440,10 @@ class Ldk: NSObject {
         peerHandler = channelManagerConstructor!.getTCPPeerHandler()
         invoicePayer = channelManagerConstructor!.payer
         
+        if enableP2PGossip {
+            self.networkGraph = channelManagerConstructor!.net_graph
+        }
+        
         return handleResolve(resolve, .channel_manager_init_success)
     }
     
@@ -819,7 +833,7 @@ class Ldk: NSObject {
     }
     
     @objc
-    func networkGraphListNodes(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    func networkGraphListNodeIds(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
         guard let networkGraph = networkGraph?.read_only() else {
             return handleReject(reject, .init_network_graph)
         }
@@ -833,20 +847,31 @@ class Ldk: NSObject {
     }
     
     @objc
-    func networkGraphNode(_ nodeId: NSString, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    func networkGraphNodes(_ nodeIds: NSArray, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
         guard let networkGraph = networkGraph?.read_only() else {
             return handleReject(reject, .init_network_graph)
         }
+        
+        let graphNodes = networkGraph.list_nodes().map { Data($0.as_slice()).hexEncodedString() }
+        
+        //Filter out nodes we don't know about as querying unknown nodes will cause a crash
+        let includedList = nodeIds.map({ $0 as! String }).filter { id in
+            return graphNodes.contains { id == $0 }
+        }
                 
-        return resolve(networkGraph.node(node_id: NodeId(pubkey: String(nodeId).hexaBytes)).asJson)
+        return resolve(includedList.map({ id in
+            var info = networkGraph.node(node_id: NodeId(pubkey: id.hexaBytes)).asJson
+            info["id"] = id
+            return info
+        }))
     }
     
     @objc
     func networkGraphListChannels(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
         guard let networkGraph = networkGraph?.read_only() else {
             return handleReject(reject, .init_network_graph)
         }
-        
+                
         let total = networkGraph.list_channels().count
         if total > 100 {
             return handleReject(reject, .data_too_large_for_rn, nil, "Too many channels to return (\(total))")
@@ -861,7 +886,14 @@ class Ldk: NSObject {
             return handleReject(reject, .init_network_graph)
         }
         
-        return resolve(networkGraph.channel(short_channel_id: UInt64(shortChannelId as String)!).asJson)
+        let channelId = String(shortChannelId)
+        
+        let channels = networkGraph.list_channels()
+        if !channels.contains{ channelId == String($0) } {
+            return handleReject(reject, .init_network_graph)
+        }
+        
+        return resolve(networkGraph.channel(short_channel_id: UInt64(channelId)!).asJson)
     }
     
     @objc
diff --git a/lib/src/ldk.ts b/lib/src/ldk.ts
diff --git a/lib/src/lightning-manager.ts b/lib/src/lightning-manager.ts
diff --git a/lib/src/utils/result.ts b/lib/src/utils/result.ts
diff --git a/lib/src/utils/types.ts b/lib/src/utils/types.ts

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,9 @@ import Foundation`
`9`	`9`	`import LightningDevKit`
`10`	`10`
`11`	`11`	`func handleResolve(_ resolve: RCTPromiseResolveBlock, _ res: LdkCallbackResponses) {`
`12`		`- LdkEventEmitter.shared.send(withEvent: .native_log, body: "Success: \(res.rawValue)")`
	`12`	`+ if res != .log_write_success {`
	`13`	`+ LdkEventEmitter.shared.send(withEvent: .native_log, body: "Success: \(res.rawValue)")`
	`14`	`+ }`
`13`	`15`	`resolve(res.rawValue)`
`14`	`16`	`}`
`15`	`17`
`@@ -116,10 +118,12 @@ extension ChannelInfo {`
`116`	`118`
`117`	`119`	`//Nodes in our network graph`
`118`	`120`	`extension NodeInfo {`
`119`		`- var asJson: Any {`
	`121`	`+ var asJson: [String: Any] {`
`120`	`122`	`return [`
`121`	`123`	`"shortChannelIds": get_channels().map({ String($0) }),`
`122`		`- //TODO gathering other details results in EXC_BAD_ACCESS. Test with next version of LDK.`
	`124`	`+ "lowest_inbound_channel_fees_base_sat": get_lowest_inbound_channel_fees().get_base_msat() / 1000,`
	`125`	`+ "lowest_inbound_channel_fees_proportional_millionths": get_lowest_inbound_channel_fees().get_proportional_millionths(),`
	`126`	`+ "announcement_info_last_update": Int(get_announcement_info().get_last_update()) * 1000`
`123`	`127`	`]`
`124`	`128`	`}`
`125`	`129`	`}`