waku-org
/
go-waku-compose
mirror of https://github.com/waku-org/go-waku-compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add a comment to readme

This commit is contained in:
Václav Pavlín 2023-11-13 12:58:23 +01:00
parent 20f91f4242
commit 7b8cebc0ce
No known key found for this signature in database
GPG Key ID: B378FB31BB6D89A5
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.env.example
View File

@ -1,3 +1,4 @@
ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/<key> ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/<key>
ETH_TESTNET_KEY=012345privatekey ETH_TESTNET_KEY=012345privatekey
RLN_RELAY_CRED_PASSWORD="my_secure_keystore_password" RLN_RELAY_CRED_PASSWORD="my_secure_keystore_password"
NODEKEY=

8
README.md
View File

@ -14,12 +14,20 @@ You need:
* Ethereum Sepolia account with some balance <0.01 Eth. Get some [here](https://www.infura.io/faucet/sepolia). * Ethereum Sepolia account with some balance <0.01 Eth. Get some [here](https://www.infura.io/faucet/sepolia).
* A password to protect your rln membership. * A password to protect your rln membership.
You can either export the environment variable (keep in mind that this will expose your secrets in your shell history)
``` ```
export ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/YOUR_INFURA_KEY export ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/YOUR_INFURA_KEY
export ETH_TESTNET_KEY=REPLACE_BY_YOUR_KEY export ETH_TESTNET_KEY=REPLACE_BY_YOUR_KEY
export RLN_RELAY_CRED_PASSWORD=PICK_A_PASSWORD export RLN_RELAY_CRED_PASSWORD=PICK_A_PASSWORD
``` ```
Or you can use `.env` file - copy the example and edit the variables inside
```
cp .env.example .env
```
**🔑 1. Register RLN membership** **🔑 1. Register RLN membership**
The RLN membership is your access key to The Waku Network. Its registration is done onchain, and allows your nwaku node to publish messages in a decentralized and private way, respecting some [rate limits](https://rfc.vac.dev/spec/64/#rate-limit-exceeded). The RLN membership is your access key to The Waku Network. Its registration is done onchain, and allows your nwaku node to publish messages in a decentralized and private way, respecting some [rate limits](https://rfc.vac.dev/spec/64/#rate-limit-exceeded).