waku-org
/
specs
mirror of https://github.com/waku-org/specs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Made relay_peer_count field optional

This commit is contained in:
NagyZoltanPeter 2024-06-26 14:05:52 +02:00 committed by GitHub
parent 6127e7a360
commit 103b6fccf0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
standards/core/lightpush.md
View File

@ -38,7 +38,7 @@ message LightPushResponse {
string request_id = 1;
uint32 status_code = 10; // non zero in case of failure, see appendix
optional string status_desc = 11;
uint32 relay_peer_count = 12; // number of peers, message is successfully relayed to
optional uint32 relay_peer_count = 12; // number of peers, message is successfully relayed to
}
```
@ -47,6 +47,7 @@ message LightPushResponse {
Nodes that respond to `LightPushRequest` MUST either relay the encapsulated message via [11/WAKU2-RELAY](https://rfc.vac.dev/waku/standards/core/11/relay) protocol on the specified `pubsub_topic`. Depending on the network configuration, the user may not need to provide `pubsub_topic` ([WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)).
If the node is unable to do so for some reason, they SHOULD return an error code in `LightPushResponse`.
Once the relay is successful, the `relay_peer_count` will indicate the number of peers that the node has managed to relay the message to. It's important to note that this number may vary depending on the node subscriptions and support for the requested pubsub_topic. The client can use this information to either consider the relay as successful or take further action, such as switching to a lightpush service peer with better connectivity.
The field `relay_peer_count` may not present or has the value zero in case of error or in other future use cases, where no relay is involved.
### Examples of possible error codes