497 lines
20 KiB
JavaScript
497 lines
20 KiB
JavaScript
var events = require('events');
|
|
var async = require('async');
|
|
|
|
var varDiff = require('./varDiff.js');
|
|
var daemon = require('./daemon.js');
|
|
var peer = require('./peer.js');
|
|
var stratum = require('./stratum.js');
|
|
var jobManager = require('./jobManager.js');
|
|
var util = require('./util.js');
|
|
|
|
|
|
/**
|
|
* Main pool object. It emits the following events:
|
|
* - started() - when the pool is effectively started
|
|
* - share(isValidShare, isValidBlock, shareData) - When a share is submitted
|
|
* - log(severity, key, text) - for debug, warning, and error messages
|
|
*
|
|
* It initializes and connects:
|
|
* - JobManager - for generating miner work, processing block templates and shares
|
|
* - DaemonInterface - for RPC communication with daemon
|
|
* - StratumServer - for TCP socket communication with miners
|
|
*
|
|
*/
|
|
|
|
var pool = module.exports = function pool(options, authorizeFn){
|
|
|
|
this.options = options;
|
|
|
|
var _this = this;
|
|
var publicKeyBuffer;
|
|
|
|
|
|
|
|
var emitLog = function(key, text) { _this.emit('log', 'debug' , key, text); };
|
|
var emitWarningLog = function(key, text) { _this.emit('log', 'warning', key, text); };
|
|
var emitErrorLog = function(key, text) { _this.emit('log', 'error' , key, text); };
|
|
|
|
this.start = function(){
|
|
emitLog('system', 'Starting pool for ' + options.coin.name + ' [' + options.coin.symbol.toUpperCase() + ']');
|
|
SetupJobManager();
|
|
SetupVarDiff();
|
|
SetupDaemonInterface();
|
|
SetupApi();
|
|
};
|
|
|
|
function SetupApi() {
|
|
if (typeof(options.api) !== 'object' || typeof(options.api.start) !== 'function') {
|
|
return;
|
|
} else {
|
|
options.api.start(_this);
|
|
}
|
|
}
|
|
|
|
function SetupPeer(){
|
|
if (!options.p2p || !options.p2p.enabled)
|
|
return;
|
|
_this.peer = new peer(options.p2p);
|
|
_this.peer.on('connected', function(){
|
|
emitLog('system', 'connected to daemon as a peer node');
|
|
}).on('disconnected', function(){
|
|
emitWarningLog('system', 'peer node disconnected - attempting reconnection...');
|
|
}).on('connectionFailed', function(){
|
|
emitErrorLog('system', 'failed to connect to daemon as a peer node');
|
|
}).on('error', function(msg){
|
|
emitWarningLog('p2p', msg);
|
|
}).on('blockFound', function(hash){
|
|
this.processBlockNotify(hash);
|
|
});
|
|
}
|
|
|
|
function SetupVarDiff(){
|
|
if (!options.varDiff.enabled){
|
|
emitLog('system', 'VarDiff has been disabled');
|
|
return;
|
|
}
|
|
_this.varDiff = new varDiff(options.varDiff, options.pool.difficulty);
|
|
_this.varDiff.on('newDifficulty', function(client, newDiff) {
|
|
|
|
if (options.varDiff.mode === 'fast'){
|
|
/* Send new difficulty, then force miner to use new diff by resending the
|
|
current job parameters but with the "clean jobs" flag set to false
|
|
so the miner doesn't restart work and submit duplicate shares */
|
|
client.sendDifficulty(newDiff);
|
|
var job = _this.jobManager.currentJob.getJobParams();
|
|
job[8] = false;
|
|
client.sendMiningJob(job);
|
|
}
|
|
else{
|
|
/* We request to set the newDiff @ the next difficulty retarget
|
|
(which should happen when a new job comes in - AKA BLOCK) */
|
|
client.enqueueNextDifficulty(newDiff);
|
|
}
|
|
});
|
|
emitLog("system", "VarDiff enabled and setup");
|
|
}
|
|
|
|
/*
|
|
Coin daemons either use submitblock or getblocktemplate for submitting new blocks
|
|
*/
|
|
function SubmitBlock(blockHex, callback){
|
|
|
|
var rpcCommand, rpcArgs;
|
|
if (options.hasSubmitMethod){
|
|
rpcCommand = 'submitblock';
|
|
rpcArgs = [blockHex];
|
|
}
|
|
else{
|
|
rpcCommand = 'getblocktemplate';
|
|
rcpArgs = [{'mode': 'submit', 'data': blockHex}];
|
|
}
|
|
|
|
|
|
_this.daemon.cmd(rpcCommand,
|
|
rpcArgs,
|
|
function(results){
|
|
results.forEach(function(result){
|
|
if (result.error)
|
|
emitErrorLog('submitblock', 'rpc error with daemon instance ' +
|
|
result.instance.index + ' when submitting block with ' + rpcCommand + ' ' +
|
|
JSON.stringify(result.error)
|
|
);
|
|
else
|
|
emitLog('submitblock', 'Submitted Block using ' + rpcCommand + ' to daemon instance ' +
|
|
result.instance.index
|
|
);
|
|
});
|
|
callback();
|
|
}
|
|
);
|
|
|
|
}
|
|
|
|
|
|
function SetupJobManager(){
|
|
_this.jobManager = new jobManager({
|
|
algorithm : options.coin.algorithm,
|
|
address : options.pool.address,
|
|
reward : options.coin.reward,
|
|
txMessages: options.coin.txMessages
|
|
});
|
|
_this.jobManager.on('newBlock', function(blockTemplate){
|
|
//Check if stratumServer has been initialized yet
|
|
if ( typeof(_this.stratumServer ) !== 'undefined') {
|
|
emitLog('system', 'Detected new block');
|
|
_this.stratumServer.broadcastMiningJobs(blockTemplate.getJobParams());
|
|
}
|
|
}).on('updatedBlock', function(blockTemplate){
|
|
//Check if stratumServer has been initialized yet
|
|
if ( typeof(_this.stratumServer ) !== 'undefined') {
|
|
emitLog('system', 'Detected updated block transactions');
|
|
var job = blockTemplate.getJobParams();
|
|
job[8] = false;
|
|
_this.stratumServer.broadcastMiningJobs(job);
|
|
}
|
|
}).on('share', function(shareData, blockHex){
|
|
var isValidShare = !shareData.error;
|
|
var isValidBlock = !!blockHex;
|
|
var emitShare = function(){
|
|
_this.emit('share', isValidShare, isValidBlock, shareData);
|
|
};
|
|
|
|
/*
|
|
If we calculated that the block solution was found,
|
|
before we emit the share, lets submit the block,
|
|
then check if it was accepted using RPC getblock
|
|
*/
|
|
if (!isValidBlock)
|
|
emitShare();
|
|
else{
|
|
SubmitBlock(blockHex, function(){
|
|
CheckBlockAccepted(shareData.solution, function(isAccepted){
|
|
isValidBlock = isAccepted;
|
|
emitShare();
|
|
});
|
|
});
|
|
}
|
|
}).on('debugBlockShare', function(debugData) {
|
|
emitLog('debugBlockSubmit', JSON.stringify(debugData));
|
|
});
|
|
}
|
|
|
|
|
|
function SetupDaemonInterface(){
|
|
emitLog('system', 'Connecting to daemon(s)');
|
|
_this.daemon = new daemon.interface(options.daemons);
|
|
_this.daemon.once('online', function(){
|
|
async.parallel({
|
|
addressInfo: function(callback){
|
|
_this.daemon.cmd('validateaddress', [options.pool.address], function(results){
|
|
|
|
//Make sure address is valid with each daemon
|
|
var allValid = results.every(function(result){
|
|
if (result.error || !result.response){
|
|
emitErrorLog('system','validateaddress rpc error on daemon instance ' +
|
|
result.instance.index + ', error +' + JSON.stringify(result.error));
|
|
}
|
|
else if (!result.response.isvalid)
|
|
emitErrorLog('system', 'Daemon instance ' + result.instance.index +
|
|
' reports address is not valid');
|
|
return result.response && result.response.isvalid;
|
|
});
|
|
|
|
if (allValid)
|
|
callback(null, results[0].response);
|
|
else{
|
|
callback('not all addresses are valid')
|
|
}
|
|
|
|
});
|
|
},
|
|
miningInfo: function(callback){
|
|
_this.daemon.cmd('getmininginfo', [], function(results){
|
|
|
|
// Print which network each daemon is running on
|
|
|
|
var isTestnet;
|
|
var allValid = results.every(function(result){
|
|
|
|
if (result.error){
|
|
emitErrorLog('system', 'getmininginfo on init failed with daemon instance ' +
|
|
result.instance.index + ', error ' + JSON.stringify(result.error)
|
|
);
|
|
return false;
|
|
}
|
|
|
|
var network = result.response.testnet ? 'testnet' : 'live blockchain';
|
|
emitLog('system', 'Daemon instance ' + result.instance.index + ' is running on ' + network);
|
|
|
|
if (typeof isTestnet === 'undefined'){
|
|
isTestnet = result.response.testnet;
|
|
return true;
|
|
}
|
|
else if (isTestnet !== result.response.testnet){
|
|
emitErrorLog('system', 'not all daemons are on same network');
|
|
return false;
|
|
}
|
|
else
|
|
return true;
|
|
});
|
|
|
|
|
|
if (!allValid){
|
|
callback('could not getmininginfo correctly on each daemon');
|
|
return;
|
|
}
|
|
|
|
//Find and return the response with the largest block height (most in-sync)
|
|
var largestHeight = results.sort(function(a, b){
|
|
return b.response.blocks - a.response.blocks;
|
|
})[0].response;
|
|
|
|
if (options.varDiff.enabled)
|
|
_this.varDiff.setNetworkDifficulty(largestHeight.difficulty);
|
|
|
|
emitLog('network', 'Current block height at ' + largestHeight.blocks +
|
|
' with difficulty of ' + largestHeight.difficulty);
|
|
|
|
callback(null, largestHeight);
|
|
|
|
});
|
|
},
|
|
submitMethod: function(callback){
|
|
/* This checks to see whether the daemon uses submitblock
|
|
or getblocktemplate for submitting new blocks */
|
|
_this.daemon.cmd('submitblock', [], function(results){
|
|
var couldNotDetectMethod = results.every(function(result){
|
|
if (result.error && result.error.message === 'Method not found'){
|
|
callback(null, false);
|
|
return false;
|
|
}
|
|
else if (result.error && result.error.code === -1){
|
|
callback(null, true);
|
|
return false;
|
|
}
|
|
else
|
|
return true;
|
|
});
|
|
if (couldNotDetectMethod){
|
|
emitErrorLog('system', 'Could not detect block submission RPC method');
|
|
callback('block submission detection failed');
|
|
}
|
|
});
|
|
}
|
|
}, function(err, results){
|
|
if (err){
|
|
emitErrorLog('system', 'Could not start pool, ' + JSON.stringify(err));
|
|
return;
|
|
}
|
|
|
|
emitLog('system','Connected to daemon via RPC');
|
|
|
|
options.hasSubmitMethod = results.submitMethod;
|
|
|
|
if (options.coin.reward === 'POS' && typeof(results.addressInfo.pubkey) == 'undefined') {
|
|
// address provided is not of the wallet.
|
|
emitErrorLog('system', 'The address provided is not from the daemon wallet.');
|
|
return;
|
|
} else {
|
|
|
|
publicKeyBuffer = options.coin.reward === 'POW' ?
|
|
util.script_to_address(results.addressInfo.address) :
|
|
util.script_to_pubkey(results.addressInfo.pubkey);
|
|
|
|
if (options.pool.difficulty > results.miningInfo.difficulty && options.pool.difficulty > 16){
|
|
var newDiff = results.miningInfo.difficulty > 16 ? results.miningInfo.difficulty : 16;
|
|
emitWarningLog('system', 'pool difficulty was set higher than network difficulty of ' + results.miningInfo.difficulty);
|
|
emitWarningLog('system', 'lowering pool diff from ' + options.pool.difficulty + ' to ' + newDiff);
|
|
|
|
options.pool.difficulty = newDiff
|
|
|
|
if (options.varDiff.enabled)
|
|
_this.varDiff.setPoolDifficulty(options.pool.difficulty);
|
|
}
|
|
|
|
GetBlockTemplate(function(error, result){
|
|
if (error){
|
|
console.error(error);
|
|
emitErrorLog('system', 'Error with getblocktemplate on initializing');
|
|
}
|
|
else{
|
|
SetupBlockPolling();
|
|
StartStratumServer();
|
|
SetupPeer();
|
|
}
|
|
});
|
|
}
|
|
});
|
|
|
|
}).on('connectionFailed', function(instance){
|
|
emitErrorLog('system','Failed to start daemon');
|
|
}).on('error', function(message){
|
|
emitErrorLog('system', message);
|
|
});
|
|
|
|
_this.daemon.init();
|
|
}
|
|
|
|
|
|
function StartStratumServer(){
|
|
_this.stratumServer = new stratum.Server({
|
|
port: options.pool.stratumPort,
|
|
authorizeFn: authorizeFn
|
|
});
|
|
_this.stratumServer.on('started', function(){
|
|
emitLog('system','Stratum server started on port ' + options.pool.stratumPort);
|
|
_this.emit('started');
|
|
}).on('client.connected', function(client){
|
|
|
|
if (options.varDiff.enabled)
|
|
_this.varDiff.manageClient(client);
|
|
|
|
client.on('difficultyChanged', function(diff){
|
|
_this.emit('difficultyUpdate', client.workerName, diff);
|
|
}).on('subscription', function(params, resultCallback){
|
|
|
|
var extraNonce = _this.jobManager.extraNonceCounter.next();
|
|
var extraNonce2Size = _this.jobManager.extraNonce2Size;
|
|
resultCallback(null,
|
|
extraNonce,
|
|
extraNonce2Size
|
|
);
|
|
|
|
this.sendDifficulty(options.pool.difficulty);
|
|
this.sendMiningJob(_this.jobManager.currentJob.getJobParams());
|
|
|
|
}).on('submit', function(params, resultCallback){
|
|
var result =_this.jobManager.processShare(
|
|
params.jobId,
|
|
client.difficulty,
|
|
client.extraNonce1,
|
|
params.extraNonce2,
|
|
params.nTime,
|
|
params.nonce,
|
|
client.socket.remoteAddress,
|
|
params.name
|
|
);
|
|
|
|
resultCallback(result.error, result.result ? true : null);
|
|
|
|
}).on('malformedMessage', function (message) {
|
|
emitWarningLog('client', client.workerName+" has sent us a malformed message: "+message);
|
|
}).on('socketError', function() {
|
|
emitWarningLog('client', client.workerName+" has somehow had a socket error");
|
|
}).on('socketDisconnect', function() {
|
|
emitLog('client', "Client '"+client.workerName+"' disconnected!");
|
|
}).on('unknownStratumMethod', function(fullMessage) {
|
|
emitLog('client', "Client '"+client.workerName+"' has sent us an unknown stratum method: "+fullMessage.method);
|
|
}).on('socketFlooded', function(){
|
|
emitWarningLog('client', 'Detected socket flooding and purged buffer');
|
|
});
|
|
});
|
|
}
|
|
|
|
function SetupBlockPolling(){
|
|
|
|
if (typeof options.pool.blockRefreshInterval !== "number" || options.pool.blockRefreshInterval <= 0){
|
|
emitLog('system', 'Block template polling has been disabled');
|
|
return;
|
|
}
|
|
|
|
var pollingInterval = options.pool.blockRefreshInterval;
|
|
|
|
setInterval(function () {
|
|
GetBlockTemplate(function(error, result){});
|
|
}, pollingInterval);
|
|
emitLog('system', 'Block polling every ' + pollingInterval + ' milliseconds');
|
|
}
|
|
|
|
function GetBlockTemplate(callback){
|
|
_this.daemon.cmd('getblocktemplate',
|
|
[{"capabilities": [ "coinbasetxn", "workid", "coinbase/append" ]}],
|
|
function(result){
|
|
if (result.error){
|
|
emitErrorLog('system', 'getblocktemplate call failed for daemon instance ' +
|
|
result.instance.index + ' with error ' + JSON.stringify(result.error));
|
|
callback(result.error);
|
|
} else {
|
|
var processedNewBlock = _this.jobManager.processTemplate(result.response, publicKeyBuffer);
|
|
|
|
if (processedNewBlock && options.varDiff.enabled)
|
|
_this.varDiff.setNetworkDifficulty(_this.jobManager.currentJob.difficulty);
|
|
|
|
callback(null, result.response);
|
|
callback = function(){};
|
|
}
|
|
}, true
|
|
);
|
|
}
|
|
|
|
function CheckBlockAccepted(blockHash, callback){
|
|
_this.daemon.cmd('getblock',
|
|
[blockHash],
|
|
function(results){
|
|
if (results.filter(function(result){return result.response &&
|
|
(result.response.hash === blockHash)}).length >= 1){
|
|
callback(true);
|
|
}
|
|
else{
|
|
callback(false);
|
|
}
|
|
}
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* This method is being called from the blockNotify so that when a new block is discovered by the daemon
|
|
* We can inform our miners about the newly found block
|
|
**/
|
|
this.processBlockNotify = function(blockHash){
|
|
if (blockHash !== _this.jobManager.currentJob.rpcData.previousblockhash){
|
|
GetBlockTemplate(function(error, result){
|
|
if (error)
|
|
emitErrorLog('system', 'Block notify error getting block template for ' + options.coin.name);
|
|
})
|
|
}
|
|
}
|
|
|
|
this.relinquishMiners = function(filterFn, resultCback) {
|
|
var origStratumClients = this.stratumServer.getStratumClients();
|
|
|
|
var stratumClients = [];
|
|
Object.keys(origStratumClients).forEach(function (subId) {
|
|
stratumClients.push({subId: subId, client: origStratumClients[subId]});
|
|
});
|
|
async.filter(
|
|
stratumClients,
|
|
filterFn,
|
|
function (clientsToRelinquish) {
|
|
clientsToRelinquish.forEach(function(cObj) {
|
|
cObj.client.removeAllListeners();
|
|
cObj.client.socket.removeAllListeners();
|
|
_this.stratumServer.removeStratumClientBySubId(cObj.subId);
|
|
});
|
|
|
|
process.nextTick(function () {
|
|
resultCback(
|
|
clientsToRelinquish.map(
|
|
function (item) {
|
|
return item.client;
|
|
}
|
|
)
|
|
);
|
|
});
|
|
}
|
|
)
|
|
};
|
|
|
|
this.attachMiners = function(miners) {
|
|
miners.forEach(function (clientObj) {
|
|
_this.stratumServer.manuallyAddStratumClient(clientObj);
|
|
});
|
|
}
|
|
|
|
};
|
|
pool.prototype.__proto__ = events.EventEmitter.prototype;
|
|
pool.daemon = daemon; |