Merge pull request #50 from waku-org/js-waku-overhaul
hide js-waku navbar
This commit is contained in:
LordGhostX
GitHub
commit
3baf040f5e
|
|
@ -6,7 +6,7 @@ Waku takes a modular approach, providing a range of protocols that enable applic
|
|||
|
||||
### [Waku Relay](https://rfc.vac.dev/spec/11/)
|
||||
|
||||
`Waku Relay` is a privacy-focused peer-to-peer messaging protocol that extends the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). It utilizes a Pub/Sub approach to enable secure communication channels, encryption, and protection against censorship. With a strong emphasis on privacy, `Waku Relay` ensures scalability, allowing many peers and messages to coexist within the network.
|
||||
`Waku Relay` is a privacy-focused peer-to-peer messaging protocol that extends the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). It utilizes a Pub/Sub architecture to enable secure communication channels, encryption, and protection against censorship. With a strong emphasis on privacy, `Waku Relay` ensures scalability, allowing many peers and messages to coexist within the network.
|
||||
|
||||
### [Waku Filter](https://rfc.vac.dev/spec/12/)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Waku Implementations
|
||||
---
|
||||
|
||||
Waku has been implemented in multiple programming languages to address various use cases. The Waku development team builds and maintains each implementation, ensuring that updates are provided automatically.
|
||||
Waku has been implemented in multiple programming languages to address various use cases. The Waku team builds and maintains each implementation, ensuring that updates are provided automatically.
|
||||
|
||||
### [nwaku](https://github.com/waku-org/nwaku)
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Ongoing research is being conducted, including developing [Rate Limiting Nullifi
|
|||
|
||||
## [Data Confidentiality, Integrity, and Authenticity](https://rfc.vac.dev/spec/10/#data-confidentiality-integrity-and-authenticity)
|
||||
|
||||
Confidentiality in Waku is ensured through data encryption, while integrity and authenticity are achieved through digital signatures. These security measures are available in [Waku Message (version 1)](https://rfc.vac.dev/spec/14#version-1)) and [Waku Noise](https://rfc.vac.dev/spec/35/) protocols, which offer payload encryption and encrypted signatures. [Waku Noise](https://rfc.vac.dev/spec/35/) also facilitates secure channel negotiation within the Waku network.
|
||||
Confidentiality in Waku is ensured through data encryption, while integrity and authenticity are achieved through digital signatures. These security measures are available in [Waku Message (version 1)](https://rfc.vac.dev/spec/14#version-1) and [Waku Noise](https://rfc.vac.dev/spec/35/) protocols, which offer payload encryption and encrypted signatures. [Waku Noise](https://rfc.vac.dev/spec/35/) also facilitates secure channel negotiation within the Waku network.
|
||||
|
||||
## [Security Considerations](https://rfc.vac.dev/spec/10/#security-considerations)
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Waku Use Cases
|
|||
|
||||
Waku is a decentralized 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 Messenger
|
||||
### Chat Messengers
|
||||
|
||||
Waku can be used as the communication layer when building a private, decentralized, and censorship-resistant messenger.
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ With Waku, you can create, answer, and view censorship-resistant polls, fosterin
|
|||
|
||||
* [Waku Connect Poll SDK](https://github.com/status-im/wakuconnect-vote-poll-sdk)
|
||||
|
||||
### NFT Marketplace
|
||||
### 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.
|
||||
|
||||
|
|
@ -65,7 +65,7 @@ dApp operators can use communication between a user's wallet and their dApp to n
|
|||
|
||||
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.
|
||||
|
||||
### Generalized Marketplace
|
||||
### Generalized Marketplaces
|
||||
|
||||
Waku can enable users to offer, bid, accept, and trade goods and services, making it possible to create ride-sharing or trading apps.
|
||||
|
||||
|
|
@ -73,6 +73,6 @@ Waku can enable users to offer, bid, accept, and trade goods and services, makin
|
|||
|
||||
* [Waku-Uber](https://github.com/TheBojda/waku-uber)
|
||||
|
||||
### Social Media Platform
|
||||
### Social Media Platforms
|
||||
|
||||
While chat messengers are a type of social media that can be decentralized 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.
|
||||
|
|
@ -31,9 +31,9 @@ Waku can run on any platform or environment, even in restricted settings with li
|
|||
|
||||
Waku can cater to applications that require privacy guarantees, such as:
|
||||
|
||||
- Pseudonymity and not being tied to any personally identifiable information (PII).
|
||||
- Pseudonymity and not being tied to any Personally Identifiable Information (PII).
|
||||
- Metadata protection in transit.
|
||||
- Various forms of unlinkability.
|
||||
- Various forms of [unlinkability](overview/reference/security-features#anonymityunlinkability).
|
||||
|
||||
### Modular Design
|
||||
|
||||
|
|
@ -47,13 +47,13 @@ These options are part of the [Anonymity Trilemma](https://eprint.iacr.org/2017/
|
|||
|
||||
## How Does Waku Work?
|
||||
|
||||
The Waku Relay protocol is the foundation of the Waku Network, which employs a Pub/Sub architecture built on the `libp2p gossipsub` protocol. In addition to this, various other Waku protocols have been created to facilitate specific functionalities, including but not limited to:
|
||||
The [Waku Relay](overview/concepts/protocols#waku-relay) protocol is the foundation of the Waku network, which employs a Pub/Sub architecture built on the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). Additionally, various other Waku protocols have been created to facilitate specific functionalities, including but not limited to:
|
||||
|
||||
1. Facilitating the retrieval of historical messages for primarily offline devices.
|
||||
2. Providing solutions for encrypted communication, such as symmetric encryption, ECIES/asymmetric encryption, and noise handshake-based key turns.
|
||||
3. Preserve bandwidth usage for resource-limited environments.
|
||||
3. Preserving bandwidth usage for resource-limited environments.
|
||||
4. Implementing economic spam protection (rate limits) while ensuring privacy.
|
||||
5. Developing methods to protect against mass deanonymization (currently being researched).
|
||||
6. Designing strategies to scale [Waku Relay/GossipSub](/overview/concepts/protocols#waku-relay) securely.
|
||||
6. Designing strategies to scale `Waku Relay/GossipSub` securely.
|
||||
|
||||
If you want to learn more about how Waku operates, the [WAKU2 RFC](https://rfc.vac.dev/spec/10/) provides an in-depth look under the hood.
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ title: Who is Using Waku?
|
|||
|
||||
### XMTP
|
||||
|
||||
[XMTP](https://xmtp.org/) is using Waku v2 for their open protocol and network for secure Web3 messaging.
|
||||
[XMTP](https://xmtp.org/) uses Waku to enable secure Web3 messaging in their open protocol and network.
|
||||
|
||||
### RAILGUN
|
||||
|
||||
[RAILGUN](https://railgun.org/) is a privacy-focused system for Ethereum that secures your assets in a smart contract wallet while using Waku to offer private ETH gas payments to other users, ensuring anonymity and privacy for your stablecoin and token transactions.
|
||||
[RAILGUN](https://railgun.org/) uses Waku to offer private ETH gas payments to users, ensuring anonymity and privacy for their stablecoin and token transactions.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Waku is intended to empower individuals by returning control of communication to
|
|||
- It allows developers to decentralize communication in their dApps or move actions off-chain while maintaining decentralization.
|
||||
- It can run on various platforms, including mobile devices, cloud environments, web browsers, native desktop apps, or even a [Dappnode](https://dappnode.com/)!
|
||||
|
||||
## Whisper vs. Waku: Why Waku is Necessary
|
||||
## Why Waku is Necessary
|
||||
|
||||
| | Whisper | Waku |
|
||||
| - | - | - |
|
||||
|
|
|
|||
|
|
@ -55,12 +55,6 @@ const config = {
|
|||
sidebarId: 'main',
|
||||
label: 'Getting Started',
|
||||
},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
position: 'left',
|
||||
sidebarId: 'browser',
|
||||
label: 'JavaScript (Browser)',
|
||||
},
|
||||
],
|
||||
},
|
||||
announcementBar: {
|
||||
|
|
|
|||
Loading…
Reference in New Issue