search

BeamMW / opencl-miner

Open CL Miner for BeamHash (Equihash 150,5)
30 stars 31 forks source link

readme

Beam Equihash 150/5 OpenCL Miner

Copyright 2018 The Beam Team
Copyright 2018 Wilke Trei

Usage

One Liner Examples

Linux: ./beamMiner --server <hostName>:<portNumer> --key <apiKey> --devices <deviceList>
Windows: ./beamMiner --server <hostName>:<portNumer> --key <apiKey> --devices <deviceList>

Parameters

--server

Passes the address and port of the node the miner will mine on to the miner. The server address can be an IP or any other valid server address.- For example when the node is running on the same computer and listens on port 17000 then use --server localhost:17000

--key

Pass a valid API key from "stratum.api.keys" to the miner. Required to authenticate the miner at the node

--devices (Optional)

Selects the devices to mine on. If not specified the miner will run on all devices found on the system. For example to mine on GPUs 0,1 and 3 but not number 2 use --devices 0,1,3 To list all devices that are present in the system and get their order start the miner with --devices -2 . Then all devices will be listed, but none selected for mining. The miner closes when no devices were selected for mining or all selected miner fail in the compatibility check.

--force3G (Optional)

Force the miner to use the 3G implementation even if the GPUs have 4G or more. This can resolve compatibility problems with 4G GPUs with screen attached or uncommon memory configurations like Nvidia GTX 970.

--beamHashI (Optional)

Force the miner to use the (pre fork) BeamHash I. If this is not set the miner will a) Switch between BeamHash I and BeamHash II automatically depending on the block height sended over stratum. b) Use BeamHash II in case the stratum server did not send the information required.

How to build

Windows

  1. Install Visual Studio >= 2017 with CMake support.
  2. Download and install Boost prebuilt binaries https://sourceforge.net/projects/boost/files/boost-binaries/1.68.0/boost_1_68_0-msvc-14.1-64.exe, also add BOOST_ROOT to the Environment Variables.
  3. Download and install OpenSSL prebuilt binaries https://slproweb.com/products/Win32OpenSSL.html (Win64 OpenSSL v1.1.0h for example).
  4. Download and install CUDA Toolkit https://developer.nvidia.com/cuda-downloads
  5. Add .../boost_1_68_0/lib64-msvc-14.1 to the System Path.
  6. Open project folder in Visual Studio, select your target (Release-x64 for example, if you downloaded 64bit Boost and OpenSSL) and select CMake -> Build All.
  7. Go to CMake -> Cache -> Open Cache Folder -> beam-opencl-miner (you'll find beam-opencl-miner.exe).

Linux (Ubuntu 14.04)

  1. Install gcc7 boost ssl packages. 
    sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt update
sudo apt install g++-7 libboost-all-dev libssl-dev -y
  2. Set it up so the symbolic links gcc, g++ point to the newer version: 
    sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-7 60 \
                       --slave /usr/bin/g++ g++ /usr/bin/g++-7 
sudo update-alternatives --config gcc
gcc --version
g++ --version
  3. Install OpenCL 
    sudo apt install ocl-icd-* opencl-headers
  4. Install latest CMake 
    wget "https://cmake.org/files/v3.12/cmake-3.12.0-Linux-x86_64.sh"
sudo sh cmake-3.12.0-Linux-x86_64.sh --skip-license --prefix=/usr
  5. Go to beam-opencl-miner project folder and call cmake -DCMAKE_BUILD_TYPE=Release . && make -j4.
  6. You'll find beam-opencl-miner binary in bin folder.

Mac

  1. Install Brew Package Manager.
  2. Installed necessary packages using brew install openssl boost cmake command.
  3. Add export OPENSSL_ROOT_DIR="/usr/local/opt/openssl" to the Environment Variables.
  4. Go to beam-opencl-miner project folder and call cmake -DCMAKE_BUILD_TYPE=Release . && make -j4.
  5. You'll find beam-opencl-miner binary in bin folder.

Build status

Build Status