Update documentation

assets/js/1067bd84.bf87ac87.js

@@ -0,0 +1 @@
+(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[5447],{53958:(e,o,t)=>{"use strict";var r=t(83639);t.o(r,"AccordionItem")&&t.d(o,{AccordionItem:function(){return r.AccordionItem}})},45173:(e,o,t)=>{"use strict";t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var r=t(87462),a=(t(67294),t(3905)),n=t(53958);const s={title:"Waku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},i=void 0,l={unversionedId:"learn/faq",id:"learn/faq",title:"Waku FAQ",description:"Check out the Getting Started guide to explore our numerous SDKs and learn how to run a Waku node.",source:"@site/docs/learn/faq.md",sourceDirName:"learn",slug:"/learn/faq",permalink:"/learn/faq",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/learn/faq.md",tags:[],version:"current",frontMatter:{title:"Waku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},sidebar:"learn",previous:{title:"Glossary",permalink:"/learn/glossary"}},c={},d=[],u={toc:d},m="wrapper";function p(e){let{components:o,...t}=e;return(0,a.kt)(m,(0,r.Z)({},u,t,{components:o,mdxType:"MDXLayout"}),(0,a.kt)(n.AccordionItem,{title:"How can I start building my application using Waku?",mdxType:"AccordionItem"},"Check out the ",(0,a.kt)("a",{href:"/"},"Getting Started")," guide to explore our numerous SDKs and learn how to run a Waku node."),(0,a.kt)(n.AccordionItem,{title:"Does messaging on Waku require a gas fee?",mdxType:"AccordionItem"},"No, sending and receiving messages on Waku involves no gas fee."),(0,a.kt)(n.AccordionItem,{title:"What encryption does Waku use?",mdxType:"AccordionItem"},"Waku uses libp2p noise encryption for node-to-node connections. However, no default encryption method is applied to the data sent over the network. This design choice enhances Waku's encryption flexibility, encouraging developers to use custom protocols or Waku message payload encryption methods freely."),(0,a.kt)(n.AccordionItem,{title:"Where does Waku store the messages?",mdxType:"AccordionItem"},"Waku's ",(0,a.kt)("a",{href:"/learn/concepts/protocols#store"},"Store protocol")," is designed to temporarily store messages within the network. However, Waku does not guarantee the message's availability and recommends using ",(0,a.kt)("a",{href:"https://codex.storage/"},"Codex")," for long-term storage."),(0,a.kt)(n.AccordionItem,{title:"Can Waku only be used for wallet-to-wallet messaging?",mdxType:"AccordionItem"},"No, Waku is flexible and imposes no specific rules on identifiers."),(0,a.kt)(n.AccordionItem,{title:"How does Waku differ from IPFS?",mdxType:"AccordionItem"},"Waku focuses on short, ephemeral, real-time messages, while IPFS focuses on large, long-term data storage. Although there's an overlap between the two technologies, Waku does not currently support large data for privacy reasons."),(0,a.kt)(n.AccordionItem,{title:"What are Rate Limiting Nullifiers (RLN)?",mdxType:"AccordionItem"},(0,a.kt)("a",{href:"/learn/concepts/protocols#rln-relay"},"Rate Limiting Nullifier")," is a zero-knowledge (ZK) protocol enabling spam protection in a decentralized network while preserving privacy. Each message must be accompanied by a ZK proof, which ",(0,a.kt)("a",{href:"/learn/concepts/protocols#relay"},"Relay")," nodes verify to ensure the publishers do not send more messages than they are allowed. The ZK proof does not leak any private information about message publishers - it only proves they are members of a set of users allowed to publish a certain number of messages per given time frame."),(0,a.kt)(n.AccordionItem,{title:"How to start a Waku node?",mdxType:"AccordionItem"},"Follow the README instructions at ",(0,a.kt)("a",{href:"https://docs.waku.org/guides/nwaku/run-node"},"nwaku-compose"),"."))}p.isMDXComponent=!0},46102:()=>{}}]);

assets/js/1067bd84.c56a7d7f.js

@@ -1 +0,0 @@
-(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[5447],{53958:(e,t,o)=>{"use strict";var a=o(83639);o.o(a,"AccordionItem")&&o.d(t,{AccordionItem:function(){return a.AccordionItem}})},45173:(e,t,o)=>{"use strict";o.r(t),o.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var a=o(87462),r=(o(67294),o(3905)),n=o(53958);const s={title:"Waku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},i=void 0,d={unversionedId:"learn/faq",id:"learn/faq",title:"Waku FAQ",description:"Check out the Getting Started guide to explore our numerous SDKs and learn how to run a Waku node.",source:"@site/docs/learn/faq.md",sourceDirName:"learn",slug:"/learn/faq",permalink:"/learn/faq",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/learn/faq.md",tags:[],version:"current",lastUpdatedAt:1727750487,formattedLastUpdatedAt:"1 Oct 2024",frontMatter:{title:"Waku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},sidebar:"learn",previous:{title:"Glossary",permalink:"/learn/glossary"}},l={},c=[],u={toc:c},m="wrapper";function p(e){let{components:t,...o}=e;return(0,r.kt)(m,(0,a.Z)({},u,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)(n.AccordionItem,{title:"How can I start building my application using Waku?",mdxType:"AccordionItem"},"Check out the ",(0,r.kt)("a",{href:"/"},"Getting Started")," guide to explore our numerous SDKs and learn how to run a Waku node."),(0,r.kt)(n.AccordionItem,{title:"Does messaging on Waku require a gas fee?",mdxType:"AccordionItem"},"No, sending and receiving messages on Waku involves no gas fee."),(0,r.kt)(n.AccordionItem,{title:"What encryption does Waku use?",mdxType:"AccordionItem"},"Waku uses libp2p noise encryption for node-to-node connections. However, no default encryption method is applied to the data sent over the network. This design choice enhances Waku's encryption flexibility, encouraging developers to use custom protocols or Waku message payload encryption methods freely."),(0,r.kt)(n.AccordionItem,{title:"Where does Waku store the messages?",mdxType:"AccordionItem"},"Waku's ",(0,r.kt)("a",{href:"/learn/concepts/protocols#store"},"Store protocol")," is designed to temporarily store messages within the network. However, Waku does not guarantee the message's availability and recommends using ",(0,r.kt)("a",{href:"https://codex.storage/"},"Codex")," for long-term storage."),(0,r.kt)(n.AccordionItem,{title:"Can Waku only be used for wallet-to-wallet messaging?",mdxType:"AccordionItem"},"No, Waku is flexible and imposes no specific rules on identifiers."),(0,r.kt)(n.AccordionItem,{title:"How does Waku differ from IPFS?",mdxType:"AccordionItem"},"Waku focuses on short, ephemeral, real-time messages, while IPFS focuses on large, long-term data storage. Although there's an overlap between the two technologies, Waku does not currently support large data for privacy reasons."),(0,r.kt)(n.AccordionItem,{title:"What are Rate Limiting Nullifiers (RLN)?",mdxType:"AccordionItem"},(0,r.kt)("a",{href:"/learn/concepts/protocols#rln-relay"},"Rate Limiting Nullifier")," is a zero-knowledge (ZK) protocol enabling spam protection in a decentralized network while preserving privacy. Each message must be accompanied by a ZK proof, which ",(0,r.kt)("a",{href:"/learn/concepts/protocols#relay"},"Relay")," nodes verify to ensure the publishers do not send more messages than they are allowed. The ZK proof does not leak any private information about message publishers - it only proves they are members of a set of users allowed to publish a certain number of messages per given time frame."),(0,r.kt)(n.AccordionItem,{title:"How to start a Waku node?",mdxType:"AccordionItem"},"Follow the README instructions at ",(0,r.kt)("a",{href:"https://docs.waku.org/guides/nwaku/run-node"},"nwaku-compose"),"."))}p.isMDXComponent=!0},46102:()=>{}}]);

assets/js/20987266.4d20d509.js

@@ -1 +0,0 @@
-(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[7442],{53958:(e,o,n)=>{"use strict";var t=n(83639);n.o(t,"AccordionItem")&&n.d(o,{AccordionItem:function(){return t.AccordionItem}})},26820:(e,o,n)=>{"use strict";n.r(o),n.d(o,{assets:()=>s,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>u,toc:()=>c});var t=n(87462),a=(n(67294),n(3905)),i=n(53958);const r={title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},d=void 0,u={unversionedId:"guides/nwaku/faq",id:"guides/nwaku/faq",title:"Nwaku FAQ",description:"Check out the Run Nwaku with Docker Compose guide to learn the simplest and fastest way to run a node. You can also check the comprehensive Run a Nwaku Node guide to explore other options like downloading binaries and building from source.",source:"@site/docs/guides/nwaku/faq.md",sourceDirName:"guides/nwaku",slug:"/guides/nwaku/faq",permalink:"/guides/nwaku/faq",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/guides/nwaku/faq.md",tags:[],version:"current",lastUpdatedAt:1709637863,formattedLastUpdatedAt:"5 Mar 2024",frontMatter:{title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},sidebar:"guides",previous:{title:"Node Configuration Examples",permalink:"/guides/nwaku/configure-nwaku"},next:{title:"Upgrade Instructions",permalink:"/guides/nwaku/upgrade-instructions"}},s={},c=[],k={toc:c},g="wrapper";function h(e){let{components:o,...n}=e;return(0,a.kt)(g,(0,t.Z)({},k,n,{components:o,mdxType:"MDXLayout"}),(0,a.kt)(i.AccordionItem,{title:"How can I run a Waku node?",mdxType:"AccordionItem"},"Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/run-docker-compose"},"Run Nwaku with Docker Compose")," guide to learn the simplest and fastest way to run a node. You can also check the comprehensive ",(0,a.kt)("a",{href:"/guides/nwaku/run-node"},"Run a Nwaku Node")," guide to explore other options like ",(0,a.kt)("a",{href:"/guides/nwaku/run-node#download-the-binary"},"downloading binaries")," and ",(0,a.kt)("a",{href:"/guides/nwaku/build-source"},"building from source"),"."),(0,a.kt)(i.AccordionItem,{title:"What are the system requirements for running a node?",mdxType:"AccordionItem"},"We recommend running a nwaku node with at least 2GB of RAM, especially if WSS is enabled. If running just a Relay node, 0.5GB of RAM is sufficient."),(0,a.kt)(i.AccordionItem,{title:"How can I interact with my running nwaku node?",mdxType:"AccordionItem"},"You can interact with a running nwaku node using the ",(0,a.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/"},"REST API interface")," or the ",(0,a.kt)("a",{href:"/guides/js-waku/"},"JavaScript Waku SDK"),"."),(0,a.kt)(i.AccordionItem,{title:"How can I view the logs of a nwaku node running in Docker?",mdxType:"AccordionItem"},'To check your node logs in Docker, use the command: "docker-compose logs -f nwaku"'),(0,a.kt)(i.AccordionItem,{title:"What configuration methods are available for nwaku nodes?",mdxType:"AccordionItem"},"You can configure Nwaku nodes using command line options and flags, environment variables, and TOML configuration files. Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/config-methods"},"Node Configuration Methods")," guide to understand their usage and priority."),(0,a.kt)(i.AccordionItem,{title:"How can I configure my nwaku node before running?",mdxType:"AccordionItem"},"Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/config-options"},"Node Configuration Options")," guide for available node configuration options, their default values and descriptions. For examples of common configuration use cases, visit the ",(0,a.kt)("a",{href:"/guides/nwaku/configure-nwaku"},"Node Configuration Examples")," guide."),(0,a.kt)(i.AccordionItem,{title:"What peer discovery mechanisms are available for nwaku nodes, and how can I configure them?",mdxType:"AccordionItem"},"You can configure peer discovery for nwaku nodes through options like ",(0,a.kt)("a",{href:"/learn/concepts/static-peers"},"Static Peers"),", ",(0,a.kt)("a",{href:"/learn/concepts/dns-discovery"},"DNS Discovery"),", ",(0,a.kt)("a",{href:"/learn/concepts/discv5"},"DiscV5"),", and ",(0,a.kt)("a",{href:"/learn/concepts/peer-exchange"},"Peer Exchange"),". Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/configure-discovery"},"Configure Peer Discovery")," guide for setting up your node."),(0,a.kt)(i.AccordionItem,{title:"How do I find my nwaku node's addresses for peer discovery?",mdxType:"AccordionItem"},"The node listening and ENR addresses can be found through the node's logs and ",(0,a.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info"},"REST API"),". Check out the ",(0,a.kt)("a",{href:"/guides/nwaku/run-node#find-the-node-addresses"},"Find the node addresses")," section to understand how to locate your node addresses."))}h.isMDXComponent=!0},46102:()=>{}}]);

assets/js/20987266.929f3522.js

@@ -0,0 +1 @@
+(self.webpackChunkwaku_guide=self.webpackChunkwaku_guide||[]).push([[7442],{53958:(e,o,n)=>{"use strict";var t=n(83639);n.o(t,"AccordionItem")&&n.d(o,{AccordionItem:function(){return t.AccordionItem}})},26820:(e,o,n)=>{"use strict";n.r(o),n.d(o,{assets:()=>s,contentTitle:()=>u,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=n(87462),i=(n(67294),n(3905)),a=n(53958);const r={title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},u=void 0,d={unversionedId:"guides/nwaku/faq",id:"guides/nwaku/faq",title:"Nwaku FAQ",description:"Check out the Run Nwaku with Docker Compose guide to learn the simplest and fastest way to run a node. You can also check the comprehensive Run a Nwaku Node guide to explore other options like downloading binaries and building from source.",source:"@site/docs/guides/nwaku/faq.md",sourceDirName:"guides/nwaku",slug:"/guides/nwaku/faq",permalink:"/guides/nwaku/faq",draft:!1,editUrl:"https://github.com/waku-org/docs.waku.org/tree/develop/docs/guides/nwaku/faq.md",tags:[],version:"current",frontMatter:{title:"Nwaku FAQ",hide_table_of_contents:!0,sidebar_label:"Frequently Asked Questions"},sidebar:"guides",previous:{title:"Node Configuration Examples",permalink:"/guides/nwaku/configure-nwaku"},next:{title:"Upgrade Instructions",permalink:"/guides/nwaku/upgrade-instructions"}},s={},c=[],k={toc:c},g="wrapper";function h(e){let{components:o,...n}=e;return(0,i.kt)(g,(0,t.Z)({},k,n,{components:o,mdxType:"MDXLayout"}),(0,i.kt)(a.AccordionItem,{title:"How can I run a Waku node?",mdxType:"AccordionItem"},"Check out the ",(0,i.kt)("a",{href:"/guides/nwaku/run-docker-compose"},"Run Nwaku with Docker Compose")," guide to learn the simplest and fastest way to run a node. You can also check the comprehensive ",(0,i.kt)("a",{href:"/guides/nwaku/run-node"},"Run a Nwaku Node")," guide to explore other options like ",(0,i.kt)("a",{href:"/guides/nwaku/run-node#download-the-binary"},"downloading binaries")," and ",(0,i.kt)("a",{href:"/guides/nwaku/build-source"},"building from source"),"."),(0,i.kt)(a.AccordionItem,{title:"What are the system requirements for running a node?",mdxType:"AccordionItem"},"We recommend running a nwaku node with at least 2GB of RAM, especially if WSS is enabled. If running just a Relay node, 0.5GB of RAM is sufficient."),(0,i.kt)(a.AccordionItem,{title:"How can I interact with my running nwaku node?",mdxType:"AccordionItem"},"You can interact with a running nwaku node using the ",(0,i.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/"},"REST API interface")," or the ",(0,i.kt)("a",{href:"/guides/js-waku/"},"JavaScript Waku SDK"),"."),(0,i.kt)(a.AccordionItem,{title:"How can I view the logs of a nwaku node running in Docker?",mdxType:"AccordionItem"},'To check your node logs in Docker, use the command: "docker-compose logs -f nwaku"'),(0,i.kt)(a.AccordionItem,{title:"What configuration methods are available for nwaku nodes?",mdxType:"AccordionItem"},"You can configure Nwaku nodes using command line options and flags, environment variables, and TOML configuration files. Check out the ",(0,i.kt)("a",{href:"/guides/nwaku/config-methods"},"Node Configuration Methods")," guide to understand their usage and priority."),(0,i.kt)(a.AccordionItem,{title:"How can I configure my nwaku node before running?",mdxType:"AccordionItem"},"Check out the ",(0,i.kt)("a",{href:"/guides/nwaku/config-options"},"Node Configuration Options")," guide for available node configuration options, their default values and descriptions. For examples of common configuration use cases, visit the ",(0,i.kt)("a",{href:"/guides/nwaku/configure-nwaku"},"Node Configuration Examples")," guide."),(0,i.kt)(a.AccordionItem,{title:"What peer discovery mechanisms are available for nwaku nodes, and how can I configure them?",mdxType:"AccordionItem"},"You can configure peer discovery for nwaku nodes through options like ",(0,i.kt)("a",{href:"/learn/concepts/static-peers"},"Static Peers"),", ",(0,i.kt)("a",{href:"/learn/concepts/dns-discovery"},"DNS Discovery"),", ",(0,i.kt)("a",{href:"/learn/concepts/discv5"},"DiscV5"),", and ",(0,i.kt)("a",{href:"/learn/concepts/peer-exchange"},"Peer Exchange"),". Check out the ",(0,i.kt)("a",{href:"/guides/nwaku/configure-discovery"},"Configure Peer Discovery")," guide for setting up your node."),(0,i.kt)(a.AccordionItem,{title:"How do I find my nwaku node's addresses for peer discovery?",mdxType:"AccordionItem"},"The node listening and ENR addresses can be found through the node's logs and ",(0,i.kt)("a",{href:"https://waku-org.github.io/waku-rest-api/#get-/debug/v1/info"},"REST API"),". Check out the ",(0,i.kt)("a",{href:"/guides/nwaku/run-node#find-the-node-addresses"},"Find the node addresses")," section to understand how to locate your node addresses."))}h.isMDXComponent=!0},46102:()=>{}}]);