micronote-pool

Table of Contents

• Usage
  • Requirements
  • Downloading & Installing
  • Configuration
  • Starting the Pool
  • Host the front-end
  • Customizing your website
• Credits
• License

Usage

Requirements

• MicroNote Coin Dameon (follow these installation instructions)
• simplewallet (included with MicroNote Coin Daemon)
• Node.js v0.10+ (follow these installation instructions)
• Redis key-value store v2.6+ (follow these instructions)
• libssl required for the node-multi-hashing module
  • For Ubuntu: sudo apt-get install libssl-dev

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.

Easy install on Ubuntu

Installing pool on different Linux distributives is different because it depends on system default components and versions. For now the easiest way to install pool is to use Ubuntu 14 LTS. Thus, all you had to do in order to prepare Ubunty 14 for pool installation is to run:

sudo apt-get install git build-essential redis-server libboost1.55-all-dev nodejs-dev nodejs-legacy npm cmake libssl-dev

1) Downloading & Installing

Clone the repository, install node 0.10.25 version and run npm update for all the dependencies to be installed:

git clone https://github.com/micronotecoin/micronote-pool.git pool
cd pool
curl https://raw.githubusercontent.com/creationix/nvm/v0.16.1/install.sh | sh
source ~/.profile
nvm install 0.10.25
nvm use 0.10.25
npm update

2) Configuration

Pool is preconfigured for XUNC mining. You only need to launch your wallet listening on port 8802:

./simplewallet --rpc-bind-port 8802 --wallet-file YOUR_WALLET_FILE.wallet --password WALLET_PASSWORD

and change the commented line at config.json:

    "poolServer": {
        "enabled": true,
        "clusterForks": "auto",
        "poolAddress": "", //YOUR_XUNC_ADDRESS here
        "blockRefreshInterval": 1000,
        "minerTimeout": 900,
        "ports": [

3) Start the pool

node init.js

The file config.json is used by default but a file can be specified using the -config=file command argument, for example:

node init.js -config=config_backup.json

This software contains four distinct modules:

• pool - Which opens ports for miners to connect and processes shares
• api - Used by the website to display network, pool and miners' data
• unlocker - Processes block candidates and increases miners' balances when blocks are unlocked
• payments - Sends out payments to miners according to their balances stored in redis

By default, running the init.js script will start up all four modules. You can optionally have the script start only start a specific module by using the -module=name command argument, for example:

node init.js -module=api

Example screenshot of running the pool in single module mode with tmux.

4) Host the front-end

Simply host the contents of the website_example directory on file server capable of serving simple static files.

Edit the variables in the website_example/config.js file to use your pool's specific configuration. Variable explanations:

/* Must point to the API setup in your config.json file. */
var api = "http://yourhost.com:8117";

/* Pool server host to instruct your miners to point to.  */
var poolHost = "yourhost.com";

/* Contact email address. */
var email = "support@domain.com";

/* Used for front-end block links. */
var blockchainExplorer = "http://blocks.unotecoin.com/block/{id}";

/* Used by front-end transaction links. */
var transactionExplorer = "http://blocks.unotecoin.com/transaction/{id}";

5) Customize your website

The following files are included so that you can customize your pool website without having to make significant changes to index.html or other front-end files thus reducing the difficulty of merging updates with your own changes:

• custom.css for creating your own pool style
• custom.js for changing the functionality of your pool website

Then simply serve the files via nginx, Apache, Google Drive, or anything that can host static content.

Credits

• LucasJones - Co-dev on this project; did tons of debugging for binary structures and fixing them. Pool couldn't have been made without him.
• surfer43 - Did lots of testing during development to help figure out bugs and get them fixed
• wallet42 - Funded development of payment denominating and min threshold feature
• Wolf0 - Helped try to deobfuscate some of the daemon code for getting a bug fixed
• Tacotime - helping with figuring out certain problems and lead the bounty for this project's creation
• fancoder - See his repo for the changes

License

Released under the GNU General Public License v3

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