search

blackmennewstyle / miningcore

Miningcore is a high-performance Mining Pool Software for Linux and Windows.
MIT License
27 stars 49 forks source link

readme

Build status .NET [license]()

Features

Support

Commercial support directly by the maintainer is available through miningcore.pro.

For general questions visit the Discussions Area.

Contributions

Code contributions are very welcome and should be submitted as standard pull requests (PR) based on the dev branch.

Building on Debian/Ubuntu

git clone https://github.com/blackmennewstyle/miningcore
cd miningcore

Depending on your OS Version run either of these scripts:

./build-debian-11.sh

or

./build-debian-12.sh

or

./build-ubuntu-20.04.sh

or

./build-ubuntu-21.04.sh

or

./build-ubuntu-22.04.sh

Building on Windows

Download and install the .NET 6 SDK

git clone https://github.com/blackmennewstyle/miningcore
cd miningcore
build-windows.bat

Building in Visual Studio

Building using Docker Engine

In case you don't want to install any dependencies then you can build the app using the official Microsoft .NET SDK Docker image.

git clone https://github.com/blackmennewstyle/miningcore
cd miningcore

Then build using Docker:

docker run --rm -v $(pwd):/app -w /app mcr.microsoft.com/dotnet/sdk:6.0 /bin/bash -c 'apt update && apt install cmake ninja-build build-essential libssl-dev pkg-config libboost-all-dev libsodium-dev libzmq5n libzmq3-dev golang-go libgmp-dev -y --no-install-recommends && cd src/Miningcore && dotnet publish -c Release --framework net6.0 -o /app/build/'

It will use a Linux container, you will build a Linux executable that will not run on Windows or macOS. You can use a runtime argument (-r) to specify the type of assets that you want to publish (if they don't match the SDK container). The following examples assume you want assets that match your host operating system, and use runtime arguments to ensure that.

For macOS:

docker run --rm -v $(pwd):/app -w /app mcr.microsoft.com/dotnet/sdk:6.0 /bin/bash -c 'apt update && apt install cmake ninja-build build-essential libssl-dev pkg-config libboost-all-dev libsodium-dev libzmq5n libzmq3-dev golang-go libgmp-dev -y --no-install-recommends && cd src/Miningcore && dotnet publish -c Release --framework net6.0 -o /app/build/ -r osx-x64 --self-contained false'

Building and Running Miningcore from a container

note - The build scripts optimize the build for the hardware platform the container is built on ( does it have avx for example). If you run this container on a platform that does NOT have the same architecture you could have unexplained crashes. YOU SHOULD BUILD THIS CONTAINER ON THE HOST YOU ARE GOING TO RUN THIS CONTAINER ON.

Commands to build container: docker build -t <your_dockerhubid>/miningcore:v73-foo .

The docker build assumes you are going to mount your config file in a volume mount. for example:


docker run -d \
    -p 4000:4000 \
    -p 4066:4066 \
    -p 4067:4067 \
    --name mc    \
    -v `pwd`/config_prod.json:/app/config.json \
    --restart=unless-stopped \
    <your_dockerhubid>/miningcore:v73-foo

For Windows using Linux container:

docker run --rm -v $(pwd):/app -w /app mcr.microsoft.com/dotnet/sdk:6.0 /bin/bash -c 'apt update && apt install cmake ninja-build build-essential libssl-dev pkg-config libboost-all-dev libsodium-dev libzmq5n libzmq3-dev golang-go libgmp-dev -y --no-install-recommends && cd src/Miningcore && dotnet publish -c Release --framework net6.0 -o /app/build/ -r win-x64 --self-contained false'

To delete used images and containers you can run after all:

docker system prune -af

Running Miningcore

Production OS

Windows is not a supported production environment. Only Linux is. Please do not file issues related to running a pool on Windows. Windows topics should be posted under discussions.

Running and developing Miningcore on Windows is of course supported.

Database setup

Miningcore currently requires PostgreSQL 10 or higher.

Run Postgres's psql tool:

sudo -u postgres psql

In psql execute:

CREATE ROLE miningcore WITH LOGIN ENCRYPTED PASSWORD 'your-secure-password';
CREATE DATABASE miningcore OWNER miningcore;

Quit psql with \q

Import the database schema:

sudo -u postgres psql -d miningcore -f miningcore/src/Miningcore/Persistence/Postgres/Scripts/createdb.sql

Advanced 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!

sudo -u postgres psql -d miningcore -f miningcore/src/Miningcore/Persistence/Postgres/Scripts/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

Create a configuration file config.json as described here.

Start the Pool

cd build
Miningcore -c config.json

Supported Currencies

Refer to this file for a complete list.

Caveats

Monero

ZCash

Vertcoin

API

Miningcore comes with an integrated REST API. Please refer to this page for instructions: https://github.com/oliverw/miningcore/wiki/API

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.

Once again, do not run a production pool on Windows! This is not a supported configuration.

Donations

To support this project you can become a sponsor or send a donation to the following accounts: