js-waku-examples/examples/eth-pm/README.md

31 lines
819 B
Markdown
Raw Permalink Normal View History

2022-06-17 00:48:15 +00:00
# Ethereum Private Message Web App
**Demonstrates**:
- Private Messaging
- React/TypeScript
- Waku Light Push
- Waku Filter
- Signature with Web3 (EIP-712, sign typed data)
2022-06-17 00:48:15 +00:00
- Asymmetric Encryption
- Symmetric Encryption
A PoC implementation of [20/ETH-DM](https://rfc.vac.dev/spec/20/).
Ethereum Private Message, or Eth-PM, is a protocol that allows sending encrypted message to a recipient,
only knowing their Ethereum Address.
This protocol has been created to demonstrated how encryption and signature could be added to message
sent over the Waku v2 network.
2022-09-22 08:05:01 +00:00
The `master` branch's HEAD is deployed at https://examples.waku.org/eth-pm/.
2022-06-17 00:48:15 +00:00
To run a development version locally, do:
```shell
2022-09-22 08:05:01 +00:00
git clone https://github.com/waku-org/js-waku-examples
cd js-waku-examples/examples/eth-pm
2022-09-22 08:05:01 +00:00
npm install
npm run start
2022-06-17 00:48:15 +00:00
```