Introduction

This guide will walk you through installing, registering, and preparing a delegate node on your instance. Whether you are experienced in Linux or completely new to it, you will be able, at the end of the guide, to have your delegate node running and start securing the X-Cash public network (provided you get elected as a delegate 😉).

This guide is split into two sections:

• ​Quick installation: With a simple auto-installer script, you will be able to install the xcash-dpops program that will enable you to relay and forge blocks, and participate in the security of the network. Linux knowledge is not mandatory to follow the auto-installer script.

• ​Manual ​installation: This step-by-step guide will cover everything about building the xcash-dpops program, the dependencies from the source code, and managing the services. It is expected that you are comfortable with Linux to follow this guide.

Requirements

System Requirements

The delegate node will need to transit a lot of information, notably messages to the other delegates to verify the block information, As time goes by, the features and information that the delegates handle will increase (notably when the X-Cash Foundation will add token creation, NFT, sidechains, smart contracts, and other exciting features ⭐).

Dependencies

The following table summarizes the tools and libraries required to run xcash-dpops program.

Time Synchronization

The xcash-dpops program uses the system time to calibrate itself and get the signal to send and receive data. It is important that the system time is accurate, otherwise, the program will not work as intended.

To check your system time, use the following command, and verify that the setting System clock synchronization: yes

timedatectl

If it says no, run the following command:

timedatectl set-ntp true
systemctl restart systemd-timesyncd

And run timedatectlagain. It should look as follow:

$ timedatectl
                      Local time: Mon 2020-06-01 16:18:19 CEST
                  Universal time: Mon 2020-06-01 14:18:19 UTC
                        RTC time: Mon 2020-06-01 14:18:19
                       Time zone: Europe/Berlin (CEST, +0200)
       System clock synchronized: yes
systemd-timesyncd.service active: yes
                 RTC in local TZ: no

Installer Script

The Installer Script has been designed to easily interact with the xcash-dpops program and provide easy steps for installation and updates. You can also use this script to restart the programs if you are not comfortable with the command-line interface.

To display the setting menu, run the following command that will fetch the autoinstaller.sh script from the official xcash-dpops repository:

bash -c "$(curl -sSL https://raw.githubusercontent.com/X-CASH-official/xcash-dpops/master/scripts/autoinstaller/autoinstaller.sh)"

This will open the following settings screen to choose from:

You can select the task by inputting the corresponding number:

1. Install: This setting will prepare the necessary directories, download the dependencies, build, and install the xcash-dpops program. The steps to follow are stated down below.

2. Update: Updates all the packages and releases of the dependencies to build the program.

3. Uninstall: Removes all the files, dependencies and related program of the xcash-dpops.

4. Install / Update Blockchain: Downloads or updates the X-Cash blockchain data.

5. Change Solo Delegate or Shared Delegate: Switches from a solo delegate setup to a shared delegate setup or the other way around.

6. Edit Shared Delegate Settings: If you are running a shared delegate setup, changes the fees and minimum payout to voters.

7. Restart Programs: Restarts all the programs and services relating to xcash-dpops

8. Stop Programs: Stop all the programs and services relating toxcash-dpops

9. Test Update: Alpha test feature

10. Test Update Reset Delegates: Alpha test feature

11. Firewall: Install the firewall for solo delegates.

12. Shared Delegates Firewall: Install the firewall with parameters for shared delegates.

Quick Installation

Once you have prepared your Linux instance by following the server setup guide, you can run an installer script to easily install, build and configure the node, as well as download the blockchain.

Installing the xcash-dpops program

xcash-dpops is the program needed to run a delegate node. It is responsible for sending messages to the other delegates, organize the consensus, relay and forge new blocks, etc...

To start the installation process, run the autoinstaller.sh script:

bash -c "$(curl -sSL https://raw.githubusercontent.com/X-CASH-official/xcash-dpops/master/scripts/autoinstaller/autoinstaller.sh)"

Choose Install (1) and press ENTER.

You will be prompted to choose an installation directory:

Press ENTER for the default location (/root/xcash-official/), or provide another path in the form /directory/

Next, you will need to choose the blockchain file directory.

Press ENTER for the default location (/root/.X-CASH/).

Next, you will need to choose the directory for the delegate database.

Press ENTER for the default location (/data/db/).

You will be then asked if you want to install the xcash-dpops program as a shared delegate or a solo delegate.

Press ENTER for the default setting (shared delegate), or type No for solo delegate.

If you choose to install the program as a shared delegate, you will need to set up your delegate fees and the minimum payment amount.

Type in your desired delegate fee in % with up to 6 decimals.

