node-boolberry-pool

High performance Node.js (with native C addons) mining pool for Boolberry, based on node-cryptonote-pool Comes with lightweight example front-end script which uses the pool's AJAX API.

Table of Contents

• Features
• Community Support
• Pools Using This Software
• Usage
  • Requirements
  • Downloading & Installing
  • Configuration
  • Configure Easyminer
  • Starting the Pool
  • Upgrading
• Setting up Testnet
• JSON-RPC Commands from CLI
• Monitoring Your Pool
• Donations
• Credits
• License

Features

• TCP (stratum-like) protocol for server-push based jobs
  • Compared to old HTTP protocol, this has a higher hash rate, lower network/CPU server load, lower orphan block percent, and less error prone
• IP banning to prevent low-diff share attacks
• Socket flooding detection
• Payment processing (with splintered transactions to deal with max transaction size)
• Detailed logging
• Ability to configure multiple ports - each with their own difficulty
• Variable difficulty / share limiter
• Share trust algorithm to reduce share validation hashing CPU load
• Clustering for vertical scaling
• Modular components for horizontal scaling (pool server, database, stats/API, payment processing, front-end)
• Live stats API (using CORS with AJAX and HTML5 EventSource)
  • Currency network/block difficulty
  • Current block height
  • Network hashrate
  • Pool hashrate
  • Each miners' individual stats (hashrate, shares submitted, total paid, etc)
  • Blocks found (pending, confirmed, and orphaned)
• An easily extendable, responsive, light-weight front-end using API to display data
• Worker login validation (make sure miners are using proper wallet addresses for mining)

Community / Support

• CryptoNote Forum
• Boolberry Github
• IRC (freenode)
  • Support / general discussion join #boolberry: https://webchat.freenode.net/?channels=#boolberry
  • Development discussion join #boolberry-dev: https://webchat.freenode.net/?channels=#boolberry-dev

Usage

Requirements

• Coin daemon(s) (find the coin's repo and build latest version from source)
• Node.js v0.10+ (follow these installation instructions)
• Redis key-value store v2.6+ (follow these instructions)

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.

1) Downloading & Installing

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

git clone https://github.com/LucasJones/node-boolberry-pool.git pool
cd pool
npm update

2) Configuration

Copy the config_example.json file to config.json then overview each options and change any to match your preferred setup.

Explanation for each field:

{
    /* Used for storage in redis so multiple coins can share the same redis instance. */
    "coin": "boolberry",

    /* Used for front-end display */
    "symbol": "BBR",

    /* Specifies the level of log output verbosity. Anything more severe than the level specified
       will also be logged. */
    "logLevel": "debug", //or "warn", "error"

    /* By default the pool logs to console and gives pretty colors. If you direct that output to a
       log file then disable this feature to avoid nasty characters in your log file. */
    "logColors": true,

    /* Minimum units in a single coin, for Bytecoin its 100000000. */
    "coinUnits": 1000000000000,

    /* Host that simpleminer is pointed to.  */
    "poolHost": "example.com",

    /* IRC Server and room used for embedded KiwiIRC chat on front-end. */
    "irc": "irc.freenode.net/#boolberry",

    /* Contact email address. */
    "email": "support@cryppit.com",

    /* Market display widget params from https://www.cryptonator.com/widget */
    "cryptonatorWidget": "num=2&base_0=Boolberry%20(BBR)&target_0=Bitcoin%20(BTC)&base_1=Boolberry%20(BBR)&target_1=US%20Dollar%20(USD)",

    /* Download link to cryptonote-easy-miner for Windows users. */
    "easyminerDownload": "https://github.com/zone117x/cryptonote-easy-miner/releases/",

    /* Download link to simplewallet for your configured coin. */
    "simplewalletDownload": "http://bit.ly/monero-starter-pack",

    /* Used for front-end block links. For other coins it can be changed, for example with
       Bytecoin you can use "https://minergate.com/blockchain/bcn/block/". */
    "blockchainExplorer": "",

    /* Modular Pool Server */
    "poolServer": {
        "enabled": true,

        /* Set to "auto" by default which will spawn one process/fork/worker for each CPU
           core in your system. Each of these workers will run a separate instance of your pool(s),
           and the kernel will load balance miners using these forks. Optionally, the 'forks' field
           can be a number for how many forks will be spawned. */
        "clusterForks": "auto",

        /* Address where block rewards go, and miner payments come from. */
        "poolAddress": "1L1ZPC9XodC6g5BX8j8m3vcdkXPiZrVF7RcERWE879coQDWiztUbkkVZ86o43P27Udb3qxL4B41gbaGpvj3nS7DgFZauAZE"

        /* Poll RPC daemons for new blocks every this many milliseconds. */
        "blockRefreshInterval": 1000,

        /* How many seconds until we consider a miner disconnected. */
        "minerTimeout": 900,

        "ports": [
            {
                "port": 5555, //Port for mining apps to connect to
                "protocol": "http",
                "difficulty": 400000, //Initial difficulty miners are set to
                "desc": "Mid range CPUs" //Description of port
            },
            {
                "port": 7777,
                "protocol": "http",
                "difficulty": 800000,
                "desc": "High end CPUs"
            }
        ],

        /* Variable difficulty is a feature that will automatically adjust difficulty for
           individual miners based on their hashrate in order to lower networking and CPU
           overhead. */
        "varDiff": {
            "minDiff": 50000, //Minimum difficulty
            "maxDiff": 10000000, //Maximum difficulty
            "targetTime": 100, //Try to get 1 share per this many seconds
            "retargetTime": 30, //Check to see if we should retarget every this many seconds
            "variancePercent": 30, //Allow time to very this % from target without retargeting
            "maxJump": 20000 //Limit how much diff can increase/decrease in a single retargetting
        },

        /* Feature to trust share difficulties from miners which can significantly reduce CPU load. */
        "shareTrust": {
            "enabled": true,
            "min": 10, //Minimum percent probability for share hashing
            "stepDown": 3, //Increase trust probability percent this much with each valid share
            "threshold": 10, //Amount of valid shares required before trusting begins
            "penalty": 30 //Upon breaking trust require this many valid share before re-trusting
        },

        /* Only used with old http protocol and only works with the simpleminer. */
        "longPolling": {
            "enabled": false,
            "timeout": 8500
        },

        /* If under low-diff share attack we can ban their IP to reduce system/network load. */
        "banning": {
            "enabled": true,
            "time": 600, //How many seconds to ban worker for
            "invalidPercent": 25, //What percent of invalid shares triggers ban
            "checkThreshold": 30 //Perform check when this many shares have been submitted
        }
    },

    /* Module that sends payments to miners according to their submitted shares. */
    "payments": {
        "enabled": true,
        "transferFee": 5000000000,
        "interval": 30, //how often to run in seconds
        "poolFee": 2, //2% pool fee
        "depth": 60, //block depth required to send payments (CRYPTONOTE_MINED_MONEY_UNLOCK_WINDOW)
        "maxAddresses": 50 //split up payments if sending to more than this many addresses
    }

    /* AJAX/EventSource API used for front-end website. */
    "api": {
        "enabled": true,
        "hashrateWindow": 600, //how many second worth of shares used to estimate hash rate
        "updateInterval": 3, //gather stats and broadcast every this many seconds
        "port": 8117
    },

    /* Coin daemon connection details. */
    "daemon": {
        "host": "127.0.0.1",
        "port": 18081
    },

    /* Wallet daemon connection details. */
    "wallet": {
        "host": "127.0.0.1",
        "port": 8082
    },

    /* Redis connection into. */
    "redis": {
        "host": "127.0.0.1",
        "port": 6379
    }
}

