Features

• Supports clusters of pools each running individual currencies
• Ultra-low-latency, multi-threaded Stratum implementation using asynchronous I/O
• Adaptive share difficulty ("vardiff")
• PoW validation (hashing) using native code for maximum performance
• Session management for purging DDoS/flood initiated zombie workers
• Payment processing
• Banning System
• Live Stats API on Port 4000
• WebSocket streaming of notable events like Blocks found, Blocks unlocked, Payments and more
• POW (proof-of-work) & POS (proof-of-stake) support
• Detailed per-pool logging to console & filesystem
• Runs on Linux and Windows
• Gitter Channel

Supported Coins

Refer to this file for a complete list.

Ethereum

Miningcore implements the Ethereum stratum mining protocol authored by NiceHash. This protocol is implemented by all major Ethereum miners.

• Claymore Miner must be configured to communicate using this protocol by supplying the -esm 3 command line option
• Genoil's ethminer must be configured to communicate using this protocol by supplying the -SP 2 command line option

ZCash

• Pools needs to be configured with both a t-addr and z-addr (new configuration property "z-address" of the pool configuration element)
• First configured zcashd daemon needs to control both the t-addr and the z-addr (have the private key)
• To increase the share processing throughput it is advisable to increase the maximum number of concurrent equihash solvers through the new configuration property "equihashMaxThreads" of the cluster configuration element. Increasing this value by one increases the peak memory consumption of the pool cluster by 1 GB.
• Miners may use both t-addresses and z-addresses when connecting to the pool

Donations

This software comes with a built-in donation of 0.1% per block-reward to support the ongoing development of this project. You can also send donations directly to the following accounts:

• BTC: 17QnVor1B6oK1rWnVVBrdX9gFzVkZZbhDm
• LTC: LTK6CWastkmBzGxgQhTTtCUjkjDA14kxzC
• DOGE: DGDuKRhBewGP1kbUz4hszNd2p6dDzWYy9Q
• ETH: 0xcb55abBfe361B12323eb952110cE33d5F28BeeE1
• ETC: 0xF8cCE9CE143C68d3d4A7e6bf47006f21Cfcf93c0
• DASH: XqpBAV9QCaoLnz42uF5frSSfrJTrqHoxjp
• ZEC: t1YHZHz2DGVMJiggD2P4fBQ2TAPgtLSUwZ7
• BTG: GQb77ZuMCyJGZFyxpzqNfm7GB1rQreP4n6
• XMR: 475YVJbPHPedudkhrcNp1wDcLMTGYusGPF5fqE7XjnragVLPdqbCHBdZg3dF4dN9hXMjjvGbykS6a77dTAQvGrpiQqHp2eH

Runtime Requirements on Windows

• .Net Core 2.2 Runtime
• PostgreSQL Database
• Coin Daemon (per pool)

Runtime Requirements on Linux

• .Net Core 2.2 SDK
• PostgreSQL Database
• Coin Daemon (per pool)
• Miningcore needs to be built from source on Linux. Refer to the section further down below for instructions.

Running pre-built Release Binaries on Windows

• Download miningcore-win-x64.zip from the latest Release
• Extract the Archive
• Setup the database as outlined below
• Create a configuration file config.json as described here
• Run dotnet Miningcore.dll -c config.json

Basic PostgreSQL Database setup

Create the database:

$ createuser miningcore
$ createdb miningcore
$ psql (enter the password for postgres)

Inside psql execute:

alter user miningcore with encrypted password 'some-secure-password';
grant all privileges on database miningcore to miningcore;

Import the database schema:

$ wget https://raw.githubusercontent.com/coinfoundry/miningcore/master/src/Miningcore/Persistence/Postgres/Scripts/createdb.sql
$ psql -d miningcore -U miningcore -f createdb.sql

Advanced PostgreSQL Database setup

If you are planning to run a Multipool-Cluster, the simple setup might not perform well enough under high load. In this case you are strongly advised to use PostgreSQL 11 or higher. After performing the steps outlined in the basic setup above, perform these additional steps:

WARNING: The following step will delete all recorded shares. Do NOT do this on a production pool unless you backup your shares table using pg_backup first!

$ wget https://raw.githubusercontent.com/coinfoundry/miningcore/master/src/Miningcore/Persistence/Postgres/Scripts/createdb_postgresql_11_appendix.sql
$ psql -d miningcore -U miningcore -f createdb_postgresql_11_appendix.sql

After executing the command, your shares table is now a list-partitioned table which dramatically improves query performance, since almost all database operations Miningcore performs are scoped to a certain pool.

The following step needs to performed once for every new pool you add to your cluster. Be sure to replace all occurences of mypool1 in the statement below with the id of your pool from your Miningcore configuration file:

CREATE TABLE shares_mypool1 PARTITION OF shares FOR VALUES IN ('mypool1');

Once you have done this for all of your existing pools you should now restore your shares from backup.

Configuration

API

Building from Source

Building on Ubuntu 16.04

$ wget -q https://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb
$ sudo dpkg -i packages-microsoft-prod.deb
$ sudo apt-get update -y
$ sudo apt-get install apt-transport-https -y
$ sudo apt-get update -y
$ sudo apt-get -y install dotnet-sdk-2.2 git cmake build-essential libssl-dev pkg-config libboost-all-dev libsodium-dev libzmq5
$ git clone https://github.com/coinfoundry/miningcore
$ cd miningcore/src/Miningcore
$ dotnet publish -c Release --framework netcoreapp2.2  -o ../../build

Building on Windows

Download and install the .Net Core 2.2 SDK

> git clone https://github.com/coinfoundry/miningcore
> cd miningcore/src/Miningcore
> dotnet publish -c Release --framework netcoreapp2.2  -o ..\..\build

Building on Windows - Visual Studio

• Download and install the .Net Core 2.2 SDK
• Install Visual Studio 2017. Visual Studio Community Edition is fine.
• Open Miningcore.sln in VS 2017

After successful build

Create a configuration file config.json as described here

cd ../../build
dotnet Miningcore.dll -c config.json

Running a production pool

A public production pool requires a web-frontend for your users to check their hashrate, earnings etc. Miningcore does not include such frontend but there are several community projects that can be used as starting point. Feel free to discuss ideas/issues with fellow pool operators using our Gitter Channel.