logos-messaging/logos-messaging-nim-compose
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim-compose.git synced 2026-01-02 14:03:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add rln.waku.org to README for membership registration (#158)

Browse Source
This commit is contained in:
Danish Arora 2025-07-17 14:05:38 +05:30 committed by GitHub
parent ce496f0c85
commit 0a5442b5e1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -39,8 +39,27 @@ The script is experimental, feedback and pull requests are welcome.
### 🔑 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).
Messages exceeding the rate limit won't be relayed by other peers.
> **Note:** If upgrading from less than v0.36.0, run the following commands before proceeding with the registration:
>
> ```sh
> sudo rm -r rln_tree
> sudo rm keystore/keystore.json
> ```
The RLN membership is your access key to The Waku Network. Its registration is done on-chain, allowing your `nwaku` node to send messages in a decentralized and private way, respecting some [rate limits](https://rfc.vac.dev/spec/64/#rate-limit-exceeded). Other peers won't relay messages that exceed the rate limit.
#### Recommended: Register via rln.waku.org
To register for RLN membership and generate your keystore:
1. Visit [https://rln.waku.org](https://rln.waku.org).
2. Follow the instructions to register your membership and generate a `keystore.json` file.
3. Download the generated `keystore.json` and place it in the `keystore/` directory of your `nwaku-compose` setup (i.e., at `keystore/keystore.json`).
#### Alternative: Register locally
You can also register your membership using the provided script, which will store it in `keystore/keystore.json`.
Note that if you just want to relay traffic (not publish), you don't need to perform the registration.
Before registering you need to mint and approve the tokens to pay for the registration.
The simplest way is using Foundry's [cast](https://getfoundry.sh/) tool, which you can install with:
@ -61,8 +80,7 @@ Approve the RLN contract to spend tokens on behalf of your account:
cast send $TOKEN_CONTRACT_ADDRESS "approve(address,uint256)" $RLN_CONTRACT_ADDRESS 5000000000000000000 --private-key $ETH_TESTNET_KEY --rpc-url $RLN_RELAY_ETH_CLIENT_ADDRESS
```
This command will register your membership and store it in `keystore/keystore.json`.
Note that if you just want to relay traffic (not publish), you don't need one.
This command will register your membership and store it in `keystore/keystore.json`:
```
./register_rln.sh