Type your desired minimum payment amount (minimum: 10000 XCASH, maximum: 10M XCASH) as a whole number.

The script will now ask you if you want to create a wallet to collect the block rewards.

Press ENTER for the default setting (YES), or type No.

If you say YES, the installer will then ask you if you want to automatically generate a password for the wallet or provide a custom one. Press ENTER for the default setting (YES), or type No to provide a custom password.

You will then be asked if you want to create a new block verifier secret key, or import an existing one:

Type I to import your secret key, or C to create a new one.

This would be the last setting to provide. Once every steps have been followed, the settings will be summarized as below and the installation will start:

The script will then install automatically the different programs and dependencies needed for the xcash-dpops program.

Once the script has installed everything, you will be prompted with your X-Cash Delegate wallet data.

Now that the program is installed, your delegate wallet initialized, and the different services running, you can go register yourself as a delegate. Follow the register delegate guide to continue the node setup.

Manual Installation

This guide is designed for people knowledgeable in Linux and who want to install everything from scratch. If you are not comfortable with the Linux distribution, or if you are following these steps without understanding what you are doing, you might make a mistake that will prevent the xcash-dpops program to run as intended.

Installation Directories

In the ~ directory, create the xcash-official directory and the xcash-wallets , systemdpid , and logs directory within. Additionally, create the .X-CASH directory that will store the X-Cash blockchain file.

mkdir -p ~/xcash-official/{xcash-wallets,logs,systemdpid}
mkdir -p ~/.X-CASH

Install Dependencies

First, update your system packages and install the necessary dependencies:

sudo apt update -y && sudo apt upgrade -y
sudo apt install build-essential cmake pkg-config libssl-dev git -y

If you want to install xcash-core from source, you will need to install these additional packages.

sudo apt install libboost-all-dev libzmq3-dev libunbound-dev libsodium-dev libminiupnpc-dev libunwind8-dev liblzma-dev libreadline6-dev libldns-dev libexpat1-dev libgtest-dev doxygen graphviz libpcsclite-dev screen p7zip-full -y

Installing MongoDB

You will need to get the latest stable version (current release) on the MongoDB website: https://www.mongodb.com/download-center/community​

Version: Latest current release. OS: Ubuntu 18.04 Linux x64 (if you are using this version). Package: Server

Then click on All version binaries.

Copy the link address of the tgz file of the latest version available (disregarding debug symbols version) and use it to download the installation folder using this command (replacing the link with the most recent version).

cd ~/xcash-official && wget http://downloads.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-v4.4-latest.tgz

Then, extract it and remove the downloaded file:

tar -xf mongodb-linux-x86_64*.tgz && rm mongodb-linux-x86_64*.tgz

Lastly, add the MongoDB binaries folder to your path with the following command.

echo -e '\nexport PATH=$USER/xcash-official/mongodb-linux-x86_64-ubuntu1804-4.4.0-rc7-36-gcf4ac31/bin:$PATH' >> ~/.profile && source ~/.profile

Replace $USER/xcash-official/mongodb-linux-x86_64-ubuntu1804-4.4.0-rc7-36-gcf4ac31/bin with the MongoDB binaries folder in your system.

Additionally, create the /data/db folder that will keep the delegates databases:

sudo mkdir -p /data/db && sudo chmod 770 /data/db && sudo chown $USER /data/db

Building the MongoDB C Driver from source

First, download the latest stable version of the MongoDB C Driver. Go to the official GitHub repository and download the latest stable release. Get the tarball file in your installation folder:

cd ~/xcash-official/ && wget https://github.com/mongodb/mongo-c-driver/releases/download/1.16.2/mongo-c-driver-1.16.2.tar.gz

Now, build the driver using the following commands (based on these instructions):

tar xzf mongo-c-driver-*.tar.gz && rm mongo-c-driver-*.tar.gz
cd mongo-c-driver-*
mkdir cmake-build && cd cmake-build
cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF ..
sudo make -j `nproc`
sudo make install

Then, update the links and cache of the newly installed library:

sudo ldconfig

Building xcash-core from source

Clone the xcash-core repository to your installation folder and go to the downloaded folder:

cd ~/xcash-official/ && git clone https://github.com/X-CASH-official/xcash-core.git
cd xcash-core
git checkout --quiet xcash_proof_of_stake

Make sure to have all the dependencies installed, and build the binaries using make:

make clean
make release -j `nproc`

Once the build finishes, the binaries will be located in ~/xcash-official/xcash-core/build/release/bin

Build Instructions

At this point, all the dependencies should be installed and built. First, clone the xcash-dpops repository:

