Skip to content

Commit 925d73c

Browse files
committed
specify relay mode
1 parent 9180cf1 commit 925d73c

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

standards/application/messaging-api.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ focusing exclusively on settings explicitly required by the `Messaging API`.
6666

6767
```typescript
6868
{
69-
mode: "edge" | "service";
69+
mode: "edge" | "relay";
7070
clusterId: number;
7171
shards: number[];
7272
storeNodes?: string[];
@@ -86,11 +86,13 @@ This property defines behavior of the node and MUST be specified.
8686
If `edge` selected the node MUST use [LIGHTPUSH](../standards/core/lightpush.md) for sending messages,
8787
and [FILTER](https://github.com/vacp2p/rfc-index/blob/7b443c1aab627894e3f22f5adfbb93f4c4eac4f6/waku/standards/core/12/filter.md) for receiving messages.
8888

89-
If `service` selected the node MUST implement [RELAY](https://github.com/vacp2p/rfc-index/blob/0277fd0c4dbd907dfb2f0c28b6cde94a335e1fae/waku/standards/core/11/relay.md),
90-
[STORE](../standards/core/store.md) as well as host endpoint for [LIGHTPUSH](../standards/core/lightpush.md) and [FILTER](https://github.com/vacp2p/rfc-index/blob/7b443c1aab627894e3f22f5adfbb93f4c4eac4f6/waku/standards/core/12/filter.md).
89+
If `relay` selected the node MUST:
90+
- Implement [RELAY](https://github.com/vacp2p/rfc-index/blob/0277fd0c4dbd907dfb2f0c28b6cde94a335e1fae/waku/standards/core/11/relay.md) protocol.
91+
- Host endpoint for [LIGHTPUSH](../standards/core/lightpush.md) and [FILTER](https://github.com/vacp2p/rfc-index/blob/7b443c1aab627894e3f22f5adfbb93f4c4eac4f6/waku/standards/core/12/filter.md).
92+
- Serve [PEER-EXCHANGE](https://github.com/vacp2p/rfc-index/blob/f08de108457eed828dadbd36339433c586701267/waku/standards/core/34/peer-exchange.md#abstract) protocol.
9193

9294
`edge` mode SHOULD be used if node functions in resource restricted environment,
93-
where as `service` SHOULD be used if node has no hard restrictions.
95+
where as `relay` SHOULD be used if node has no hard restrictions.
9496

9597
##### `clusterId`
9698
This property MUST be provided.
@@ -149,7 +151,7 @@ Instead, the initial configuration MUST be supplied at node creation time accord
149151
The `Send API` is responsible for broadcasting messages across the network using the configured protocol.
150152
The node SHOULD select the appropriate protocol based on its configuration and the protocols that are mounted:
151153
- If the initial configuration specifies mode: "edge", then [LIGHTPUSH](../standards/core/lightpush.md) MUST be used to send messages.
152-
- If the initial configuration specifies mode: "service", then [RELAY](https://github.com/vacp2p/rfc-index/blob/0277fd0c4dbd907dfb2f0c28b6cde94a335e1fae/waku/standards/core/11/relay.md) MUST be used to send messages.
154+
- If the initial configuration specifies mode: "relay", then [RELAY](https://github.com/vacp2p/rfc-index/blob/0277fd0c4dbd907dfb2f0c28b6cde94a335e1fae/waku/standards/core/11/relay.md) MUST be used to send messages.
153155

154156
The `Send API` is also responsible for ensuring message delivery and MUST attempt retries as described in the `Retry` section.
155157

0 commit comments

Comments
 (0)