Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
drdada committed Jul 22, 2017
1 parent 81567de commit 40482d4
Showing 1 changed file with 25 additions and 35 deletions.
60 changes: 25 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,43 @@
# flakjacket ETH

Removes Claymore's 1-2% mining fee using Stratum Proxy. Tested on Ubuntu 16.04 and Windows 10 with Claymore 9.6 ETH.
Removes Claymore's 1-2% mining fee using Stratum Proxy. Tested on Ubuntu 16.04 and Windows 10 with Claymore 9.7 ETH.

## How it works?
This proxy is placed between Claymore and Internet in order to catch mining fee packet and substituting the devfee address with your wallet address. The redirection are done on the fly and do not require stoping or relaunching the mining software.

## Setup

### On Linux

Python 2.7 is required

Edit the host file on every mining system.
```
nano /etc/hosts
```
Place the fake pool name at the end:
```
127.0.0.1 eth-eu.dwarfpool.com
```

### On Windows

Python 2.7 is required

Edit the host file as Administrator on every mining system.
_C:/Windows/System32/drivers/etc/hosts_

Place the fake pool name at the end:
```
127.0.0.1 eth-eu.dwarfpool.com
```

### Create a fake Wan Network
Follow this [guide for Windows](https://github.com/JuicyPasta/Claymore-No-Fee-Proxy/wiki/Creating-a-fake-WAN-network-(Win))

NB: DNS redirection is not mandatory anymore (except for ETH-fork mining).

## RUN
Run the proxy daemon first and pay attention to change the pool you use, you must specify here your real pool (here nanopool):
```
./stratum_proxy.py 127.0.0.1 8008 eth-eu2.nanopool.org 9999 0xB7716d5A768Bc0d5bc5c216cF2d85023a697D04D
./stratum_proxy.py 0.0.0.0 8008 eth-eu2.nanopool.org 9999 0xB7716d5A768Bc0d5bc5c216cF2d85023a697D04D
```

Run the mining software with the fake pool name
Run the mining software with the fake WAN IP
```
./ethdcrminer64 -epool eth-eu.dwarfpool.com:8008 ....
./ethdcrminer64 -epool 194.12.12.2:8008 ....
```

## Known issues
- Mining ETH-Fork coins is not fully supported.
- Proxy is only compatible with ESM mode 0 & 1

## Features
- Redirecting DevFee to your wallet
- Detecting network outage
- Minimal footprint
- Detecting worker name separator
- Custom worker name

## FAQ

### What if i use other pool?
Claymore try to mine the fee on the same pool as you. So you have to change the pool server above by yours.
If you use a custom pool - other than nanopool, ethpool, dwarfpool and ethermine - you have to redirect also all the devfee miner pool in the hosts file. [Windows guide here](https://github.com/JuicyPasta/Claymore-No-Fee-Proxy/wiki/Redirecting-all-domains-(Win)) [Linux guide here](https://github.com/JuicyPasta/Claymore-No-Fee-Proxy/wiki/Redirecting-all-domains-(Linux))
Claymore try to mine the fee on the same pool as you. So you have to change the pool server above by yours in the proxy arg.

### Is it lightweight?
We try to reduce the footprint to the maximum, the stratum proxy daemon take up to 130MB RAM and few CPU resources. The power consumption is trivial.
Expand All @@ -65,8 +50,9 @@ Yes, we recommand to install the proxy on every mining station. If you have a fa

### Is it compatible with every currency?
This proxy was designed to be used with Claymore ETH version. If you are planning to mine ETH-like, you have to specify `-allcoins 1` in claymore and replace the host file with the right pool. [Windows guide here](https://github.com/JuicyPasta/Claymore-No-Fee-Proxy/wiki/Redirecting-all-domains-(Win)) [Linux guide here](https://github.com/JuicyPasta/Claymore-No-Fee-Proxy/wiki/Redirecting-all-domains-(Linux))
Since Claymore 9.6 you are able to mine ETC more easily, use `-allcoins etc` and adapt the guide above with the right values (domains and ports).
Zcash version in the futur?
Since Claymore 9.6 you are able to mine ETC more easily, use `-allcoins etc` arg in claymore (So you can skip the redirections guide above).
DNS redirection is only needed when Claymore can't mine on the same pool as you.
Zcash version in the futur?

### Is it compatible with dual mode mining?
Yes, the claymore software take the fee from ETH mining only.
Expand All @@ -78,14 +64,18 @@ Spot and edit `worker_name` variable. By default the worker name is _rekt_. The
Read the window output (1 devfee per hour). You can also check your pool stats, but some pool ignore small mining time if it did not find a share. But it mines for you !

### Claymore warns me something about local proxy...
Do not worry, Claymore check the pool's IP to avoid local proxies, because it can cause stale shares. In our case, the proxy is on the same computer so the lag is trivial. You can create a fake wan network to remove the warnings.
Claymore check the pool's IP to avoid local proxies, if you have the warning make sure you followed this guide: [Fake WAN For Windows](https://github.com/JuicyPasta/Claymore-No-Fee-Proxy/wiki/Creating-a-fake-WAN-network-(Win))

### I detect a strange behaviour or reduced hashrate with untested claymore version
If you see something wrong with a new Claymore version, maybe the cheat has been detected and Claymore tries to punish us.
If it's the case, tell us in the issue section with clues.

## Contact & Issues
You can chat us on [Gitter](https://gitter.im/claymore-no-fee-proxy/Lobby)
If you met an issue you can also post in the issue section.

## Credit & Donations
Offer us a beer (or something healthier)
- [JuicyPasta](https://github.com/JuicyPasta) - 0xfeE03fB214Dc0EeDc925687D3DC9cdaa1260e7EF
- Drdada - 0xB7716d5A768Bc0d5bc5c216cF2d85023a697D04D
- Drdada - 0xB7716d5A768Bc0d5bc5c216cF2d85023a697D04D (ethermine)

0 comments on commit 40482d4

Please sign in to comment.