Head back to Documentation
Documentation
QRL Pool Setup
QRL uses the RandomX protocol and can be mined collectively using a centralized pool server and a collection of computers running mining software.
This guide will walk through the steps required to get a pool up and running using Our GithHub Fork of the popular cryptonote-nodejs-pool software. This fork has been modified to run the QRL blockchain. You can use this as a basis for integrating QRL into your Pool or hosting your own private pool.
It is assumed that the appropriate security measures have been taken to secure the server hosting this pool software. Please follow best practice and keep software up to date.
Running a mining pool is not something that should be taken lightly. You need to have a good understanding of multiple complex administration and security practices.
Requirements
Hardware
- minimum 4GB RAM
- 2 Core CPU
- Support for AES-NI
- Support for avx2
- 64 bit Processor
- high bandwidth network connection
- Dedicated IP address
Software and OS
- This guide uses Ubuntu 18.04LTS
- python 3.6
- All required dependencies specified in the Pool software repo
QRL Install
Follow the instructions found docs.theqrl.org/node/QRLnode/ to get the node started.
Start QRL and Sync
Create a configuration file to give the QRL node instructions on how to run. By default the QRL node will look in ~/.qrl/ You may need to create this directory if you have not started the node.
Note if you are running a testnet node, you will find the active qrl configuration at
~/.qrl-testnet/config.yml
Create a ~/.qrl/config.yml file and add these minimum configuration settings.
mining_enabled: False
enable_peer_discovery: True
mining_api_enabled: True
public_api_enabled: True
Make sure to restart the node to pickup the changes.
start_qrl
Check the state of the qrl node with
qrl state
Verify the local node blockheight matches the block explorer. This may take some time.
grpcProxy
The QRL requires a bridge between the RPC and gRPC that QRL utilizes. The proxy handles the communication between the pool and the QRL node.
To use the proxy you must have a slaves.json file named payment_slaves.json in your ~/.qrl/ directory. To generate this file first you need a QRL wallet.
QRL CLI Wallet
Generate a new QRL wallet using the QRL node CLI. With the node running enter:
# Creates a QRL wallet
qrl wallet_gen --height 12 --hash_function shake128 --encrypt
The cli will ask for an encryption password to encrypt the file. This password will be required every time this wallet is needed, typically to generate a new slave tree in the distant future. DO not lose this password
There now is a wallet.json file in the local directory the command was issued in. Backup this file to a secure location for future use if needed. This is the new pool wallet. Now generate slave trees to use for sending payments through the pools automated system.
QRL payment_slaves.json
With the encrypted QRL Wallet.json file can create a slave tree file. This file contains a new set of One Time Signatures (OTS) generated from the main address that the pool will use to send transactions. See more on the XMSS slave trees in our Documentation
To generate a slave file from the wallet, run the following command. This will create the slaves tree and broadcast a signed transaction with the slave tree public keys onto the QRL network, allowing the set of slaves to be used.
qrl slave_tx_generate --src 0 --master '' --number_of_slaves 100 --access_type 0 --fee .001
This will create a new file called slaves.json in the same directory you are in, sign the message and send onto the network. This transaction will require a small fee to broadcast to the network. Make sure you have enough funds to cover the fee.
Move the slaves.json file to the ~/.qrl/ directory and rename to payment_slaves.json
Start the QRL_gRPC_Proxy
Run the proxy with the following:
qrl_grpc_proxy
Note: if you are running testnet, start the proxy with
--network-type testnetto use the default testnet directory~/.qrl-testnet. You will need to move the payments.slaves.json file to this directory as well.
Ports
Check to see that you have open ports for the pool to communicate on using netstat
netstat -tulnp
This will print all of the open ports on the server. Ensure ports 18090, 19007, 19009 are open and available for the pool.
Pool Install
To install the pool follow the instructions in the GitHub Repository. This will guide you through the dependencies and various steps to getting the pool software installed.
Please use the configuration found at the end of these docs to connect to the QRL node and wallet. this file lives at the root of the pool directory as config.json
Install Web Server
You will need a web server setup somewhere pointed at the pool API port. See the README.md in the pool Github for instructions on setting up the web front end. There is an additional configuration file needed to host the web server.
Most importantly, ensure the port is available to the web server and you can reach the address or IP externally.
var api = "http://pool.FQDN_OR_IP:8117";
Start The Pool
With the QRL node fully synced and running, slaves.json file in the correct place, ~/.qrl/config.yml file correctly filled out, and the qrl_grpc_proxy running, you can start the pool.
from the root pool directory, run
node init.js
Enjoy.
Pool Config File
Copy the /config_examples/qrl.json file found in the repository to /config.json and overview each option. Change any to match your preferred setup however pay attention to the following few configurations, as they are important.
- “poolAddress”: “Q01060019b0f4ce8ea82e71a5fc60851541db7e515d2585247c70533487cc89c50f6dddb8a4f386”,
- “daemon”: { “host”: “127.0.0.1”, “port”: 18090 },
- “wallet”: { “host”: “127.0.0.1”, “port”: 18090 },
{
"poolHost": "pool.FQDN_or_IPADDRESS",
"coin": "quantum_resistant_ledger",
"symbol": "QRL",
"hardForkHeight": 942375,
"coinUnits": 1000000000,
"coinDecimalPlaces": 9,
"coinDifficultyTarget": 60,
"daemonType": "default",
"cnAlgorithm": "randomx",
"cnVariant": 0,
"cnBlobType": 0,
"includeHeight": true,
"isRandomX": true,
"logging": {
"files": {
"level": "info",
"directory": "logs",
"flushInterval": 5
},
"console": {
"level": "info",
"colors": true
}
},
"poolServer": {
"enabled": true,
"clusterForks": "auto",
"poolAddress": "Q01060019b0f4ce8ea82e71a5fc60851541db7e515d2585247c70533487cc89c50f6dddb8a4f386",
"intAddressPrefix": null,
"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": 8888,
"difficulty": 25000,
"desc": "Hidden port",
"hidden": true
},
{
"port": 9999,
"difficulty": 20000,
"desc": "SSL connection",
"ssl": true
}
],
"varDiff": {
"minDiff": 100,
"maxDiff": 100000000,
"targetTime": 120,
"retargetTime": 60,
"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": 1800,
"maxAddresses": 50,
"mixin": 7,
"priority": 0,
"transferFee": 1000000,
"dynamicTransferFee": true,
"minerPayFee" : true,
"minPayment": 1000000000,
"maxPayment": null,
"maxTransactionAmount": 0,
"denomination": 10000000000
},
"blockUnlocker": {
"enabled": true,
"interval": 30,
"depth": 60,
"poolFee": 0.8,
"devDonation": 0.2,
"networkFee": 0.0
},
"api": {
"enabled": true,
"hashrateWindow": 600,
"updateInterval": 5,
"bindIp": "0.0.0.0",
"port": 8117,
"blocks": 30,
"payments": 30,
"password": "j$73Mds&ABUELID*$Fir7Tz!!0TllGt",
"ssl": false,
"sslPort": 8119,
"sslCert": "./cert.pem",
"sslKey": "./privkey.pem",
"sslCA": "./chain.pem",
"trustProxyIP": true
},
"daemon": {
"host": "127.0.0.1",
"port": 18090
},
"wallet": {
"host": "127.0.0.1",
"port": 18090
},
"redis": {
"host": "127.0.0.1",
"port": 6379,
"auth": null,
"db": 0,
"cleanupInterval": 15
},
"notifications": {
"emailTemplate": "email_templates/default.txt",
"emailSubject": {
"emailAdded": "Your email was registered",
"workerConnected": "Worker %WORKER_NAME% connected",
"workerTimeout": "Worker %WORKER_NAME% stopped hashing",
"workerBanned": "Worker %WORKER_NAME% banned",
"blockFound": "Block %HEIGHT% found !",
"blockUnlocked": "Block %HEIGHT% unlocked !",
"blockOrphaned": "Block %HEIGHT% orphaned !",
"payment": "We sent you a payment !"
},
"emailMessage": {
"emailAdded": "Your email has been registered to receive pool notifications.",
"workerConnected": "Your worker %WORKER_NAME% for address %MINER% is now connected from ip %IP%.",
"workerTimeout": "Your worker %WORKER_NAME% for address %MINER% has stopped submitting hashes on %LAST_HASH%.",
"workerBanned": "Your worker %WORKER_NAME% for address %MINER% has been banned.",
"blockFound": "Block found at height %HEIGHT% by miner %MINER% on %TIME%. Waiting maturity.",
"blockUnlocked": "Block mined at height %HEIGHT% with %REWARD% and %EFFORT% effort on %TIME%.",
"blockOrphaned": "Block orphaned at height %HEIGHT% :(",
"payment": "A payment of %AMOUNT% has been sent to %ADDRESS% wallet."
},
"telegramMessage": {
"workerConnected": "Your worker _%WORKER_NAME%_ for address _%MINER%_ is now connected from ip _%IP%_.",
"workerTimeout": "Your worker _%WORKER_NAME%_ for address _%MINER%_ has stopped submitting hashes on _%LAST_HASH%_.",
"workerBanned": "Your worker _%WORKER_NAME%_ for address _%MINER%_ has been banned.",
"blockFound": "*Block found at height* _%HEIGHT%_ *by miner* _%MINER%_*! Waiting maturity.*",
"blockUnlocked": "*Block mined at height* _%HEIGHT%_ *with* _%REWARD%_ *and* _%EFFORT%_ *effort on* _%TIME%_*.*",
"blockOrphaned": "*Block orphaned at height* _%HEIGHT%_ *:(*",
"payment": "A payment of _%AMOUNT%_ has been sent."
}
},
"email": {
"enabled": false,
"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"
},
"tls": {
"rejectUnauthorized": false
}
},
"mailgun": {
"key": "your-private-key",
"domain": "mg.yourdomain"
}
},
"telegram": {
"enabled": false,
"botName": "",
"token": "",
"channel": "",
"channelStats": {
"enabled": false,
"interval": 30
},
"botCommands": {
"stats": "/stats",
"report": "/report",
"notify": "/notify",
"blocks": "/blocks"
}
},
"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
},
"worker_hashrate": {
"enabled": true,
"updateInterval": 60,
"stepInterval": 60,
"maximumPeriod": 86400
},
"payments": {
"enabled": true
}
},
"blocks": {
"enabled": true,
"days": 30
}
}
}
