diff --git a/docs/guides/js-waku/faq.md b/docs/guides/js-waku/faq.md index 0649222..8a3588a 100644 --- a/docs/guides/js-waku/faq.md +++ b/docs/guides/js-waku/faq.md @@ -1,5 +1,5 @@ --- -title: JavaScript Waku FAQ +title: JavaScript SDK FAQ hide_table_of_contents: true sidebar_label: Frequently Asked Questions --- @@ -7,31 +7,41 @@ sidebar_label: Frequently Asked Questions import { AccordionItem } from '@site/src/components/mdx' + You can add the JavaScript SDK to your project using NPM, Yarn, or a CDN. Check out the installation guide to get started. + Protocol Buffers ensure consistent formatting, interoperability, and backward compatibility for your application's messages, with a smaller payload size than JSON. Check out the installation guide and Protobuf documentation to learn more. - + + Check out the Retrieve Messages Using Store Protocol guide to learn how to retrieve and filter historical messages using the Store protocol. + When creating your message encoder, you can configure the ephemeral option to prevent Store peers from keeping your messages on the Waku Network. + You can encrypt and decrypt your messages using symmetric, ECIES, and noise encryption methods. Check out the Encrypt, Decrypt, and Sign Your Messages guide to get started. + Waku has a specialized SDK designed for building React applications. Check out the Build React DApps Using @waku/react guide for instructions on installation and usage. - + + The JavaScript SDK has a default bootstrap method that can be configured with Static Peers and DNS Discovery. Check out the Bootstrap Nodes and Discover Peers guide for setting up peer discovery for your node. + Though the JavaScript SDK isn't directly usable in NodeJS due to certain limitations, we suggest running nwaku in a Docker container and consuming its REST API in a NodeJS application. + Check out the Debug Your Waku DApp and WebSocket guide to discover how to use debug logs to troubleshoot your Waku DApp and resolve connection issues with nwaku WebSockets. + We recommend regularly pinging peers to check for an active connection and reinitiating the subscription when it disconnects. Check out the Manage Your Filter Subscriptions guide for a detailed explanation and step-by-step instructions. \ No newline at end of file diff --git a/docs/guides/js-waku/light-send-receive.md b/docs/guides/js-waku/light-send-receive.md index fd52bc3..02bfa67 100644 --- a/docs/guides/js-waku/light-send-receive.md +++ b/docs/guides/js-waku/light-send-receive.md @@ -62,12 +62,12 @@ const encoder = createEncoder({ contentTopic }); const decoder = createDecoder(contentTopic); ``` -The `ephemeral` option allows you to specify whether messages should not be stored by [Store peers](/guides/js-waku/store-retrieve-messages): +The `ephemeral` option allows you to specify whether messages should **NOT** be stored by [Store peers](/guides/js-waku/store-retrieve-messages): ```js const encoder = createEncoder({ contentTopic: contentTopic, // message content topic - ephemeral: true, // allows messages not be stored on the network + ephemeral: true, // allows messages NOT be stored on the network }); ``` diff --git a/docs/guides/js-waku/run-waku-nodejs.md b/docs/guides/js-waku/run-waku-nodejs.md index 0346974..cf995df 100644 --- a/docs/guides/js-waku/run-waku-nodejs.md +++ b/docs/guides/js-waku/run-waku-nodejs.md @@ -27,7 +27,7 @@ Certain features in `@waku/sdk` are tailored for browsers and might not translat ## Recommendations -Before using `@waku/sdk` in a NodeJS environment, take into account these limitations. For a more optimised solution, we recommend [running nwaku in a Docker container](/guides/nwaku/run-docker) and consuming its [REST API](https://waku-org.github.io/waku-rest-api/). +Before using `@waku/sdk` in a NodeJS environment, take into account these limitations. For a more optimised solution, we recommend [running nwaku in a Docker container](/guides/nwaku/run-docker-compose) and consuming its [REST API](https://waku-org.github.io/waku-rest-api/). ## Future developments diff --git a/docs/guides/js-waku/use-waku-react.md b/docs/guides/js-waku/use-waku-react.md index 2aa50b6..163e14e 100644 --- a/docs/guides/js-waku/use-waku-react.md +++ b/docs/guides/js-waku/use-waku-react.md @@ -294,5 +294,5 @@ To explore the available Store query options, have a look at the [Retrieve Messa ::: :::tip -You have successfully integrated `@waku/sdk` into a React application using the `@waku/react` package. Have a look at the [web-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/web-chat) example for a working demo. +You have successfully integrated `@waku/sdk` into a React application using the `@waku/react` package. Have a look at the [web-chat](https://github.com/waku-org/js-waku-examples/tree/master/examples/web-chat) example for a working demo and the [Building a Tic-Tac-Toe Game with Waku](https://blog.waku.org/tictactoe-tutorial) tutorial to learn more. ::: \ No newline at end of file