mirror of
https://github.com/logos-messaging/logos-delivery-compose.git
synced 2026-06-07 20:59:28 +00:00
chore: simplify README and give some more clarity (#162)
Co-authored-by: Darshan K <35736874+darshankabariya@users.noreply.github.com> Co-authored-by: fryorcraken <110212804+fryorcraken@users.noreply.github.com>
This commit is contained in:
parent
20fbb80c81
commit
f3d2db8b17
@ -3,11 +3,12 @@
|
|||||||
RLN_RELAY_ETH_CLIENT_ADDRESS=https://linea-sepolia.infura.io/v3/<key>
|
RLN_RELAY_ETH_CLIENT_ADDRESS=https://linea-sepolia.infura.io/v3/<key>
|
||||||
|
|
||||||
# Account of testnet where you have Linea Sepolia ETH that would be staked into RLN contract.
|
# Account of testnet where you have Linea Sepolia ETH that would be staked into RLN contract.
|
||||||
|
# e.g.: ETH_TESTNET_ACCOUNT=0xbecd1546a397a6bad875247d51c4c6da0e469021
|
||||||
ETH_TESTNET_ACCOUNT=<YOUR_TESTNET_ACCOUNT_ADDRESS_HERE>
|
ETH_TESTNET_ACCOUNT=<YOUR_TESTNET_ACCOUNT_ADDRESS_HERE>
|
||||||
|
|
||||||
# Private key of testnet where you have Linea Sepolia ETH that would be staked into RLN contract.
|
# Private key of testnet where you have Linea Sepolia ETH that would be staked into RLN contract.
|
||||||
# Note: make sure you don't use the '0x' prefix.
|
# Note: make sure you don't use the '0x' prefix.
|
||||||
# e.g. 0116196e9a8abed42dd1a22eb63fa2a5a17b0c27d716b87ded2c54f1bf192a0b
|
# e.g. ETH_TESTNET_KEY=0116196e9a8abed42dd1a22eb63fa2a5a17b0c27d716b87ded2c54f1bf192a0b
|
||||||
ETH_TESTNET_KEY=<YOUR_TESTNET_PRIVATE_KEY_HERE>
|
ETH_TESTNET_KEY=<YOUR_TESTNET_PRIVATE_KEY_HERE>
|
||||||
|
|
||||||
# Address of the RLN contract on Linea Sepolia.
|
# Address of the RLN contract on Linea Sepolia.
|
||||||
|
|||||||
43
README.md
43
README.md
@ -14,7 +14,7 @@ Ready‑to‑use **docker‑compose** stack for running your own [nwaku](https:/
|
|||||||
* Need test ETH? Use the [Linea Sepolia faucet](https://www.infura.io/faucet/sepolia)
|
* 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)
|
* Already have ETH on Sepolia? Bridge it to Linea via the [official bridge](https://bridge.linea.build/native-bridge)
|
||||||
|
|
||||||
### 🚀 Starting your node — pick one of three paths
|
### 🚀 Starting your node
|
||||||
|
|
||||||
| # | Option | Quick-start command | What happens |
|
| # | Option | Quick-start command | What happens |
|
||||||
|---|------|--------------------|--------------|
|
|---|------|--------------------|--------------|
|
||||||
@ -105,7 +105,7 @@ For advanced documentation, refer to [ADVANCED.md](https://github.com/waku-org/n
|
|||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>⚙️ option 1 :- SETUP-WIZARD [ experimental ]</summary>
|
<summary>⚙️ option 2 :- SETUP-WIZARD [ experimental ]</summary>
|
||||||
|
|
||||||
Run the wizard script.
|
Run the wizard script.
|
||||||
Once the script is done, the node will be started for you, so there is nothing else to do.
|
Once the script is done, the node will be started for you, so there is nothing else to do.
|
||||||
@ -121,27 +121,17 @@ The script is experimental, feedback and pull requests are welcome.
|
|||||||
### 📌 Note
|
### 📌 Note
|
||||||
RLN membership is your access key to The Waku Network. It is registered on-chain, enabling your nwaku node to send messages in a decentralized and privacy-preserving way while adhering to rate limits. Messages exceeding the rate limit will not be relayed by other peers.
|
RLN membership is your access key to The Waku Network. It is registered on-chain, enabling your nwaku node to send messages in a decentralized and privacy-preserving way while adhering to rate limits. Messages exceeding the rate limit will not be relayed by other peers.
|
||||||
|
|
||||||
If you’re upgrading from a version earlier than v0.36.0, we recommend starting from a fresh clone.
|
If you just want to relay traffic (not publish), you don't need to perform the registration.
|
||||||
|
|
||||||
docker-compose automatically reads the .env file from the filesystem. A .env.example is provided as a template — copy it and update the values as needed:
|
|
||||||
|
|
||||||
```
|
|
||||||
cp .env.example .env
|
|
||||||
${EDITOR} .env
|
|
||||||
```
|
|
||||||
|
|
||||||
Make sure to **NOT** place any secrets into `.env.example`, as they might be unintentionally published in the Git repository.
|
|
||||||
|
|
||||||
if you just want to relay traffic (not publish), you don't need to perform the registration.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
## How to update to latest version
|
<details>
|
||||||
|
<summary>How to update to latest version</summary>
|
||||||
|
|
||||||
We regularly announce new available versions in our [Discord](https://discord.waku.org/) server.
|
We regularly announce new available versions in our [Discord](https://discord.waku.org/) server.
|
||||||
|
|
||||||
### From `v0.29` or older
|
### From `v0.35.1` or older
|
||||||
|
|
||||||
You will need to delete both the `keystore` and `rln_tree` folders, and register your membership again before using the new version by running the following commands:
|
You will need to delete both the `keystore` and `rln_tree` folders, and register your membership again before using the new version by running the following commands:
|
||||||
|
|
||||||
@ -152,15 +142,17 @@ You will need to delete both the `keystore` and `rln_tree` folders, and register
|
|||||||
5. `./register_rln.sh`
|
5. `./register_rln.sh`
|
||||||
6. `docker-compose up -d`
|
6. `docker-compose up -d`
|
||||||
|
|
||||||
### From `v0.30` or newer
|
### From `v0.36.0` or newer
|
||||||
|
|
||||||
Updating the node is as simple as running the following:
|
Updating the node is as simple as running the following:
|
||||||
1. `cd nwaku-compose` ( go into the root's repository folder )
|
1. `cd nwaku-compose` ( go into the root's repository folder )
|
||||||
2. `docker-compose down`
|
2. `docker-compose down`
|
||||||
3. `git pull origin master`
|
3. `git pull origin master`
|
||||||
4. `docker-compose up -d`
|
4. `docker-compose up -d`
|
||||||
|
</details>
|
||||||
|
|
||||||
### Set size
|
<details>
|
||||||
|
<summary>Set storage size (optional)</summary>
|
||||||
|
|
||||||
To improve storage on the network, you can increase the allocated space for the database.
|
To improve storage on the network, you can increase the allocated space for the database.
|
||||||
To do so, you can simply run:
|
To do so, you can simply run:
|
||||||
@ -168,8 +160,10 @@ To do so, you can simply run:
|
|||||||
```
|
```
|
||||||
./set_storage_retention.sh
|
./set_storage_retention.sh
|
||||||
```
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
### Check
|
<details>
|
||||||
|
<summary>Node's health check</summary>
|
||||||
|
|
||||||
Once done, check your node is healthy:
|
Once done, check your node is healthy:
|
||||||
|
|
||||||
@ -187,6 +181,7 @@ All good:
|
|||||||
{
|
{
|
||||||
"Rln Relay": "Ready"
|
"Rln Relay": "Ready"
|
||||||
}
|
}
|
||||||
|
...
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@ -200,8 +195,10 @@ If the `./chkhealth.sh` script is hanging or returns the following, wait a few m
|
|||||||
"protocolsHealth": []
|
"protocolsHealth": []
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
### Clean-up
|
<details>
|
||||||
|
<summary>Disk cleanup tips</summary>
|
||||||
|
|
||||||
Docker artefact can take some precious disk space, run the following commands to free space **while your node is running**.
|
Docker artefact can take some precious disk space, run the following commands to free space **while your node is running**.
|
||||||
|
|
||||||
@ -253,7 +250,9 @@ journalctl --disk-usage
|
|||||||
> Archived and active journals take up 55.8M in the file system.
|
> Archived and active journals take up 55.8M in the file system.
|
||||||
```
|
```
|
||||||
|
|
||||||
-----
|
</details>
|
||||||
|
|
||||||
# FAQ
|
<details>
|
||||||
|
<summary>FAQ</summary>
|
||||||
[see](FAQ.md)
|
[see](FAQ.md)
|
||||||
|
</details>
|
||||||
|
|||||||
@ -12,8 +12,6 @@ if test -f .env; then
|
|||||||
. "$(pwd)"/.env
|
. "$(pwd)"/.env
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# TODO: Set nwaku release when ready instead of quay
|
|
||||||
|
|
||||||
if test -n "${ETH_CLIENT_ADDRESS}"; then
|
if test -n "${ETH_CLIENT_ADDRESS}"; then
|
||||||
echo "ETH_CLIENT_ADDRESS variable was renamed to RLN_RELAY_ETH_CLIENT_ADDRESS"
|
echo "ETH_CLIENT_ADDRESS variable was renamed to RLN_RELAY_ETH_CLIENT_ADDRESS"
|
||||||
echo "Please update your .env file"
|
echo "Please update your .env file"
|
||||||
@ -34,6 +32,7 @@ TOKEN_CONTRACT_ADDRESS=0x185A0015aC462a0aECb81beCc0497b649a64B9ea
|
|||||||
TTT_AMOUNT_WEI=5000000000000000000
|
TTT_AMOUNT_WEI=5000000000000000000
|
||||||
|
|
||||||
# Mint
|
# Mint
|
||||||
|
echo "\nMinting test token"
|
||||||
if ! cast send "$TOKEN_CONTRACT_ADDRESS" "mint(address,uint256)" \
|
if ! cast send "$TOKEN_CONTRACT_ADDRESS" "mint(address,uint256)" \
|
||||||
"$ETH_TESTNET_ACCOUNT" "$TTT_AMOUNT_WEI" \
|
"$ETH_TESTNET_ACCOUNT" "$TTT_AMOUNT_WEI" \
|
||||||
--private-key "$ETH_TESTNET_KEY" \
|
--private-key "$ETH_TESTNET_KEY" \
|
||||||
@ -44,6 +43,7 @@ then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
# Approve
|
# Approve
|
||||||
|
echo "\nApprove to spend the test tokens"
|
||||||
if ! cast send "$TOKEN_CONTRACT_ADDRESS" "approve(address,uint256)" \
|
if ! cast send "$TOKEN_CONTRACT_ADDRESS" "approve(address,uint256)" \
|
||||||
"$RLN_CONTRACT_ADDRESS" "$TTT_AMOUNT_WEI" \
|
"$RLN_CONTRACT_ADDRESS" "$TTT_AMOUNT_WEI" \
|
||||||
--private-key "$ETH_TESTNET_KEY" \
|
--private-key "$ETH_TESTNET_KEY" \
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user