lehuwu / liskpool

First open source DPoS delegate pool made for Lisk

Lisk Pool

This is first and fully open source Lisk delegate forging pool (also known as delegate reward sharing). Written in PHP.

Requirements

MariaDB server
Memcached
Nginx
Lisk Node
Highcharts (included in project)

Important

Only public directory must be served with webserver. While config.php and private should not be served.

Installation

Liskpool now fully relies on Lisk-PHP to interact with Lisk node, including transaction signing.

cd liskpool
git submodule update --init --recursive
cd lisk-php
bash setup.sh
cd ..
apt-get install nginx mariadb-server memcached php-memcached php php-curl

Setup mariadb server, nginx and import database scheme

lisk_pool_scheme_db.sql

Navigate to config.php

lisk_nodes & lisk_ports You can add here more independent nodes which are used to determine node with best height. It keeps pool updated with most recent state of network, prevents messing up charts in case of forks and other issues.

$lisk_nodes = array(0 => 'localhost',1 => '123.123.123.123');
$lisk_ports = array(0 => '8000',1 => '8000');

'host' => 'localhost',    //<- dont change if mariadb is running on the same machine
'username' => 'root',     //<- Database user
'password' => 'dbpass',  //<- Database Password
'bdd' => 'lisk',    //<- Database Name
'lisk_host' => $lisk_nodes,
'lisk_port' => $lisk_ports,
'protocol' => 'http', //<-pick http or https
'pool_fee' => '25.0%',     //<- adjustable pool fee as float for ex. "25.0%"
'pool_fee_payout_address' => '17957303129556813956L',   //<- Payout address if fee > 0.0
'delegate_address' => '17957303129556813956L',    //<- Delegate address - must be valid forging delegate address
'payout_threshold' => '1',    //<- Payout threshold in LISK
'fixed_withdraw_fee' => '0.1',    //<- Fixed Withdraw fee in LISK
'withdraw_interval_in_sec' => '43200',   //<- Withdraw script interval represented in seconds
'secret' => 'passphrase1',    //<- Main passphrase the same your as in your forging delegate
'fancy_withdraw_hub' => '', //<-beta withdraw hub, leave empty for normal withdraws
'secondSecret' => 'passphrase2', //<- Second passphrase, if you dont have one leave it empty ex. ""
'public_directory' => 'private', //<- directory name of public dir
'cap_balance' => '150000000000000', //balance to cap voter votepower, default - anything over 1.5m LSK will be reduced to 1.5m
'slow_withdraw' => true //with payouts >1k lisk tx pool limit problem

pool_fee_payout_address address specified for pool fee should be voting for delegate or should be manually added to table "miners".

Usage

Start Lisk core node, enable forging directly or use lisk-best-forger. You can forge with different node that one used for pool.

Navigate to /private/ directory and start background scripts:

Node height checker, necessary even there is only one defined

screen -dmS bestnode php bestnode.php

Block Processing - this script checks if delegate forged new block, if so it will split as defined in config

screen -dmS processing php processing.php

Updating charts - this script updates data to keep charts up to date.

screen -dmS stats php stats.php

Withdraw script - this script withdraws revenue as defined in config. It features multithreaded withdraw processing if your cpu has multiple cores or supports htt. Technically, it's more like forking rather threading, however it was simplier to implement and saves some time building php with zts enabled.

screen -dmS withdraw php withdraw.php

If you want to support Liskstats contributors and Liskstats itself use also script below. This script connects to Liskstats.net and retrieve all current contributors. Every contributor is added to split with "fake" votepower which is defined in processing.php.

screen -dmS liskstats php liskstats.php

Optional Balance checker - Simple script to compare total LISK value stored in database in reference to actual LISK stored on delegate account.

cd helpers
php check.php

All background scripts can be easily accessed with

NAME = "processing" or "stats" or "withdraw" or "bestnode" or "liskstats"
screen -x NAME

Example

screen -x processing

Forging productivity

Optionally you can use lisk-best-forger background script to improve forging productivity.

cd private/forging
nano config.php

In private/config.php you need to add trusted nodes and it's ports. Each specified server needs to have whitelisted IP address of server which will be used to run this script. As described here. Passphrase will be taken from main configuration file. For more details visit main lisk-best-forger repository.

Usage

screen -dmS bestforger php daemon.php

This script should be used along with trusted servers only via SSL.

Public API

Specified voter balance data for balance chart, respectively entitled pool balance, network balance and withdraw amount.

data/voters/ADDRESS.json
data/voters/balance/ADDRESS.json
data/voters/withdraw/ADDRESS.json

General data for charts

data/approval.json
data/balance.json
data/rank.json
data/voters.json
data/reserve.json
data/productivity.json

General pool info

api/info/

Current forged balance for each voter / contributor

api/info/forged/
api/info/forged/?by=ADDRESS

Liskstats.net good and bad nodes for processing.php

api/info/liskstats/?type=html
api/info/liskstats/?type=json

Logs

As soon any of background scripts gets excuted, logs directory will appear in private directory. It will store all logs of all background scripts.

Migration from older version of pool

In past all chart data was stored in database tables, however with millions of rows and cheap vps it could have been possible bottleneck with thousands of voters and more. If you are pool operator and you want to keep all statistics history.

1. Stop all background scripts
2. Navigate to /helpers/ directory in /private/
3. Execute php db2files.php all or screen -dmS dump php db2files.php all
4. Wait until it finish, it can take hours for huge database. If your connection might drop, possibly execute this as background job choosing second command.
5. Start updated background scripts.
6. Tables pool_xxx and miner_balance can be deleted.

Contributing

If you want to contribute, fork and pull request or open issue.

License

Everything is under MIT License (MIT) except Front-end (site theme) which is paid. Sorry, at first it wasn't meant to be open sourced thus i just picked paid template
At some point it will be rewritten from scratch.