3) [Optional] Configure cryptonote-easy-miner for your pool

Your miners that are Windows users can use cryptonote-easy-miner which will automatically generate their wallet address and stratup multiple threads of simpleminer. You can download it and edit the config.ini file to point to your own pool. Inside the easyminer folder, edit config.init to point to your pool details

pool_host=example.com
pool_port=5555

Rezip and upload to your server or a file host. Then change the easyminerDownload link in your config.json file to point to your zip file.

4) Start the pool

node init.js

5) Host the front-end

Edit index.html to use your pool API configuration

    <script>

        var api = 'http://poolhost:8117';

    </script>

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

Upgrading

When updating to the latest code its important to not only git pull the latest from this repo, but to also update the Node.js modules, and any config files that may have been changed.

• Inside your pool directory (where the init.js script is) do git pull to get the latest code.
• Remove the dependencies 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 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.

Setting up Testnet

No cryptonote based coins have a testnet mode (yet) but you can effectively create a testnet with the following steps:

• Open /src/p2p/net_node.inl and remove lines with ADD_HARDCODED_SEED_NODE to prevent it from connecting to mainnet (Monero example: http://git.io/0a12_Q)
• Build the coin from source
• You now need to run two instance of the daemon and connect them to each other (without a connection to another instance the daemon will not accept RPC requests)
  • Run first instance with ./coind --p2p-bind-port 28080 --allow-local-ip
  • Run second instance with ./coind --p2p-bind-port 5011 --rpc-bind-port 5010 --add-peer 0.0.0.0:28080 --allow-local-ip
• You should now have a local testnet setup. The ports can be changes as long as the second instance is pointed to the first instance, obviously

Credit to surfer43 for these instructions

JSON-RPC Commands from CLI

Documentation for JSON-RPC commands can be found here:

• Daemon https://wiki.bytecoin.org/wiki/Daemon_JSON_RPC_API
• Wallet https://wiki.bytecoin.org/wiki/Wallet_JSON_RPC_API

Curl can be used to use the JSON-RPC commands from command-line. Here is an example of calling getblockheaderbyheight for block 100:

curl -X POST http://127.0.0.1:18081/json_rpc -d '{"jsonrpc":"2.0","id":"test","method":"getblockheaderbyheight","params":{"height":100}}'

Monitoring Your Pool

• To inspect and make changes to redis I suggest using redis-commander
• To monitor server load for CPU, Network, IO, etc - I suggest using New Relic
• To keep your pool node script running in background, logging to file, and automatically restarting if it crashes - I suggest using forever

Donations

• BBR: 1KfzJfoA2pbB6J2ee2JG7wYSqwKtdoqs97pVMdB471FXArr1ce52Wm1BCWdAv9JAxZTa7wcUkq2s695Nmn59HgZ6VVnSjfp
• XMR/MRO: 41id8jHp2UiVuSKJcq9D78CQp9Ku2ecqvWL76kUCMDxzA5Q4rAbTHJSijWC33aPjMD92Dbs8XBG3yU3neWGFfmB57WNkZxb
• BTC: 1LBvA9X7KToPPKJFL8E5qdePhUoYCJiEfW

Credits

• zone117x - Co-Dev on node-cryptonote-pool, did a ton of work on the pool
• surfer43 - Did lots of testing during development to help figure out bugs and get them fixed
• 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

License

Released under the GNU General Public License v2

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