Skip to content

Commit 6780863

Browse files
authored
Update lightpush.md
1 parent bfe1226 commit 6780863

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

waku/standards/core/19/lightpush.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,24 @@ This specification describes the Waku lightpush protocol used with resource rest
2020
A non-relay node, or a edge node,
2121
are resource restricted devices that have short connection windows and
2222
limited bandwidth.
23-
Edge nodes should be able to send and receive messages in the network.
24-
To accomplish this, the lightpush protocol helps edge nodes push messages to other nodes
23+
Edge nodes should be able to send and receive messages in the network.
24+
To accomplish this,
25+
the lightpush protocol helps edge nodes push messages to other nodes
2526
in the [64/WAKU-NETWORK](/waku/standards/core/64/network.md) for access to message services.
2627
A common use case is to request that a service node publish a message,
2728
received by an edge node, to an [11/WAKU2-RELAY](/waku/standards/core/11/relay.md) pubsub-topic.
28-
Additionally, in some cases, there is a need for confirmation that a message has been received "by the network"
29+
Additionally, in some cases,
30+
there is a need for confirmation that a message has been received "by the network"
2931
(here, at least one node).
3032

3133
## Payloads
34+
3235
The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
33-
“SHOULD NOT”, “RECOMMENDED”, “MAY”, and
36+
“SHOULD NOT”, “RECOMMENDED”, “MAY”, and
3437
“OPTIONAL” in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
3538

36-
Below describes the protobuf stucture used by Waku edge nodes and Waku service nodes who have lightpush enabled (set to `true`):
39+
Below describes the protobuf stucture used by Waku edge nodes and
40+
Waku service nodes who have lightpush enabled (set to `true`):
3741

3842
```protobuf
3943
syntax = "proto3";
@@ -57,7 +61,8 @@ message LightPushResponse {
5761

5862
Nodes that respond to `LightPushRequest` SHOULD
5963

60-
- either relay the encapsulated message via [11/WAKU2-RELAY](/waku/standards/core/11/relay.md) protocol on the specified `pubsub_topic`
64+
- either relay the encapsulated message via
65+
[11/WAKU2-RELAY](/waku/standards/core/11/relay.md) protocol on the specified `pubsub_topic`
6166
- or perform another requested service.
6267
`Services beyond [11/WAKU2-RELAY](/waku/standards/core/11/relay.md) are yet to be defined.`
6368

@@ -70,7 +75,7 @@ it SHOULD return an error code in `LightPushResponse`.
7075
Possible error codes described below.
7176

7277
Once the relay is successful,
73-
the `relay_peer_count` will indicate the number of peers that the node has managed to relay the message to.
78+
the `relay_peer_count` will indicate the number of peers that the node has managed to relay the message to.
7479
It's important to note that this number may vary depending on the node subscriptions and
7580
support for the requested `pubsub_topic`.
7681
The client can use this information to either consider the relay as successful or
@@ -98,6 +103,7 @@ take further action, such as switching to a lightpush service peer with better c
98103
Since this can introduce an amplification factor,
99104
it is RECOMMENDED for the node relaying to the rest of the network to take extra precautions.
100105
Therefore Waku applies or will apply:
106+
101107
- DOS protection through request rate limitation on the service itself.
102108
- message rate limiting via [17/WAKU2-RLN-RELAY](https://rfc.vac.dev/waku/standards/core/17/rln-relay), applied via network membership subscription.
103109

@@ -113,7 +119,7 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
113119

114120
## References
115121

116-
* [11/WAKU2-RELAY](../11/relay.md)
117-
* [WAKU2-DANDELION](https://github.com/waku-org/specs/blob/master/standards/application/dandelion.md)
118-
* [17/WAKU2-RLN-RELAY](../17/rln-relay.md)
119-
* [WAKU2-INCENTIVIZATION](https://github.com/waku-org/specs/blob/master/standards/core/incentivization.md)
122+
- [11/WAKU2-RELAY](../11/relay.md)
123+
- [WAKU2-DANDELION](https://github.com/waku-org/specs/blob/master/standards/application/dandelion.md)
124+
- [17/WAKU2-RLN-RELAY](../17/rln-relay.md)
125+
- [WAKU2-INCENTIVIZATION](https://github.com/waku-org/specs/blob/master/standards/core/incentivization.md)

0 commit comments

Comments
 (0)