From 424ea61cdc89cb7a8181275a4f50e440b5c60a70 Mon Sep 17 00:00:00 2001 From: Ivan Folgueira Bande Date: Wed, 25 Feb 2026 14:31:07 +0100 Subject: [PATCH 1/6] add debug API --- standards/application/waku-api.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/standards/application/waku-api.md b/standards/application/waku-api.md index fe633ff..33a2da9 100644 --- a/standards/application/waku-api.md +++ b/standards/application/waku-api.md @@ -561,6 +561,27 @@ 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, error> + + getNodeInfo: + description: "Returns the node's information that is requested" + parameters: + - name: nodeInfoId + type: string + description: "Information identifier. The only supported values are the ones returned by getAvailableNodeInfoItems function" + returns: + type: result +``` + ## 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. From 66a75584db36153919807abdae522a6301eb6a8d Mon Sep 17 00:00:00 2001 From: Ivan Folgueira Bande Date: Fri, 27 Feb 2026 14:49:47 +0100 Subject: [PATCH 2/6] add getAvailableConfigs into debug API --- standards/application/waku-api.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/standards/application/waku-api.md b/standards/application/waku-api.md index 33a2da9..518f72b 100644 --- a/standards/application/waku-api.md +++ b/standards/application/waku-api.md @@ -573,13 +573,18 @@ functions: type: result, error> getNodeInfo: - description: "Returns the node's information that is requested" + description: "Returns the node's information that is requested." parameters: - name: nodeInfoId type: string - description: "Information identifier. The only supported values are the ones returned by getAvailableNodeInfoItems function" + description: "Information identifier. The only supported values are the ones returned by getAvailableNodeInfoItems function." returns: type: result + + getAvailableConfigs: + description: "Returns a list of all available options, their description and default values." + returns: + type: string ``` ## The Validation API From 63f8bc428292b1c4e5294ffbffe72cd1ecf1eb44 Mon Sep 17 00:00:00 2001 From: Ivan Folgueira Bande Date: Fri, 27 Feb 2026 14:58:03 +0100 Subject: [PATCH 3/6] add new terms in .wordlist.txt to make speller happy --- .wordlist.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.wordlist.txt b/.wordlist.txt index 1889016..197b7e4 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -36,7 +36,9 @@ EventSource eventType fb fBF +getAvailableNodeInfoItems getMerkleRoot +getNodeInfo github GITHUB gossipsub @@ -76,6 +78,7 @@ NetworkingConfig nim nodeConfig NodeConfig +nodeInfoId num Oleksandr onEvent From a35f47dfbe7d5d254f6fd944cf6b045413f5c147 Mon Sep 17 00:00:00 2001 From: Ivan Folgueira Bande Date: Fri, 27 Feb 2026 14:59:58 +0100 Subject: [PATCH 4/6] adjust comment as per Zoltan's recommendation --- standards/application/waku-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/standards/application/waku-api.md b/standards/application/waku-api.md index 518f72b..2f38096 100644 --- a/standards/application/waku-api.md +++ b/standards/application/waku-api.md @@ -573,7 +573,7 @@ functions: type: result, error> getNodeInfo: - description: "Returns the node's information that is requested." + 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 From 296dbe943ec33fbdf9587b91058c2f1b2d7a5e2e Mon Sep 17 00:00:00 2001 From: Ivan Folgueira Bande Date: Fri, 27 Feb 2026 15:13:06 +0100 Subject: [PATCH 5/6] add misspelled words exceptions --- .wordlist.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.wordlist.txt b/.wordlist.txt index 197b7e4..86f95ad 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -36,6 +36,7 @@ EventSource eventType fb fBF +getAvailableConfigs getAvailableNodeInfoItems getMerkleRoot getNodeInfo @@ -56,6 +57,7 @@ Init ipv iterable Jazzz +JSON KiB Kozlov libp From 46caf0cc4d86bfc5d39f722e3500bc89e6e0c5ec Mon Sep 17 00:00:00 2001 From: Ivan Folgueira Bande Date: Fri, 27 Feb 2026 15:14:20 +0100 Subject: [PATCH 6/6] same as previous commit --- .wordlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.wordlist.txt b/.wordlist.txt index 86f95ad..e5562d0 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -37,6 +37,7 @@ eventType fb fBF getAvailableConfigs +getAvailableNodeInfoIds getAvailableNodeInfoItems getMerkleRoot getNodeInfo