BitcoinZ - ZHash Node Open Mining Portal
This is a ZHash mining pool based off of Z-NOMP
Production Usage Notice
This is beta software. All of the following are things that can change and break an existing ZH-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. Only tagged releases are considered stable.
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
- Support / general discussion join: https://gitter.im/zclassicorg/z-nomp
- Coin daemon. You will need BitcoinZ daemon 1.2.0 or later, and operate ZH-Nomp after block 160,000 is reached (find the coin's repo and build latest version from source)BitcoinZ
- Node.js v7+ (follow these installation instructions)
- Redis key-value store v2.6+ (follow these instructions)
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
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=BitcoinZRPCuser rpcpassword=securepassword
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 libboost-dev libboost-system-dev sudo npm install n -g sudo n stable git clone https://github.com/NickRHill/zh-nomp.git cd zh-nomp npm update npm install
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.
Please Note that: 1 Difficulty is actually 8192, 0.125 Difficulty is actually 1024. Whenever a miner submits a share, the pool counts the difficulty and keeps adding them as the shares. ie: Miner 1 mines at 0.1 difficulty and finds 10 shares, the pool sees it as 1 share. Miner 2 mines at 0.5 difficulty and finds 5 shares, the pool sees it as 2.5 shares.
[Optional, recommended] Setting up blocknotify
config.jsonset the port and password for
- In your daemon conf file set the
blocknotifycommand to use:
node [path to cli.js] [coin name in config] [block hash symbol]
bitcoinz.conf add the line
blocknotify=node /home/user/z-nomp/scripts/cli.js blocknotify bitcoinz %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
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.
When updating ZH-NOMP to the latest code its important to not only
git pull the latest from this repo, but to also update
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 pullto get the latest Z-NOMP code.
- Remove the dependenices by deleting the
rm -r node_modules.
npm updateto force updating/reinstalling of the dependencies.
- Compare your
pool_configs/coin.jsonconfigurations 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.
- Matthew Little / zone117x - developer of NOMP
- Jerry Brady / mintyfresh68 - got coin-switching fully working and developed proxy-per-algo feature
- Tony Dobbs - designs for front-end and created the NOMP logo
- LucasJones - got p2p block notify working and implemented additional hashing algos
- vekexasia - co-developer & great tester
- TheSeven - answering an absurd amount of my questions and being a very helpful gentleman
- UdjinM6 - helped implement fee withdrawal in payment processing
- Alex Petrov / sysmanalex - contributed the pure C block notify script
- svirusxxx - sponsored development of MPOS mode
- icecube45 - helping out with the repo wiki
- Fcases - ordered me a pizza <3
- Those that contributed to node-stratum-pool
Released under the MIT License. See LICENSE file.