Skip to content

StorXNetwork/StorX-Node

Repository files navigation

StorX Farmer Node

Run a Farmer/Storage Node on StorX Network

This guide will instruct you how to set up Farmer/Storage Node on the StorX Network

Preliminaries

  • Running a Storage Node on a live network is a responsible job. The credibility of the complete network depends upon the performance of Farmer/Storage Nodes.
  • If there are any issues the possibility of your node getting slashed.
  • To compensate for the efforts, running a community memes are rewarded with SRX Tokens, knowing that you contribute to the security of a decentralized network while growing your stash.

If you need help, please reach out on the Community Page. The community members are there to help answer questions and provide tips from experience.


How many SRX (StorX Native Tokens) do I need?

To qualify for Farmer/Storage Node on StorX Network, you need between 6000 - 1 Million SRX, with the existential deposit, plus XDC for transaction fees.

Note: The minimum staking amount will be updated as per the new incremental model from 03/08/2021 onwards. Refer


We requests Storage Node operators to maintain Good Node Reputation to ensure StorX Ecosystem works perfectly.

Tips for maintaining a Good Node Reputation:

  • Ensure Strong Cloud Infrastructure.
  • Higher SRX Stake adds value to “Good” Node Reputation.
  • Ensure 100% uptime.
  • Always ensure nodes maintain the latest software patch and OS updates.

Warning:

  • Underperformance can lead to disqualification of nodes, which can lead to No ‘hosting and staking rewards’. Repeated low reputation can lead to a penalty; Staked SRX might be burned as a penalty as it may harm StorX Storage Network.
  • Any SRX that you stake for Farmer/Storage Node on StorX Network is liable to be slashed, meaning that an insecure or improper setup may result in loss of reputation leading to slashing of Farmer/Storage Node on StorX Network.

Initial Set-up

Requirements

The most common way for a beginner to run a validator is on a cloud server running Linux. You may choose whatever VPS provider that you prefer, and whatever operating system you are comfortable with. For this guide we will be using Ubuntu 20.04 64-bit or higher, but the instructions should be similar for other platforms.

The storage operations in Farmer/Storage Node on StorX were benchmarked on standard hardware. It is recommended that you run at least the standard hardware in order to ensure they are able to process all storage requirements. The following are not minimum requirements but if you decide to run with less than this beware that you might have performance issues.

  • Six Processor Core
  • RAM 8 GB (16 GB Recommended)
  • Minimum HDD 1 TB SSD / NVME Recommended
  • Minimum 10 TB of available bandwidth a month
  • Minimum upload speed of 25 MBPS
  • Minimum download speed of 25 MBPS
  • Ensure Node availability 24/7

Note: The Node requirements keep changing as the Network evolves.

Key Management

  • Private keys are the central primitive of any cryptographic system and need to be handled with extreme care.
  • Loss of your private key can lead to irreversible loss of value.

How to Setup StorX Farmer node

Method 1:- Setup StorX Farmer node Bootstrap Script

Bootstrap Command StorX Node Setup :-

    sudo su -c "bash <(wget -qO- https://raw.githubusercontent.com/StorXNetwork/StorX-Node/main/bootstrap.sh)" root 

Examples :-

    root……..:~# sudo su -c "bash <(wget -qO- https://raw.githubusercontent.com/StorXNetwork/StorX-Node/main/bootstrap.sh)" root
    Please enter your XDC Address for StorX Rewards:- xdc……

Method 2:- Setup StorX Farmer Node Docker

  • Operating System: Ubuntu 20.04 64-bit or higher Should be facing internet directly with public IP & without NAT

  • Tools: Docker, Docker Compose (1.29.2+) Setup (For Ubuntu 20.04 64-bit or higher Operating System)


Clone repository

    git clone https://github.com/StorXNetwork/StorX-Node

Enter StorX-Node directory

    cd StorX-Node

Step 1: Install docker & docker-compose

    sudo bash ./install_docker.sh

Step 2: Update .env file with details

  • Create .env file by using the sample - .env.example
  • Enter either your StorX Rewards address in the WALLETADD field.
    cp env.example .env
    nano .env

Step 3: Start your Node

For MainNet Run:

    sudo docker-compose -f docker-services.yml up -d

To stop the node or if you encounter any issues use::

    sudo docker-compose -f docker-services.yml down

Step 4: Stake SRX token

After setting up FarmNode/StorageNode please Stake SRX token from the URL : https://farmer.storx.io/

IMP Note : You have to stake SRX token to get hosting and staking rewards.

How to Check Status

To check the status of your node:

    sudo bash ./getstatus.sh

How to Upgrade your StorX Farmer Node

How to upgrade your StorX node with the latest changes?

    git pull
    sudo bash ./upgrade.sh

Troubleshooting

Public discussions on the technical issues, post articles and request for Enhancements and Technical Contributions.

  • Telegram - Stay updated with all the Announcements.
  • Discord - Join the community to find answers to all your questions.
  • Reddit - Join the channel to have a healthy interaction with the community.
  • GitHub - Join the developers community on GitHub