Prysm client Installation guide

One-page interactive guide to install Prysm client and configurate it for running on supported chain.

Disclaimer

This guide is for informational purposes only. The author nor website owner does not guarantee accuracy of the information in this guide and is not responsible for any damages or losses incurred by following the guide. See more.

Install client

  1. Find the latest stable version of Prysm on Github
  2. Download Prysm clients to your node
    cd ~/downloads && curl -LO https://github.com/prysmaticlabs/prysm/releases/download/v6.0.4/beacon-chain-v6.0.4-modern-linux-amd64
    cd ~/downloads && curl -LO https://github.com/prysmaticlabs/prysm/releases/download/v6.0.4/validator-v6.0.4-linux-amd64
  3. Rename downloaded files
    mv beacon-chain-v6.0.4-modern-linux-amd64 beacon-chain && mv validator-v6.0.4-linux-amd64 validator
  4. Set files permissions
    chmod +x beacon-chain && chmod +x validator
  5. Copy clients to /usr/local/bin
    sudo cp ~/downloads/beacon-chain /usr/local/bin
    sudo cp ~/downloads/validator /usr/local/bin
  6. Remove downloaded files

    cd ~/downloads && rm beacon-chain && rm validator

Configurate the service

  • Create a user

    :
    sudo useradd --system --no-create-home --shell /bin/false prysmbeacon
  • Create a folder for Prysmbeacon data

    :
    sudo mkdir -p /var/lib/prysm/beacon
  • Set access permission and ownership for the Prysm data folder

    sudo chown -R prysmbeacon:prysmbeacon /var/lib/prysm/beacon
  • Communication ports selection

    Each service on the server needs a custom port for communication. Through ports, consensus client communicates with other peers in the network as well as other services running on the server, such as validator clients. There is an IPv4 and IPv6 variant, depending on the ISP support / preference. Each protocol version needs custom port. If you are not sure what to select, continue with default IPv4 port.

    1. Configurate public IPv4 port for P2P communication with other peers

      • :
      • Verify availability of selected port 9000
        ss -tuln | grep ':9000'

        If it returns empty response, the port 9000 is free and can be used.

      • Enable traffic on the port through UFW
        sudo ufw allow 9000
      • Disable IPv6 traffic on the port
        • List allowed ports
          sudo ufw status numbered
        • Find order number for V6, see 9000 (V6) and remove it with the following line
          sudo ufw delete <Number>
    2. QUIC IPv4 port

      • :
      • Verify availability of selected port 9001
        ss -tuln | grep ':9001'

        If it returns empty response, the port 9001 is free and can be used.

    3. Beacon API port for internal communication

      • :
      • Verify availability of selected port 5052
        ss -tuln | grep ':5052'

        If it returns empty response, the port 5052 is free and can be used.

    1. Configurate public IPv6 port for P2P communication with other peers

      • :
      • Verify availability of selected port 9090
        ss -tuln | grep ':9090'

        If it returns empty response, the port 9090 is free and can be used.

      • Enable traffic on the port through UFW
        sudo ufw allow 9090
      • Disable IPv6 traffic on the port
        • List allowed ports
          sudo ufw status numbered
        • Find order number for V6, see 9090 and remove it with the following line
          sudo ufw delete <Number>
    2. QUIC IPv6 port

      • :
      • Verify availability of selected port 9091
        ss -tuln | grep ':9091'

        If it returns empty response, the port 9091 is free and can be used.

  • Create configuration file for Tekubeacon service

    1. Open PrysmBeacon configuration file

      sudo nano /etc/systemd/system/prysmbeacon.service
    2. Copy configuration

      [Unit]
      Description=Prysm Consensus Client BN (Mainnet)
      Wants=network-online.target
      After=network-online.target
      
      [Service]
      User=prysmbeacon
      Group=prysmbeacon
      Type=simple
      Restart=always
      RestartSec=5
      ExecStart=/usr/local/bin/beacon-chain \
        --mainnet \
        --datadir=/var/lib/prysm/beacon \
        --execution-endpoint=http://127.0.0.1:8551 \
        --jwt-secret=/var/lib/jwtsecret/ethereum.hex \
        --suggested-fee-recipient=FeeRecipientAddress \
        #--local-block-value-boost=0 \
        --checkpoint-sync-url=CheckpointSyncURL \
        --genesis-beacon-api-url=CheckpointSyncURL \
        --accept-terms-of-use
      
      [Install]
      WantedBy=multi-user.target

      NOTE: Be sure to set the FeeRecipientAddress above to a valid Ethereum address within your control to receive the validator fees. For example: --suggested-fee-recipient=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

      NOTE: Be sure to set the CheckpointSyncURL above (both occurrences) to a valid checkpoint sync URL. --checkpoint-sync-url and --genesis-beacon-api-url Enables the Checkpoint Sync feature to greatly speed up the Beacon Chain Node sync. More information here. Provide a URL to a synced Beacon Chain Node for the sync. You can get one here.

      Gnosis Chain is not supported by Prysm client
      *Note: Update jwt-secret-file, if you use different
    3. Press CTRL + X then Y then ENTER to save and exit the config file.
  • Load changes

    sudo systemctl daemon-reload

Launch PrysmBeacon service

  • Start the Beacon chain service

    sudo systemctl start prysmbeacon
  • Check the service

    systemctl status prysmbeacon
    journalctl -fu prysmbeacon
  • Start the service automatically on system startup

    sudo systemctl enable prysmbeacon
    • Open Delayed Start shell
      sudo nano /usr/local/bin/delayed-start.sh

      Configurate service start inside it

      systemctl start prysmbeacon.service
    • Be sure, delayed-start.service service controlling delayed-start.sh is enabled for auto start with system startup
      sudo systemctl enable delayed-start.service
    1. Configurate Staking Manager util

      • Open the configuration file
        sudo nano /usr/local/etc/staking/config/clients.conf

        If the file is empty, generate it with command sudo /usr/local/bin/staking.sh init

      • Set link to proper service. It should be as follow:
        beaconServices="prysmbeacon"

        If you place more services to the category, separate them with a space, see beaconServices="service1 service2 service3 ..."

    2. Activate service to start automatically on OS startup

      • Open Start with delay util
        sudo nano /usr/local/bin/delayed-start.sh
      • Place or uncomment a command to start the beacon client(s)
        /usr/local/bin/staking.sh start beacon
      • Verify, that a service `delayed-start.service` exists and is automatically launched on system start.
        sudo systemctl enable delayed-start.service

Any issue while running Prysm client?

Check Prysm client emergency page.

Update Prysm client Emergency for Prysm client Add Prysm validator Exit Prysm validator