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

feat: introduce new waitForPeers API (#226)

Browse Source
This commit is contained in:
Sasha 2024-10-11 12:05:07 +02:00 committed by GitHub
parent 1b2affe15e
commit 2b0258ade2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guides/js-waku/configure-discovery.md
View File

@ -191,10 +191,10 @@ const node = await createLightNode({
You can retrieve the array of peers connected to a node using the `libp2p.getPeers()` function within the `@waku/sdk` package: You can retrieve the array of peers connected to a node using the `libp2p.getPeers()` function within the `@waku/sdk` package:
```js ```js
import { createLightNode, waitForRemotePeer } from "@waku/sdk"; import { createLightNode } from "@waku/sdk";
const node = await createLightNode({ defaultBootstrap: true }); const node = await createLightNode({ defaultBootstrap: true });
await waitForRemotePeer(node); await node.waitForPeers();
// Retrieve array of peers connected to the node // Retrieve array of peers connected to the node
console.log(node.libp2p.getPeers()); console.log(node.libp2p.getPeers());

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

@ -54,22 +54,20 @@ const node = await createLightNode({
## Connect to remote peers ## Connect to remote peers
Use the `waitForRemotePeer()` function to wait for the node to connect with peers on the Waku Network: Use the `node.waitForPeers()` function to wait for the node to connect with peers on the Waku Network:
```js ```js
import { waitForRemotePeer } from "@waku/sdk";
// Wait for a successful peer connection // Wait for a successful peer connection
await waitForRemotePeer(node); await node.waitForPeers();
``` ```
The `protocols` parameter allows you to specify the [protocols](/learn/concepts/protocols) that the remote peers should have enabled: The `protocols` parameter allows you to specify the [protocols](/learn/concepts/protocols) that the remote peers should have enabled:
```js ```js
import { waitForRemotePeer, Protocols } from "@waku/sdk"; import { Protocols } from "@waku/sdk";
// Wait for peer connections with specific protocols // Wait for peer connections with specific protocols
await waitForRemotePeer(node, [Protocols.LightPush, Protocols.Filter]); await node.waitForPeers([Protocols.LightPush, Protocols.Filter]);
``` ```
## Choose a content topic ## Choose a content topic

6
docs/guides/js-waku/store-retrieve-messages.md
View File

@ -19,13 +19,13 @@ await node.start();
## Connect to store peers ## Connect to store peers
Use the `waitForRemotePeer()` function to wait for the node to connect with Store peers: Use the `node.waitForPeers()` method to wait for the node to connect with Store peers:
```js ```js
import { waitForRemotePeer, Protocols } from "@waku/sdk"; import { Protocols } from "@waku/sdk";
// Wait for a successful peer connection // Wait for a successful peer connection
await waitForRemotePeer(node, [Protocols.Store]); await node.waitForPeers([Protocols.Store]);
``` ```
## Choose a content topic ## Choose a content topic