Skip to content

Commit

Permalink
Actually adding the updated documentations.
Browse files Browse the repository at this point in the history
  • Loading branch information
ProgrammerDan committed May 22, 2018
1 parent 5cea45d commit 75af1ac
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 13 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Major differentiators:

* The hashers never stop -- the reference PHP implementation pauses the hasher during update requests and nonce submissions. The java hashers never stop.

* (Very slight) optimizations -- the Java miner has easy swap support for alternate "core" types, with "basic", "debug" and "experimental" for now; basic is equivalent to php-reference, debug is chatty giving runtime details, and experimental has some improvements to improve the amount of time the hasher spends computing argon2i hashes instead of other things.
* Optimizations -- the Java miner has easy swap support for alternate "core" types, with "standard", "experimental" and "legacy" for now; standard (or "enhanced") is the current strong recommendation, it has better adaptive behavior and some optimizations to reduce rejections, identify bad or reduced capability memory sectors and generally focus on accepted hashes, not just hashrate (although hashrate is great too). All other cores represent prior or lower performing cores.

For more details, see the arionum forum thread here: https://forum.arionum.com/viewtopic.php?f=11&t=28

I hope you enjoy. See the README.md in the arionum-miner subfolder for details on compiling and running.
16 changes: 9 additions & 7 deletions arionum-miner/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,17 @@ Extended Documentation for Java port of Arionum-miner

Choose which image you want to install from the downloads below.

If your hardware supports AVX, AVX2, or AVX512F and you are a Windows user, download the correctly named EXE and run. If your system does not support it, you will know on launch as it will fail noisily.
If your hardware supports AVX or AVX2 and you are a Windows user, download the correctly named EXE and run. If your system does not support it, you will know on launch as it will fail noisily. If you know your system supports AVX512F, please contact me on Discord. All prior testing of AVX512F builds on Windows were unsuccessful, but I can work with you to see what we can accomplish.

If you see crazy high hashrates, you are using 32bit java and these programs will _not_ function. Immediately shut off miner and go here: http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html and download a 64 bit jre.

# Release details:

* Corrected argon2i included dlls for Windows. Includes a new avx512f build for advanced systems.
* Replaced `standard` and `enhanced` hashers with a hasher that trades a very small (0.1% or so) hashrate for significantly improved accept rate, as the method of creating salts and nonces matches the code that will verify them. In addition, improved affinity and memory handling quickly moves away from memory that results in rejected hashes; only "successful" memory is kept, and its kept for a long time.

* Hot fix for off-by-one in argon submission. If rebuilding locally, follow again all steps as below.
* Better handling in general of the differences in affinity and memory handling between Windows and Linux

# General Details:

* Auto-adapt to block 10800-hf-resistance to remain compliance with primary node code.

Expand Down Expand Up @@ -89,9 +91,9 @@ For pool-based mining, full command line flags:

**hasher core**: Currently, one of:

`standard`: Stable, but far from php-parity. This hasher tries to squeeze even more performance out of your CPU cores. Current Default.
`standard`: Stable, best, most improved with best speed AND acceptance.

`experimental`: Bleeding edge. Will likely be much faster, might have tradeoffs, no warrantees.
`experimental`: Less handling for affinity and memory, use standard.

**colored output**: Only supported in linux, set to true to add some color to the output of the statistic updates. Note, this isn't working yet.

Expand All @@ -111,9 +113,9 @@ For solo mining, full command line flags:

**hasher core**: Currently, one of:

`standard`: Stable, but far from php-parity. This hasher tries to squeeze even more performance out of your CPU cores. Current Default.
`standard`: Stable, best, most improved with best speed AND acceptance.

`experimental`: Bleeding edge. Will likely be much faster, might have tradeoffs, no warrantees.
`experimental`: Less handling for affinity and memory, use standard.

**colored output**: Only supported in linux, set to true to add some color to the output of the statistic updates.

Expand Down
10 changes: 8 additions & 2 deletions arionum-miner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ Get dependency:

* Double click the .exe to run

* For some advanced systems, a special, optimized version is available. Check if your CPU supports AVX, AVX2, or AVX512F and use that version if supported.
* For some advanced systems, a special, optimized version is available. Check if your CPU supports AVX or AVX2 and use that version if supported.

* Follow interactive prompt -- if a default is offered, press "enter" key to accept it. I recommend using defaults.

* Configuration is automatically saved and used again when you open the miner up next

* Default config is `config.cfg` in the same folder as the .jar or .exe -- open it in any text editor to modify

#### To compile
#### To compile on Linux

Get depencies

Expand All @@ -51,6 +51,12 @@ Clone this repository, change directory into ```arionum-miner```

Execute ```mvn clean package``` -- this will build the miner

Run ```./build-argon.sh``` -- this will build the argon and run shell

Launch with ```./run.sh``` -- follow interactive prompts to set up.

For windows build instructions, check DOCS.md

##### Summary:

Pick a place to install. For linux:
Expand Down
6 changes: 3 additions & 3 deletions arionum-miner/WINDOWS_COMPILE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Only use these steps if the release `.exe` doesn't work for you, otherwise, pref
6. Start up a command prompt
7. Navigate towards the aronium-miner directory (the one with the POM.xml file)
8. Execute “mvn clean package” (do not used quotes)
9. **Run the run.bat file.** Follow on screen prompts to configure your miner.
10. **Rename the aronium-java folder** to arionum-miner to avoid conflicts with GitHub Desktop if you want to catch the latest release.
11. Start up the bat file you just created.
9. Run "pick-argon.bat" and follow the prompts to choose a pre-built argon2i library.
10. **Run the run.bat file.** Follow on screen prompts to configure your miner.
11. **Rename the aronium-java folder** to arionum-miner to avoid conflicts with GitHub Desktop if you want to catch the latest release.

Need help? Contact Rezegen or ProgrammerDan for more help!

Expand Down

0 comments on commit 75af1ac

Please sign in to comment.