cd ~/xcash-official/ && git clone https://github.com/X-CASH-official/xcash-dpops.git

Go into the downloaded folder, and build using make:

cd ~/xcash-official/xcash-dpops
make clean ; make release -j `nproc`

Once the build is completed, you will get the xcash-dpops Has Been Built Successfully message. Now that the program is built, you will need to generate a wallet to be used for the delegate and set up the different units for systemd to organize how your server manages the different services.

Generate a Wallet

You will need to create a wallet to register as a delegate, to receive the block reward if you are elected as a top delegate and if you are a shared delegate, the payments will be sent from this wallet as well.

To generate a new wallet, use the following command:

~/xcash-official/xcash-core/build/release/bin/xcash-wallet-cli --generate-new-wallet ~/xcash-official/xcash-wallet/<WALLET_NAME> --password <PASSWORD> --mnemonic-language English --restore-height 0 --daemon-address <REMOTE_NODE>

Replace <WALLET_NAME>, <PASSWORD> and the <REMOTE_NODE> with the parameters of your choice.

The wallet files will be located in ~/xcash-official/xcash-wallets/

Setup The Services

In systemd, a unit refers to any resource that the system knows how to operate on and manage. This is the primary object that the systemd tools know how to deal with. These resources are defined using configuration files called unit files.

On this guide, we will set up the different unit files to manage the programs needed to run your delegate node. The unit files template are present in the xcash-dpops/scripts/systemd folder, but will need to be adjusted with your delegate information.

1. Initialization

Create two empty PID files in the systemdpid folder previously created, that will manage the corresponding services:

touch ~/xcash-official/systemdpid/mongod.pid ~/xcash-official/systemdpid/xcash-daemon.pid

2. mongodb Service

Edit the systemd unit file mongodb.service from in the xcash-dpops/scripts/systemdfolder :

nano ~/xcash-official/xcash-dpops/scripts/systemd/mongodb.service

You will get the following unitfile:

mongodb.service
[Unit]
Description=MongoDB X-Cash Database Server
After=network.target
​
[Service]
Type=forking
User=root
Type=oneshot
RemainAfterExit=yes
PIDFile=~/xcash-official/systemdpid/mongod.pid
ExecStart=~/xcash-official/mongodb-linux-x86_64-ubuntu1804-4.4.0-rc7-36-gcf4ac31/bin/mongod --fork --syslog --dbpath /data/db
​
LimitFSIZE=infinity
LimitCPU=infinity
LimitAS=infinity
LimitNOFILE=64000
LimitNPROC=64000
LimitMEMLOCK=infinity
TasksMax=infinity
TasksAccounting=false
​
[Install]
WantedBy=multi-user.target

In the file, replace the following if needed:

• User: User of the system (most likely root)

• PIDFile: The path to mongod.pid file that you created at the initialization step.

• ExecStart:

  • Replace the path to the mongod file.

  • Replace the path to the database directory (/data/db as per the instructions)

3. xcash-daemon Service

Edit the systemd unit file xcash-daemon.service from in the xcash-dpops/scripts/systemdfolder :

nano ~/xcash-official/xcash-dpops/scripts/systemd/xcash-daemon.service

You will get the following unitfile:

xcash-daemon.service
[Unit]
Description=X-CASH Daemon background process
​
[Service]
Type=forking
User=root
PIDFile=~/xcash-official/systemdpid/xcash-daemon.pid
ExecStart=~/xcash-official/xcash-core/build/release/bin/xcashd --rpc-bind-ip 0.0.0.0 --p2p-bind-ip 0.0.0.0 --rpc-bind-port 18281 --restricted-rpc --confirm-external-bind --log-file ~/xcash-official/logs/xcash-daemon-log.txt --max-log-file-size 0 --detach --pidfile ~/xcash-official/systemdpid/xcash-daemon.pid
RuntimeMaxSec=15d
Restart=always
​
[Install]
WantedBy=multi-user.target

In the file, replace the following if needed:

• User: User of the system (most likely root)

• PIDFile: The path to xcash-daemon.pid file that you created at the initialization step.

• ExecStart:

  • Replace the path to the xcashd file.

  • Replace the path to the xcash-daemon_Log.txt file.

  • Replace the path to the xcash-daemon.pid file.

4. xcash-rpc-wallet Service

Edit the systemd unit file xcash-rpc-wallet.service from in the xcash-dpops/scripts/systemdfolder :

nano ~/xcash-official/xcash-dpops/scripts/systemd/xcash-rpc-wallet.service

You will get the following unit file:

