node-stratum-pool/index.js

var net        = require('net');
var events     = require('events');
var fs         = require('fs');
var async      = require('async');
var daemon     = require('./libs/daemon.js');
var stratum    = require('./libs/stratum.js');
var jobManager = require('./libs/jobManager.js');
var util       = require('./libs/util.js');

/**
 * Main pool object. It emits the following events:
 *  - 'started'() - when the pool is effectively started.
 *  - 'share'(isValid, dataObj) - In case it's valid the dataObj variable will contain (TODO) and in case it's invalid (TODO) 
 */
var pool = module.exports = function pool(coin){

    var _this = this;
    var publicKeyBuffer;

    this.shareManager = undefined; // just for us to know that the variable should be this one.
    this.jobManager = new jobManager({
        algorithm: coin.options.algorithm,
        address: coin.options.address
    });

    
    // Worker authorizer fn. 
    var authorizeFn;
    if ( typeof (coin.authorizeFn) === 'function' ) {
        authorizeFn = coin.authorizeFn;
    } else {
        authorizeFn = function (ip, workerName, password, cback) {
            // Default implementation just returns true
            console.log("Athorize ["+ip+"] "+workerName+":"+password);
            cback(null, true, true);
        };
    }




    this.jobManager.on('newBlock', function(blockTemplate){
        if ( typeof(_this.stratumServer ) === 'undefined') {
            console.warn("Stratum server still not started! cannot broadcast block!"); 
        } else {
            _this.stratumServer.broadcastMiningJobs(blockTemplate.getJobParams());    
        }
        
    }).on('blockFound', function(blockHex, headerHex, third){
        if (coin.options.hasSubmitMethod) {
            _this.daemon.cmd('submitblock',
                [blockHex],
                function(error, result){
                    console.log(JSON.stringify(error));
                    console.log(JSON.stringify(result));
                    console.log("submitblock", JSON.stringify(error), JSON.stringify(result));
                }
            );
        } else {
            _this.daemon.cmd('getblocktemplate',
                [{'mode': 'submit', 'data': blockHex}],
                function(error, result){
                    console.log(JSON.stringify(error));
                    console.log(JSON.stringify(result));
                    console.log("submitblockgetBlockTEmplate", JSON.stringify(error), JSON.stringify(result));
                }
            );
        }
    });

    console.log('Connecting to daemon for ' + coin.options.name);
    this.daemon = new daemon.interface(coin.options.daemon);
    this.daemon.on('online', function(){
        async.parallel({
            rpcTemplate: GetBlockTemplate,
            addressInfo: function(callback){
                _this.daemon.cmd('validateaddress',
                    [coin.options.address],
                    function(error, result){
                        if (error){
                            console.log('validateaddress rpc error for ' + coin.options.name);
                            callback(error);
                        }
                        else if (!result.isvalid){
                            console.log('address is not valid for ' + coin.options.name);
                            callback(error);
                        }
                        else
                            callback(error, result);
                    }
                );
            },
            submitMethod: function(callback){
                _this.daemon.cmd('submitblock',
                    [],
                    function(error, result){
                        if (error && error.message === 'Method not found')
                            callback(null, false);
                        else
                            callback(null, true);
                    }
                );
            }
        }, function(err, results){
            if (err) return;
            console.log('Connected to daemon for ' + coin.options.name);
            coin.options.hasSubmitMethod = results.submitMethod;

            publicKeyBuffer = coin.options.reward === 'POW' ?
                util.script_to_address(results.addressInfo.address) :
                util.script_to_pubkey(results.addressInfo.pubkey);

            _this.jobManager.newTemplate(results.rpcTemplate, publicKeyBuffer);

            StartStratumServer();

        });

    }).on('startFailed', function(){
        console.log('Failed to start daemon for ' + coin.name);
    });


    function StartStratumServer(){

        console.log('Stratum server starting on port ' + coin.options.stratumPort + ' for ' + coin.options.name);
        _this.stratumServer = new stratum.Server({
            port        : coin.options.stratumPort,
            authorizeFn : authorizeFn,
        });
        _this.stratumServer.on('started', function(){
            _this.emit('started');
            console.log('Stratum server started on port ' + coin.options.stratumPort + ' for ' + coin.options.name);
        }).on('client', function(client){
            client.on('subscription', function(params, resultCallback){
                var extraNonce = _this.jobManager.extraNonceCounter.next();
                var extraNonce2Size = _this.jobManager.extraNonce2Size;
                resultCallback(null,
                    extraNonce,
                    extraNonce2Size
                );
                this.sendDifficulty(coin.options.difficulty);
                if (typeof(_this.jobManager.currentJob) === 'undefined') {
                    console.warn("[subscription] Cannot send job to client. No jobs in jobManager!");
                } else {
                    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
                );
                if (result.error){
                    resultCallback(result.error);
                    _this.emit('share', false, {
                        workerName : params.name,
                        error      : result.error
                    });
                } else {
                    resultCallback(null, true);
                    _this.emit('share', true, {
                        blockHeaderHex   : result.headerHEX,
                        workerName       : params.name,
                        jobId            : params.jobId,
                        clientDifficulty : client.difficulty,
                        extraNonce1      : client.extraNonce1,
                        extraNonce2      : params.extraNonce2,
                        nTime            : params.nTime,
                        nonce            : params.nonce  
                    });
                }
                
            });
        });
    }

    function GetBlockTemplate(callback){
        _this.daemon.cmd('getblocktemplate',
            [{"capabilities": [ "coinbasetxn", "workid", "coinbase/append" ]}],
            function(error, result){
                if (error) {
                    callback(error);
                } else {
                    callback(null, result);
                }
            }
        );
    }

    /**
     * This method needs to be called to perform a block polling to the daemon so that we can notify our miners
     * about new blocks
    **/
    this.processBlockPolling = function() {
        GetBlockTemplate(function(error, result) {
            if (error) {
                console.error("[processBlockPolling] Error getting block template for " + coin.options.name);
            }
            _this.jobManager.newTemplate(result, publicKeyBuffer);
        });
    }

    /**
     * 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){
                    console.error('[processBlockNotify] Error getting block template for ' + coin.options.name);
                    return;
                }
                _this.jobManager.newTemplate(result, publicKeyBuffer);
            })
        }
    }

};
pool.prototype.__proto__ = events.EventEmitter.prototype;