BTCPrivate
/
z-nomp
mirror of https://github.com/BTCPrivate/z-nomp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
548 Commits 5 Branches 6 Tags 1.1 MiB
JavaScript 63.3%
HTML 35.9%
C 0.5%
CSS 0.3%
Go to file
Joshua Yabut 8a5e1faee8 Create CHANGELOG.md 2016-11-27 22:32:58 -05:00
coins Add Zclassic.json coin data 2016-11-17 05:01:49 +00:00
libs Fix error catching for listUnspent and listUnspentZ 2016-11-27 22:20:15 -05:00
pool_configs Updated default difficulty to 0.125. 2016-11-27 20:32:32 -05:00
scripts NOMP CLI gives replies now. Profit switching transitioned to using CLI port rather than old profitListener port. 2014-04-28 15:04:12 -06:00
website Fix switching port showing 2014-06-08 15:01:27 +04:00
.gitignore Initial Z-NOMP commit 2016-11-16 22:46:07 +00:00
CHANGELOG.md Create CHANGELOG.md 2016-11-27 22:32:58 -05:00
LICENSE Added license 2014-03-01 12:51:48 -07:00
README.md Update README.md 2016-11-27 22:24:55 -05:00
config_example.json Initial Z-NOMP commit 2016-11-16 22:46:07 +00:00
init.js Force content type on doT generated html strings 2014-05-21 19:58:41 -06:00
package.json Make LD_LIBRARY_PATH compatible with Node 7 2016-11-27 17:50:32 +00:00

README.md

Z-NOMP (READY FOR TESTING)

Zclassic - Node Open Mining Portal

This is a Zclassic mining pool based off of Node Open Mining Portal.

Production Usage Notice

This is beta software. All of the following are things that can change and break an existing Z-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.

Community / Support

IRC

If your pool uses Z-NOMP let us know and we will list your website here.

Some pools using Z-NOMP or node-stratum-module:
  • //to be added

Usage

Requirements

Seriously

Those are legitimate requirements. If you use old versions of Node.js or Redis that may come with your system package manager then you will have problems. Follow the linked instructions to get the last stable versions.

Redis security warning: be sure firewall access to redis - an easy way is to include bind 127.0.0.1 in your redis.conf file. Also it's a good idea to learn about and understand software that you are using - a good place to start with redis is data persistence.

0) Setting up coin daemon

Follow the build/install instructions for your coin daemon. Your coin.conf file should end up looking something like this:

daemon=1
rpcuser=zclassicrpc
rpcpassword=securepassword
rpcport=19332

For redundancy, its recommended to have at least two daemon instances running in case one drops out-of-sync or offline, all instances will be polled for block/transaction updates and be used for submitting blocks. Creating a backup daemon involves spawning a daemon using the -datadir=/backup command-line argument which creates a new daemon instance with it's own config directory and coin.conf file. Learn about the daemon, how to use it and how it works if you want to be a good pool operator. For starters be sure to read:

1) Downloading & Installing

Clone the repository and run npm update for all the dependencies to be installed:

sudo apt-get install build-essential libsodium-dev npm
sudo npm install n -g
sudo n stable
git clone https://github.com/joshuayabut/node-open-mining-portal.git z-nomp
cd z-nomp
npm update
npm install
Pool config

Take a look at the example json file inside the pool_configs directory. Rename it to zclassic.json and change the example fields to fit your setup.

[Optional, recommended] Setting up blocknotify
  1. In config.json set the port and password for blockNotifyListener
  2. In your daemon conf file set the blocknotify command to use:
node [path to cli.js] [coin name in config] [block hash symbol]

Example: inside zclassic.conf add the line

blocknotify=node /home/z-nomp/scripts/cli.js blocknotify zclassic %s

Alternatively, you can use a more efficient block notify script written in pure C. Build and usage instructions are commented in scripts/blocknotify.c.

3) Start the portal

npm start
Optional enhancements for your awesome new mining pool server setup:
  • Use something like forever to keep the node script running in case the master process crashes.
  • Use something like redis-commander to have a nice GUI for exploring your redis database.
  • Use something like logrotator to rotate log output from Z-NOMP.
  • Use New Relic to monitor your Z-NOMP instance and server performance.

Upgrading Z-NOMP

When updating Z-NOMP to the latest code its important to not only git pull the latest from this repo, but to also update the node-stratum-pool and node-multi-hashing modules, and any config files that may have been changed.

  • Inside your Z-NOMP directory (where the init.js script is) do git pull to get the latest Z-NOMP code.
  • Remove the dependenices by deleting the node_modules directory with rm -r node_modules.
  • Run npm update to force updating/reinstalling of the dependencies.
  • Compare your config.json and pool_configs/coin.json configurations to the latest example ones in this repo or the ones in the setup instructions where each config field is explained. You may need to modify or add any new changes.

Credits

License

Released under the MIT License. See LICENSE file.