node-stratum
============

    Under development

High performance Stratum poolserver in Node.js. One instance of this software can startup and manage multiple coin pools, each with their own daemon and stratum port :)

#### Why
This server was built to be more efficient and easier to setup, maintain and scale than existing stratum poolservers which are written in python. Compared to the spaghetti state of the latest stratum-mining python server, this software should also have a lower barrier to entry for other developers to fork and add feature or fix bugs.


Features (mostly untested)
--------------------------
* Daemon interface
* Stratum TCP socket server
* Block template / job manager
* Optimized generation transaction building
* Process share submissions
* Supports algos: scrypt, scrypt-jane, quark

#### To do
* Proof-of-stake support
* Payment processing module
* Vardiff
* Statistics module
* Integrate with PostgreSQL database
* Web frontend


Requirements
------------
* node v0.10+
* coin daemon
* PostgreSQL
* npm dependencies
  * [scrypt256-hash](https://github.com/zone117x/node-scrypt256-hash)
  * [scrypt-jane-hash](https://github.com/zone117x/node-scrypt-jane-hash)
  * [quark-hash](https://github.com/zone117x/node-quark-hash)
  * [binpack](https://github.com/russellmcc/node-binpack)
  * [bignum](https://github.com/justmoon/node-bignum)
  * [buffertools] (https://github.com/bnoordhuis/node-buffertools)
  * [base58-native](https://github.com/gasteve/node-base58)
  * [async](https://github.com/caolan/async)


Installation
------------
* For each coin you would like to start a pool server for, create a file in the "coins" directory titled "(name of coin).json"
  Example configuration for dogecoin.json
  ```javascript
  {
    "name": "Dogecoin",
    "symbol": "doge",
    "algorithm": "scrypt",
    "reward": "POW",
    "address": "DDt79i6P3Wro3SD3HSnkRLpMgUGUGdiNhS",
    "stratumPort": 3333,
    "difficulty": 8,
    "daemon": {
      "bin": "dogecoind",
      "port": 8332,
      "user": "test",
      "password": "test",
      "blocknotify": "blockNotify.js doge %s",
      "startIfOffline": true
    }
  }
  ```
* To start the poolserver run init.js
  `node init.js`


Credits
-------
* [Slush0](https://github.com/slush0/stratum-mining) - stratum protocol, documentation and original python code
* [viperaus](https://github.com/viperaus/stratum-mining) - scrypt adaptions to python code
* [ahmedbodi](https://github.com/ahmedbodi/stratum-mining) - more algo adaptions to python code
* [TheSeven](https://github.com/TheSeven) - being super knowledgeable & helpful
* [vekexasia](https://github.com/vekexasia) - lots of help with research and development

Donations
---------
BTC: 1KRotMnQpxu3sePQnsVLRy3EraRFYfJQFR

License
-------
Released under the GNU General Public License v2

http://www.gnu.org/licenses/gpl-2.0.html