Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for handling with bridge component #26

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Update docs for handling with bridge component #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d5e406
Update docs for handling with bridge component
huyngopt1994 Jun 26, 2024
f5b1e48
update
huyngopt1994 Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/validators/setup/random-beacon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- Go version 1.19 or higher
- Docker
- Registered the [VRF key](../manage/vrf-key.mdx)
- A Ronin address to submit the random beacon. This can be any address but make sure to top up to this address (you will need to send one transaction per day).
- A Ronin address to submit the random beacon. This can be any address (https://docs.roninchain.com/validators/setup/generate-keys#generate-an-ecdsa-key-using-the-cli ) but make sure to top up to this address some RON (you will need to send one transaction per day).

Check warning on line 18 in docs/validators/setup/random-beacon.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/validators/setup/random-beacon.md", "range": {"start": {"line": 18, "column": 224}}}, "severity": "WARNING"}

## Run Random Beacon Service in standalone mode

Expand Down Expand Up @@ -45,14 +45,14 @@
RONIN_SECRET_KEY: ${RONIN_SECRET_KEY}
RONIN_RPC_ENDPOINT: ${RONIN_RPC_ENDPOINT}
RONIN_VERBOSITY: ${RONIN_VERBOSITY}
RONIN_DATABASE_URL: postgresql://${DB_USER}:${DB_PASS}@ronin-random-beacon-chain-db:5432/${DB_NAME}?sslmode=disable
RONIN_DATABASE_URL: postgresql://${DB_USER}:${DB_PASS}@ronin-random-beacon-chain-db:5432/${DB_USER}?sslmode=disable
depends_on:
- ronin-random-beacon-chain-db
ronin-random-beacon-chain-db:
image: postgres:14
restart: always
ports:
- "127.0.0.1:5432:5432"
- "127.0.0.1:5433:5432"
logging:
options:
max-size: 10m
Expand All @@ -73,7 +73,7 @@

**Note.** In case you want to connect to node container in different docker-compose in the same machine, please check [here](https://docs.docker.com/compose/networking/#use-a-pre-existing-network) for reusing the existing network in the above setting for making a connection between random-beacon service with rpc node service.

For example if the current docker network of node containers you wanna connect is `ronin_default`. Then put this block in per service inside the above docker-compose to connect to the existing network.
For example if the current docker network of node containers you wanna connect is `ronin_default` (You can check by running `docker network ls`). Then put this block in per service inside the above docker-compose to connect to the existing network.

Check warning on line 76 in docs/validators/setup/random-beacon.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'select' instead of 'check'.

Raw Output:
{"message": "[Google.WordList] Use 'select' instead of 'check'.", "location": {"path": "docs/validators/setup/random-beacon.md", "range": {"start": {"line": 76, "column": 108}}}, "severity": "WARNING"}

Check warning on line 76 in docs/validators/setup/random-beacon.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'preceding' instead of 'above'.

Raw Output:
{"message": "[Google.WordList] Use 'preceding' instead of 'above'.", "location": {"path": "docs/validators/setup/random-beacon.md", "range": {"start": {"line": 76, "column": 193}}}, "severity": "WARNING"}

```
...
Expand All @@ -89,15 +89,19 @@
networks:
- ronin_default
...
...

networks:
ronin_default:
external: true
```

3. In the docker directory, create an `.env` file and add the following content, replacing the `<...>` placeholder values with your information:

```
NODE_IMAGE=ghcr.io/ronin-chain/ronin-random-beacon:v0.0.1-2798dc6
DB_USER=<DB_USER>
DB_USER=ronin
DB_PASS=<DB_PASS>
DB_NAME=<DB_NAME>
# your ronin private key with the 0x prefix for submitting the transactions to chain.
RONIN_PRIVATE_KEY=<RONIN_PRIVATE_KEY>
# Your VRF Secret key with the 0x prefix
Expand Down Expand Up @@ -149,14 +153,14 @@
RONIN_SECRET_KEY: ${RONIN_RANDOM_BEACON_CHAIN_SECRET_KEY}
RONIN_RPC_ENDPOINT: ${RONIN_RANDOM_BEACON_CHAIN_RPC_ENDPOINT}
RONIN_VERBOSITY: ${RONIN_RANDOM_BEACON_CHAIN_VERBOSITY}
RONIN_DATABASE_URL: postgresql://${RONIN_RANDOM_BEACON_DB_USER}:${RONIN_RANDOM_BEACON_DB_PASS}@ronin-random-beacon-chain-db:5432/${RONIN_RANDOM_BEACON_DB_NAME}?sslmode=disable
RONIN_DATABASE_URL: postgresql://${RONIN_RANDOM_BEACON_DB_USER}:${RONIN_RANDOM_BEACON_DB_PASS}@ronin-random-beacon-chain-db:5432/${RONIN_RANDOM_BEACON_DB_USER}?sslmode=disable
depends_on:
- ronin-random-beacon-chain-db
ronin-random-beacon-chain-db:
image: postgres:14
restart: always
ports:
- "127.0.0.1:5432:5432"
- "127.0.0.1:5433:5432"
logging:
options:
max-size: 10m
Expand All @@ -179,9 +183,8 @@

```
RONIN_RANDOM_BEACON_CHAIN_IMAGE=ghcr.io/ronin-chain/ronin-random-beacon:v0.0.1-2798dc6
RONIN_RANDOM_BEACON_DB_USER=<RONIN_RANDOM_BEACON_DB_USER>
RONIN_RANDOM_BEACON_DB_USER=ronin
RONIN_RANDOM_BEACON_DB_PASS=<RONIN_RANDOM_BEACON_DB_PASS>
RONIN_RANDOM_BEACON_DB_NAME=<RONIN_RANDOM_BEACON_DB_NAME>
# your ronin private key with the 0x prefix for submitting the transactions to chain.
RONIN_RANDOM_BEACON_CHAIN_PRIVATE_KEY=<RONIN_RANDOM_BEACON_CHAIN_PRIVATE_KEY>
# Your VRF Secret key with the 0x prefix
Expand Down
Loading