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

chore: prioritize autosharding over static sharding

Browse Source
This commit is contained in:
Danish Arora 2024-10-01 12:00:30 +05:30
parent 83f8290d06
commit e34e764b7f
No known key found for this signature in database
GPG Key ID: 1C6EF37CDAE1426E
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,7 +24,22 @@ 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. 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:
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] }`). For most applications, it's recommended to use autosharding:
```js
// Create node with auto sharding (recommended)
const node = await createLightNode({
defaultBootstrap: true,
networkConfig: {
clusterId: 1,
contentTopics: ["/my-app/1/notifications/proto"],
},
});
```
### Alternative network configuration
If your project requires a specific network configuration, you can use static sharding:
```js
// Create node with static sharding
@ -35,15 +50,6 @@ const node = await createLightNode({
shards: [0, 1, 2, 3],
},
});
// Create node with auto sharding
const node = await createLightNode({
defaultBootstrap: true,
networkConfig: {
clusterId: 1,
contentTopics: ["/my-app/1/notifications/proto"],
},
});
```
## Connect to remote peers