From 24a6e28398b007d3794f463003b9aa65f6a6476d Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Mon, 25 Sep 2023 16:50:35 +0200 Subject: [PATCH 1/7] Create README.md --- content/docs/rfcs/66/README.md | 35 ++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 content/docs/rfcs/66/README.md diff --git a/content/docs/rfcs/66/README.md b/content/docs/rfcs/66/README.md new file mode 100644 index 000000000..bc38ba102 --- /dev/null +++ b/content/docs/rfcs/66/README.md @@ -0,0 +1,35 @@ +--- +slug: 66 +title: 66/WAKU2-METADATA +name: Waku Metadata Protocol +status: raw +editor: Alvaro Revuelta +contributors: +--- + +# Metadata Protocol + +Waku specifies a req/resp protocol that provides information about the node medatadata. + + +## protocol id + +`/vac/waku/metadata/1.0.0` + +## request + +```proto +message WakuMetadataRequest { +} +``` + +## response + +```proto +message WakuMessageResponse { + uint64 network_id = 1; + uint64 rln_tree_block = 2; + bytes rln_root = 3; + TODO: capabilities? +} +``` From 97dc8184d316e00679dea2cd9f71af21824a7e95 Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Mon, 25 Sep 2023 16:53:30 +0200 Subject: [PATCH 2/7] Update index.md --- content/menu/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/menu/index.md b/content/menu/index.md index 689686a09..1e349b72b 100644 --- a/content/menu/index.md +++ b/content/menu/index.md @@ -26,6 +26,7 @@ bookMenuLevels: 1 - [61/STATUS-Community-History-Archives]({{< relref "/docs/rfcs/61/README.md" >}}) - [63/STATUS-Keycard-Usage]({{< relref "/docs/rfcs/63/README.md" >}}) - [64/WAKU2-NETWORK]({{< relref "/docs/rfcs/64/README.md" >}}) + - [66/WAKU2-METADATA]({{< relref "/docs/rfcs/66/README.md" >}}) - Draft - [1/COSS]({{< relref "/docs/rfcs/1/README.md" >}}) - [3/REMOTE-LOG]({{< relref "/docs/rfcs/3/README.md" >}}) From 3f01712be7adb4c3035ef30574639450639cca5e Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Tue, 26 Sep 2023 09:00:42 +0200 Subject: [PATCH 3/7] Update README.md --- content/docs/rfcs/66/README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/content/docs/rfcs/66/README.md b/content/docs/rfcs/66/README.md index bc38ba102..48d51ffeb 100644 --- a/content/docs/rfcs/66/README.md +++ b/content/docs/rfcs/66/README.md @@ -9,27 +9,24 @@ contributors: # Metadata Protocol -Waku specifies a req/resp protocol that provides information about the node medatadata. +Waku specifies a req/resp protocol that provides information about the node's medatadata. -## protocol id +## Protocol id `/vac/waku/metadata/1.0.0` -## request +## Request ```proto message WakuMetadataRequest { } ``` -## response +## Response ```proto message WakuMessageResponse { uint64 network_id = 1; - uint64 rln_tree_block = 2; - bytes rln_root = 3; - TODO: capabilities? } ``` From d381ee1bbdaf033a4561eda773048117e2be731d Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Fri, 29 Sep 2023 12:50:43 +0200 Subject: [PATCH 4/7] Update README.md --- content/docs/rfcs/66/README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/content/docs/rfcs/66/README.md b/content/docs/rfcs/66/README.md index 48d51ffeb..2e5f17f50 100644 --- a/content/docs/rfcs/66/README.md +++ b/content/docs/rfcs/66/README.md @@ -9,7 +9,11 @@ contributors: # Metadata Protocol -Waku specifies a req/resp protocol that provides information about the node's medatadata. +Waku specifies a req/resp protocol that provides information about the node's medatadata. Such metadata is meant to be used +by the node to decide if a peer is worth connecting or not. The node that makes the request, includes its metadata +so that the receiver is aware of it, without requiring an extra interaction. The parameters are the following: +* `networkId`: Unique identifier of the network that the node is running in. +* `shards`: Shard indexes that the node is subscribed to. ## Protocol id @@ -20,13 +24,16 @@ Waku specifies a req/resp protocol that provides information about the node's me ```proto message WakuMetadataRequest { + uint32 network_id = 1; + repeated unt32 shards = 2; } ``` ## Response ```proto -message WakuMessageResponse { - uint64 network_id = 1; +message WakuMetadataResponse { + uint32 network_id = 1; + repeated unt32 shards = 2; } ``` From 285670710300ce1e6a1a33053836c51e357942fc Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Mon, 2 Oct 2023 09:29:59 +0200 Subject: [PATCH 5/7] Update README.md --- content/docs/rfcs/66/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/rfcs/66/README.md b/content/docs/rfcs/66/README.md index 2e5f17f50..1539b7db0 100644 --- a/content/docs/rfcs/66/README.md +++ b/content/docs/rfcs/66/README.md @@ -24,8 +24,8 @@ so that the receiver is aware of it, without requiring an extra interaction. The ```proto message WakuMetadataRequest { - uint32 network_id = 1; - repeated unt32 shards = 2; + optional uint32 network_id = 1; + repeated uint32 shards = 2; } ``` @@ -33,7 +33,7 @@ message WakuMetadataRequest { ```proto message WakuMetadataResponse { - uint32 network_id = 1; - repeated unt32 shards = 2; + optional uint32 network_id = 1; + repeated uint32 shards = 2; } ``` From 7d8cbec9790566bf0020f30464eb0eaf1186eae1 Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Tue, 3 Oct 2023 13:53:40 +0200 Subject: [PATCH 6/7] Update README.md --- content/docs/rfcs/66/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/rfcs/66/README.md b/content/docs/rfcs/66/README.md index 1539b7db0..0d02b3737 100644 --- a/content/docs/rfcs/66/README.md +++ b/content/docs/rfcs/66/README.md @@ -12,7 +12,7 @@ contributors: Waku specifies a req/resp protocol that provides information about the node's medatadata. Such metadata is meant to be used by the node to decide if a peer is worth connecting or not. The node that makes the request, includes its metadata so that the receiver is aware of it, without requiring an extra interaction. The parameters are the following: -* `networkId`: Unique identifier of the network that the node is running in. +* `clusterId`: Unique identifier of the network that the node is running in. * `shards`: Shard indexes that the node is subscribed to. @@ -24,7 +24,7 @@ so that the receiver is aware of it, without requiring an extra interaction. The ```proto message WakuMetadataRequest { - optional uint32 network_id = 1; + optional uint32 cluster_id = 1; repeated uint32 shards = 2; } ``` @@ -33,7 +33,7 @@ message WakuMetadataRequest { ```proto message WakuMetadataResponse { - optional uint32 network_id = 1; + optional uint32 cluster_id = 1; repeated uint32 shards = 2; } ``` From 79831da6de6f7a9a27dabe32144d15d075826852 Mon Sep 17 00:00:00 2001 From: Alvaro Revuelta Date: Tue, 3 Oct 2023 17:13:10 +0200 Subject: [PATCH 7/7] Update README.md --- content/docs/rfcs/66/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/rfcs/66/README.md b/content/docs/rfcs/66/README.md index 0d02b3737..e034fc98e 100644 --- a/content/docs/rfcs/66/README.md +++ b/content/docs/rfcs/66/README.md @@ -12,7 +12,7 @@ contributors: Waku specifies a req/resp protocol that provides information about the node's medatadata. Such metadata is meant to be used by the node to decide if a peer is worth connecting or not. The node that makes the request, includes its metadata so that the receiver is aware of it, without requiring an extra interaction. The parameters are the following: -* `clusterId`: Unique identifier of the network that the node is running in. +* `clusterId`: Unique identifier of the cluster that the node is running in. * `shards`: Shard indexes that the node is subscribed to.