Core Miner

Core CPU miner with stratum protocol support

CoreMiner is a RandomY CPU mining worker - with CoreMiner you can mine every coin which relies on a RandomY Proof of Work.

Table of Contents

• Install
  • Manual Installation
  • Automatic Installation
• Usage
• Limitations
• Post-installation steps
• Config file
• Build
• Pools

Install

Manual Installation

Standalone executables for Linux, macOS and Windows are provided in the Releases section. Download an archive for your operating system and unpack the content to a place accessible from command line. The CoreMiner is ready to go.

Automatic Installation

Pre-requirements

The curl tool is required for the automatic installation as it is used to fetch the installation script.

If you don't have curl installed on your Linux system, you can install it with the following command:

sudo apt-get install curl

Execution

To start the automatic installation, execute the following command in your Linux terminal:

bash <(curl -s https://raw.githubusercontent.com/catchthatrabbit/coreminer/master/mine.sh)

After the installation completes, we recommend proceeding with the post-installation steps to ensure continuous high availability.

Usage

The CoreMiner is a command line program. This means you launch it either from a Windows command prompt or Linux console, or create shortcuts to predefined command lines using a Linux Bash script or Windows batch/cmd file. For a full list of available command, please run:

coreminer --help

We are providing additional scripts to start mining easily:

• mine.sh update of miner, mining inputs, additional checks of parameters & mine
• pool.sh additional checks of parameters & mine with docker

How to start mining

1. Download latest release of CoreMiner.
2. You have several options how to run it: standalone, docker container

Standalone

1. Navigate to the directory, where is CoreMiner with cd … command.
2. Make the script mine.sh executable with the command: chmod +x mine.sh.
3. Start the mine script in the terminal with bash mine.sh.
4. Follow the steps in the terminal.

Limitations

The Coreminer is released for Linux distributions and require GLIBC_2.33.

Post-installation steps

Follow the post-installation steps from documentation.

Config file

After running the mine.sh in the same folder produced setting file pool.cfg.

This file is loaded from two possible sources:

1. Same directory as mine.sh file with name pool.cfg.
2. Connected flash drive named coredrive and pool.cfg is located in the root folder.

Example of the contents of pool.cfg file:

wallet=cb…
worker=Rabbit
server[1]=eu.catchthatrabbit.com
port[1]=8008
server[2]=as.catchthatrabbit.com
port[2]=8008
server[3]=eu1.catchthatrabbit.com
port[3]=8008
server[4]=as1.catchthatrabbit.com
port[4]=8008

Build

Building from source

See docs/BUILD.md for build/compilation details.

API documentation

You can read more about API in the documentation.

Pools

CTR instructions to start mining process.

Read more about Stratum server in the documentation.

License

Licensed under the GNU General Public License, Version 3.

Cryptoni confidimus