waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs.waku.org/docs/guides/getting-started.md

6.9 KiB
Raw Blame History

title hide_table_of_contents slug
Introduction to Waku true /

Waku is a family of robust, censorship-resistant, peer-to-peer communication protocols that enable privacy-focused messaging for Web3 applications, allowing you to integrate decentralised communication features into your dApp without compromising security or privacy.

graph LR
    S1(Message Sender 1) -->|Message 1| W(The Waku Network)
    S2(Message Sender 2) -->|Message 2| W
    S3(Message Sender 3) -->|Message 3| W
    W -->|Message 1| R1(Message Receiver 1)
    W -->|Message 2| R1
    W -->|Message 3| R2(Message Receiver 2)

:::tip Check out our Learn section, YouTube channel, and Blog to dive into how Waku works behind the scenes! :::

What isn’t Waku?

  • Waku is not a blockchain but a network composed of protocols designed for Web3 communication, operating without the need for gas fees.
  • Waku is not just for messaging applications; it supports the development of complex applications that require secure and private data transmission.
  • Waku is not a long-term data storage network; it focuses on short, ephemeral, real-time messaging.

What can Waku be used for?

  1. Chat Messengers: Waku can be used to build private, decentralised chat apps resistant to censorship.
  2. Voting and Proposals: Exchange votes on proposals off-chain via Waku to save gas fees, then submit aggregated results to the blockchain.
  3. NFT Marketplaces: Use Waku to handle off-chain NFT bids and offers for gas savings, and to integrate social interactions like likes and comments.
  4. State Channels: Establish and maintain state channels with Waku, facilitating seamless message exchanges and updates without blockchain interaction.
  5. Signature Exchange for Multi-Signature Wallets: Allow multi-signature wallet owners to exchange signatures privately and securely through Waku.
  6. Game Mechanics Communication: Implement Waku as a communication layer for decentralised, peer-to-peer gaming, avoiding centralised infrastructure.
  7. Layer 2 Coordination (Open Market, Spam Protected Mempool): Broadcast and aggregate Layer 2 transactions via Waku to enhance privacy and scalability, reducing network load.
  8. Social Media Platforms: Beyond chat messengers, use Waku for decentralised, censorship-resistant social media platforms like news feeds and multimedia sharing.

:::tip Looking for what to build with Waku? Discover a collection of sample ideas and use cases for inspiration, curated by our community at: https://ideas.waku.org/ and Awesome Waku. :::

Case studies

Getting started

Run a Waku node

Waku is a decentralised, permissionless system where anyone can run a node, use the network, and contribute to its support. We recommend following the Run Nwaku with Docker Compose guide and Waku Node Operator Cheatsheet to easily run a node.

:::tip If you encounter issues running your node or require assistance with anything, please visit the #node-help channel on our Discord. :::

Integrate using SDKs

Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.

Description Documentation
@waku/sdk JavaScript/TypeScript SDK designed for browser environments JavaScript Waku SDK
@waku/react React components and UI adapters designed for seamless integration with @waku/sdk Build React DApps Using @waku/react

Other integrations

Description Documentation
REST API REST API interface provided by nwaku and go-waku to interact with the Waku Network Waku Node REST API Reference
@waku/create-app Starter kit to bootstrap your next @waku/sdk project from various example templates Scaffold DApps Using @waku/create-app

:::tip Explore some example apps built using Waku at https://examples.waku.org/ and view a list of projects and workshops from previous hackathons at Awesome Waku. :::