lukMiner - luk's Cryptonight(-family) Miner

This README's main purpose is to instruct on how to use and run the miner; for more information relating to the miner - supported platforms, supported coins, developer shares for the various configuration, performance for various hardware platforms, plans for the future, temperature on the back side of the moon, or anything else, please refer to either one of the three links below:

• http://www.lukminer.com : The "official" Wordpress blog I use for distributing lukMiner-related news and updates
• http://www.lukminer.net/releases : Latest releases for the miner
• http://sites.google.com/site/lukxmrminer : The "original" google site with some more general information on the miner.

Using LukMiner

Basic Usage is ./<binaryName> <args> , with binary name and arguments as follows:

Pick your binary

Depending on your architecture, pick:

• luk-cpu : for cpu-only mining

• luk-phi : for mining on 'bootable' x200 Xeon Phi nodes

• luk-knc-native : for running natively x100 Phi cards (7120, 31s1p, etc)

• luk-mpss-knc : for MPSS offload to x100 Phi Cards (7120, 31s1p, etc)

• luk-mpss-knl : For MPSS offload to x200 Phi Cards (7220 or 7240)

• luk-ocl : For mining on OpenCL-capable GPUs.

Command line arguments

The miner understands the following arguments:

• --algo <alg> | -a <alg> : mining algorithm to use (see below)

• --host <hostname> : hostname for the pool to use

• --port <port>: port of the pool to use

• --user <username>: username to use on the specified pool

• --pass <password>: passwrod to use on the specified pool (usually 'x')

• --nicehash|-nh: enable nicehash-mode

Mining Algorithm to Use

The miner currnetly understands the following algorithms (via "--algo "):

• xmr-v7, xmr : monero v7 algorithm, as will be used by monero after the march 2018 hard-fork

• xn, xnclassic : classic 'cryptonight' algorithm, as used in ETN, SUMO, and (pre-fork) Monero

• xnlight, aeon : 'cryptonight light' algorithm; as used in Aeon coin.

• xndark : 'cryptonight dark', as used in Bitnote coin (XBN)

• xnheavy, sumo : 'cryptonight heavy', as used in Sumo v1 (past Apr 5, 2018)

Examples

Example 1: Running the CPU miner for mining Monero on dwarfpool (after the Apr 6, 2018 'v7' fork)

./luk-cpu -a xmr --host xmr-usa.dwarfpool.com --port 8080 --user 45Pw3bWFJXQiR1hN97huM6BbNPpnYdPytWnTUbkEm6KS9MExU7Gtr3nBsVoZA746qhCEwqVsFuPdwfXVtZwXxHQ6LDyfBaL --pass x

Example 2: Running the x200 Xeon Phi miner for mining classical cryptonight on nicehash:

./luk-phi -a xnclassic -nh --host cryptonight.usa.nicehash.com --port 3355 --user 37YhhV3j4qnCmkdrQvYWqgMMkgxqtQTrP4 --pass x

Example 3: Running the x200 Xeon Phi miner for mining sumocoin on sumopool:

./luk-phi -a sumo --host pool.sumokoin.com --port 4444 --user Sumoo6SgKXMD8NcBFzqB1QBzmRPiLeJxFPUmcy7tfM88br8y76G6EGTi8ireo3dy1VcSiK5sVKB4wbpcHtCu32RLBGMbZ1Nbfx3 --pass x

Example 4: Running old, x100 Xeon Phi PCI cards using MPSS offload; mining aeon on aeon-pool

./luk-knc-mpss -a aeon --host mine.aeon-pool.com --port 8080 --user Wmt5hTKURa1bzAaUroB9JQByeiK7nPooLf4KcMXBCjMfdbeoTHVWzXePHMiyGFTNVhgtzXrxn9vZTfCqKFD57oea2UV2de3Qy --pass x

Example 5: Running OpenCL GPU miner on bitnote:

 ./luk-ocl -a xndark --host bitnotepool.ga --host bitnotepool.ga --port 3334 --user B3bEdUAZLAJJrgEdd9fe6gW9rFcAs8GRD9qwQnN5e8JoKD8g2Q2iLsFChZph4MwzCXP4K4mXZkAoAf7cVdM4vCz2Ba7MHwL --pass x

Example 5: Running cpu miner for turtle (TRTL) coin:

 ./luk-cpu -a trtl --host trtl.pool.mine2gether.com --port 6665 --user TRTLv1uvD2YdjbXjCtfkgLZLMbWVvJFD39hSJC3PPHHdJadVuni1myWVFx6KzZ8YRmAAQh6Uq8amyVzm533KzHBA8quAddENG1D --pass x

Additional Information on Different Binaries

LukMiner comes with multiple different pre-compiled binaries; typially because either a given platofrm requires a binary that isn't compatible with other platforms (say, -knc-native for knights corner devices won't run on a regular CPU; or x200 Phi binaries won't run on x100 Phi cards, etc); or because a binary requires additional dependencies that not everybody might have (e.g., the -ocl binary requires you to have a working install of opencl, which many machines do not have).

As such, you first have to choose the right binary from the following list:

Binaries you run directly on the CPU

• luk-cpu : For regular CPUs: Intel Core, Intel Xeon, Intel Celeron, AMD Opteron, AMD FX, etcpp. Pretty much everything that has an x86 compatible instruction set. This binary is intentionally without any form of GPU mining, thus running even on older systems without (or with broken) GPU drivers.

• luk-phi : For bootable x200 "Knights Landing" (or "Knights Mill") Xeon Phis (ie, typically the Asrock or Exxact machines that the blog talked about.

• luk-knc-native : For the older, x100 "Knights Corner" Xeon Phis that you intend to run in "native mode"; i.e., where you manually copy the binary to the device, and run it there (most commonly this is only for advanced KNC users - if you're not a "Ninja" KNC user, use the luk-mpss-knc version).

Binaries to drive PCI cards (Xeon Phis or GPUs)

• luk-mpss-knc : For MPSS offloading to the older, x100 "Knights Corner" Xeon Phis (7120, 31s1p, 5110, etc).

• luk-mpss-knl : For MPSS offloading to the newer, x200 "Knights Landing" cards (7220 and 7240).

• luk-ocl : For systems that contain OpenCL-capable GPUs (both NVidia and AMD).

All all these three "offload" binaries also contain the plain cpu driver, so unless you turn CPU mining off explicitly it will automatically run on all GPUs/Phis and on the CPU.

Release Notes

• v0.10.7

• full support for "CryptoNight Light v1" as used in Turtle

• v0.10.4

• several optimizations to sumo

• v0.10.2

• support for "CryptoNight Heavy" as used in Sumo v1

• v0.10.1

• Various bugfixes, in particular re outputs

• First support for "-a xmr-v7" for monero v7 fork (fixed in all of cpu, knc, knl, and ocl)

• v0.10.0

• Lots of various bugfixes

• Added support for x200 MPSS offloading; can now do both mpss offload and native mining for both x100 and x200

• Added cryptonight dark (bitnote) algorithm

• Reduced number of binaries via unifying miners: Rather than having different miners for different algorithm we now use a single binary and specify mining algorithm via "-a ". Also all miners now support all mining algorithms.

• Better documentation via auto-generated README.html; will now automatically get distributed to public releases/

• Generating different releases based on dependencies: regular (cpu, opencl, phi), x100 KNC witht MPSS 3.8, and x200 phi MPSS offload (MPSS 4.4)

• releases now hosted on files.lukminer.net/releases

• now have auto-booting lukSticks for cpu, phi, phi-mpss, and knc-mpss