mirror of https://github.com/waku-org/waku.org.git
Update documentation
This commit is contained in:
parent
21d9d67e3f
commit
8bb12f0365
4
404.html
4
404.html
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><link rel="preload" href="/_next/static/css/c7897736c7018a17.css" as="style"/><link rel="stylesheet" href="/_next/static/css/c7897736c7018a17.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-9cdd9239c2045e33.js" defer=""></script><script src="/_next/static/chunks/framework-fc97f3f1282ce3ed.js" defer=""></script><script src="/_next/static/chunks/main-ada0258e433ba222.js" defer=""></script><script src="/_next/static/chunks/pages/_app-ac0d6d6b6e593ede.js" defer=""></script><script src="/_next/static/chunks/pages/_error-a16dbc4b5b6c5911.js" defer=""></script><script src="/_next/static/F1rlGuw3Xt5CMgXE4ks6U/_buildManifest.js" defer=""></script><script src="/_next/static/F1rlGuw3Xt5CMgXE4ks6U/_ssgManifest.js" defer=""></script><script src="/_next/static/F1rlGuw3Xt5CMgXE4ks6U/_middlewareManifest.js" defer=""></script></head><body><div id="__next"><svg width="0" height="0" xmlns="http://www.w3.org/2000/svg" style="display:none"><defs><filter id="colored"><feColorMatrix type="matrix" values="0.12 0 0 0 0 0 0.12 0 0 0 0 0 0.26 0 0 0 0 0 1 0"></feColorMatrix></filter></defs></svg><style nonce="logos">
|
||||
<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><link rel="preload" href="/_next/static/css/c7897736c7018a17.css" as="style"/><link rel="stylesheet" href="/_next/static/css/c7897736c7018a17.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-9cdd9239c2045e33.js" defer=""></script><script src="/_next/static/chunks/framework-fc97f3f1282ce3ed.js" defer=""></script><script src="/_next/static/chunks/main-ada0258e433ba222.js" defer=""></script><script src="/_next/static/chunks/pages/_app-dc02b8ac6e4e4fba.js" defer=""></script><script src="/_next/static/chunks/pages/_error-a16dbc4b5b6c5911.js" defer=""></script><script src="/_next/static/Lco7JB0a1eUa5TG0HhXmw/_buildManifest.js" defer=""></script><script src="/_next/static/Lco7JB0a1eUa5TG0HhXmw/_ssgManifest.js" defer=""></script><script src="/_next/static/Lco7JB0a1eUa5TG0HhXmw/_middlewareManifest.js" defer=""></script></head><body><div id="__next"><svg width="0" height="0" xmlns="http://www.w3.org/2000/svg" style="display:none"><defs><filter id="colored"><feColorMatrix type="matrix" values="0.12 0 0 0 0 0 0.12 0 0 0 0 0 0.26 0 0 0 0 0 1 0"></feColorMatrix></filter></defs></svg><style nonce="logos">
|
||||
#nprogress {
|
||||
pointer-events: none;
|
||||
}
|
||||
|
|
@ -65,4 +65,4 @@
|
|||
transform: rotate(360deg);
|
||||
}
|
||||
}
|
||||
</style><div style="color:#000;background:#fff;font-family:-apple-system, BlinkMacSystemFont, Roboto, "Segoe UI", "Fira Sans", Avenir, "Helvetica Neue", "Lucida Grande", sans-serif;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div><style>body { margin: 0 }</style><h1 style="display:inline-block;border-right:1px solid rgba(0, 0, 0,.3);margin:0;margin-right:20px;padding:10px 23px 10px 0;font-size:24px;font-weight:500;vertical-align:top">404<!-- --></h1><div style="display:inline-block;text-align:left;line-height:49px;height:49px;vertical-align:middle"><h2 style="font-size:14px;font-weight:normal;line-height:inherit;margin:0;padding:0">This page could not be found<!-- -->.<!-- --></h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"F1rlGuw3Xt5CMgXE4ks6U","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
|
||||
</style><div style="color:#000;background:#fff;font-family:-apple-system, BlinkMacSystemFont, Roboto, "Segoe UI", "Fira Sans", Avenir, "Helvetica Neue", "Lucida Grande", sans-serif;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div><style>body { margin: 0 }</style><h1 style="display:inline-block;border-right:1px solid rgba(0, 0, 0,.3);margin:0;margin-right:20px;padding:10px 23px 10px 0;font-size:24px;font-weight:500;vertical-align:top">404<!-- --></h1><div style="display:inline-block;text-align:left;line-height:49px;height:49px;vertical-align:middle"><h2 style="font-size:14px;font-weight:normal;line-height:inherit;margin:0;padding:0">This page could not be found<!-- -->.<!-- --></h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"Lco7JB0a1eUa5TG0HhXmw","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
|
||||
|
|
@ -1 +1 @@
|
|||
{"pageProps":{"markdown":{"content":"\n# About\n\nCommunication today is rife with third party interference.\nFrom censorship and deplatforming, to rent seeking intermediaries, to the misuse of data in the surveillance economy.\n\nWaku is designed to place control of communication back into the hands of the individual.\n\n## Motivation and goals\n\n### Privacy\n\nThese applications have a desire for some privacy guarantees, such as pseudonymity, metadata protection in transit, etc.\n\n### Peer-to-Peer\n\nThese applications sometimes have requirements that make them suitable for peer-to-peer solutions.\n\n### Generalized messaging\n\nMany applications require some form of messaging protocol to communicate between different subsystems or different nodes.\nThis messaging can be human-to-human or machine-to-machine or a mix.\n\n### Resource restricted\n\nThese applications often run in constrained environments,\nwhere resources or the environment is restricted in some fashion.\nE.g.:\n\n- limited bandwidth, CPU, memory, disk, battery, etc.,\n- not being publicly connectable,\n- only being intermittently connected; mostly-offline.\n\n## History\n\nWaku v1 was a fork of Whisper with some added tweaks for efficiency.\nWaku v2 is a completely redesigned suite of protocols designed to address the goals set out above.\n\n```mermaid\n%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'HISTORY'}} }%%\n gitGraph\n commit id:\"2013\"\n commit id:\"2015\" tag:\"R&D\"\n commit id:\"2018\" tag:\"R&D\" type: HIGHLIGHT\n branch v1\n checkout v1\n commit id:\"2020\" tag:\"release\"\n checkout HISTORY\n merge v1\n branch v2\n checkout v2\n commit id:\"2021\" tag:\"release\"\n checkout HISTORY\n merge v2\n commit id:\"🔥\"\n\n```\n\n### 2013\n\nEthereum White Paper was introduced with the Holy Trinity,\nconsisting of Ethereum for consensus, Swarm for decentralized storage, and Whisper for p2p messaging.\n\n### 2015-2018\n\nR&D of Whisper was slow to follow progress of the Ethereum EVM and Swarm without a dedicated team building out the protocol.\n\n### 2018\n\nWith little progress made on Whisper and significant scalability concerns growing,\nVac was formed to conduct R&D on more scalable p2p messaging.\n\n### 2020\n\nWaku v1 was introduced as the messaging protocol in Status, replacing Whisper.\n\n### 2021\n\nWaku v2 replaces Waku v1.\n","metadata":{"title":"About","category":"page"},"toc":[{"content":"About","slug":"about","lvl":1,"i":0,"seen":0},{"content":"Motivation and goals","slug":"motivation-and-goals","lvl":2,"i":1,"seen":0},{"content":"Privacy","slug":"privacy","lvl":3,"i":2,"seen":0},{"content":"Peer-to-Peer","slug":"peer-to-peer","lvl":3,"i":3,"seen":0},{"content":"Generalized messaging","slug":"generalized-messaging","lvl":3,"i":4,"seen":0},{"content":"Resource restricted","slug":"resource-restricted","lvl":3,"i":5,"seen":0},{"content":"History","slug":"history","lvl":2,"i":6,"seen":0},{"content":"2013","slug":"2013","lvl":3,"i":7,"seen":0},{"content":"2015-2018","slug":"2015-2018","lvl":3,"i":8,"seen":0},{"content":"2018","slug":"2018","lvl":3,"i":9,"seen":0},{"content":"2020","slug":"2020","lvl":3,"i":10,"seen":0},{"content":"2021","slug":"2021","lvl":3,"i":11,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"About","category":"page"},"navOrder":1679484445.308,"localPath":"about.md","path":["about"],"children":[],"isDir":false},"routeParams":{"path":["about"]}},"__N_SSG":true}
|
||||
{"pageProps":{"markdown":{"content":"\n# About\n\nCommunication today is rife with third party interference.\nFrom censorship and deplatforming, to rent seeking intermediaries, to the misuse of data in the surveillance economy.\n\nWaku is designed to place control of communication back into the hands of the individual.\n\n## Motivation and goals\n\n### Privacy\n\nThese applications have a desire for some privacy guarantees, such as pseudonymity, metadata protection in transit, etc.\n\n### Peer-to-Peer\n\nThese applications sometimes have requirements that make them suitable for peer-to-peer solutions.\n\n### Generalized messaging\n\nMany applications require some form of messaging protocol to communicate between different subsystems or different nodes.\nThis messaging can be human-to-human or machine-to-machine or a mix.\n\n### Resource restricted\n\nThese applications often run in constrained environments,\nwhere resources or the environment is restricted in some fashion.\nE.g.:\n\n- limited bandwidth, CPU, memory, disk, battery, etc.,\n- not being publicly connectable,\n- only being intermittently connected; mostly-offline.\n\n## History\n\nWaku v1 was a fork of Whisper with some added tweaks for efficiency.\nWaku v2 is a completely redesigned suite of protocols designed to address the goals set out above.\n\n```mermaid\n%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'HISTORY'}} }%%\n gitGraph\n commit id:\"2013\"\n commit id:\"2015\" tag:\"R&D\"\n commit id:\"2018\" tag:\"R&D\" type: HIGHLIGHT\n branch v1\n checkout v1\n commit id:\"2020\" tag:\"release\"\n checkout HISTORY\n merge v1\n branch v2\n checkout v2\n commit id:\"2021\" tag:\"release\"\n checkout HISTORY\n merge v2\n commit id:\"🔥\"\n\n```\n\n### 2013\n\nEthereum White Paper was introduced with the Holy Trinity,\nconsisting of Ethereum for consensus, Swarm for decentralized storage, and Whisper for p2p messaging.\n\n### 2015-2018\n\nR&D of Whisper was slow to follow progress of the Ethereum EVM and Swarm without a dedicated team building out the protocol.\n\n### 2018\n\nWith little progress made on Whisper and significant scalability concerns growing,\nVac was formed to conduct R&D on more scalable p2p messaging.\n\n### 2020\n\nWaku v1 was introduced as the messaging protocol in Status, replacing Whisper.\n\n### 2021\n\nWaku v2 replaces Waku v1.\n","metadata":{"title":"About","category":"page"},"toc":[{"content":"About","slug":"about","lvl":1,"i":0,"seen":0},{"content":"Motivation and goals","slug":"motivation-and-goals","lvl":2,"i":1,"seen":0},{"content":"Privacy","slug":"privacy","lvl":3,"i":2,"seen":0},{"content":"Peer-to-Peer","slug":"peer-to-peer","lvl":3,"i":3,"seen":0},{"content":"Generalized messaging","slug":"generalized-messaging","lvl":3,"i":4,"seen":0},{"content":"Resource restricted","slug":"resource-restricted","lvl":3,"i":5,"seen":0},{"content":"History","slug":"history","lvl":2,"i":6,"seen":0},{"content":"2013","slug":"2013","lvl":3,"i":7,"seen":0},{"content":"2015-2018","slug":"2015-2018","lvl":3,"i":8,"seen":0},{"content":"2018","slug":"2018","lvl":3,"i":9,"seen":0},{"content":"2020","slug":"2020","lvl":3,"i":10,"seen":0},{"content":"2021","slug":"2021","lvl":3,"i":11,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"About","category":"page"},"navOrder":1685028083.828,"localPath":"about.md","path":["about"],"children":[],"isDir":false},"routeParams":{"path":["about"]}},"__N_SSG":true}
|
||||
|
|
@ -1 +1 @@
|
|||
{"pageProps":{"markdown":{"content":"\n# Contribute to Waku\n\nYou can contribute to Waku in several manners:\n\n## Run a Node\n\nThe Waku Network is a permissionless, decentralized set of nodes.\nAnyone can run their own node, use and support the network.\n\nLearn more [here](https://github.com/waku-org/nwaku/tree/master/docs/operators).\n\n## Build Your Own Waku Application\n\nBy integrating Waku in your application,\nyou may contribute by:\n\n- Running Waku node within your application,\n- Reporting bugs and missing features to the development teams,\n- Inspire other developers in using Waku for various use cases.\n\n[Get started now](/platform).\n\n## Contribute to the Waku Implementations\n\nAll Waku implementations are open source,\nPull Requests and welcome and encouraged.\n\nWe sometimes open bounties on [Gitcoin](https://gitcoin.co/),\npotential bounties are marked with the label `bounty` on GitHub issues.\n\nRepositories:\n\n- [js-waku](https://github.com/waku-org/js-waku)\n- [nwaku](https://github.com/waku-org/nwaku)\n- [go-waku](https://github.com/waku-org/go-waku)\n\n## Research\n\nWaku Research is ongoing and driven by Vac.\nVac is an R&D org creating modular p2p protocols for private, secure, censorship resistant communication.\n\nLearn more at https://vac.dev/\n\n## Other Ways of Contributing\n\nIf you are keen to contribute but not sure how,\njoin the discussion on [Vac Discord](https://discord.gg/Nrac59MfSX)\nor the [Waku Telegram Group](https://t.me/waku_org).\n\nWaku is a public good, we are always welcoming help from the community.\n","metadata":{"title":"Contribute to Waku"},"toc":[{"content":"Contribute to Waku","slug":"contribute-to-waku","lvl":1,"i":0,"seen":0},{"content":"Run a Node","slug":"run-a-node","lvl":2,"i":1,"seen":0},{"content":"Build Your Own Waku Application","slug":"build-your-own-waku-application","lvl":2,"i":2,"seen":0},{"content":"Contribute to the Waku Implementations","slug":"contribute-to-the-waku-implementations","lvl":2,"i":3,"seen":0},{"content":"Research","slug":"research","lvl":2,"i":4,"seen":0},{"content":"Other Ways of Contributing","slug":"other-ways-of-contributing","lvl":2,"i":5,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Contribute to Waku"},"navOrder":1679484442.309,"localPath":"contribute.md","path":["contribute"],"children":[],"isDir":false},"routeParams":{"path":["contribute"]}},"__N_SSG":true}
|
||||
{"pageProps":{"markdown":{"content":"\n# Contribute to Waku\n\nYou can contribute to Waku in several manners:\n\n## Run a Node\n\nThe Waku Network is a permissionless, decentralized set of nodes.\nAnyone can run their own node, use and support the network.\n\nLearn more [here](https://github.com/waku-org/nwaku/tree/master/docs/operators).\n\n## Build Your Own Waku Application\n\nBy integrating Waku in your application,\nyou may contribute by:\n\n- Running Waku node within your application,\n- Reporting bugs and missing features to the development teams,\n- Inspire other developers in using Waku for various use cases.\n\n[Get started now](/platform).\n\n## Contribute to the Waku Implementations\n\nAll Waku implementations are open source,\nPull Requests and welcome and encouraged.\n\nWe sometimes open bounties on [Gitcoin](https://gitcoin.co/),\npotential bounties are marked with the label `bounty` on GitHub issues.\n\nRepositories:\n\n- [js-waku](https://github.com/waku-org/js-waku)\n- [nwaku](https://github.com/waku-org/nwaku)\n- [go-waku](https://github.com/waku-org/go-waku)\n\n## Research\n\nWaku Research is ongoing and driven by Vac.\nVac is an R&D org creating modular p2p protocols for private, secure, censorship resistant communication.\n\nLearn more at https://vac.dev/\n\n## Other Ways of Contributing\n\nIf you are keen to contribute but not sure how,\njoin the discussion on [Vac Discord](https://discord.gg/Nrac59MfSX)\nor the [Waku Telegram Group](https://t.me/waku_org).\n\nWaku is a public good, we are always welcoming help from the community.\n","metadata":{"title":"Contribute to Waku"},"toc":[{"content":"Contribute to Waku","slug":"contribute-to-waku","lvl":1,"i":0,"seen":0},{"content":"Run a Node","slug":"run-a-node","lvl":2,"i":1,"seen":0},{"content":"Build Your Own Waku Application","slug":"build-your-own-waku-application","lvl":2,"i":2,"seen":0},{"content":"Contribute to the Waku Implementations","slug":"contribute-to-the-waku-implementations","lvl":2,"i":3,"seen":0},{"content":"Research","slug":"research","lvl":2,"i":4,"seen":0},{"content":"Other Ways of Contributing","slug":"other-ways-of-contributing","lvl":2,"i":5,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Contribute to Waku"},"navOrder":1685028080.829,"localPath":"contribute.md","path":["contribute"],"children":[],"isDir":false},"routeParams":{"path":["contribute"]}},"__N_SSG":true}
|
||||
|
|
@ -1 +1 @@
|
|||
{"pageProps":{"markdown":{"content":"\nWaku is the communication layer for Web3. Decentralized communication that scales.\n\nPrivate. Secure. Runs anywhere.\n\n[Check the docs](https://js.waku.guide/)\n\n## What is Waku?\n\nWaku is a suite of privacy-preserving, peer-to-peer messaging protocols.\n\nWaku **removes centralized third parties** from messaging,\nenabling private, secure, censorship-free communication with no single point of failure.\n\nWaku **provides privacy-preserving** capabilities,\nsuch as sender anonymity,metadata protection and unlinkability to personally identifiable information.\n\nWaku is designed for **generalized messaging**, enabling human-to-human, machine-to-machine or hybrid communication.\n\nWaku runs everywhere: desktop, server, including **resource-restricted devices**, such as mobile devices and browsers.\n\n## How does it work?\n\nThe first version of Waku had its origins in the Whisper protocol,\nwith optimizations for scalability and usability.\nWaku v2 is a complete rewrite.\nIts relay protocol implements pub/sub over libp2p, and also introduces additional capabilities:\n\n1. Retrieving historical messages for mostly-offline devices.\n2. Adaptive nodes, allowing for heterogeneous nodes to contribute.\n3. Bandwidth preservation for light nodes.\n\nThis makes it ideal for running a p2p protocol on mobile, or in other similarly resource-restricted environments.\n\n[Read the RFCs](https://rfc.vac.dev/spec/10/)\n\n## Use Waku Now\n\nYou can\n\n- [Run a Waku node](/operator)\n- [Integrate Waku in your application](/platform)\n- [Contribute to Waku](/contribute)\n\n## Who is using Waku?\n\n### Status\n\nStatus is a secure messaging app, crypto wallet, and Web3 browser built with state-of-the-art technology.\n\n[Visit Status](https://status.im/)\n\n### RAILGUN\n\nRAILGUN is a privacy system for Ethereum that shields your assets in your own smart contract wallet.\nRAILGUN uses Waku when offering the ETH gas payments to other users,\nprivately signaling fees and offers for gas payment relayers to keep the privacy & anonymity of your stablecoin & token transactions.\n\n[Visit RAILGUN](https://railgun.org/)\n\n### XMTP\n\nXMTP is using Waku v2 for their open protocol and network for secure web3 messaging.\n\n[Visit XMTP](https://xmtp.com/)\n\n## Implementations\n\n### nwaku\n\nA nim implementation of the Waku v2 protocol.\nReference client and flagship implementation.\n\n[nwaku repository](https://github.com/waku-org/nwaku)\n\n### js-waku\n\nA JavaScript implementation for browser environments.\n\n[js-waku docs](https://js.waku.guide/)\n\n### go-waku\n\nA Go implementation for native integration in go applications,\nC-Bindings are also available with C#, Swift and Kotlin examples.\n\n[go-waku repository](https://github.com/waku-org/go-waku)\n\n### @waku/react-native\n\nIntegrate Waku in your React Native app using go-waku for mobile.\n\n[@waku/react-native repo](https://github.com/waku-org/waku-react-native)\n\n### Waku Rust Bindings\n\nRust layer on top of go-waku C FFI bindings.\n\n[waku-rust-bindings repo](https://github.com/waku-org/waku-rust-bindings)\n","metadata":{"title":"Main page"},"toc":[{"content":"What is Waku?","slug":"what-is-waku","lvl":2,"i":0,"seen":0},{"content":"How does it work?","slug":"how-does-it-work","lvl":2,"i":1,"seen":0},{"content":"Use Waku Now","slug":"use-waku-now","lvl":2,"i":2,"seen":0},{"content":"Who is using Waku?","slug":"who-is-using-waku","lvl":2,"i":3,"seen":0},{"content":"Status","slug":"status","lvl":3,"i":4,"seen":0},{"content":"RAILGUN","slug":"railgun","lvl":3,"i":5,"seen":0},{"content":"XMTP","slug":"xmtp","lvl":3,"i":6,"seen":0},{"content":"Implementations","slug":"implementations","lvl":2,"i":7,"seen":0},{"content":"nwaku","slug":"nwaku","lvl":3,"i":8,"seen":0},{"content":"js-waku","slug":"js-waku","lvl":3,"i":9,"seen":0},{"content":"go-waku","slug":"go-waku","lvl":3,"i":10,"seen":0},{"content":"@waku/react-native","slug":"waku-react-native","lvl":3,"i":11,"seen":0},{"content":"Waku Rust Bindings","slug":"waku-rust-bindings","lvl":3,"i":12,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Main page"},"navOrder":1679484446.309,"localPath":"main.md","path":[],"children":[],"isDir":false},"routeParams":{}},"__N_SSG":true}
|
||||
{"pageProps":{"markdown":{"content":"\nWaku is the communication layer for Web3. Decentralized communication that scales.\n\nPrivate. Secure. Runs anywhere.\n\n[Check the docs](https://js.waku.guide/)\n\n## What is Waku?\n\nWaku is a suite of privacy-preserving, peer-to-peer messaging protocols.\n\nWaku **removes centralized third parties** from messaging,\nenabling private, secure, censorship-free communication with no single point of failure.\n\nWaku **provides privacy-preserving** capabilities,\nsuch as sender anonymity,metadata protection and unlinkability to personally identifiable information.\n\nWaku is designed for **generalized messaging**, enabling human-to-human, machine-to-machine or hybrid communication.\n\nWaku runs everywhere: desktop, server, including **resource-restricted devices**, such as mobile devices and browsers.\n\n## How does it work?\n\nThe first version of Waku had its origins in the Whisper protocol,\nwith optimizations for scalability and usability.\nWaku v2 is a complete rewrite.\nIts relay protocol implements pub/sub over libp2p, and also introduces additional capabilities:\n\n1. Retrieving historical messages for mostly-offline devices.\n2. Adaptive nodes, allowing for heterogeneous nodes to contribute.\n3. Bandwidth preservation for light nodes.\n\nThis makes it ideal for running a p2p protocol on mobile, or in other similarly resource-restricted environments.\n\n[Read the RFCs](https://rfc.vac.dev/spec/10/)\n\n## Use Waku Now\n\nYou can\n\n- [Run a Waku node](/operator)\n- [Integrate Waku in your application](/platform)\n- [Contribute to Waku](/contribute)\n\n## Who is using Waku?\n\n### Status\n\nStatus is a secure messaging app, crypto wallet, and Web3 browser built with state-of-the-art technology.\n\n[Visit Status](https://status.im/)\n\n### RAILGUN\n\nRAILGUN is a privacy system for Ethereum that shields your assets in your own smart contract wallet.\nRAILGUN uses Waku when offering the ETH gas payments to other users,\nprivately signaling fees and offers for gas payment relayers to keep the privacy & anonymity of your stablecoin & token transactions.\n\n[Visit RAILGUN](https://railgun.org/)\n\n### XMTP\n\nXMTP is using Waku v2 for their open protocol and network for secure web3 messaging.\n\n[Visit XMTP](https://xmtp.com/)\n\n## Implementations\n\n### nwaku\n\nA nim implementation of the Waku v2 protocol.\nReference client and flagship implementation.\n\n[nwaku repository](https://github.com/waku-org/nwaku)\n\n### js-waku\n\nA JavaScript implementation for browser environments.\n\n[js-waku docs](https://js.waku.guide/)\n\n### go-waku\n\nA Go implementation for native integration in go applications,\nC-Bindings are also available with C#, Swift and Kotlin examples.\n\n[go-waku repository](https://github.com/waku-org/go-waku)\n\n### @waku/react-native\n\nIntegrate Waku in your React Native app using go-waku for mobile.\n\n[@waku/react-native repo](https://github.com/waku-org/waku-react-native)\n\n### Waku Rust Bindings\n\nRust layer on top of go-waku C FFI bindings.\n\n[waku-rust-bindings repo](https://github.com/waku-org/waku-rust-bindings)\n","metadata":{"title":"Main page"},"toc":[{"content":"What is Waku?","slug":"what-is-waku","lvl":2,"i":0,"seen":0},{"content":"How does it work?","slug":"how-does-it-work","lvl":2,"i":1,"seen":0},{"content":"Use Waku Now","slug":"use-waku-now","lvl":2,"i":2,"seen":0},{"content":"Who is using Waku?","slug":"who-is-using-waku","lvl":2,"i":3,"seen":0},{"content":"Status","slug":"status","lvl":3,"i":4,"seen":0},{"content":"RAILGUN","slug":"railgun","lvl":3,"i":5,"seen":0},{"content":"XMTP","slug":"xmtp","lvl":3,"i":6,"seen":0},{"content":"Implementations","slug":"implementations","lvl":2,"i":7,"seen":0},{"content":"nwaku","slug":"nwaku","lvl":3,"i":8,"seen":0},{"content":"js-waku","slug":"js-waku","lvl":3,"i":9,"seen":0},{"content":"go-waku","slug":"go-waku","lvl":3,"i":10,"seen":0},{"content":"@waku/react-native","slug":"waku-react-native","lvl":3,"i":11,"seen":0},{"content":"Waku Rust Bindings","slug":"waku-rust-bindings","lvl":3,"i":12,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Main page"},"navOrder":1685028084.829,"localPath":"main.md","path":[],"children":[],"isDir":false},"routeParams":{}},"__N_SSG":true}
|
||||
|
|
@ -1 +1 @@
|
|||
{"pageProps":{"markdown":{"content":"\n# Run a Waku Node\n\nBy running your own node you provide additional nodes for the Waku Network.\n\nIn the future, we intend to design and implement incentivization within some Waku protocols,\nso you can be rewarded when supporting the network.\n\nCheck out [the nwaku guide for operators](https://github.com/waku-org/nwaku/tree/master/docs/operators) to run your own node.\n","metadata":{"title":"Run a Waku Node"},"toc":[{"content":"Run a Waku Node","slug":"run-a-waku-node","lvl":1,"i":0,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Run a Waku Node"},"navOrder":1679484443.309,"localPath":"operator.md","path":["operator"],"children":[],"isDir":false},"routeParams":{"path":["operator"]}},"__N_SSG":true}
|
||||
{"pageProps":{"markdown":{"content":"\n# Run a Waku Node\n\nBy running your own node you provide additional nodes for the Waku Network.\n\nIn the future, we intend to design and implement incentivization within some Waku protocols,\nso you can be rewarded when supporting the network.\n\nCheck out [the nwaku guide for operators](https://github.com/waku-org/nwaku/tree/master/docs/operators) to run your own node.\n","metadata":{"title":"Run a Waku Node"},"toc":[{"content":"Run a Waku Node","slug":"run-a-waku-node","lvl":1,"i":0,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Run a Waku Node"},"navOrder":1685028081.83,"localPath":"operator.md","path":["operator"],"children":[],"isDir":false},"routeParams":{"path":["operator"]}},"__N_SSG":true}
|
||||
|
|
@ -1 +1 @@
|
|||
{"pageProps":{"markdown":{"content":"\n# Use Waku in Your Application\n\nInterested in using Waku to add private, secure, censorship-free communication\nto your Application?\nHere are your options:\n\n## Desktop & Server Applications\n\n### JSON RPC API\n\nYou can run your own nwaku (or go-waku) node alongside your application\nand access the Waku network using the available JSON RPC API.\n\nDocs:\n\n- [Use nwaku's JSON RPC API](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/jsonrpc-api.md)\n\n### HTTP REST API\n\n[Work is in progress](https://github.com/waku-org/nwaku/issues/727) to add an HTTP REST API to nwaku.\n\n### Waku as a library\n\nIt is possible to integrate Waku as a library.\n\n| Your Application's language | What to Use | Links |\n| --------------------------- | ------------------------ | ----------------------------------------------------------------------------------- |\n| Nim | nwaku as a library | [repository](https://github.com/waku-org/nwaku/tree/master/waku/v2) |\n| Go | go-waku as a library | [tutorials](https://github.com/waku-org/go-waku#tutorials-and-documentation) |\n| C/C++/etc | go-waku using C-Bindings | [C example](https://github.com/waku-org/go-waku/tree/master/examples/c-bindings) |\n| C# | go-waku using C-Bindings | [C# example](https://github.com/waku-org/go-waku/tree/master/examples/waku-csharp) |\n| Rust | Waku Rust Bindings | [Rust example](https://github.com/waku-org/waku-rust-bindings/tree/master/examples) |\n\n## Browser Application\n\n### JS-Waku\n\nYou can use js-waku to run a Waku node in the browser.\n\nDocs: https://js.waku.guide/\n\n## Mobile Application\n\nYou can run Waku on mobile phones, Android and iOS are supported:\n\n| Your Application's language | What to Use | Links |\n| --------------------------- | -------------------------- | ----------------------------------------------------------------------------------------- |\n| Swift (iOS) | go-waku using C-Bindings | [Swift example](https://github.com/waku-org/go-waku/tree/master/examples/swift-waku) |\n| Kotlin (Android) | go-waku using C-Bindings | [Kotlin example](https://github.com/waku-org/go-waku/tree/master/examples/android-kotlin) |\n| Go | go-waku as a library | [tutorials](https://github.com/waku-org/go-waku#tutorials-and-documentation) |\n| React Native | go-waku as a native module | [repository](https://github.com/waku-org/waku-react-native) |\n","metadata":{"title":"Use Waku in Your Application"},"toc":[{"content":"Use Waku in Your Application","slug":"use-waku-in-your-application","lvl":1,"i":0,"seen":0},{"content":"Desktop & Server Applications","slug":"desktop-server-applications","lvl":2,"i":1,"seen":0},{"content":"JSON RPC API","slug":"json-rpc-api","lvl":3,"i":2,"seen":0},{"content":"HTTP REST API","slug":"http-rest-api","lvl":3,"i":3,"seen":0},{"content":"Waku as a library","slug":"waku-as-a-library","lvl":3,"i":4,"seen":0},{"content":"Browser Application","slug":"browser-application","lvl":2,"i":5,"seen":0},{"content":"JS-Waku","slug":"js-waku","lvl":3,"i":6,"seen":0},{"content":"Mobile Application","slug":"mobile-application","lvl":2,"i":7,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Use Waku in Your Application"},"navOrder":1679484444.31,"localPath":"platform.md","path":["platform"],"children":[],"isDir":false},"routeParams":{"path":["platform"]}},"__N_SSG":true}
|
||||
{"pageProps":{"markdown":{"content":"\n# Use Waku in Your Application\n\nInterested in using Waku to add private, secure, censorship-free communication\nto your Application?\nHere are your options:\n\n## Desktop & Server Applications\n\n### JSON RPC API\n\nYou can run your own nwaku (or go-waku) node alongside your application\nand access the Waku network using the available JSON RPC API.\n\nDocs:\n\n- [Use nwaku's JSON RPC API](https://github.com/waku-org/nwaku/blob/master/docs/tutorial/jsonrpc-api.md)\n\n### HTTP REST API\n\n[Work is in progress](https://github.com/waku-org/nwaku/issues/727) to add an HTTP REST API to nwaku.\n\n### Waku as a library\n\nIt is possible to integrate Waku as a library.\n\n| Your Application's language | What to Use | Links |\n| --------------------------- | ------------------------ | ----------------------------------------------------------------------------------- |\n| Nim | nwaku as a library | [repository](https://github.com/waku-org/nwaku/tree/master/waku/v2) |\n| Go | go-waku as a library | [tutorials](https://github.com/waku-org/go-waku#tutorials-and-documentation) |\n| C/C++/etc | go-waku using C-Bindings | [C example](https://github.com/waku-org/go-waku/tree/master/examples/c-bindings) |\n| C# | go-waku using C-Bindings | [C# example](https://github.com/waku-org/go-waku/tree/master/examples/waku-csharp) |\n| Rust | Waku Rust Bindings | [Rust example](https://github.com/waku-org/waku-rust-bindings/tree/master/examples) |\n\n## Browser Application\n\n### JS-Waku\n\nYou can use js-waku to run a Waku node in the browser.\n\nDocs: https://js.waku.guide/\n\n## Mobile Application\n\nYou can run Waku on mobile phones, Android and iOS are supported:\n\n| Your Application's language | What to Use | Links |\n| --------------------------- | -------------------------- | ----------------------------------------------------------------------------------------- |\n| Swift (iOS) | go-waku using C-Bindings | [Swift example](https://github.com/waku-org/go-waku/tree/master/examples/swift-waku) |\n| Kotlin (Android) | go-waku using C-Bindings | [Kotlin example](https://github.com/waku-org/go-waku/tree/master/examples/android-kotlin) |\n| Go | go-waku as a library | [tutorials](https://github.com/waku-org/go-waku#tutorials-and-documentation) |\n| React Native | go-waku as a native module | [repository](https://github.com/waku-org/waku-react-native) |\n","metadata":{"title":"Use Waku in Your Application"},"toc":[{"content":"Use Waku in Your Application","slug":"use-waku-in-your-application","lvl":1,"i":0,"seen":0},{"content":"Desktop & Server Applications","slug":"desktop-server-applications","lvl":2,"i":1,"seen":0},{"content":"JSON RPC API","slug":"json-rpc-api","lvl":3,"i":2,"seen":0},{"content":"HTTP REST API","slug":"http-rest-api","lvl":3,"i":3,"seen":0},{"content":"Waku as a library","slug":"waku-as-a-library","lvl":3,"i":4,"seen":0},{"content":"Browser Application","slug":"browser-application","lvl":2,"i":5,"seen":0},{"content":"JS-Waku","slug":"js-waku","lvl":3,"i":6,"seen":0},{"content":"Mobile Application","slug":"mobile-application","lvl":2,"i":7,"seen":0}]},"navProps":{"metadata":{"published":true,"title":"Use Waku in Your Application"},"navOrder":1685028082.83,"localPath":"platform.md","path":["platform"],"children":[],"isDir":false},"routeParams":{"path":["platform"]}},"__N_SSG":true}
|
||||
|
|
@ -1 +0,0 @@
|
|||
self.__SSG_MANIFEST=new Set(["\u002Fauthors\u002F[author]","\u002F[[...path]]"]);self.__SSG_MANIFEST_CB&&self.__SSG_MANIFEST_CB()
|
||||
|
|
@ -0,0 +1 @@
|
|||
self.__SSG_MANIFEST=new Set(["\u002F[[...path]]","\u002Fauthors\u002F[author]"]);self.__SSG_MANIFEST_CB&&self.__SSG_MANIFEST_CB()
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -5,7 +5,7 @@
|
|||
"title": "About",
|
||||
"category": "page"
|
||||
},
|
||||
"navOrder": 1679484445.308,
|
||||
"navOrder": 1685028083.828,
|
||||
"localPath": "about.md",
|
||||
"path": [
|
||||
"about"
|
||||
|
|
@ -18,7 +18,7 @@
|
|||
"published": true,
|
||||
"title": "Contribute to Waku"
|
||||
},
|
||||
"navOrder": 1679484442.309,
|
||||
"navOrder": 1685028080.829,
|
||||
"localPath": "contribute.md",
|
||||
"path": [
|
||||
"contribute"
|
||||
|
|
@ -31,7 +31,7 @@
|
|||
"published": true,
|
||||
"title": "Main page"
|
||||
},
|
||||
"navOrder": 1679484446.309,
|
||||
"navOrder": 1685028084.829,
|
||||
"localPath": "main.md",
|
||||
"path": [],
|
||||
"children": [],
|
||||
|
|
@ -42,7 +42,7 @@
|
|||
"published": true,
|
||||
"title": "Run a Waku Node"
|
||||
},
|
||||
"navOrder": 1679484443.309,
|
||||
"navOrder": 1685028081.83,
|
||||
"localPath": "operator.md",
|
||||
"path": [
|
||||
"operator"
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
"published": true,
|
||||
"title": "Use Waku in Your Application"
|
||||
},
|
||||
"navOrder": 1679484444.31,
|
||||
"navOrder": 1685028082.83,
|
||||
"localPath": "platform.md",
|
||||
"path": [
|
||||
"platform"
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
[{"metadata":{"published":true,"title":"About","category":"page"},"navOrder":1679484445.308,"localPath":"about.md","path":["about"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Contribute to Waku"},"navOrder":1679484442.309,"localPath":"contribute.md","path":["contribute"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Main page"},"navOrder":1679484446.309,"localPath":"main.md","path":[],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Run a Waku Node"},"navOrder":1679484443.309,"localPath":"operator.md","path":["operator"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Use Waku in Your Application"},"navOrder":1679484444.31,"localPath":"platform.md","path":["platform"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"privacy-policy"},"navOrder":-1,"localPath":"privacy-policy.md","path":["privacy-policy"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"terms-of-use"},"navOrder":-1,"localPath":"terms-of-use.md","path":["terms-of-use"],"children":[],"isDir":false}]
|
||||
[{"metadata":{"published":true,"title":"About","category":"page"},"navOrder":1685028083.828,"localPath":"about.md","path":["about"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Contribute to Waku"},"navOrder":1685028080.829,"localPath":"contribute.md","path":["contribute"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Main page"},"navOrder":1685028084.829,"localPath":"main.md","path":[],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Run a Waku Node"},"navOrder":1685028081.83,"localPath":"operator.md","path":["operator"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Use Waku in Your Application"},"navOrder":1685028082.83,"localPath":"platform.md","path":["platform"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"privacy-policy"},"navOrder":-1,"localPath":"privacy-policy.md","path":["privacy-policy"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"terms-of-use"},"navOrder":-1,"localPath":"terms-of-use.md","path":["terms-of-use"],"children":[],"isDir":false}]
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
"published": true,
|
||||
"title": "Main page"
|
||||
},
|
||||
"navOrder": 1679484446.309,
|
||||
"navOrder": 1685028084.829,
|
||||
"localPath": "main.md",
|
||||
"path": [],
|
||||
"children": [],
|
||||
|
|
@ -26,7 +26,7 @@
|
|||
"title": "About",
|
||||
"category": "page"
|
||||
},
|
||||
"navOrder": 1679484445.308,
|
||||
"navOrder": 1685028083.828,
|
||||
"localPath": "about.md",
|
||||
"path": [
|
||||
"about"
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
"published": true,
|
||||
"title": "Use Waku in Your Application"
|
||||
},
|
||||
"navOrder": 1679484444.31,
|
||||
"navOrder": 1685028082.83,
|
||||
"localPath": "platform.md",
|
||||
"path": [
|
||||
"platform"
|
||||
|
|
@ -52,7 +52,7 @@
|
|||
"published": true,
|
||||
"title": "Run a Waku Node"
|
||||
},
|
||||
"navOrder": 1679484443.309,
|
||||
"navOrder": 1685028081.83,
|
||||
"localPath": "operator.md",
|
||||
"path": [
|
||||
"operator"
|
||||
|
|
@ -65,7 +65,7 @@
|
|||
"published": true,
|
||||
"title": "Contribute to Waku"
|
||||
},
|
||||
"navOrder": 1679484442.309,
|
||||
"navOrder": 1685028080.829,
|
||||
"localPath": "contribute.md",
|
||||
"path": [
|
||||
"contribute"
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
{"metadata":{"published":true,"title":"docs"},"navOrder":-1,"localPath":"","path":[""],"children":[{"metadata":{"published":true,"title":"Main page"},"navOrder":1679484446.309,"localPath":"main.md","path":[],"children":[],"isDir":false},{"metadata":{"published":true,"title":"About","category":"page"},"navOrder":1679484445.308,"localPath":"about.md","path":["about"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Use Waku in Your Application"},"navOrder":1679484444.31,"localPath":"platform.md","path":["platform"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Run a Waku Node"},"navOrder":1679484443.309,"localPath":"operator.md","path":["operator"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Contribute to Waku"},"navOrder":1679484442.309,"localPath":"contribute.md","path":["contribute"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"privacy-policy"},"navOrder":-1,"localPath":"privacy-policy.md","path":["privacy-policy"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"terms-of-use"},"navOrder":-1,"localPath":"terms-of-use.md","path":["terms-of-use"],"children":[],"isDir":false}]}
|
||||
{"metadata":{"published":true,"title":"docs"},"navOrder":-1,"localPath":"","path":[""],"children":[{"metadata":{"published":true,"title":"Main page"},"navOrder":1685028084.829,"localPath":"main.md","path":[],"children":[],"isDir":false},{"metadata":{"published":true,"title":"About","category":"page"},"navOrder":1685028083.828,"localPath":"about.md","path":["about"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Use Waku in Your Application"},"navOrder":1685028082.83,"localPath":"platform.md","path":["platform"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Run a Waku Node"},"navOrder":1685028081.83,"localPath":"operator.md","path":["operator"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"Contribute to Waku"},"navOrder":1685028080.829,"localPath":"contribute.md","path":["contribute"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"privacy-policy"},"navOrder":-1,"localPath":"privacy-policy.md","path":["privacy-policy"],"children":[],"isDir":false},{"metadata":{"published":true,"title":"terms-of-use"},"navOrder":-1,"localPath":"terms-of-use.md","path":["terms-of-use"],"children":[],"isDir":false}]}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue