Installing the Miner

This tool is the core of the entire XEL network. Opposed to what the name suggests, it is way more than just a miner. It is a fully fledged ePL to C conversion and compilation tool and helps you to convert your ePL program to C, compile it into executable machine code and natively execute your ePL programs on your local machine. On top of that, it allows you to pull work from other scientists on the XEL network and search for solutions to their algorithms. Once a solution is found, xel_miner is capable of submitting it to the network in exchange for cryptocurrency rewards. It is not required to develop and submit jobs to the XEL network, however, it is a very hand tool for debugging purposes.

Windows

Download the latest (experimental CPU only) binary version from the following Github releases page:

https://github.com/xel-software/xel-miner-releases/files/1933994/xel_miner-0.9.6.zip

After you unzip the archive, go into the folder xel_miner-0.9.6/xel_miner. There, you will find the xel_miner.exe executable. You can test if it’s functioning properly by running:

xel_miner.exe --test-vm examples\SHA256_BTC.epl

If you encounter any errors, the reason may be that you already have a MinGW installation on your system and in your PATH. This may interfere with the packages stipped down MinGW environment. In this case, try to clean the PATH variable by doing a simple:

set PATH=

The build-process on Windows is somewhat "messy", so we do not provide instructions on building that software from sources at this point. We are happy to publish a guide if the community comes up with a reliable and reproducible way.

You can now switch to the programming section (accessible from the top menu) to start learning how to develop algorithms for the XEL blockchain, or getting more information on how to use the mining software properly.

MacOS

Make sure you have homebrew installed (if you do, skip this step):

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Now, you can use Homebrew to install all required build dependencies:

brew install gmp make cmake openssl

At this point it might be wise to check whether you have your GPU SDK (Cuda, OpenCL) along with the proper drivers installed in order to compile xel_miner with GPU support. If you don't want to worry about this at the moment, just go with the CPU version for now.

In the next step, make sure you check out the latest source code version from Github:

git clone https://github.com/xel-software/xel-miner.git xel_miner

For some reason, the libssl directory is not being linked to the proper location. You can fix this by simply running:

ln -s /usr/local/opt/openssl/include/openssl/ /usr/local/include/openssl

Now, you can go ahead and build the miner:

cd xel_miner
OPENSSL_ROOT_DIR=/usr/local/opt/openssl cmake .
make

You can test if it’s functioning properly by running:

xel_miner --test-vm examples/SHA256_BTC.epl

You can now switch to the programming section (accessible from the top menu) to start learning how to develop algorithms for the XEL blockchain, or getting more information on how to use the mining software properly.

Linux

As it is nearly impossible to cover all currently available linux distributions, we will cover the installation for Ubuntu based systems. While the individual dependencies might have a slightly different name, the entire process should be easily adaptable to any distribution out there.

In a first step, make sure you have all dependencies installed:

sudo apt-get install git libgmp-dev libcurl4-openssl-dev libssl-dev build-essential cmake

At this point it might be wise to check whether you have your GPU SDK (Cuda, OpenCL) along with the proper drivers installed in order to compile xel_miner with GPU support. If you don't want to worry about this at the moment, just go with the CPU version for now.

Now, please make sure you check out the latest source code version from Github:

git clone https://github.com/xel-software/xel-miner.git xel_miner

Now use cmake and make to gernerate the Makefile and compile the software:

cd xel_miner
cmake .
make

You can now switch to the programming section (accessible from the top menu) to start learning how to develop algorithms for the XEL blockchain, or getting more information on how to use the mining software properly.