Many useful updates to bring NOMP to life #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

vagabondan wants to merge 39 commits into idigger:master from vagabondan:master

Blockchain.Mining.pdf

Binary file not shown.

CONTRIBUTING.md

-Original file line number
+Diff line change
@@ -0,0 +1,20 @@
+    # Contributing
+    # Issues
+    Issues are always very welcome - after all, they are a big part of making any code better. However, there are a couple of things you can do to make the lives of the developers _much, much_ easier:
+    ### Tell us:
+    * What you are doing?
+      * What do you expect to happen?
+      * What is actually happening?
+      * Post an _enough_ log samples that indicates the issue
+    * Did you try to investigate the problem?
+      * What are the results?
+    * Which OS and OS version you are using (Windows/Linux)?
+    * Which Node.js version you are using?
+    * Which coin software you are using and its version?
+    When you post code, please use [Github flavored markdown](https://help.github.com/articles/github-flavored-markdown), in order to get proper syntax highlighting!
+    If you can even provide a pull request with a failing unit test, we will love you long time! Plus your issue will likely be fixed much faster.

Pool_probability_calculator.xlsx

Binary file not shown.

README.md

-Original file line number
+Diff line change
@@ -1,3 +1,8 @@
+    # Some basic considerations of Blockchain, mining, pool.
+    * ![Blockchain.Mining key concepts](https://github.com/vagabondan/ric-nomp/blob/master/Blockchain.Mining.pdf)
+    * ![Pool probability calculator](https://github.com/vagabondan/ric-nomp/blob/master/Pool_probability_calculator.xlsx)
     # NOMP ![NOMP Logo](http://zone117x.github.io/node-open-mining-portal/logo.svg "NOMP Logo")
     #### Node Open Mining Portal
@@ Expand All @@
     This is beta software. All of the following are things that can change and break an existing NOMP setup: functionality of any feature, structure of configuration files and structure of redis data. If you use this software in production then *DO NOT* pull new code straight into production usage because it can and often will break your setup and require you to tweak things like config files or redis data.
     #### Paid Solution
-    Usage of this software requires abilities with sysadmin, database admin, coin daemons, and sometimes a bit of programming. Running a production pool can literally be more work than a full-time job. [LiveChains UK](http://www.livechains.net/) offers full hosting, setup and management of NOMP pools with several different configurations.
+    Usage of this software requires abilities with sysadmin, database admin, coin daemons, and sometimes a bit of programming. Running a production pool can literally be more work than a full-time job.
-    **Coin switching & auto-exchanging for payouts in BTC/LTC** to miners is a feature that very likely will not be included in this project. [LiveChains UK](http://www.livechains.net/) however does offer this feature as part of there own customised NOMP called [LivePool](http://www.livechains.net/LivePool.html).
+    **Coin switching & auto-exchanging for payouts in BTC/LTC** to miners is a feature that very likely will not be included in this project.
     #### Table of Contents
@@ Expand Down Expand Up @@
     If your pool uses NOMP let us know and we will list your website here.
     ##### Some pools using NOMP or node-stratum-module:
-    * http://chunkypools.com
     * http://clevermining.com
-    * http://rapidhash.net
     * http://suchpool.pw
     * http://hashfaster.com
     * http://miningpoolhub.com
-    * http://teamdoge.com
-    * http://miningwith.us
     * http://kryptochaos.com
-    * http://uberpools.org
-    * http://onebtcplace.com
-    * http://minr.es
-    * http://mining.theminingpools.com
-    * http://www.omargpools.ca/pools.html
-    * http://pool.trademybit.com/
-    * http://fixminer.com
-    * http://poollo.com
+    * http://miningpools.tk
+    * http://umine.co.uk
     Usage
     =====
@@ Expand Down @@

coins/dash.json

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    {
+        "name": "Dash",
+        "symbol": "DASH",
+        "algorithm": "x11",
+        "mposDiffMultiplier": 256,
+        "peerMagic": "bf0c6bbd",
+        "peerMagicTestnet": "cee2caff"
+    }

coins/litecoin.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,5 +3,5 @@ @@
         "symbol": "LTC",
         "algorithm": "scrypt",
         "peerMagic": "fbc0b6db",
-        "peerMagicTestnet": "fcc1b7dc"
-    }
+        "peerMagicTestnet": "fdd2c8f1"
+    }

coins/verium.json

-Original file line number
+Diff line change
@@ -0,0 +1,11 @@
+    {
+        "name": "Verium",
+        "symbol": "VRM",
+        "algorithm": "scrypt-n",
+        "reward": "POS",
+        "peerMagic": "70352205",
+        "peerMagicTestnet": "cdf2c0ef",
+        "timeTable": {
+          "1048576": 100
+        }
+    }

config.json

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -10,12 +10,12 @@
  
        },

        "defaultPoolConfigs": {

            "blockRefreshInterval": 0,

            "blockRefreshInterval": 5000,

            "jobRebroadcastTimeout": 55,

            "connectionTimeout": 600,

            "connectionTimeout": 180,

            "emitInvalidBlockHashes": false,

            "validateWorkerUsername": true,

            "tcpProxyProtocol": false,

            "tcpProxyProtocol": true,

            "shareDiff": 5,

            "banning": {

                "enabled": true,

    @@ -56,7 +56,7 @@
  
                "enabled": false,

                "algorithm": "sha256",

                "ports": {

                    "3333": {

                    "2222": {

                        "diff": 10,

                        "varDiff": {

                            "minDiff": 16,

    @@ -72,7 +72,7 @@
  
                "enabled": false,

                "algorithm": "scrypt",

                "ports": {

                    "4444": {

                    "3333": {

                        "diff": 10,

                        "varDiff": {

                            "minDiff": 16,

    @@ -88,7 +88,7 @@
  
                "enabled": false,

                "algorithm": "x11",

                "ports": {

                    "5555": {

                    "4443": {

                        "diff": 0.001,

                        "varDiff": {

                            "minDiff": 0.001,

config_example.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
         "logLevel": "debug",
         "logColors": true,
+        "cliHost": "127.0.0.1",
         "cliPort": 17117,
         "clustering": {
@@ Expand Down @@

init.js

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -4,7 +4,6 @@ var os = require('os');
  
    var cluster = require('cluster');

    var async = require('async');

    var extend = require('extend');

    var PoolLogger = require('./libs/logUtil.js');

    var CliListener = require('./libs/cliListener.js');

    @@ -159,10 +158,11 @@ var buildPoolConfigs = function(){
  
                if (!(option in poolOptions)){

                    var toCloneOption = portalConfig.defaultPoolConfigs[option];

                    var clonedOption = {};

                    if (toCloneOption.constructor === Object)

                        extend(true, clonedOption, toCloneOption);

                    else

                    if (toCloneOption.constructor === Object) {

                        Object.assign(clonedOption, toCloneOption);

                    } else { 

                        clonedOption = toCloneOption;

                    }

                    poolOptions[option] = clonedOption;

                }

            }

    @@ -255,9 +255,15 @@ var spawnPoolWorkers = function(){
  
    var startCliListener = function(){

        // For backward compatibility

        var cliHost = '127.0.0.1';

        if (portalConfig.cliHost) {

            cliHost = portalConfig.cliHost;

        }

        var cliPort = portalConfig.cliPort;

        var listener = new CliListener(cliPort);

        var listener = new CliListener(cliHost, cliPort);

        listener.on('log', function(text){

            logger.debug('Master', 'CLI', text);

        }).on('command', function(command, params, options, reply){

libs/cliListener.js

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,7 +1,7 @@
  
    var events = require('events');

    var net = require('net');

    var listener = module.exports = function listener(port){

    var listener = module.exports = function listener(host, port){

        var _this = this;

    @@ -35,8 +35,8 @@ var listener = module.exports = function listener(port){
  
                    emitLog('CLI listener failed to parse message ' + data);

                }

            }).listen(port, '127.0.0.1', function() {

                emitLog('CLI listening on port ' + port)

            }).listen(port, host, function() {

                emitLog('CLI listening on ' + host + ':' + port)

            });

        }

libs/mongoCompatibility.js

-Original file line number
+Diff line change
@@ -0,0 +1,79 @@
+    var MongoClient = require('mongodb').MongoClient,
+    f = require('util').format;
+    module.exports = function(logger, poolConfig){
+        var mongoConfig = poolConfig.mongoMode;
+        var coin = poolConfig.coin.name;
+        var mongoConfig = {
+            host: poolConfig.mongoMode.host,
+            database: poolConfig.mongoMode.database,
+            user: encodeURIComponent(poolConfig.mongoMode.user),
+            pass: encodeURIComponent(poolConfig.mongoMode.pass),
+            authMechanism: poolConfig.mongoMode.authMechanism ? poolConfig.mongoMode.authMechanism : "DEFAULT"
+        };
+        var logIdentify = 'MongoDB';
+        var logComponent = coin;
+        var connectionURL = "";
+        if (mongoConfig.user && mongoConfig.pass) {
+            connectionURL = f('mongodb://%s:%s@%s:27017/myproject?authMechanism=%s', mongoConfig.user, mongoConfig.pass, mongoConfig.host, mongoConfig.database, mongoConfig.authMechanism);
+        } else {
+            connectionURL = f('mongodb://%s:27017/%s', mongoConfig.host, mongoConfig.database);
+        }
+        //TODO: PRIORITY: Check to see if collection exists and create it if not
+        var mongoInsert = function(collectionName, data, errCallback, successCallback) {
+            MongoClient.connect(connectionURL, function(err, db) {
+                var collection = db.collection(collectionName);
+                collection.insert(data, function(err, result){
+                    if (err) {
+                        errCallback(err);
+                        //TODO: do we stop it from moving on here?
+                    }
+                    successCallback(result);
+                    db.close(); //TODO: does this work? does it get called before the above callback can do whatever with result?
+                });
+            });
+        };
+        this.handleShare = function(isValidShare, isValidBlock, shareData){
+            var dbData = {
+                rem_host: shareData.ip,
+                worker: shareData.worker,
+                valid_share: isValidShare ? 'Y' : 'N',
+                valid_block: isValidBlock ? 'Y' : 'N',
+                difficulty: shareData.difficulty * (poolConfig.coin.mposDiffMultiplier || 1),
+                reason: typeof(shareData.error) === 'undefined' ? null : shareData.error,
+                solution: shareData.blockHash ? shareData.blockHash : (shareData.blockHashInvalid ? shareData.blockHashInvalid : '')
+            };
+            mongoInsert('shares', dbData,
+            function(err){
+                logger.error(logIdentify, logComponent, 'Insert error when adding share: ' + JSON.stringify(err));
+            },
+            function(result) {
+                logger.debug(logIdentify, logComponent, 'Share inserted');
+            });
+        };
+        this.handleDifficultyUpdate = function(workerName, diff){
+            //TODO:
+        };
+        this.handleAuth = function(workerName, password, authCallback){
+            //TODO:
+        };
+    };

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Many useful updates to bring NOMP to life #1

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Many useful updates to bring NOMP to life #1

Are you sure you want to change the base?

Uh oh!

Many useful updates to bring NOMP to life #1

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!