docs.waku.org/assets/js/a494bfbc.57ff26f9.js

(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[2675],{53958:(e,t,o)=>{"use strict";var a=o(83639);o.o(a,"AccordionItem")&&o.d(t,{AccordionItem:function(){return a.AccordionItem}})},43815:(e,t,o)=>{"use strict";o.r(t),o.d(t,{assets:()=>u,contentTitle:()=>r,default:()=>g,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var a=o(87462),i=(o(67294),o(3905)),s=o(53958);const n={title:"JavaScript SDK FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},r=void 0,c={unversionedId:"guides/js-waku/faq",id:"guides/js-waku/faq",title:"JavaScript SDK FAQ",description:"You can add the JavaScript SDK to your project using NPM, Yarn, or a CDN. Check out the installation guide to get started.",source:"@site/docs/guides/js-waku/faq.md",sourceDirName:"guides/js-waku",slug:"/guides/js-waku/faq",permalink:"/guides/js-waku/faq",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/guides/js-waku/faq.md",tags:[],version:"current",lastUpdatedAt:1719443789,formattedLastUpdatedAt:"26 Jun 2024",frontMatter:{title:"JavaScript SDK FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},sidebar:"guides",previous:{title:"Manage Your Filter Subscriptions",permalink:"/guides/js-waku/manage-filter"}},u={},d=[],p={toc:d},k="wrapper";function g(e){let{components:t,...o}=e;return(0,i.kt)(k,(0,a.Z)({},p,o,{components:t,mdxType:"MDXLayout"}),(0,i.kt)(s.AccordionItem,{title:"How do I install the @waku/sdk package in my project?",mdxType:"AccordionItem"},"You can add the JavaScript SDK to your project using NPM, Yarn, or a CDN. Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/#installation"},"installation guide")," to get started."),(0,i.kt)(s.AccordionItem,{title:"Why should I use Protocol Buffers for my application's message structure when using Waku?",mdxType:"AccordionItem"},"Protocol Buffers ensure consistent formatting, interoperability, and backward compatibility for your application's messages, with a smaller payload size than JSON. Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/#message-structure"},"installation guide")," and ",(0,i.kt)("a",{href:"https://protobuf.dev/overview/"},"Protobuf documentation")," to learn more."),(0,i.kt)(s.AccordionItem,{title:"What are the steps to retrieve historical messages on Waku?",mdxType:"AccordionItem"},"Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/store-retrieve-messages"},"Retrieve Messages Using Store Protocol")," guide to learn how to retrieve and filter historical messages using the ",(0,i.kt)("a",{href:"/learn/concepts/protocols#store"},"Store protocol"),"."),(0,i.kt)(s.AccordionItem,{title:"How can I prevent Store peers from storing my messages?",mdxType:"AccordionItem"},"When ",(0,i.kt)("a",{href:"/guides/js-waku/light-send-receive#choose-a-content-topic"},"creating your message encoder"),", you can configure the ",(0,i.kt)("strong",null,"ephemeral")," option to prevent Store peers from keeping your messages on the Waku Network."),(0,i.kt)(s.AccordionItem,{title:"How can I encrypt, decrypt, and sign messages in my Waku application?",mdxType:"AccordionItem"},"You can encrypt and decrypt your messages using symmetric, ECIES, and noise encryption methods. Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/message-encryption"},"Encrypt, Decrypt, and Sign Your Messages")," guide to get started."),(0,i.kt)(s.AccordionItem,{title:"How do I integrate Waku into a React application?",mdxType:"AccordionItem"},"Waku has a specialized SDK designed for building React applications. Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/use-waku-react"},"Build React DApps Using @waku/react")," guide for instructions on installation and usage."),(0,i.kt)(s.AccordionItem,{title:"How can I bootstrap and discover peers in the Waku Network for browser nodes?",mdxType:"AccordionItem"},"The JavaScript SDK has a ",(0,i.kt)("a",{href:"/guides/js-waku/configure-discovery#default-bootstrap-method"},"default bootstrap method")," that can be configured with ",(0,i.kt)("a",{href:"/learn/concepts/static-peers"},"Static Peers")," and ",(0,i.kt)("a",{href:"/learn/concepts/dns-discovery"},"DNS Discovery"),". Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/configure-discovery"},"Bootstrap Nodes and Discover Peers")," guide for setting up peer discovery for your node."),(0,i.kt)(s.AccordionItem,{title:"How can I integrate Waku into a NodeJS application?",mdxType:"AccordionItem"},"Though the JavaScript SDK isn't directly usable in NodeJS due to ",(0,i.kt)("a",{href:"/guides/js-waku/run-waku-nodejs"},"certain limitations"),", we recommend running ",(0,i.kt)("a",{href:"/guides/nwaku/run-docker-compose"},"nwaku in a Docker container")," and consuming its ",(0,i.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/"},"REST API")," in a NodeJS application."),(0,i.kt)(s.AccordionItem,{title:"How can I debug my Waku DApp and check WebSocket connections?",mdxType:"AccordionItem"},"Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/debug-waku-dapp"},"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."),(0,i.kt)(s.AccordionItem,{title:"How can I manage unexpected disconnections of my Filter subscription from Waku?",mdxType:"AccordionItem"},"We recommend regularly pinging peers to check for an active connection and reinitiating the subscription when it disconnects. Check out the ",(0,i.kt)("a",{href:"/guides/js-waku/manage-filter"},"Manage Your Filter Subscriptions")," guide for a detailed explanation and step-by-step instructions."),(0,i.kt)(s.AccordionItem,{title:"How can I send images and videos on the Waku Network?",mdxType:"AccordionItem"},"While it's possible to transmit media such as images as bytes on Waku, we recommend uploading your media to a CDN or a file system like ",(0,i.kt)("a",{href:"https://ipfs.tech/"},"IPFS")," and then sharing the corresponding URL via Waku."),(0,i.kt)(s.AccordionItem,{title:"How can I connect to my own node?",mdxType:"AccordionItem"},"To manually set your own node as a starting point use ",(0,i.kt)("a",{href:"/guides/js-waku/configure-discovery#configure-static-peers"},"Configure static peers"),"."))}g.isMDXComponent=!0},46102:()=>{}}]);