xcash-rpc-wallet.service
[Unit]
Description=X-Cash RPC Wallet background service
​
[Service]
Type=simple
User=root
ExecStart=~/xcash-official/xcash-core/build/release/bin/xcash-wallet-rpc --wallet-file ~/xcash-official/xcash-wallets/WALLET --password PASSWORD --rpc-bind-port 18285 --confirm-external-bind --daemon-port 18281 --disable-rpc-login --trusted-daemon
Restart=always
​
[Install]
WantedBy=multi-user.target

In the file, replace the following if needed:

• User: User of the system (most likely root)

• ExecStart:

  • Replace the path to the xcash-wallet-rpc file.

  • Replace the path to the xcash-wallets folder, and replace WALLET by your delegate wallet name.

  • Replace PASSWORD with your delegate wallet password.

5. Firewall Service

Edit the systemd unit file firewall.service from in the xcash-dpops/scripts/systemdfolder :

nano ~/xcash-official/xcash-dpops/scripts/systemd/firewall.service

You will get the following unit file:

firewall.service
[Unit]
Description=firewall
​
[Service]
Type=oneshot
RemainAfterExit=yes
User=root
ExecStart=~/xcash-official/xcash-dpops/scripts/firewall/firewall_script.sh
​
[Install]
WantedBy=multi-user.target

In the file, replace the following if needed:

• User: User of the system (most likely root)

• ExecStart: Replace the path to the firewall/firewall_script.sh file.

6. xcash-dpops Service

Edit the systemd unit file xcash-dpops.service from in the xcash-dpops/scripts/systemdfolder :

nano ~/xcash-official/xcash-dpops/scripts/systemd/xcash-dpops.service

You will get the following unit file:

xcash-dpops.service
[Unit]
Description=X-Cash DPOPS Daemon background process
​
[Service]
Type=simple
LimitNOFILE=infinity
User=root
WorkingDirectory=~/xcash-official/xcash-dpops/build
ExecStart=~/xcash-official/xcash-dpops/build/xcash-dpops --block-verifiers-secret-key BLOCK_VERIFIER_SECRET_KEY
Restart=always
​
[Install]
WantedBy=multi-user.target

In the file, replace the following if needed:

• User: User of the system (most likely root)

• WorkingDirectory: Replace the path of the xcash-dpops/build folder.

• ExecStart:

  • Replace the path to the xcash-dpops file.

  • Replace BLOCK_VERIFIER_SECRET_KEY with your generated verifier secret key. This should be the first parameter.

7. Install and reload

Now that you have prepared all the unit systemd files, you will need to copy all of them to the system folder:

cp -a ~/xcash-official/xcash-dpops/scripts/systemd/* /lib/systemd/system/

Then, reload systemd to take the changes into account and run the services.

systemctl daemon-reload

Generate a Block Verifier Key

The block verifier key is a unique identifier generated by a delegate and is used in the consensus process to sign messages and verify the information. As a delegate, you will need to generate a block verifier key before being able to register yourself in the system.

First of all, stop the currently running process of the xcash-dpops program.

systemctl stop xcash-dpops

Then, run the xcash-dpops program with the --generate-key option. The program is located in the xcash-dpops/build folder. Run the command:

~/xcash-official/xcash-dpops/build/xcash-dpops --generate-key

You will be given a public key and private key.

Block Verifier Key
XCASH DPOPS - Version 1.0.0
---------------------------
Public Key:
cf8718d638ce0a831f3538ea60d1e27c3a258c7004a1ad7c547cc5331de7d9d7
Secret Key:
ca1319431124f55fa0d9e0fcc84edd780f80da7d91f08d334fac17c803934ecccf8718d638ce0a831f3538ea60d1e27c3a258c7004a1ad7c547cc5331de7d9d7

First of all, stop the currently running process of the xcash-dpops program.

systemctl stop xcash-dpops

Then, add your block verifier secret key as a parameter in the service. See the setup of the services guide to see how to edit the unit file.

Once done, make sure to save the new changes to systemctl by using the following command:

systemctl daemon-reload

Test build

Navigate to the folder that contains the binary, rebuild the binary in debug mode then run the test

make clean ; make debug -j `nproc`
cd build && ./xcash-dpops --test

The test will return the number of passed and failed tests at the bottom of the console. The failed test need to be 0 before you run the node. If the output is not showing 0 for a failed test, then you need to scroll through the testing output and find what test failed (It will be red instead of green).

If this is a system compatibility test, then you will need to fix the system. If this is a core test that has failed, then you need to possibly rebuild, or contact us on the DPoPS testing section or go the Discord channel to get help from testers and the dev-team.