Examples on how to use the js-waku library

Go to file

Arseniy Klempner 73ca3ab4e9 Merge pull request #283 from waku-org/adklempner/light-js-store-query feat: add button to query from store in light-js		2023-11-07 08:04:58 -08:00
.github	feat: add direct relay-rtc example (#260 )	2023-10-03 01:03:48 +02:00
.husky	use npx in husky	2022-12-23 23:05:50 +01:00
ci	feat: add direct relay-rtc example (#260 )	2023-10-03 01:03:48 +02:00
create-waku-app	update README, bump version and fix bin command	2023-01-19 20:05:59 +01:00
examples	Merge pull request #283 from waku-org/adklempner/light-js-store-query	2023-11-07 08:04:58 -08:00
.eslintrc.json	setup: eslint config	2022-12-09 16:59:27 +05:30
.gitignore	chore!: update rln-js (#225 )	2023-04-28 01:33:25 +02: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	chore: update docs link (#251 )	2023-07-12 11:11:30 +01:00
index.html	Correcting title	2023-04-28 13:50:04 +08:00
package-lock.json	use npm instead of pnpm	2022-12-24 01:05:22 +01:00
package.json	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://examples.waku.org/ 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 seamless integration of js-waku into AngularJS.

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 seamless integration of js-waku into ReactJS.

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 retrieval of messages with js-waku and ReactJS.

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.