status-im
/
js-waku-examples
mirror of https://github.com/status-im/js-waku-examples.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Examples on how to use the js-waku library
322 Commits 10 Branches 0 Tags 183 MiB
JavaScript 90.1%
HTML 5.6%
Dockerfile 3.4%
Shell 0.9%
Go to file
weboko 3d3f75bb64
use npx in husky 		2022-12-23 23:05:50 +01:00
.github/workflows chore: remove dependabot 2022-11-21 10:16:45 +11:00
.husky use npx in husky 2022-12-23 23:05:50 +01:00
ci add: eslint & lint all files 2022-12-09 16:59:11 +05:30
eth-pm chore(eth-pm): bump @waku/core to 0.0.8 2022-12-20 11:47:57 +11:00
light-chat chore(light-chat): bump @waku/core to 0.0.7 2022-12-16 12:24:20 +11:00
light-js chore(light-js): bump @waku/core to 0.0.7 2022-12-16 12:29:52 +11:00
packages/create-waku-app nit: move to await try/catch 2022-12-13 00:11:18 +01:00
relay-angular-chat add: eslint & lint all files 2022-12-09 16:59:11 +05:30
relay-js chore(relay-js): bump @waku/core to 0.0.7 2022-12-16 12:56:14 +11:00
relay-reactjs-chat chore(relay-reactjs-chat): bump @waku/core to 0.0.8 and other @waku/* pkgs 2022-12-21 16:45:15 +11:00
rln-js fix: unaddressed variable 2022-12-23 18:32:35 +05:30
store-js chore(store-js): bump @waku/core to 0.0.7 2022-12-16 13:00:22 +11:00
store-reactjs-chat add: eslint & lint all files 2022-12-09 16:59:11 +05:30
web-chat add: prettier to precommit; prettify everything 2022-12-09 16:25:19 +05:30
.cspell.json chore(eth-pm): bump js-waku to 0.29.0 2022-09-22 17:42:56 +10:00
.eslintrc.json setup: eslint config 2022-12-09 16:59:27 +05:30
.gitignore ignore package-lock.json 2022-12-13 00:08:20 +01:00
LICENSE-APACHE-v2 First commit 2022-06-17 10:48:15 +10:00
LICENSE-MIT First commit 2022-06-17 10:48:15 +10:00
README.md doc: update readme 2022-10-28 14:17:15 +11:00
package.json setup: eslint config 2022-12-09 16:59:27 +05:30
pnpm-lock.yaml setup: eslint config 2022-12-09 16:59:27 +05:30

README.md

Js-Waku Examples

Examples

Here is the list of the examples using js-waku and the features they demonstrate:

See https://docs.wakuconnect.dev/docs/examples/ for more examples.

Web Chat App

  • code
  • website
  • Demonstrates: Group chat, React/TypeScript, Relay, Store.

Ethereum Private Messaging

End-to-end encrypted communication between two Ethereum addresses.

  • code
  • website
  • Demonstrates: Private Messaging, React/TypeScript, Light Client, Signature with Web3, Asymmetric Encryption.

Waku Light Client in JavaScript

Send messages between several users (or just one) using light client targetted protocols.

  • code
  • website
  • Demonstrates: Waku Light node: Filter + Light Push, Pure Javascript/HTML using ESM/unpkg bundle.

Minimal Angular (v13) Waku Relay

A barebone messaging app to illustrate the Angular Relay guide.

  • code
  • website
  • Demonstrates: Group messaging, Angular, Waku Relay, Protobuf using protobufjs, No async/await syntax.

Waku Relay in JavaScript

This example uses Waku Relay to send and receive simple text messages.

  • code
  • website
  • Demonstrates: Waku Relay, Pure Javascript/HTML using ESM/unpkg bundle.

Waku Relay in ReactJS

A barebone chat app to illustrate the ReactJS Relay guide.

  • code
  • website
  • Demonstrates: Group chat, React/JavaScript, Waku Relay, Protobuf using protobufjs.

Using RLN in JavaScript

Rate limiting nullifier (RLN) is a construct based on zero-knowledge proofs that provides an anonymous rate-limited signaling/messaging framework suitable for decentralized (and centralized) environments

Use RLN in the browser, compatible with nwaku chat2 and go-waku chat2 RLN implementations.

  • code
  • website
  • Demonstrates:
    • RLN:
      • Generate credentials
      • Insert membership to smart contract (Goerli testnet)
      • Retrieve smart contract state
      • Generate and send proofs
      • Verify incoming proofs
  • Pure Javascript/HTML using ESM/unpkg bundle.

Using Waku Store in JavaScript

This example uses Waku Store to retrieve the latest ping relay message (used for keep alive purposes) and displays its timestamp.

  • code
  • website
  • Demonstrates: Waku Store: Using a condition to stop retrieving results from Waku Store, Pure Javascript/HTML using ESM/unpkg bundle.

Minimal ReactJS Waku Store App

A simple app that retrieves chat messages using Waku Store to illustrate the Retrieve Messages Using Waku Store With ReactJS guide.

  • code
  • website
  • Demonstrates: React/JavaScript, Waku Store, Protobuf using protobufjs, no async/await syntax.

Continuous Integration

The master branch is being built by Jenkins CI: https://ci.infra.status.im/job/website/job/examples.waku.org/

Based on the ci/Jenkinsfile.