Cryptonote-pool

Cryptonote-pool is a linux-based cryptonote currency mining pool, currently configured for Monero (XMR), but Aeon or other cryptonote currencies would also be compatible with some tweaking. The API and frontend are NodeJS, with Redis as the database.

Usage

You will need a fresh Ubuntu Server 16 x64 install, preferably with a domain pointed at it. There is an automatic installer script in the works, but it is better used as a step-by-step for setup, as it is currently only able to take you 90% of the way, and isn't finished.

Ideal Hardware Specs

Technically you could run this pool on very little hardware, or a budget VPS, but if you're expecting to be able to handle enough users to make it profitable, you'll need something resembling the following:

• CPU: 4 cores
• RAM: 8GB
• HD: 60GB SSD
• Net: 200mMbit/s
• OS: Ubuntu 16.x

MinerTopia.org pool is currently deployed on a dedicated serverd, with roughly 4x the specs above.

Thanks

This project was originally forked from the work of zone117x, fancoder, gingeropolous, snipa22, mesh0000, thehihoguy and clintar. Without them, this project would not have happened. If you end up making it big with this software, consider throwing a few points their way.

Install

You can use the install script to set up the api, database and frontend automatically, or you can open the script and run through the code step by step. In general, copy-pasting commands from some stranger on the internet is ill-advised, but you can trust me :). Best practice would be to curl the script to a text file, and type the commands in one by one after you have verified their safety

curl -sL https://raw.githubusercontent.com/Teracycle/teracycle-pool/master/setup/install.sh | bash

Configuration

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.

Here is a brief description of most fields:

{
    "coin": "monero", // name of the currency, affects the header branding.
    "symbol": "XMR", // abbreviated currency name, trade symbol

    "logging": {
        "files": {
            "level": "info", // verbosity
            "directory": "logs", // save location
            "flushInterval": 5 // flushing logs lol
        },
        "console": {
            "level": "info", // amount of verbosity in the terminal
            "colors": true // colorized output
        }
    },

    "poolServer": {
        "enabled": true, // api on or off
        "clusterForks": "auto",
        "poolAddress": // pool's wallet address "44M3UPnJmcz2Zx6YLKeeTjV44LgPguD7pfmuwaw92T5f7cgfHfBMBRMethrxjUbn4kdsBMNXPWHhd7bXZUmL2DtN99AB8KX",
        "blockRefreshInterval": 1000,
        "minerTimeout": 900,
        "ports": [ // these are the ports you'll offer your miners
            {
                "port": 3333, // miners specify this port
                "difficulty": 100, // starting difficulty
                "desc": "Low end hardware" // description
            },
            {
                "port": 5555, // miners specify this port
                "difficulty": 2000, // starting difficulty
                "desc": "Mid range hardware" // description
            },
            {
                "port": 7777, // miners specify this port
                "difficulty": 10000, // starting difficulty
                "desc": "High end hardware" // description
            },
            {
                "port": 8888, // not sure why you'd want a hidden port, but here it is.
                "difficulty": 10000, // starting difficulty
                "desc": "Hidden port", // description
                "hidden": true
            }
        ],
        "varDiff": {
            "minDiff": 2,
            "maxDiff": 100000,
            "targetTime": 100,
            "retargetTime": 30,
            "variancePercent": 30,
            "maxJump": 100
        },
        "shareTrust": {
            "enabled": true,
            "min": 10,
            "stepDown": 3,
            "threshold": 10,
            "penalty": 30
        },
        "banning": {
            "enabled": true,
            "time": 600,
            "invalidPercent": 25,
            "checkThreshold": 30
        },
        "slushMining": { // I'm not sure if this works
            "enabled": false,
            "weight": 300,
            "blockTime": 60,
            "lastBlockCheckRate": 1
        }
    },

    "payments": {
        "enabled": true, // payday timer on or off
        "interval": 600, /*
         This is how many seconds long the payment cycle for the miners who earned a payout is.
         600 = 10 minutes
         3600 = 1 hour
         86400 = 1 day
         604800 = 1 week
         */
        "maxAddresses": 50, // how many miners to pay at a time
        "mixin": 3, // 3 is the minimum
        "transferFee": 5000000000, // mind the decimals. .005 I think?
        "minPayment": 1000000000000, // 1XMR minimum for payout to reduce fees
        "denomination": 100000000000
    },

    "blockUnlocker": { // this guy signs the paychecks
        "enabled": true,
        "interval": 30,
        "depth": 60,
        "poolFee": 1,
        "devDonation": 0,
        "coreDevDonation": 0
    },

    "api": { // this handles your stats
        "enabled": true,
        "hashrateWindow": 600,
        "updateInterval": 5,
        "port": 8117,
        "blocks": 30,
        "payments": 30,
        "password": "PasswordNotNeeded" // admin page was removed. this is not needed currently
    },

    "daemon": { // port for monero-daemon
        "host": "127.0.0.1", // I suppose this -could- be a remote node, but why, other than laziness?
        "port": 18081 // Make sure this matches your config
    },

    "wallet": { // port for monero-wallet-rpc
        "host": "127.0.0.1",
        "port": 8082 // Make sure this matches your config
    },

    "redis": { // port for database
        "host": "127.0.0.1",
        "port": 6379, // Make sure this matches your config
        "auth": null
    }
}

