acid-info
/
docs.wakuconnect.dev
mirror of https://github.com/acid-info/docs.wakuconnect.dev.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Examples are now hosted on wakuconnect.dev (#33)

This commit is contained in:
Franck R 2022-02-02 11:56:14 +11:00 committed by GitHub
parent f2e22d0cd0
commit 9f9d3eb6b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
content/docs/examples.md
View File

@ -44,6 +44,7 @@ Demonstrates:
## Web Chat App
Repo: [web-chat](https://github.com/status-im/js-waku/tree/main/examples/web-chat).
Live: https://js-waku.wakuconnect.dev/examples/web-chat/
Demonstrates:
@ -56,6 +57,7 @@ Demonstrates:
## Ethereum Private Message Web App
Repo: [eth-pm](https://github.com/status-im/js-waku/tree/main/examples/eth-pm).
Live: https://js-waku.wakuconnect.dev/examples/eth-pm/
Demonstrates:
@ -70,6 +72,7 @@ Demonstrates:
## Ethereum Private Message Using Web3 Wallet Encryption API Web App
Repo: [eth-pm-wallet-encryption](https://github.com/status-im/js-waku/tree/main/examples/eth-pm-wallet-encryption).
Live: https://js-waku.wakuconnect.dev/examples/eth-pm-wallet-encryption/
Demonstrates:

4
content/docs/guides/04_encrypt_messages_version_1.md
View File

@ -239,7 +239,7 @@ waku.relay.addObserver(
## Code Example
The [Eth-PM](https://github.com/status-im/js-waku/tree/main/examples/eth-pm) Web App example demonstrates both the use of symmetric and asymmetric encryption.
The [Eth-PM](https://github.com/status-im/js-waku/tree/main/examples/eth-pm/) Web App example demonstrates both the use of symmetric and asymmetric encryption.
Asymmetric encryption is used for private messages so that only the intended recipient can read said messages.
@ -247,6 +247,6 @@ Symmetric encryption is used for the public key messages.
In this instance, the same key is used for all users: the Keccak-256 hash of the content topic (which results in 32 bytes array).
While this does not add functional value, it does demonstrate the usage of symmetric encryption in a web app.
A live version of Eth-PM can be found at https://status-im.github.io/js-waku/eth-pm/.
A live version of Eth-PM can be found at https://js-waku.wakuconnect.dev/examples/eth-pm.
The specifications of the protocol it implements can be found at [20/TOY-ETH-PM](https://rfc.vac.dev/spec/20/).

2
content/docs/guides/08_reactjs_store.md
View File

@ -530,7 +530,7 @@ However, it can only select a connected node, which is why the bootstrapping is
It will throw an error if no store node is available.
If no message are returned,
then you can use https://status-im.github.io/js-waku/ to send some messages on the
then you can use https://js-waku.wakuconnect.dev/examples/web-chat/ to send some messages on the
toy chat topic and refresh your app.
## Filter messages by send time

9
content/docs/introduction.md
View File

@ -31,6 +31,15 @@ The js-waku repository also holds a number of [examples](https://github.com/stat
The examples are working Proof-of-Concepts that demonstrate how to use js-waku.
Check out the [example list](/docs/examples/) to see what usage each example demonstrates.
You can also try out some of the examples at the following locations:
- [web-chat](https://js-waku.wakuconnect.dev/examples/web-chat): A simple public chat ([docs](/docs/examples/#web-chat-app)).
- [eth-pm](https://js-waku.wakuconnect.dev/examples/eth-pm): End-to-end encrypted private messages
([docs](/docs/examples/#ethereum-private-message-web-app)).
- [eth-pm-wallet-encryption](https://js-waku.wakuconnect.dev/examples/eth-pm-wallet-encryption): Eth-pm using Web3 wallet encryption API
- ([dosc](/docs/examples/#ethereum-private-message-using-web3-wallet-encryption-api-web-app)).
Finally, if you want to learn how Waku works under the hoods, check the specs at [rfc.vac.dev](https://rfc.vac.dev/).
## Bugs, Questions & Support