Merge pull request #102 from logos-messaging/add-debug-api

.wordlist.txt

@@ -36,7 +36,11 @@ EventSource
 eventType
 fb
 fBF
+getAvailableConfigs
+getAvailableNodeInfoIds
+getAvailableNodeInfoItems
 getMerkleRoot
+getNodeInfo
 github
 GITHUB
 gossipsub
@@ -54,6 +58,7 @@ Init
 ipv
 iterable
 Jazzz
+JSON
 KiB
 Kozlov
 libp
@@ -76,6 +81,7 @@ NetworkingConfig
 nim
 nodeConfig
 NodeConfig
+nodeInfoId
 num
 Oleksandr
 onEvent

standards/application/waku-api.md

@@ -561,6 +561,32 @@ although performance or reliability may still be impacted.
 `Connected` indicates that the node is operating optimally,
 with full support for message reception and transmission.
 
+### Debug
+
+#### Debug function definitions
+
+```yaml
+functions:
+  getAvailableNodeInfoIds:
+    description: "Returns a list of available node information identifiers. e.g., [ version, my_peer_id, metrics ]."
+    returns:
+      type: result<array<string>, error>
+
+  getNodeInfo:
+    description: "Returns the JSON formatted node's information that is requested. Expect single value or list results depending on requested information."
+    parameters:
+      - name: nodeInfoId
+        type: string
+        description: "Information identifier. The only supported values are the ones returned by getAvailableNodeInfoItems function."
+    returns:
+      type: result<string, error>
+
+  getAvailableConfigs:
+    description: "Returns a list of all available options, their description and default values."
+    returns:
+      type: string
+```
+
 ## The Validation API
 
 [WAKU2-RLN-RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md) is currently the primary message validation mechanism in place.