X-Cash Delegates Pool Website

🗳 The website to manage an elected delegate.

Admin-panel-styled dashboard forked from cdk-admin, an Angular 6 admin panel using angular material.

Table of Contents

• Table of Contents
• Features
• License
• Contributing
• Documentation
• Security
• System Requirements
• Installation Process
  • Dependencies
  • Requirements
  • Develop
  • Testing

Features

Voters payout
Automatically pay voters, and provide them with their payment history.

List of voters
See the number of votes and addresses associated to them.

Block history See how many blocks the delegate you voted for has found.

License

The X-Cash Delegates Pool Website is an open-source project managed by the X-Cash Foundation.
We are operating under the MIT License.

Contributing

Thank you for thinking of contributing! 😃
If you want to help out, check CONTRIBUTING for a set of guidelines and check our opened issues.

Documentation

We are hosting our documentation on GitBook 👉 docs.xcash.foundation

You can contribute directly on our gitbook-docs repository.

Security

If you discover a security vulnerability, please send an e-mail to security@xcash.foundation.
All security vulnerabilities concerning the X-Cash blockchain will be promply addressed.

System Requirements

The delegates pool website is optional for delegates to run, as the network nodes will run it already.

To run the delegates pool website, it needs to be on the same server as an X-Cash node. The system requirements for running a node are in the xcash-dpops repository.

At the moment, xcash-dpops is only available for Linux/Unix distributions.

Installation Process

Dependencies

The following table summarizes the tools and libraries required to run the delegates pool website.

Dependencies	Min. version	Ubuntu package
Node.js	8	install from binaries
Angular	6	install from npm
xcash-dpops	latest version	build from source

If you want to run the website using SSL then you will need to install a webserver like nginx
The readme shows you how to setup the website using HTTP, since there is no sensitive data in the website

Requirements

Intalling Node.js from binaries

It is recommended to install the nodejs folder in the home directory /home/$USER/ or root directory (/root/) in a new folder

To download, go to the Node.js official release page and download the Linux Binaries. Copy it to your deisgnated folder and run these commands:

tar -xf node*.tar.xz
rm node*.tar.xz

Then add Node.js to your path:

echo -e '\nexport PATH=path_to_nodejs/bin:$PATH' >> ~/.profile && source ~/.profile

Replace path_to_nodejs/bin with the location of the bin folder where you installed Node.js

npm

Note if your installing on a root session, you need to run these additional commands before upgrading

npm config set user 0
npm config set unsafe-perm true

Update npm globally:

npm install -g npm

angular

Install the latest version of Angular globally:

npm install -g @angular/cli@latest

Then install the compressor UglifyJS globally :

npm install -g uglify-js

Develop

Clone repository

In your desired folder, clone the repository:

git clone https://github.com/X-CASH-official/delegates-pool-website.git

Install dependencies

~cd /delegates-pool-website
npm install

Enable port 80 in the firewall and redirect port 80 to 18283

Uncomment these lines in $HOME/firewall_script.sh

# iptables -t filter -I INPUT -p tcp --syn --dport 80 -m connlimit --connlimit-above 100 --connlimit-mask 32 -j DROP

# iptables -A INPUT -p tcp --dport 80 -j ACCEPT

Run the firewall script
$HOME/firewall_script.sh

Build

To build the delegates pool website, go to the delegates-pool-website folder and run:

npm run build

It will build in the distfolder.

Compress the .js files with Uglify-JS and move all of the contents of this folder to your xcash-dpops/ folder

cd dist
for f in *.js; do echo "Processing $f file.."; uglifyjs $f --compress --mangle --output "{$f}min"; rm $f; mv "{$f}min" $f; done
rm -r ../xcash-dpops/delegates-pool-website
mkdir ../xcash-dpops/delegates-pool-website
cd ../
cp -a dist/* ../xcash-dpops/delegates-pool-website/

Testing

npm test

To test that you have properly configured the delegates pool website, run xcash-dpops with the --test_data_add flag. This will add test datas to the MongoDB.

Now run the website server again using the normal options.

Next, navigate to your servers IP address or website domain. You should now see the website and some test data. You can navigate through the website using the test data.

When you have verified that the website works correctly, remove the test data by shutting down the xcash-dpops and then running it again with the --test_data_remove flag.