logos-messaging/docs.waku.org
1
0
Fork 0
mirror of https://github.com/logos-messaging/docs.waku.org.git synced 2026-01-02 12:53:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update guide for v0.027

Browse Source
This commit is contained in:
Danish Arora 2024-09-30 23:26:47 +05:30
parent 25668984a1
commit 51766a8427
No known key found for this signature in database
GPG Key ID: 1C6EF37CDAE1426E
1 changed files with 23 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/guides/js-waku/light-send-receive.md
View File

@ -24,20 +24,25 @@ await node.start();
When the `defaultBootstrap` parameter is set to `true`, your node will be bootstrapped using the [default bootstrap method](/guides/js-waku/configure-discovery#default-bootstrap-method). Have a look at the [Bootstrap Nodes and Discover Peers](/guides/js-waku/configure-discovery) guide to learn more methods to bootstrap nodes.
:::
A node needs to know how to route messages. In order to do that you can use standard pubsub topic (`/waku/2/default-waku/proto`). If your project uses a different pubsub topic, you can configure this by providing a set of [content topics](/learn/concepts/content-topics) for the node to use with the `contentTopics` parameter or by using the `ShardInfo` parameter:
A node needs to know how to route messages. By default, it will use The Waku Network configuration (`{ clusterId: 1, shards: [0,1,2,3,4,5,6,7] }`). If your project uses a different network configuration, you can configure this using the `networkConfig` parameter:
```js
// Create node with content topics
// Create node with static sharding
const node = await createLightNode({
defaultBootstrap: true,
contentTopics: [/*set of content topics*/],
networkConfig: {
clusterId: 1,
shards: [0, 1, 2, 3],
},
});
// Create node with custom shard info
const shardInfo = { clusterId: 3, shards: [1, 2] };
// Create node with auto sharding
const node = await createLightNode({
defaultBootstrap: true,
shardInfo: shardInfo,
networkConfig: {
clusterId: 1,
contentTopics: ["/my-app/1/notifications/proto"],
},
});
```
@ -85,18 +90,18 @@ const encoder = createEncoder({
});
```
The `pubsubTopicShardInfo` parameter allows you to configure a different shared pubsub topic for your `encoder` and `decoder`:
The `pubsubTopicShardInfo` parameter allows you to configure a different network configuration for your `encoder` and `decoder`:
```js
// Create the shard info
const shardInfo = { clusterId: 3, shard: 1 };
// Create the network config
const networkConfig = { clusterId: 3, shards: [1, 2] };
// Create encoder and decoder with custom shard info
// Create encoder and decoder with custom network config
const encoder = createEncoder({
contentTopic: contentTopic,
pubsubTopicShardInfo: shardInfo,
pubsubTopicShardInfo: networkConfig,
});
const decoder = createDecoder(contentTopic, shardInfo);
const decoder = createDecoder(contentTopic, networkConfig);
```
:::info
@ -168,14 +173,14 @@ if (error) {
await subscription.subscribe([decoder], callback);
```
The `pubsubTopicShardInfo` parameter allows you to configure a different shared pubsub topic for your `Filter` subscription:
The `pubsubTopicShardInfo` parameter allows you to configure a different network configuration for your `Filter` subscription:
```js
// Create the shard info
const shardInfo = { clusterId: 3, shard: 1 };
// Create the network config
const networkConfig = { clusterId: 3, shards: [1, 2] };
// Create Filter subscription with custom shard info
const subscription = await node.filter.createSubscription(shardInfo);
// Create Filter subscription with custom network config
const subscription = await node.filter.createSubscription(networkConfig);
```
You can use the `subscription.unsubscribe()` function to stop receiving messages from a content topic:
@ -186,4 +191,4 @@ await subscription.unsubscribe([contentTopic]);
:::tip Congratulations!
You have successfully sent and received messages over the Waku Network using the `Light Push` and `Filter` protocols. Have a look at the [light-js](https://github.com/waku-org/js-waku-examples/tree/master/examples/light-js) and [light-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/light-chat) examples for working demos.
:::
:::