Skip to content
This repository has been archived by the owner on Apr 10, 2024. It is now read-only.

gnosischain/prysm-launch

Repository files navigation

DEPRECATED

Warning

This is no longer supported as native Gnosis Chain support has been introduced. Please consider using the interactive guide provided in documentation.

Running a Prysm client for GBC

This document describes how to run Prysm beacon node + Prysm validator for the Gnosis Beacon Chain.

See a similar repo with Lighthouse node setup - https://github.com/gnosischain/lighthouse-launch

Assumptions

  • This document assumes that you already have an xDai node available for your use (or public JSON RPC endpoint)
  • You have already generated your validator accounts using the fork of the official deposit-cli - https://github.com/gnosischain/deposit-cli. You will need validator keystores and passwords for them to run the validator client.
  • You might start your node and validator first, and only them make a deposit, once everything works.
  • You have a persistent linux VM with docker installed on it, which is accessible from the public internet via a fixed IP address. We recommend using a VM with at least 4 vCPU, 8 GB RAM, 100 GB SSD

Configuration

  1. Create an empty directory somewhere on the VM (e.g. /root/gbc)
  2. Clone the repository with all necessary configs:
cd /root/gbc
git clone https://github.com/gnosischain/prysm-launch .
  1. Generate wallet password and place it in the ./keys/wallet_password.txt
  2. Copy all validators keystore files to the ./keys/validator_keys directory. Ensure that copied keystores are only used on a single VM instance.
  3. Write keystore password to the ./keys/keystore_password.txt file
  4. Create .env file from the example at .env.example. Put the valid external IP address of your VM and xDAI RPC url in the config. Other values can be left without changes.
  5. Modify ./config/graffiti.yml, if needed. (See https://lighthouse-book.sigmaprime.io/graffiti.html for file format description)

If it is required to send the node and validator logs to a remote syslog server the following actions can be done (it is assumed that the node and validator will be run by using the docker-compose-syslog.yml file with the docker-compose command in the instructions below).

  1. Copy ./syslog/etc/logrotate.d/docker-logs to /etc/logrotate.d/.
  2. Copy ./syslog/etc/rsyslog.d/30-gbc-local.conf and ./syslog/etc/rsyslog.d/35-gbc-remote-logging.conf to /etc/rsyslog.d/.
  3. Modify target and port in /etc/rsyslog.d/35-gbc-remote-logging.conf to point to a remote syslog server.
  4. Restart the rsyslog service by systemctl restart rsyslog.

Import of validator keys

  1. Run the following command to import and all added keystore files:
docker-compose up validator-import
  1. If you want to confirm that all validators are imported correctly, you can run the following command to see the whole list:
docker-compose up validator-list

Running node

  1. Run the following command to start the beacon node:
docker-compose up -d node
docker-compose logs -f node
  1. Your node should find other peers and start syncing with the rest of the network

Running validator

  1. Run the following command to start the validator client:
docker-compose up -d validator
docker-compose logs -f validator

About

Running a Prysm client for GBC

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published