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-28 10:43:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove mention of message publication

Browse Source
This commit is contained in:
fryorcraken 2025-07-29 10:28:58 +10:00
parent 10ef431640
commit 6dd14fd03c
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 8 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,28 +1,27 @@
# nwaku-compose
Ready‑to‑use **docker‑compose** stack for running your own [nwaku](https://github.com/waku-org/nwaku) node for a subset of protocols (full node capability is coming soon).:
Ready‑to‑use **docker‑compose** stack for running your own [nwaku](https://github.com/waku-org/nwaku) node:
* RLN‑enabled nwaku node (relay + store protocols, excluding message publishing)
* Simple web UI to publish and receive messages
* Grafana dashboard for metrics
* Requires **Docker Compose** and **Git**
## 📝 Prerequisites
* **Linea Sepolia RPC endpoint** — grab one for free on [Infura](https://www.infura.io)
* **Linea Sepolia wallet** with at least **0.01 ETH** (Only REquired For RLN Membership Registration which is WIP)
* **Linea Sepolia wallet** with at least **0.01 ETH** (Only Required For RLN Membership Registration which is WIP)
* Need test ETH? Use the [Linea Sepolia faucet](https://www.infura.io/faucet/sepolia)
* Already have ETH on Sepolia? Bridge it to Linea via the [official bridge](https://bridge.linea.build/native-bridge)
### 🚀 Starting your node
| # | Option | Quick-start command | What happens |
|---|------|--------------------|--------------|
| **1** | **script** | Power user / CI | setup a .env file manually and then start the node.|
| **2** | ** WIP setup-wizard** | Fastest one-command bootstrap | Generates `.env`, registers RLN, and spins up the whole stack automatically |
| # | Option | Quick-start command | What happens |
|-------|----------------------|-------------------------------|-----------------------------------------------------------------------------|
| **A** | **script** | Power user / CI | setup a .env file manually and then start the node. |
| **B** | **WIP setup-wizard** | Fastest one-command bootstrap | Generates `.env`, registers RLN, and spins up the whole stack automatically |
<details>
<summary>🧪 option 1 :- SCRIPT [ manual ] [ recommended ] </summary>
<summary>🧪 option A :- SCRIPT [ manual ] [ recommended ] </summary>
```
cp .env.example .env
@ -69,7 +68,6 @@ docker-compose up -d
###🏄🏼‍♂️ 4. Interact with your nwaku node
* See [localhost:3000](http://localhost:3000/d/yns_4vFVk/nwaku-monitoring) for node metrics.
* See [localhost:4000](http://localhost:4000) for a nice frontend to chat with other users.
**📬 4. Use the REST API**
@ -82,14 +80,6 @@ curl http://127.0.0.1:8645/debug/v1/version
curl http://127.0.0.1:8645/debug/v1/info
```
**Publish a message to a `contentTopic`**. Everyone subscribed to it will receive it. Note that `payload` is base64 encoded.
```
curl -X POST "http://127.0.0.1:8645/relay/v1/auto/messages" \
-H "content-type: application/json" \
-d '{"payload":"'$(echo -n "Hello Waku Network - from Anonymous User" | base64)'","contentTopic":"/my-app/2/chatroom-1/proto"}'
```
**Get messages sent to a `contentTopic`**. Note that any store node in the network is used to reply.
```
curl -X GET "http://127.0.0.1:8645/store/v1/messages?contentTopics=%2Fmy-app%2F2%2Fchatroom-1%2Fproto&pageSize=50&ascending=true" \
@ -101,7 +91,7 @@ For advanced documentation, refer to [ADVANCED.md](https://github.com/waku-org/n
</details>
<details>
<summary>⚙️ option 2 (not recommended at this time):- SETUP-WIZARD [ experimental ]</summary>
<summary>⚙️ option B (not recommended at this time):- SETUP-WIZARD [ experimental ]</summary>
Run the wizard script.
Once the script is done, the node will be started for you, so there is nothing else to do.
@ -119,8 +109,6 @@ RLN membership is your access key to The Waku Network. It is registered on-chain
If you just want to relay traffic (not publish), you don't need to perform the registration.
-----
<details>
<summary>How to update to latest version</summary>