finishing touches

Author: mining-visualizer

README.md

@@ -1,33 +1,81 @@
 ## MVis-ethminer
 
-This is a fork of Genoil's ethminer-0.9.41-genoil-1.x.x, which was a fork of the Ethereum Foundation ethminer.  It is part of the [Mining Visualizer](https://github.com/mining-visualizer/Mining-Visualizer) suite of programs, and as such the main emphasis is on solo mining.  Pool mining is currently not supported.
 
-This page describes the miner for **0xBitcoin**.  For regular ethereum miner, [click here](https://github.com/mining-visualizer/MVis-ethminer).
+This page describes the miner for **0xBitcoin**.  For the regular ethereum miner, [click here](https://github.com/mining-visualizer/MVis-ethminer).
 
-**Platform support** : Windows, Linux
+This is a fork of my MVis-ethminer program, which was a fork of Genoil's ethminer-0.9.41-genoil-1.x.x. 
 
-#### NEW!! - 0xBitcoin mining support
+* This miner is for AMD gpu's only.
+* Source code is on the **0xbitcoin** branch. The version number series for binaries is 2.x
+* The **Master** branch is for Ethereum mining.  The version number series is 1.x
+* Windows binaries can be downloaded from the  [Releases](https://github.com/mining-visualizer/MVis-ethminer/releases) page, or you can build from source (see below).
+* Linux support is limited.  The original MVis-ethminer worked well on Linux, so I see no reason why this shouldn't as well, but I haven't tried building or running it under Linux.  You can try building from source and see if it works.
+* Currently only solo mining is supported.  That means you either need to run your own node, or use a public one,  like Infura.
+* Pool mining support will hopefully be added soon.
 
-* Source code is on the **0xbitcoin** branch. The version number series is 2.x
-* The Master branch is for **Ethereum** mining.  The version number series is 1.x
-* Windows binaries can be downloaded from the  [Releases](https://github.com/mining-visualizer/MVis-ethminer/releases) page.
-* Installation & operation instructions can be found on the relevant wiki page.
 
+### Installation
 
+* Unzip the [download package](https://github.com/mining-visualizer/MVis-ethminer/releases) anywhere you like.  
+* Move `ethminer.ini` to `%LocalAppData%/ethminer` on Windows, or `$HOME/.config/ethminer` on Linux.  If that folder path does not exist, you will need to create it manually.
+* Various settings need to be specified in the `.ini` file.  They are fairly well commented.  Have a look at them.
+    * Input an Ethereum account and associated private key.  Yah, I know ... that sucks!  A PK in plain text format on your hard drive!  Make sure it is a 'throw away' account with only the bare minimum amount of money.  I might get around to implementing a proper, secure vault someday, although if someone wants to submit a PR, I'd be happy to merge it in.
+    * You can specify the address of your node in the `.ini` file, or on the command line.
+    * You can enable gas price bidding.  (see comments in the file).  Note that enabling this feature does not guarantee that you will win every bid.  Network latency will sometimes result in failed transactions, even if you 'out-bid' the other transaction.
+* Windows Only: download and install **both** the [VC 2013 Redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=40784) and the [VC 2015 Redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=48145)
+* Run `ethminer.exe --list-devices -G`.  Verify your GPU's are recognized.  Pay special attention to the PlatformID.  If it is anything other than 0, you will need to add `--opencl-platform <n>` to your command line.
+* Start mining with `ethminer.exe -G -N 127.0.0.1:8545`.  This assumes the node is on  the same machine as the miner.
 
-### Download
+#### Configuration Details ####
 
-Binaries are are available for Windows and Linux.  Please visit the [Release page](https://github.com/mining-visualizer/MVis-ethminer/releases) for the latest binary downloads
+*MVis-ethminer* is partially configured via command line parameters, and partially by settings in `ethminer.ini`.  Run `ethminer --help` to see which settings are available on the command line.  Have a look inside the .ini file to see what settings can be configured there. (It is fairly well commented).  Some settings can *only* be set on the command line (legacy ones mostly), some settings can *only* be set in the .ini file (newer ones mostly), and some can be set in both.  For the last group, command line settings take precedence over the .ini file settings.
 
-### Documentation
+#### Command Line Options ####
 
-Please visit the [Miner page](https://github.com/mining-visualizer/Mining-Visualizer/wiki/Miner) of the [MVis wiki](https://github.com/mining-visualizer/Mining-Visualizer/wiki) for full documentation.
-
-#### Limitations
-
-* CUDA mining is broken.  The old code from Genoil is still there, but I don't have an NVidia device so I have not been able to modify the CUDA code to support some of the new features I have added to the miner.  Hopefully I will be able to address this in the near future, or better yet, maybe an experienced CUDA dev will step up and volunteer for this effort. :smiley:
-* Pool mining is broken.  Many of the features I have added don't really make any sense with pool mining, so it is unlikely I will expend any effort on this issue.  If someone wants to submit a PR though, I would be happy to look at it.
-* GPU temperatures and fan speeds are unavailable when running under Linux.  Hopefully support for this can be added soon.
+```
+Node configuration:
+    -N, --node <host:rpc_port>  Host address and RPC port of your node. 
+        (default: 127.0.0.1:8545)
+    -I, --polling-interval <n>  If using getWork (polling) to obtain work packages, check 
+        for new work every <n> milliseconds (default: 200). Does not apply to stratum 
+        mode (-S).
+
+ Benchmarking mode:
+    -M [<n>],--benchmark [<n>] Benchmark for mining and exit; Optionally specify block 
+        number to benchmark against specific DAG.
+    --benchmark-warmup <seconds>  Set the duration of warmup for the benchmark tests 
+      (default: 8).
+    --benchmark-trial <seconds>  Set the duration for each trial for the benchmark tests
+      (default: 3).
+    --benchmark-trials <n>  Set the number of benchmark tests (default: 5).
+
+ Mining configuration:
+    -C,--cpu  CPU mining
+    -G,--opencl  When mining use the GPU via OpenCL.
+    --cl-local-work <n> Set the OpenCL local work size. Default is 128
+    --cl-work-multiplier <n> This value multiplied by the cl-local-work value equals 
+       the number of hashes computed per kernel run (ie. global work size). (Default: 8192)
+    --opencl-platform <n>  When mining using -G/--opencl use OpenCL platform n (default: 0).
+    --opencl-device <n>  When mining using -G/--opencl use OpenCL device n (default: 0).
+    --opencl-devices <0 1 ..n> Select which OpenCL devices to mine on. Default: all
+    -t, --mining-threads <n> Limit number of CPU/GPU miners to n (default: all)
+    --allow-opencl-cpu  Allows CPU to be considered as an OpenCL device if 
+      the OpenCL platform supports it.
+    --list-devices List the detected OpenCL/CUDA devices and exit. Should be 
+      combined with -G or -U flag
+    --cl-extragpu-mem <n> Set the memory (in MB) you believe your GPU requires 
+       for stuff other than mining. default: 0
+
+ Miscellaneous Options:
+    --config <FileSpec>  - Full path to an INI file containing program options. 
+       Windows default: %LocalAppData%/ethminer/ethminer.ini.  
+       Linux default: $HOME/.config/ethminer/ethminer.ini.  If this option is 
+       specified, it must appear before all others.
+ 
+General Options:
+    -V,--version  Show the version and exit.
+    -h,--help  Show this help message and exit.
+```
 
 
 ### Building on Windows
@@ -51,8 +99,6 @@ cmake -G "Visual Studio 12 2013 Win64" ..
 - Set `ethminer` as the startup project by right-clicking on it in the project pane.
 - Build. Run
 
-Note: if any devs want to help update this project and build process to something more modern (that uses the VS2015 toolset) I would gladly accept submissions.
-
 
 ### Building on Ubuntu
 
@@ -82,9 +128,4 @@ You can then find the executable in the `build/ethminer` subfolder
 
 ### Donations
 
-Donations will be gratefully accepted at the following addresses:
-```
-- mining-visualizer.eth
-- 0xA804e933301AA2C919D3a9834082Cddda877C205 (ETH)
-- 0x29224Be72851D7Bad619f64c2E51E8Ca5Ba1094b (ETC)
-```
+Please consider a donation to `mining-visualizer.eth (0xA804e933301AA2C919D3a9834082Cddda877C205)`

ethminer/MinerAux.h

@@ -558,18 +558,7 @@ class MinerCLI
 		_out
 			<< " Node configuration:" << endl
 			<< "    -N, --node <host:rpc_port>  Host address and RPC port of your node. (default: 127.0.0.1:8545)" << endl
-			<< "    -S, --stratum-port <port>  Stratum port of your node (default: disabled).  Setting this option" << endl
-			<< "        implicitly enables stratum mode, otherwise polling method is used to obtain work packages (ie. getWork)" << endl
-			<< "    -P, --stratum-pwd <string>  Stratum password (default: disabled)" << endl
-			<< "    -N2, --node2 <host:rpc_port>  Failover node (default: disabled)" << endl
-			<< "    -S2, --stratum-port2 <port>  Stratum port of failover node (default: disabled)" << endl
-			<< "    -P2, --stratum-pwd2 <string>  Stratum password of failover node (default: disabled)" << endl
-			<< "    -I, --polling-interval <n>  If using getWork (polling) to obtain work packages, check for new work" << endl
-			<< "        every <n> milliseconds (default: 200). Does not apply to stratum mode (-S)." << endl
-			<< "    --work-timeout <n> In stratum mode, if more than <n> seconds go by with no new work package, attempt" << endl
-			<< "        to reconnect, or, if a failover node is available, switch to the failover.  Defaults to 180. Don't" << endl
-			<< "        set lower than max. avg. block time" << endl
-			<< "    -R, --farm-retries <n> Number of retries until switch to failover (default: 4)" << endl
+			<< "    -I, --polling-interval <n>  Check for new work every <n> milliseconds (default: 200). " << endl
 			<< endl
 			<< " Benchmarking mode:" << endl
 			<< "    -M [<n>],--benchmark [<n>] Benchmark for mining and exit; Optionally specify block number to benchmark" << endl
@@ -584,37 +573,15 @@ class MinerCLI
 			<< "    --cl-local-work <n> Set the OpenCL local work size. Default is " << toString(ethash_cl_miner::c_defaultLocalWorkSize) << endl
 			<< "    --cl-work-multiplier <n> This value multiplied by the cl-local-work value equals the number of hashes computed per kernel " << endl
 			<< "       run (ie. global work size). (Default: " << toString(ethash_cl_miner::c_defaultWorkSizeMultiplier) << ")" << endl
-#if ETH_ETHASHCUDA
-			<< "    -U,--cuda  When mining use the GPU via CUDA." << endl
-			<< "    -X,--cuda-opencl Use OpenCL + CUDA in a system with mixed AMD/Nvidia cards. May require setting --opencl-platform 1" << endl
-#endif
 			<< "    --opencl-platform <n>  When mining using -G/--opencl use OpenCL platform n (default: 0)." << endl
 			<< "    --opencl-device <n>  When mining using -G/--opencl use OpenCL device n (default: 0)." << endl
 			<< "    --opencl-devices <0 1 ..n> Select which OpenCL devices to mine on. Default is to use all" << endl
 			<< "    -t, --mining-threads <n> Limit number of CPU/GPU miners to n (default: use everything available on selected platform)" << endl
 			<< "    --allow-opencl-cpu  Allows CPU to be considered as an OpenCL device if the OpenCL platform supports it." << endl
 			<< "    --list-devices List the detected OpenCL/CUDA devices and exit. Should be combined with -G or -U flag" << endl
-			<< "    -L, --dag-load-mode <mode> DAG generation mode." << endl
-			<< "            parallel    - load DAG on all GPUs at the same time (default)" << endl
-			<< "            sequential  - load DAG on GPUs one after another. Use this when the miner crashes during DAG generation" << endl
-			<< "            single <n>  - generate DAG on device n, then copy to other devices" << endl
 			<< "    --cl-extragpu-mem <n> Set the memory (in MB) you believe your GPU requires for stuff other than mining. default: 0" << endl
-#if ETH_ETHASHCUDA
-			<< "    --cuda-extragpu-mem Set the memory (in MB) you believe your GPU requires for stuff other than mining. Windows rendering e.t.c.." << endl
-			<< "    --cuda-block-size Set the CUDA block work size. Default is " << toString(ethash_cuda_miner::c_defaultBlockSize) << endl
-			<< "    --cuda-grid-size Set the CUDA grid size. Default is " << toString(ethash_cuda_miner::c_defaultGridSize) << endl
-			<< "    --cuda-streams Set the number of CUDA streams. Default is " << toString(ethash_cuda_miner::c_defaultNumStreams) << endl
-			<< "    --cuda-schedule <mode> Set the schedule mode for CUDA threads waiting for CUDA devices to finish work. Default is 'sync'. Possible values are:" << endl
-			<< "            auto  - Uses a heuristic based on the number of active CUDA contexts in the process C and the number of logical processors in the system P. If C > P, then yield else spin." << endl
-			<< "            spin  - Instruct CUDA to actively spin when waiting for results from the device." << endl
-			<< "            yield - Instruct CUDA to yield its thread when waiting for results from the device." << endl
-			<< "            sync  - Instruct CUDA to block the CPU thread on a synchronization primitive when waiting for the results from the device." << endl
-			<< "    --cuda-devices <0 1 ..n> Select which CUDA GPUs to mine on. Default is to use all" << endl
-#endif
 			<< endl
 			<< " Miscellaneous Options:" << endl
-			<< "    --export-dag <n>  - Generate DAG for block <n> and save as file in executable folder " << endl
-			<< "    --verify-dag      - Spot check DAG entries " << endl
 			<< "    --config <FileSpec>  - Full path to an INI file containing program options. Windows default: %LocalAppData%/ethminer/ethminer.ini " << endl
 			<< "                           Linux default: $HOME/.config/ethminer/ethminer.ini.  If this option is specified,  it must appear before " << endl
 			<< "                           all others." << endl
@@ -991,7 +958,7 @@ class MinerCLI
 	std::vector<node_t> m_nodes;
 
 	unsigned m_maxFarmRetries = 4;
-	unsigned m_pollingInterval = 200;
+	unsigned m_pollingInterval = 1000;
 	unsigned m_worktimeout = 180;
 	bool m_shutdown = false;
 };

ethminer/main.cpp

@@ -80,9 +80,7 @@ void CtrlHandlerPosix(int s){
 void donations()
 {
 	cout
-	<< " Please consider a donation to :" << endl
-	<< "    ETH : mining-visualizer.eth  (0xA804e933301AA2C919D3a9834082Cddda877C205)" << endl
-	<< "    ETC : 0x29224Be72851D7Bad619f64c2E51E8Ca5Ba1094b" << endl
+	<< " Please consider a donation to mining-visualizer.eth  (0xA804e933301AA2C919D3a9834082Cddda877C205)" << endl
 	<< " " << endl;
 }