2021-12-10 15:46:13 +00:00
<!DOCTYPE html>
< html lang = "en" dir = "ltr" >
< head >
< meta charset = "UTF-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2022-01-27 00:19:14 +00:00
< meta name = "description" content = "Waku Connect Docs # Waku Connect is a suite of libraries , SDKs and documentations to help you use Waku in your dApp .
2021-12-10 15:46:13 +00:00
Waku is a decentralized, censorship-resistant, network and protocol family. It enables you to add communication features to your dApp in a decentralized manner, ensuring to your users that they will not be censored or de-platformed.
2022-01-27 00:19:14 +00:00
Waku can be used for chat purposes and for many machine-to-machine use cases.">
2021-12-10 15:46:13 +00:00
< meta name = "theme-color" content = "#FFFFFF" >
< meta name = "color-scheme" content = "light dark" > < meta property = "og:title" content = "Introduction" / >
< meta property = "og:description" content = "" / >
< meta property = "og:type" content = "website" / >
2022-01-10 15:07:23 +00:00
< meta property = "og:url" content = "https://docs.wakuconnect.dev/docs/" / >
2022-01-11 09:09:21 +00:00
2022-01-27 00:19:14 +00:00
< title > Introduction | Waku Connect Docs< / title >
2021-12-10 15:46:13 +00:00
< link rel = "manifest" href = "/manifest.json" >
< link rel = "icon" href = "/favicon.png" type = "image/x-icon" >
2022-01-10 15:07:23 +00:00
< link rel = "alternate" hreflang = "es" href = "https://docs.wakuconnect.dev/es/docs/" title = "Introducción" >
< link rel = "alternate" hreflang = "pt" href = "https://docs.wakuconnect.dev/pt/docs/" title = "Introdução" >
2022-01-11 09:09:21 +00:00
< link rel = "stylesheet" href = "/book.min.89a77f7e702a8626749b948bbfb01109823daf6c1246ca407d1378833494c402.css" integrity = "sha256-iad/fnAqhiZ0m5SLv7ARCYI9r2wSRspAfRN4gzSUxAI=" crossorigin = "anonymous" >
2021-12-10 15:46:13 +00:00
< script defer src = "/flexsearch.min.js" > < / script >
2022-05-24 08:03:59 +00:00
< script defer src = "/en.search.min.091f76335a3aa8163fdc3a82453ef560dd921a0f0f90a9e0edaba7d761470954.js" integrity = "sha256-CR92M1o6qBY/3DqCRT71YN2SGg8PkKng7aun12FHCVQ=" crossorigin = "anonymous" > < / script >
2022-01-27 00:19:14 +00:00
< link rel = "alternate" type = "application/rss+xml" href = "https://docs.wakuconnect.dev/docs/index.xml" title = "Waku Connect Docs" / >
2021-12-10 15:46:13 +00:00
<!--
Made with Book Theme
https://github.com/alex-shpak/hugo-book
-->
2022-04-12 00:57:19 +00:00
< script >
(function (f, a, t, h, o, m) {
a[h] = a[h] || function () {
(a[h].q = a[h].q || []).push(arguments)
};
o = f.createElement('script');
m = f.getElementsByTagName('script')[0];
o.async = 1;
o.src = t;
o.id = 'fathom-script';
m.parentNode.insertBefore(o, m)
})(document, window, '//fathom.status.im/tracker.js', 'fathom');
fathom('set', 'siteId', 'BBYCC');
fathom('trackPageview');
< / script >
2021-12-10 15:46:13 +00:00
< / head >
< body dir = "ltr" >
< input type = "checkbox" class = "hidden toggle" id = "menu-control" / >
< input type = "checkbox" class = "hidden toggle" id = "toc-control" / >
< main class = "container flex" >
< aside class = "book-menu" >
< div class = "book-menu-content" >
< nav >
< h2 class = "book-brand" >
2022-01-27 00:19:14 +00:00
< a class = "flex align-center" href = "/" > < span > Waku Connect Docs< / span >
2021-12-10 15:46:13 +00:00
< / a >
< / h2 >
< div class = "book-search" >
< input type = "text" id = "book-search-input" placeholder = "Search" aria-label = "Search" maxlength = "64" data-hotkeys = "s/" / >
< div class = "book-search-spinner hidden" > < / div >
< ul id = "book-search-results" > < / ul >
< / div >
2022-01-10 15:07:23 +00:00
2021-12-10 15:46:13 +00:00
2022-01-10 15:07:23 +00:00
2021-12-10 15:46:13 +00:00
< ul class = "book-languages" >
< li >
< input type = "checkbox" id = "languages" class = "toggle" / >
< label for = "languages" class = "flex justify-between" >
< a role = "button" class = "flex align-center" >
< img src = "/svg/translate.svg" class = "book-icon" alt = "Languages" / >
English
< / a >
< / label >
< ul >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/es/docs/" >
Español
< / a >
< / li >
< li >
< a href = "https://docs.wakuconnect.dev/pt/docs/" >
Português
2021-12-10 15:46:13 +00:00
< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/introduction/" class = "" > Introduction< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/quick_start/" class = "" > Quick Start< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-03-21 03:40:29 +00:00
< a href = "https://docs.wakuconnect.dev/docs/faq/" class = "" > FAQ< / a >
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/use_cases/" class = "" > Use Cases< / a >
< / li >
< li >
2022-01-12 03:43:06 +00:00
< a href = "https://docs.wakuconnect.dev/docs/presentations/" class = "" > Presentations & Videos< / a >
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/" class = "" > Guides< / a >
2021-12-10 15:46:13 +00:00
< ul >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/01_choose_content_topic/" class = "" > How to Choose a Content Topic< / a >
< / li >
< li >
2022-03-10 05:51:15 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/discovery_bootstrap/" class = "" > Discovery & Bootstrap Nodes< / a >
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/02_relay_receive_send_messages/" class = "" > Receive and Send Messages Using Waku Relay< / a >
< / li >
< li >
< a href = "https://docs.wakuconnect.dev/docs/guides/03_store_retrieve_messages/" class = "" > Retrieve Messages Using Waku Store< / a >
< / li >
< li >
< a href = "https://docs.wakuconnect.dev/docs/guides/04_encrypt_messages_version_1/" class = "" > Encrypt Messages Using Waku Message Version 1< / a >
< / li >
< li >
2022-02-24 05:50:46 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/sign_messages_web3_eip712/" class = "" > Sign Messages Using a Web3 Wallet (EIP-712)< / a >
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/05_sign_messages_version_1/" class = "" > Sign Messages Using Waku Message Version 1< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/06_light_push_send_messages/" class = "" > Send Messages Using Waku Light Push< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-02-21 00:45:17 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/07_reactjs_relay/" class = "" > Receive and Send Messages Using Waku Relay With ReactJS< / a >
2022-02-21 00:35:51 +00:00
< / li >
< li >
2022-02-21 00:45:17 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/08_reactjs_store/" class = "" > Retrieve Messages Using Waku Store With ReactJS< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-02-21 00:45:17 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/angular_relay/" class = "" > Send and Receive Messages Using Waku Relay With Angular v13< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-02-21 00:45:17 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/nwaku/" class = "" > Nwaku Service Node< / a >
2022-01-30 23:57:45 +00:00
< / li >
< li >
2022-02-21 00:45:17 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/debug/" class = "" > How to Debug your Waku dApp< / a >
2022-02-21 00:35:51 +00:00
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/" class = "" > Vote Poll Sdk< / a >
< ul >
< li >
2022-02-09 23:42:13 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/dapp_creation/" class = "" > Create a DApp< / a >
< ul >
< li >
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/dapp_creation/01_create_dapp/" class = "" > Create the DApp and Install Dependencies< / a >
< / li >
< li >
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/dapp_creation/02_connect_wallet/" class = "" > Connect to the Ethereum Wallet< / a >
< / li >
< li >
2022-03-21 03:40:29 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/dapp_creation/03_connect_wallet_usedapp/" class = "" > Connect to the Ethereum Wallet useDapp< / a >
2022-02-09 23:42:13 +00:00
< / li >
< / ul >
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/poll_sdk/" class = "" > Poll SDK< / a >
< ul >
< li >
2022-02-09 23:42:13 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/poll_sdk/01_create-a-poll_button/" class = "" > Create-A-Poll Button< / a >
2022-01-10 15:07:23 +00:00
< / li >
< li >
2022-02-09 23:42:13 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/poll_sdk/02_poll_creation/" class = "" > Poll Creation Component< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-02-09 23:42:13 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/poll_sdk/03_poll_list/" class = "" > Poll List Component< / a >
< / li >
< / ul >
< / li >
< li >
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/vote_sdk/" class = "" > Vote SDK< / a >
< ul >
< li >
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/vote_sdk/01_deploying_smart_contract/" class = "" > Deploy smart contract< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-02-09 23:42:13 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/vote_sdk/02_voting_creation/" class = "" > Creating Voting component< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-02-09 23:42:13 +00:00
< a href = "https://docs.wakuconnect.dev/docs/guides/vote_poll_sdk/vote_sdk/03_using_voting/" class = "" > Use Voting Component< / a >
2021-12-10 15:46:13 +00:00
< / li >
2022-01-10 15:07:23 +00:00
< / ul >
< / li >
< / ul >
< / li >
2021-12-10 15:46:13 +00:00
< / ul >
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/examples/" class = "" > Examples< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/crypto_libraries/" class = "" > Cryptographic Libraries< / a >
2021-12-10 15:46:13 +00:00
< / li >
< li >
2022-01-10 15:07:23 +00:00
< a href = "https://docs.wakuconnect.dev/docs/waku_protocols/" class = "" > Implemented Waku Protocols< / a >
2021-12-10 15:46:13 +00:00
< / li >
< / ul >
< ul >
2021-12-13 00:29:57 +00:00
< li >
2022-01-27 00:19:14 +00:00
< a href = "https://js-waku.wakuconnect.dev/" target = "_blank" rel = "noopener" >
2021-12-13 00:29:57 +00:00
JS-Waku API Doc
< / a >
< / li >
2021-12-10 15:46:13 +00:00
< li >
< a href = "https://vac.dev/" target = "_blank" rel = "noopener" >
Vac Team
< / a >
< / li >
< li >
< a href = "https://rfc.vac.dev/" target = "_blank" rel = "noopener" >
Vac RFCs
< / a >
< / li >
< li >
< a href = "https://status.im/" target = "_blank" rel = "noopener" >
Status.im
< / a >
< / li >
< / ul >
< / nav >
2022-01-11 09:09:21 +00:00
< script > ( function ( ) { var a = document . querySelector ( "aside .book-menu-content" ) ; addEventListener ( "beforeunload" , function ( b ) { localStorage . setItem ( "menu.scrollTop" , a . scrollTop ) } ) , a . scrollTop = localStorage . getItem ( "menu.scrollTop" ) } ) ( ) < / script >
2021-12-10 15:46:13 +00:00
< / div >
< / aside >
< div class = "book-page" >
< header class = "book-header" >
< div class = "flex align-center justify-between" >
< label for = "menu-control" >
< img src = "/svg/menu.svg" class = "book-icon" alt = "Menu" / >
< / label >
< strong > Introduction< / strong >
< label for = "toc-control" >
< img src = "/svg/toc.svg" class = "book-icon" alt = "Table of Contents" / >
< / label >
< / div >
< aside class = "hidden clearfix" >
< nav id = "TableOfContents" >
< ul >
2022-01-27 00:19:14 +00:00
< li > < a href = "#waku-connect-docs" > Waku Connect Docs< / a >
2021-12-10 15:46:13 +00:00
< ul >
< li > < a href = "#bugs-questions--support" > Bugs, Questions & Support< / a > < / li >
< / ul >
< / li >
< / ul >
< / nav >
< / aside >
< / header >
2022-01-27 00:19:14 +00:00
< article class = "markdown" > < h1 id = "waku-connect-docs" >
Waku Connect Docs
< a class = "anchor" href = "#waku-connect-docs" > #< / a >
2022-01-11 09:09:21 +00:00
< / h1 >
2022-01-27 00:19:14 +00:00
< p > Waku Connect is a suite of libraries, SDKs and documentations to help you use Waku in your dApp.< / p >
2021-12-10 15:46:13 +00:00
< p > Waku is a decentralized, censorship-resistant, network and protocol family.
It enables you to add communication features to your dApp in a decentralized manner,
ensuring to your users that they will not be censored or de-platformed.< / p >
< p > Waku can be used for chat purposes and for many machine-to-machine use cases.
2022-05-06 01:27:15 +00:00
You can learn more about Waku at < a href = "https://waku.org" > waku.org< / a > .< / p >
2021-12-10 15:46:13 +00:00
< p > JS-Waku is the TypeScript implementation of the Waku protocol,
built for browser environment.< / p >
2022-03-21 03:40:29 +00:00
< p > The < a href = "/docs/quick_start/" > quick start< / a > presents an easy way to send and receive messages using js-waku.
The < a href = "/docs/faq/" > FAQ< / a > lists frequently asked questions.< / p >
2022-01-12 03:43:06 +00:00
< p > If you prefer video content, check out the < a href = "/docs/presentations" > presentations< / a > .< / p >
2022-01-10 15:07:23 +00:00
< p > If you are looking for inspiration, check out the < a href = "/docs/use_cases" > use cases< / a > Waku can enable.< / p >
2021-12-10 15:46:13 +00:00
< p > The < a href = "/docs/guides" > guides< / a > explain specific js-waku features
and how it can be used with popular web frameworks.< / p >
< p > The js-waku repository also holds a number of < a href = "https://github.com/status-im/js-waku/tree/main/examples" > examples< / a > .
The examples are working Proof-of-Concepts that demonstrate how to use js-waku.
Check out the < a href = "/docs/examples/" > example list< / a > to see what usage each example demonstrates.< / p >
2022-02-02 01:02:45 +00:00
< p > You can also try out some of the examples at the following locations:< / p >
< ul >
< li > < a href = "https://js-waku.wakuconnect.dev/examples/web-chat" > web-chat< / a > : A simple public chat (< a href = "/docs/examples/#web-chat-app" > docs< / a > ).< / li >
< li > < a href = "https://js-waku.wakuconnect.dev/examples/eth-pm" > eth-pm< / a > : End-to-end encrypted private messages
(< a href = "/docs/examples/#ethereum-private-message-web-app" > docs< / a > ).< / li >
2022-02-21 00:35:51 +00:00
< li > < a href = "https://js-waku.wakuconnect.dev/examples/eth-pm-wallet-encryption" > eth-pm-wallet-encryption< / a > : Eth-pm using Web3 wallet encryption API
(< a href = "/docs/examples/#ethereum-private-message-using-web3-wallet-encryption-api-web-app" > docs< / a > ).< / li >
2022-02-02 01:02:45 +00:00
< / ul >
2021-12-10 15:46:13 +00:00
< p > Finally, if you want to learn how Waku works under the hoods, check the specs at < a href = "https://rfc.vac.dev/" > rfc.vac.dev< / a > .< / p >
2022-01-11 09:09:21 +00:00
< h2 id = "bugs-questions--support" >
Bugs, Questions & Support
< a class = "anchor" href = "#bugs-questions--support" > #< / a >
< / h2 >
2021-12-10 15:46:13 +00:00
< p > If you encounter any bug or would like to propose new features, feel free to < a href = "https://github.com/status-im/js-waku/issues/new/" > open an issue< / a > .< / p >
2022-05-24 08:03:59 +00:00
< p > For general discussion, get help or latest news,
join < strong > #js-waku< / strong > on < a href = "https://discord.gg/j5pGbn7MHZ" > Vac Discord< / a > or the < a href = "https://t.me/waku_org" > Waku Telegram Group< / a > .< / p >
2021-12-10 15:46:13 +00:00
< / article >
< footer class = "book-footer" >
< div class = "flex flex-wrap justify-between" >
2022-05-24 08:03:59 +00:00
< div > < a class = "flex align-center" href = "https://github.com/vacp2p/docs.wakuconnect.dev/commit/94783e8db51dd2a46f3bb6545b2b63c915fedbed" title = 'Last modified by Franck R | May 24, 2022' target = "_blank" rel = "noopener" >
2021-12-10 15:46:13 +00:00
< img src = "/svg/calendar.svg" class = "book-icon" alt = "Calendar" / >
2022-05-24 08:03:59 +00:00
< span > May 24, 2022< / span >
2021-12-10 15:46:13 +00:00
< / a >
< / div >
< div >
2022-01-10 15:07:23 +00:00
< a class = "flex align-center" href = "https://github.com/vacp2p/docs.wakuconnect.dev/edit/develop/content/docs/_index.md" target = "_blank" rel = "noopener" >
2021-12-10 15:46:13 +00:00
< img src = "/svg/edit.svg" class = "book-icon" alt = "Edit" / >
< span > Edit this page< / span >
< / a >
< / div >
< / div >
2022-01-11 09:09:21 +00:00
< script > ( function ( ) { function a ( c ) { const a = window . getSelection ( ) , b = document . createRange ( ) ; b . selectNodeContents ( c ) , a . removeAllRanges ( ) , a . addRange ( b ) } document . querySelectorAll ( "pre code" ) . forEach ( b => { b . addEventListener ( "click" , function ( c ) { a ( b . parentElement ) , navigator . clipboard && navigator . clipboard . writeText ( b . parentElement . textContent ) } ) } ) } ) ( ) < / script >
2021-12-10 15:46:13 +00:00
< / footer >
< div class = "book-comments" >
< / div >
< label for = "menu-control" class = "hidden book-menu-overlay" > < / label >
< / div >
< aside class = "book-toc" >
< div class = "book-toc-content" >
< nav id = "TableOfContents" >
< ul >
2022-01-27 00:19:14 +00:00
< li > < a href = "#waku-connect-docs" > Waku Connect Docs< / a >
2021-12-10 15:46:13 +00:00
< ul >
< li > < a href = "#bugs-questions--support" > Bugs, Questions & Support< / a > < / li >
< / ul >
< / li >
< / ul >
< / nav >
< / div >
< / aside >
< / main >
< / body >
< / html >
