mirror of https://github.com/waku-org/waku.org.git
add missing pages
This commit is contained in:
LordGhostX
parent
715a020f93
commit
efad44f481
|
|
@ -0,0 +1,38 @@
|
||||||
|
---
|
||||||
|
title: Contribute to Waku
|
||||||
|
sidebar_position: 7
|
||||||
|
---
|
||||||
|
|
||||||
|
Get involved in Waku's open-source initiatives to improve the protocols, SDKs, developer tools and examples, and documentation. You can contribute by:
|
||||||
|
|
||||||
|
- [Running a node](https://docs.waku.org/#run-a-waku-node) within your application.
|
||||||
|
- [Reporting bugs](#report-a-bug) and [suggesting missing features](#suggest-a-feature) to the development team.
|
||||||
|
- Completing [Waku bounties](#complete-waku-bounties) and participating in our [bug bounty programme](#submit-security-bug-reports).
|
||||||
|
- Inspiring other developers to explore and use Waku for [various use cases](/about/use-cases).
|
||||||
|
|
||||||
|
Begin your journey by visiting the [documentation](https://docs.waku.org/) and start building on Waku today!
|
||||||
|
|
||||||
|
## Report a bug
|
||||||
|
|
||||||
|
To report a bug, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the bug and include detailed steps to reproduce the bug.
|
||||||
|
|
||||||
|
## Suggest a feature
|
||||||
|
|
||||||
|
To suggest a new feature, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the feature and specify the use cases the feature can enable, allowing us to investigate and prioritise accordingly.
|
||||||
|
|
||||||
|
## Make pull requests
|
||||||
|
|
||||||
|
Community pull requests (PRs) are highly encouraged, but we recommend [suggesting a feature](#suggest-a-feature) first to gauge interest and gather feedback before proceeding with a PR.
|
||||||
|
|
||||||
|
## Complete Waku bounties
|
||||||
|
|
||||||
|
To promote community contributions, we encourage members to complete bounties that benefit Waku and earn rewards while positively impacting the network. Join the bounty programme at: <https://github.com/waku-org/bounties>.
|
||||||
|
|
||||||
|
|
||||||
|
## Submit security bug reports
|
||||||
|
|
||||||
|
To improve Waku's security, we invite researchers to collaborate in identifying and resolving potential vulnerabilities and earn rewards for their efforts. To participate, please review our bug bounty programme's details and submit your reports at: <https://hackenproof.com/status-dot-app/waku>.
|
||||||
|
|
||||||
|
## Contribute to Waku research
|
||||||
|
|
||||||
|
Waku Research is an innovative R&D project dedicated to developing modular peer-to-peer protocols for communication that prioritise privacy, security, and censorship resistance. Explore Waku's ongoing challenges and experimental code at <https://github.com/waku-org/research>.
|
||||||
|
|
@ -0,0 +1,79 @@
|
||||||
|
---
|
||||||
|
title: Use cases
|
||||||
|
sidebar_position: 6
|
||||||
|
---
|
||||||
|
|
||||||
|
Waku is a decentralised communication network, facilitating secure and private person-to-person and machine-to-machine communication without a central authority. It supports various use cases, including but not limited to:
|
||||||
|
|
||||||
|
### Chat messengers
|
||||||
|
|
||||||
|
Waku can be used as the communication layer when building a private, decentralised, and censorship resistant messenger.
|
||||||
|
|
||||||
|
#### Demos
|
||||||
|
|
||||||
|
* [Status Web](https://github.com/status-im/status-web)
|
||||||
|
|
||||||
|
### Polls
|
||||||
|
|
||||||
|
With Waku, you can create, answer, and view censorship resistant polls, promoting a democratic and transparent voting environment immune to manipulation and censorship.
|
||||||
|
|
||||||
|
#### Demos
|
||||||
|
|
||||||
|
* [Waku Connect Poll SDK](https://github.com/status-im/wakuconnect-vote-poll-sdk)
|
||||||
|
|
||||||
|
### NFT marketplaces
|
||||||
|
|
||||||
|
Waku can be used to take NFT bids and offers off-chain, enabling gas savings. Additionally, it allows for adding a social media layer, enabling NFT owners to like, comment, and perform other social actions.
|
||||||
|
|
||||||
|
#### Demos
|
||||||
|
|
||||||
|
* [SmolPuddle Marketplace](https://github.com/Agusx1211/smolpuddle-web)
|
||||||
|
|
||||||
|
### State channels
|
||||||
|
|
||||||
|
Waku can enable two parties to establish and sustain a state channel effortlessly, facilitating message exchange and seamless updates to their shared agreement without direct blockchain involvement.
|
||||||
|
|
||||||
|
### Voting and proposals
|
||||||
|
|
||||||
|
To save on gas fees, votes for proposals submitted on the blockchain can be exchanged over Waku. These votes can then be aggregated and submitted to the blockchain to commit the result.
|
||||||
|
|
||||||
|
#### Demos
|
||||||
|
|
||||||
|
* [Waku Connect Poll SDK](https://github.com/status-im/wakuconnect-vote-poll-sdk)
|
||||||
|
|
||||||
|
### Signature exchange for multi-signature wallets
|
||||||
|
|
||||||
|
Waku can enable multiple owners of a given multi-signature wallet to exchange signatures in a decentralised, private, and censorship resistant manner, allowing for the approval of transactions.
|
||||||
|
|
||||||
|
### Game mechanics communication
|
||||||
|
|
||||||
|
Waku can be used as the communication layer for a peer-to-peer, decentralised game, eliminating the need for a centralised infrastructure for gameplay communications.
|
||||||
|
|
||||||
|
#### Demos
|
||||||
|
|
||||||
|
* [Super Card Game](https://github.com/fjij/ethonline-2021)
|
||||||
|
|
||||||
|
### DApp to wallet communication
|
||||||
|
|
||||||
|
DApp operators can use communication between a user's wallet and their DApp to notify users (e.g., governance token holders can be notified to vote on a proposal) or to request transaction signatures from the wallet.
|
||||||
|
|
||||||
|
#### Demos
|
||||||
|
|
||||||
|
* [WalletConnect 2.0](https://walletconnect.com/)
|
||||||
|
* [HashPack](https://www.hashpack.app/hashconnect)
|
||||||
|
|
||||||
|
### Layer 2 coordination (open market, spam protected mempool)
|
||||||
|
|
||||||
|
Waku can broadcast and aggregate Layer 2 transactions to enhance privacy, anonymity, and resilience. Aggregating transactions reduces network load and improves scalability, ensuring a more robust Layer 2 ecosystem.
|
||||||
|
|
||||||
|
### Generalised marketplaces
|
||||||
|
|
||||||
|
Waku can enable users to offer, bid, accept, and trade goods and services, making it possible to create ride-sharing or trading apps.
|
||||||
|
|
||||||
|
#### Demos
|
||||||
|
|
||||||
|
* [Waku-Uber](https://github.com/TheBojda/waku-uber)
|
||||||
|
|
||||||
|
### Social media platforms
|
||||||
|
|
||||||
|
While chat messengers are a type of social media that can be decentralised and made censorship resistant through Waku, other forms of social media, such as news feeds, blog posts, and audio or video sharing, can also benefit from using Waku.
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
title: Why Waku?
|
||||||
|
sidebar_position: 5
|
||||||
|
---
|
||||||
|
|
||||||
|
Present-day communication is predominantly centralised, enabling significant third-party intervention, with profit motives overshadowing principles and downplaying censorship and privacy concerns. This shift leads to the exploitation and unauthorised use of user data in the surveillance economy, where data ownership is no longer in the hands of individuals.
|
||||||
|
|
||||||
|
Waku transforms how individuals communicate and manage data by offering a scalable, decentralised solution that grants ultimate control.
|
||||||
|
|
||||||
|
- Waku improves upon Whisper's capabilities by overcoming limitations and addressing functional gaps.
|
||||||
|
- Provides a public infrastructure for the Ethereum and multi-chain ecosystem, serving as a common good.
|
||||||
|
- Waku is not confined to a particular blockchain.
|
||||||
|
- Modular, adaptable, configurable, and can cater to various use cases.
|
||||||
|
- Enables developers to decentralise communication in their DApps or move actions off-chain while maintaining decentralisation.
|
||||||
|
- Designed to run on various platforms, including mobile devices, cloud environments, web browsers, desktop apps, or even a [Dappnode](https://dappnode.com/)!
|
||||||
|
|
||||||
|
## Why Waku is necessary
|
||||||
|
|
||||||
|
| | Whisper | Waku |
|
||||||
|
| - | - | - |
|
||||||
|
| **Scalability** | Whisper does not scale very well, specifically when it comes to bandwidth usage on mobile devices. | Uses GossipSub and Content Topics. |
|
||||||
|
| **Spam Resistance** | Proof of work requires too much battery and compute power making it a poor mechanism for heterogeneous nodes. | Uses innovative p2p economic spam protection mechanism RLN Relay. |
|
||||||
|
| **Incentivisation Infrastructure** | There is no incentive to run a Whisper node. | Research in progress to design incentivisation for node operators. |
|
||||||
|
| **Formal Specification/Documentation** | Lack of formal and unambiguous specification. | The specs and docs are open-source and licenced under CC0, making them freely available for anyone to read, modify and improve without restrictions. |
|
||||||
|
| **Portability** | Runs over devp2p which limits where Whisper can run and how. | Waku is built using libp2p, making it easy to run Waku anywhere. |
|
||||||
|
|
@ -5,7 +5,7 @@ require('dotenv').config()
|
||||||
/** @type {import('@docusaurus/types').Config} */
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
const config = {
|
const config = {
|
||||||
title: 'Waku',
|
title: 'Waku',
|
||||||
url: 'https://url',
|
url: 'https://waku.org',
|
||||||
baseUrl: '/',
|
baseUrl: '/',
|
||||||
|
|
||||||
markdown: {
|
markdown: {
|
||||||
|
|
@ -16,8 +16,8 @@ const config = {
|
||||||
// metadata like html lang. For example, if your site is Chinese, you may want
|
// metadata like html lang. For example, if your site is Chinese, you may want
|
||||||
// to replace "en" with "zh-Hans".
|
// to replace "en" with "zh-Hans".
|
||||||
i18n: {
|
i18n: {
|
||||||
defaultLocale: 'en',
|
defaultLocale: 'en-GB',
|
||||||
locales: ['en'],
|
locales: ['en-GB'],
|
||||||
},
|
},
|
||||||
|
|
||||||
presets: [
|
presets: [
|
||||||
|
|
|
||||||
|
|
@ -9,12 +9,8 @@ sidebar_class_name: hidden
|
||||||
import { Grid, Box, SocialCard, GithubChallenges } from '/src/components/mdx'
|
import { Grid, Box, SocialCard, GithubChallenges } from '/src/components/mdx'
|
||||||
import * as challengesData from '/generated/challenges.json'
|
import * as challengesData from '/generated/challenges.json'
|
||||||
|
|
||||||
# Join the community
|
|
||||||
|
|
||||||
<Box top={24} bottom={24}>
|
<Box top={24} bottom={24}>
|
||||||
Welcome to the Waku Community!
|
Welcome to the Waku Community! Whether you are interested in building with Waku, contributing to the network, expanding your knowledge, or staying abreast of our progress, we have something for everyone.
|
||||||
|
|
||||||
Whether you are interested in building with Waku, contributing to the network, expanding your knowledge, or staying abreast of our progress, we have something for everyone.
|
|
||||||
</Box>
|
</Box>
|
||||||
|
|
||||||
<Box top={56} bottom={56}>
|
<Box top={56} bottom={56}>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue