High performance Node.js (with native C addons) mining pool for CryptoNote based coins such as Bytecoin, DuckNote, Monero, QuazarCoin, Boolberry, Dashcoin, GRAFT, SUPERIORCOIN etc. Comes with lightweight example front-end script which uses the pool's AJAX API.
- Features
- Community Support
- Pools Using This Software
- Usage
- JSON-RPC Commands from CLI
- Monitoring Your Pool
- Donations
- Credits
- License
- TCP (stratum-like) protocol for server-push based jobs
- Compared to old HTTP protocol, this has a higher hash rate, lower network/CPU server load, lower orphan block percent, and less error prone
- IP banning to prevent low-diff share attacks
- Socket flooding detection
- Share trust algorithm to reduce share validation hashing CPU load
- Clustering for vertical scaling
- Ability to configure multiple ports - each with their own difficulty
- Miner login (wallet address) validation
- Workers identification (specify worker name as the password)
- Variable difficulty / share limiter
- Set fixed difficulty on miner client by passing "address" param with "+[difficulty]" postfix
- Modular components for horizontal scaling (pool server, database, stats/API, payment processing, front-end)
- SSL support for both pool and API servers
- Currency network/block difficulty
- Current block height
- Network hashrate
- Pool hashrate
- Each miners' individual stats (hashrate, shares submitted, pending balance, total paid, payout estimate, etc)
- Blocks found (pending, confirmed, and orphaned)
- Historic charts of pool's hashrate, miners count and coin difficulty
- Historic charts of users's hashrate and payments
- Mined blocks table with block status (pending, confirmed, and orphaned)
- Blocks luck (shares/difficulty) statistics
- Universal blocks and transactions explorer based on chainradar.com
- Splintered transactions to deal with max transaction size
- Minimum payment threshold before balance will be paid out
- Minimum denomination for truncating payment amount precision to reduce size/complexity of block transactions
- Prevent "transaction is too big" error with "payments.maxTransactionAmount" option
- Option to enable dynamic transfer fee based on number of payees per transaction and option to have miner pay transfer fee instead of pool owner (applied to dynamic fee only)
- Control transactions priority with config.payments.priority (default: 0).
- Set payment ID on miner client when using "[address].[paymentID]" login
- Integrated payment ID addresses support for Exchanges
- Aggregated pool statistics
- Coin daemon & wallet RPC services stability monitoring
- Log files data access
- Users list with detailed statistics
- Detailed logging in process console & log files
- Coin daemon & wallet RPC services stability monitoring
- See logs data from admin panel
- An easily extendable, responsive, light-weight front-end using API to display data
- Onishin's keepalive function
- Support for slush mining system (disabled by default)
- E-Mail Notifications on worker connected, disconnected (timeout) or banned (support MailGun, SMTP and Sendmail)
- Coin daemon(s) (find the coin's repo and build latest version from source)
- Node.js v4.0+
- For Ubuntu:
sudo apt-get install nodejs npm && ln -s /usr/bin/nodejs /usr/bin/node
- For Ubuntu:
- Redis key-value store v2.6+ (follow these instructions)
- libssl required for the node-multi-hashing module
- For Ubuntu:
sudo apt-get install libssl-dev
- For Ubuntu:
- Boost is required for the cryptonote-util module
- For Ubuntu:
sudo apt-get install libboost-all-dev
- For Ubuntu:
Those are legitimate requirements. If you use old versions of Node.js or Redis that may come with your system package manager then you will have problems. Follow the linked instructions to get the last stable versions.
Redis security warning: be sure firewall access to redis - an easy way is to
include bind 127.0.0.1 in your redis.conf file. Also it's a good idea to learn about and understand software that
you are using - a good place to start with redis is data persistence.
Clone the repository and run npm update for all the dependencies to be installed:
git clone https://github.com/ReCoal/recoal-pool.git pool
cd pool
npm updateWarning for Cryptonote coins other than Monero: this software may or may not work with any given cryptonote coin. Be wary of altcoins that change the number of minimum coin units because you will have to reconfigure several config values to account for those changes. Unless you're offering a bounty reward - do not open an issue asking for help getting a coin other than Monero working with this software.
Copy the config_examples/COIN.json file of your choice to config.json then overview each options and change any to match your preferred setup.
Example Configuration :
{
"coin": "recoal",
"symbol": "RECL",
"coinUnits": 1000000000000,
"coinDifficultyTarget": 120,
"cnVariant": null,
"logging": {
"files": {
"level": "info",
"directory": "logs",
"flushInterval": 5
},
"console": {
"level": "info",
"colors": true
}
},
"poolServer": {
"enabled": true,
"clusterForks": "auto",
"poolAddress": "__________________________YOUR_POOL_ADDRESS____________________________",
"blockRefreshInterval": 1000,
"minerTimeout": 900,
"sslCert": "./cert.pem",
"sslKey": "./privkey.pem",
"sslCA": "./chain.pem",
"ports": [
{
"port": 3333,
"difficulty": 5000,
"desc": "Low end hardware"
},
{
"port": 4444,
"difficulty": 15000,
"desc": "Mid range hardware"
},
{
"port": 5555,
"difficulty": 25000,
"desc": "High end hardware"
},
{
"port": 7777,
"difficulty": 500000,
"desc": "Cloud-mining / NiceHash"
},
{
"port": 9999,
"difficulty": 20000,
"desc": "SSL connection",
"ssl": true
}
],
"varDiff": {
"minDiff": 100,
"maxDiff": 100000000,
"targetTime": 60,
"retargetTime": 30,
"variancePercent": 30,
"maxJump": 100
},
"paymentId": {
"addressSeparator": "+"
},
"fixedDiff": {
"enabled": true,
"addressSeparator": "."
},
"shareTrust": {
"enabled": true,
"min": 10,
"stepDown": 3,
"threshold": 10,
"penalty": 30
},
"banning": {
"enabled": true,
"time": 600,
"invalidPercent": 25,
"checkThreshold": 30
},
"slushMining": {
"enabled": false,
"weight": 300,
"blockTime": 60,
"lastBlockCheckRate": 1
}
},
"payments": {
"enabled": true,
"interval": 300,
"maxAddresses": 50,
"mixin": 5,
"priority": 0,
"transferFee": 14000000000,
"dynamicTransferFee": true,
"minerPayFee" : true,
"minPayment": 1000000000000,
"maxTransactionAmount": 0,
"denomination": 100000000000
},
"blockUnlocker": {
"enabled": true,
"interval": 30,
"depth": 60,
"poolFee": 1.8,
"devDonation": 0.2
},
"api": {
"enabled": true,
"hashrateWindow": 600,
"updateInterval": 5,
"port": 8117,
"blocks": 30,
"payments": 30,
"password": "your_password",
"ssl": false,
"sslPort": 8119,
"sslCert": "./cert.pem",
"sslKey": "./privkey.pem",
"sslCA": "./chain.pem",
"trustProxyIP": false
},
"daemon": {
"host": "127.0.0.1",
"port": 12121
},
"wallet": {
"host": "127.0.0.1",
"port": 12123
},
"redis": {
"host": "127.0.0.1",
"port": 6379,
"auth": null,
"cleanupInterval": 15
},
"email": {
"enabled": false,
"templateDir": "email_templates",
"templates": ["worker_connected", "worker_banned", "worker_timeout"],
"variables": {
"POOL_HOST": "poolhost.com"
},
"fromAddress": "your@email.com",
"transport": "sendmail",
"sendmail": {
"path": "/usr/sbin/sendmail"
},
"smtp": {
"host": "smtp.example.com",
"port": 587,
"secure": false,
"auth": {
"user": "username",
"pass": "password"
}
},
"mailgun": {
"key": "your-private-key",
"domain": "mg.yourdomain"
}
},
"monitoring": {
"daemon": {
"checkInterval": 60,
"rpcMethod": "getblockcount"
},
"wallet": {
"checkInterval": 60,
"rpcMethod": "getbalance"
}
},
"prices": {
"source": "cryptonator",
"currency": "USD"
},
"charts": {
"pool": {
"hashrate": {
"enabled": true,
"updateInterval": 60,
"stepInterval": 1800,
"maximumPeriod": 86400
},
"miners": {
"enabled": true,
"updateInterval": 60,
"stepInterval": 1800,
"maximumPeriod": 86400
},
"workers": {
"enabled": true,
"updateInterval": 60,
"stepInterval": 1800,
"maximumPeriod": 86400
},
"difficulty": {
"enabled": true,
"updateInterval": 1800,
"stepInterval": 10800,
"maximumPeriod": 604800
},
"price": {
"enabled": true,
"updateInterval": 1800,
"stepInterval": 10800,
"maximumPeriod": 604800
},
"profit": {
"enabled": true,
"updateInterval": 1800,
"stepInterval": 10800,
"maximumPeriod": 604800
}
},
"user": {
"hashrate": {
"enabled": true,
"updateInterval": 180,
"stepInterval": 1800,
"maximumPeriod": 86400
},
"payments": {
"enabled": true
}
}
}
}node init.jsThe file config.json is used by default but a file can be specified using the -config=file command argument, for example:
node init.js -config=config_backup.jsonThis software contains four distinct modules:
pool- Which opens ports for miners to connect and processes sharesapi- Used by the website to display network, pool and miners' dataunlocker- Processes block candidates and increases miners' balances when blocks are unlockedpayments- Sends out payments to miners according to their balances stored in redis
By default, running the init.js script will start up all four modules. You can optionally have the script start
only start a specific module by using the -module=name command argument, for example:
node init.js -module=apiExample screenshot of running the pool in single module mode with tmux.
Simply host the contents of the website_example directory on file server capable of serving simple static files.
Edit the variables in the website_example/config.js file to use your pool's specific configuration.
Variable explanations:
/* Must point to the API setup in your config.json file. */
var api = "http://poolhost:8117";
/* Pool server host to instruct your miners to point to. */
var poolHost = "poolhost.com";
/* Contact email address. */
var email = "support@poolhost.com";
/* Pool Telegram URL. */
var telegram = "https://t.me/YourPool";
/* Pool Discord URL */
var discord = "https://discordapp.com/invite/YourPool";
/* Market stat display params from https://www.cryptonator.com/widget */
var cryptonatorWidget = ["{symbol}-BTC", "{symbol}-USD", "{symbol}-EUR", "{symbol}-CAD"];
/* Default currency used by Estimate Mining Profit tool */
var defaultCurrency = 'USD';
/* Used for front-end block links. */
var blockchainExplorer = "http://chainradar.com/{symbol}/block/{id}";
/* Used by front-end transaction links. */
var transactionExplorer = "http://chainradar.com/{symbol}/transaction/{id}";
/* Any custom CSS theme for pool frontend */
var themeCss = "themes/light.css";The following files are included so that you can customize your pool website without having to make significant changes
to index.html or other front-end files thus reducing the difficulty of merging updates with your own changes:
custom.cssfor creating your own pool stylecustom.jsfor changing the functionality of your pool website
Then simply serve the files via nginx, Apache, Google Drive, or anything that can host static content.
You can configure the API to be accessible via SSL using various methods. Find an example for nginx below:
- Using SSL api in
config.json:
By using this you will need to update your api variable in the website_example/config.js. For example:
var api = "https://poolhost:8119";
- Inside your SSL Listener, add the following:
location ~ ^/api/(.*) {
proxy_pass http://127.0.0.1:8117/$1$is_args$args;
}By adding this you will need to update your api variable in the website_example/config.js to include the /api. For example:
var api = "http://poolhost/api";
You no longer need to include the port in the variable because of the proxy connection.
- Using his own subdomain, for example
api.poolhost.com:
server {
server_name api.poolhost.com
listen 443 ssl http2;
ssl_certificate /your/ssl/certificate;
ssl_certificate_key /your/ssl/certificate_key;
location / {
more_set_headers 'Access-Control-Allow-Origin: *';
proxy_pass http://127.0.01:8117;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade;
}
}By adding this you will need to update your api variable in the website_example/config.js. For example:
var api = "//api.poolhost.com";
You no longer need to include the port in the variable because of the proxy connection.
When updating to the latest code its important to not only git pull the latest from this repo, but to also update
the Node.js modules, and any config files that may have been changed.
- Inside your pool directory (where the init.js script is) do
git pullto get the latest code. - Remove the dependencies by deleting the
node_modulesdirectory withrm -r node_modules. - Run
npm updateto force updating/reinstalling of the dependencies. - Compare your
config.jsonto the latest example ones in this repo or the ones in the setup instructions where each config field is explained. You may need to modify or add any new changes.
Documentation for JSON-RPC commands can be found here:
- Daemon https://wiki.bytecoin.org/wiki/Daemon_JSON_RPC_API
- Wallet https://wiki.bytecoin.org/wiki/Wallet_JSON_RPC_API
Curl can be used to use the JSON-RPC commands from command-line. Here is an example of calling getblockheaderbyheight for block 100:
curl 127.0.0.1:12121/json_rpc -d '{"method":"getblockheaderbyheight","params":{"height":100}}'- To inspect and make changes to redis I suggest using redis-commander
- To monitor server load for CPU, Network, IO, etc - I suggest using New Relic
- To keep your pool node script running in background, logging to file, and automatically restarting if it crashes - I suggest using forever
- BTC:
19R69NNM4BAwSTcuJ8UjUCxcLBPyek9K8a - ETH:
0xb3272fb4e201d737cb2ffe82c46f674363c37057 - LTC:
LbjuGwve9PwfSSkA4VZBANzuFNDfBc17Wx - XMR:
41iFUpFHqSnSoxJEADGPTihZXTtCpJUTLiaSh19Hdp5QePmVQ8DmdxgbfqCUUHH9CPC9t2Fwnwgg8cFs18jNvKUxAi4vrhJ
Released under the GNU General Public License v2