waku-org/js-waku
1
0
Fork 0
mirror of https://github.com/waku-org/js-waku.git synced 2025-02-24 18:18:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move Eth-DM notes to root dir

Browse Source
This commit is contained in:
Franck Royer 2021-06-21 15:48:56 +10:00
parent d9f875ca4a
commit 68faba24c1
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -191,6 +191,29 @@ You can also specify an optional `listenAddr` parameter (.e.g `--listenAddr /ip4
This is only useful if you want a remote node to dial to your chat app,
it is not necessary in normal usage when you just connect to the fleet.
## Ethereum Direct Message
A PoC implementation of [20/ETH-DM](https://rfc.vac.dev/spec/20/).
Ethereum Direct Message, or Eth-DM, is a protocol that allows sending encrypted message to a recipient,
only knowing their Ethereum Address.
This is protocol has been created to demonstrated how encryption and signature could be added to messages
sent over the Waku v2 network.
The `main` branch's HEAD is deployed on GitHub Pages at https://status-im.github.io/js-waku/eth-dm/.
To run a development version locally, do:
```shell
git clone https://github.com/status-im/js-waku/ ; cd js-waku
npm install # Install dependencies for js-waku
npm run build # Build js-waku
cd examples/eth-dm
npm install # Install dependencies for the web app
npm run start # Start development server to serve the web app on http://localhost:3000/js-waku/eth-dm
```
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md).

2
examples/eth-dm/README.md
View File

@ -1,3 +1,3 @@
# Ethereum Direct Message Web App
A showcase app of [20/ETH-DM](https://rfc.vac.dev/spec/20/).
See js-waku [README](../../README.md#ethereum-direct-message) for details.