Edit the variables in the frontend/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://teracycle.net:8117";

/* Minimum units in a single coin, for Bytecoin its 100000000. */
var coinUnits = 1000000000000;

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

/* IRC Server and room used for embedded KiwiIRC chat. */
var irc = "irc.freenode.net/#monero";

/* Contact email address. */
var email = "[email protected]";

/* Market stat display params from https://www.cryptonator.com/widget */
var cryptonatorWidget = ["XMR-BTC", "XMR-USD", "XMR-EUR", "XMR-GBP"];

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

/* 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/". */
var blockchainExplorer = "http://monerochain.info/block/";

/* Used by front-end transaction links. Change for other coins. */
var transactionExplorer = "http://monerochain.info/tx/";

Launching For The First Time

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

forever init.js -config=config_backup.json

Forever is a tool that is used with NodeJS apps to ensure that they stay up and running. Alternatives to Forever would be:

• PM2
• Nodemon
• Phusion Passenger
• Supervisor

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:

forever init.js -module=pool
forever init.js -module=api
forever init.js -module=unlocker
forever init.js -module=payments

TIP: An easy way to keep track of all of these, rather than the overhead of running a GUI on your server, is to run TMUX. TMUX will let you split your terminal screen however many ways you want to, or arrange them into virtual-workspaces. You can also detach from your SSH session and reconnect to it later with everything still running how you left it. Here's an example: Log in to your server via SSH. Ubuntu 16 already has TMUX installed so just type tmux and hit ENTER. The only thing that changes is a green bar shows up at the bottom of the screen, which means TMUX is running successfuly. Here are a few shortcuts to help you navigate within TMUX.

TMUX CHEATSHEET

• To view running TMUX sessions, type tmux ls
• To connect to a running session, type tmux attach -t 0 If 0 is the session name.
• Press CTRL+B and then " to split the screen horizontally.
• To split the screen vertically, press CTRL+B and then %.
• To move from window to window, press CTRL+B and then press UP/DOWN/LEFT/RIGHT
• To resize a window, press CTRL+B and then CTRL+UP/DOWN/LEFT/RIGHT
• To create a new workspace, press CTRL+B and then c
• To switch to the previous workspace, press CTRL+B and then p
• To switch to the next workspace, press CTRL+B and then n
• To kill a window in a workspace, press CTRL+B and then x
• To detach from your TMUX session, press CTRL+B and then d

Don't forget your wallet

**TIP:**You need a wallet running to handle the payments that the API will try to make when you mine a block and need to pay miners. There's a script included called launchewallet.sh which contains a BASH one-liner that launched the wallet the proper way. A big part of my frustration trying this project for the first time was my wallet would be running but it would be refusing RPC commands from the API. This meant I had to do weekly manual payouts and answer countless messages about if the money is still there or not.

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.

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 127.0.0.1:18081/json_rpc -d '{"method":"getblockheaderbyheight","params":{"height":100}}'

Feature Roadmap

This progress is tracked via Trello publicly at: https://trello.com/b/PsqX8itf/teracycle-pool

Community / Support

• Monero Github
• Monero Announcement Thread
• IRC (freenode)
  • Support / general discussion join #monero: https://webchat.freenode.net/?channels=#monero
  • Development discussion join #monero-dev: https://webchat.freenode.net/?channels=#monero-dev

Donations

• BTC: 19NFjoifjMys1cMmzWVSfZUMQpJm7zURmG
• XMR: 44bBEdVybk9aSYu9JfVDwjXb1zTrKJy1mCfW8EbiHb916Q9uHdv5UvfBccnLLEWCZfMZrP3VT4uCQFVvxcgoBygq6E5DWBA

License

Released under the GNU General Public License v2

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