/miningcore

Miningcore is the multi-currency stratum-engine powering

Primary LanguageCMIT LicenseMIT

Build status Docker Build Statu Docker Stars Docker Pulls license

Miningcore

Miningcore is the multi-currency stratum-engine powering poolmining.org.

Even though the pool engine can be used to run a production-pool, doing so currently requires to develop your own website frontend talking to the pool's API-Endpoint at http://127.0.0.1:4000. This is going to change in the future.

Features

  • Supports clusters of pools each running individual currencies
  • Ultra-low-latency Stratum implementation using asynchronous I/O (LibUv)
  • 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 for banning peers that are flooding with invalid shares
  • Live Stats API on Port 4000
  • POW (proof-of-work) & POS (proof-of-stake) support
  • Detailed per-pool logging to console & filesystem
  • Runs on Linux and Windows

Coins

Coin Implemented Tested Planned Notes
Bitcoin Yes Yes
Litecoin Yes Yes
Zcash Yes Yes
Monero Yes Yes
Ethereum Yes Yes Requires Parity
Ethereum Classic Yes Yes Requires Parity
Expanse Yes Yes Not working for Byzantinium update Requires Parity
DASH Yes Yes
Bitcoin Gold Yes Yes
Bitcoin Cash Yes Yes
Vertcoin Yes Yes
Monacoin Yes Yes
Globaltoken Yes Yes GLT Daemon
Ellaism Yes Yes Requires Parity
Groestlcoin Yes Yes
Dogecoin Yes No
DigiByte Yes No
Namecoin Yes No
Viacoin Yes No
Peercoin Yes No
Straks Yes Yes
Electroneum Yes No
MoonCoin Yes Yes

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.15% per block-reward to support the ongoing development of this project. If you do not want to support the project, you can remove or alter the donation by adding devDonation = 0.0 to the configuration file. 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: 475YVJbPHPedudkhrcNp1wDcLMTGYusGPF5fqE7XjnragVLP dqbCHBdZg3dF4dN9hXMjjvGbykS6a77dTAQvGrpiQqHp2eH

Runtime Requirements

PostgreSQL Database setup

Create the database:

createuser miningcore
createdb miningcore
psql (enter the password for postgressql)
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

Configuration

API

Docker

The official miningcore docker-image expects a valid pool configuration file as volume argument:

$ docker run -d -p 3032:3032 -v /path/to/config.json:/config.json:ro coinfoundry/miningcore-docker

You also need to expose all stratum ports specified in your configuration file.

Building from Source (Shell)

Install the .Net Core 2.0 SDK for your platform

git clone https://github.com/coinfoundry/miningcore
cd miningcore/src/MiningCore

Linux

Install dev-dependencies (Ubuntu)

apt-get update -y && apt-get -y install git cmake build-essential libssl-dev pkg-config libboost-all-dev libsodium-dev
./linux-build.sh

Windows

windows-build.bat

Now copy config.json to ../../build, edit it to your liking and run:

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

Building from Source (Visual Studio)

  • Install Visual Studio 2017 (Community Edition is sufficient)
  • Install the .Net Core 2.0 SDK for your platform
  • Open MiningCore.sln in VS 2017