Skip to content

Commit 7f03038

Browse files
authored
Update README.md
1 parent 305823d commit 7f03038

File tree

1 file changed

+90
-51
lines changed

1 file changed

+90
-51
lines changed

README.md

Lines changed: 90 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@ In the [release](https://github.com/madMAx43v3r/chia-gigahorse/releases) section
1717
The compressed plot harvester and farmer are not compatible with the official Chia Node, it only works together with the Gigahorse Node.
1818
However it's possible to use a wallet from the official Chia repository, instead of the Gigahorse binary wallet.
1919

20-
Both NFT and OG plots are supported, as well as solo and pool farming (via the official pool protocol). Regular uncompressed plots are supported as well, so you can use the Gigahorse version while re-plotting your farm.
20+
Both NFT and OG plots are supported, as well as solo and pool farming (via the official pool protocol).
21+
Regular uncompressed plots and Bladebit plots are supported as well, so you can use Gigahorse while re-plotting your farm.
2122

2223
The dev fee is as follows:
2324
- 3.125 % when using GPU(s) to farm compressed plots
2425
- 1.562 % when using CPU(s) to farm compressed plots
2526
- 0 % for regular uncompressed plots
2627

27-
When you find a block there's a chance the 0.25 XCH farmer reward is used as fee, this is a random process. In case of CPU farming it's 1 out of 8 blocks on average, and for GPU farming it's 1 out of 4 blocks on average.
28+
When you find a block there's a chance the 0.125 XCH farmer reward is used as fee, this is a random process. In case of CPU farming it's 1 out of 8 blocks on average, and for GPU farming it's 1 out of 4 blocks on average.
2829

2930
When the fee is paid from a block, you will see a log entry like this:
3031
```
@@ -34,14 +35,9 @@ It will show the block height as well as the average fee that applies, depending
3435

3536
### Pool Partial Difficulty
3637

37-
When farming NFT plots on a pool it is recommended to set the partial difficulty to 20 or more, otherwise your harvester will be overloaded with computing full proofs.
38+
When farming NFT plots on a pool it is recommended to set the partial difficulty to 100 or more, otherwise your harvester will be overloaded with computing full proofs.
3839

39-
The chance of having to compute a full proof is roughly `1 / (2 * difficulty)`. The cost of computing a full proof is 8 (for C6+) or 16 (for C5 and lower) times that of a quality lookup.
40-
41-
For example:
42-
- Difficulty 20 (at C6+): `8 / 40 = 20 %` compute overhead
43-
- Difficulty 100 (at C6+): `8 / 200 = 4 %` compute overhead
44-
- Difficulty 1000 (at C6+): `8 / 2000 = 0.4 %` compute overhead
40+
For GH 3.0 a much higher parital difficulty is required to achieve optimal performance, see the chart above for recommended settings.
4541

4642
### Plot Reload Interval
4743

@@ -53,7 +49,29 @@ harvester:
5349
```
5450
The default value of 120 sec will cause too much CPU load with large plot counts.
5551

56-
### Usage Linux
52+
### GUI Usage
53+
54+
Gigahorse now offers a full GUI package, by installing via `ChiaSetup-X.X.X.gigaX.exe` on Windows or installing `chia-blockchain_X.X.X.gigaX_amd64.deb` on Linux.
55+
56+
This will over-write any existing Chia installation, but keeps your databse and all your settings and wallets. It works just like the official GUI but with GH support.
57+
58+
![chia64x64](https://github.com/madMAx43v3r/chia-gigahorse/assets/951738/e5af9b48-18da-4235-ba66-b078a613c7b0)
59+
60+
You will see this icon to signal that you're running GH and not official Chia.
61+
62+
### CLI Usage Linux
63+
64+
#### The new way with *.deb package install
65+
66+
Usage with the `*.deb` package install is the same as with official Chia.
67+
68+
For example:
69+
```
70+
chia stop all -d
71+
chia start farmer
72+
```
73+
74+
#### The old way with *.tar.gz install
5775

5876
Make sure to close any other instances first:
5977
```
@@ -76,7 +94,19 @@ Note the usage of `./chia.bin ...` instead of just `chia ...`, this is the only
7694

7795
Alternatively, you can `. ./activate.sh` in `chia-gigahorse-farmer` to be able to use `chia ...` commands instead of `./chia.bin ...`.
7896

79-
### Usage Windows
97+
### CLI Usage Windows
98+
99+
#### The new way with ChiaSetup-*.exe install
100+
101+
Usage with the `ChiaSetup-*.exe` install is the same as with official Chia.
102+
103+
For example:
104+
```
105+
chia stop all -d
106+
chia start farmer
107+
```
108+
109+
#### The old way with *.tar.gz install
80110

81111
Make sure to close any running Chia GUI first, otherwise you cannot start the Gigahorse version.
82112

@@ -94,28 +124,50 @@ chia wallet show
94124
chia stop all -d
95125
```
96126

97-
### Official GUI + Gigahorse
127+
#### Official GUI + Gigahorse
128+
129+
Note: Gigahorse now offers the GUI as well, but if you still want to use official GUI, see below.
98130

99-
You can start the official Chia GUI after starting Gigahorse in a terminal, however it needs to be the same version. It will still complain about version mismatch but when the base version (like `1.6.2`) is the same then it works.
131+
You can start the official Chia GUI after starting Gigahorse in a terminal, however it needs to be the same version.
132+
It will still complain about version mismatch but when the base version (like `1.6.2`) is the same then it works.
100133

101134
When you close the GUI everything will be stopped, so you need to restart Gigahorse in the terminal again if so desired.
135+
Newer GUI versions allow to keep services running at exit though, if you select it.
102136

103-
### Installation
137+
## Installation
104138

105-
Note: There is no need to re-sync the blockchain, Gigahorse node will re-use your existing DB and config. Even the old v1 DB format still works.
139+
### Linux
106140

107-
#### Linux
141+
Install dependency first:
108142
```
109143
sudo apt install ocl-icd-libopencl1
144+
```
145+
146+
The new way of using GH on Debian systems:
147+
```
148+
sudo dpkg -i ~/Downloads/chia-blockchain_X.X.X.gigaX_amd64.deb
149+
```
150+
Or if you don't need the GUI and use CLI only:
151+
```
152+
sudo dpkg -i ~/Downloads/chia-blockchain-cli_X.X.X.gigaX_amd64.deb
153+
```
154+
Alternatively, the old way of using GH:
155+
```
110156
tar xf chia-gigahorse-farmer-*.tar.gz
111157
```
112158

113-
#### Windows
159+
### Windows
160+
161+
The new way of using GH:
162+
Install `ChiaSetup-X.X.X.gigaX.exe` and use the GUI or command line.
114163

115-
Just unzip the chia-gigahorse-farmer-*.zip somewhere.
164+
The old way of using GH:
165+
Unzip the `chia-gigahorse-farmer-*.zip` somewhere.
116166

117167
You might also have to install latest Microsoft Visual C++ Redistributable: https://aka.ms/vs/17/release/vc_redist.x64.exe
118168

169+
Note: There is no need to re-sync the blockchain, Gigahorse will re-use your existing database and config.
170+
119171
### Limit GPU / RAM usage
120172

121173
Please take a look at:
@@ -124,22 +176,9 @@ Please take a look at:
124176

125177
Note: When changing environment variables you need to restart the Chia daemon for it to take effect: `./chia.bin stop all -d` or `chia.exe stop all -d`
126178

127-
### RAM / VRAM requirements to farm
128-
129-
![image](https://github.com/madMAx43v3r/chia-gigahorse/assets/951738/742fde23-cce2-4548-91ec-b22199fb435e)
130-
131-
![image](https://github.com/madMAx43v3r/chia-gigahorse/assets/951738/a1fd6c50-711d-4b79-947a-76a32783ccec)
132-
133179
When mixing different K size and C levels, only the higest RAM / VRAM requirement applies.
134180

135-
## K33+
136-
137-
![image](https://github.com/madMAx43v3r/chia-gigahorse/assets/951738/6bb34775-8e8b-480b-84f6-4bff49b46534)
138-
139-
K33+ performance for the new C11 to C20 is considerably less than K32.
140-
In addition higher K size benefits more from a higher partial difficulty.
141-
142-
### Remote Compute
181+
## Remote Compute
143182

144183
It's possible to move the compute task to another machine or machines, in order to avoid having to install a GPU or powerful CPU in every harvester:
145184

@@ -170,45 +209,45 @@ For example if you have a single compute server with 32 CPU cores, you should se
170209
The sum of `CHIAPOS_MAX_CORES` accross all harvesters should be greater or equal to the sum of CPU cores on all compute servers.
171210
In case of low number of harvesters (ie. 1-3) you should set `CHIAPOS_MAX_CORES` to the number of CPU cores on your compute server.
172211

173-
### Known Issues
174-
175-
- AMD GPU getting stuck in Linux, workaround is: `watch -n 0.1 sudo cat /sys/kernel/debug/dri/0/amdgpu_pm_info`
212+
### K33+
176213

177-
### Fixed in latest version
214+
![image](https://github.com/madMAx43v3r/chia-gigahorse/assets/951738/6bb34775-8e8b-480b-84f6-4bff49b46534)
178215

179-
N / A
216+
K33+ performance for C11 to C20 is considerably less than K32.
217+
In addition higher K size benefits more from a higher partial difficulty.
218+
GH 3.0 only supports K32.
180219

181-
## Gigahorse GPU Plotter
220+
### Known Issues
182221

183-
You can find the GPU plotter binaries in [cuda-plotter](https://github.com/madMAx43v3r/chia-gigahorse/tree/master/cuda-plotter).
222+
- AMD GPU getting stuck in Linux, workaround is: `watch -n 0.1 sudo cat /sys/kernel/debug/dri/0/amdgpu_pm_info`
184223

185-
They support plotting for Chia as well as MMX.
224+
### Gigahorse GPU Plotter
186225

187-
## CPU Plotter
226+
You can find the GPU plotter binaries here: [cuda-plotter](https://github.com/madMAx43v3r/chia-gigahorse/tree/master/cuda-plotter).
188227

189-
You can find the CPU plotter binaries in [cpu-plotter](https://github.com/madMAx43v3r/chia-gigahorse/tree/master/cpu-plotter).
228+
### CPU Plotter (GH 1.0 and 2.0 only)
190229

191-
They support plotting for Chia as well as MMX.
230+
You can find the CPU plotter binaries here: [cpu-plotter](https://github.com/madMAx43v3r/chia-gigahorse/tree/master/cpu-plotter).
192231

193-
## Farming Benchmark
232+
### Farming Benchmark
194233

195234
To test how many plots you can farm on a given system you can use the `ProofOfSpace` tool in [chiapos](https://github.com/madMAx43v3r/chia-gigahorse/tree/master/chiapos).
196235

197-
## Plot Sink
236+
### Plot Sink
198237

199238
Plot Sink is a tool to receive plots over the network and copy them to multiple HDDs in parallel.
200239

201240
You can find binaries in [plot-sink](https://github.com/madMAx43v3r/chia-gigahorse/tree/master/plot-sink)
202241

203242
See also the open source repository: https://github.com/madMAx43v3r/chia-plot-sink
204243

205-
## Docker Usage
244+
### Docker Usage
206245

207246
The Dockerfile file uses multiple build stages to support 4 different applications CPU-Only, NVIDIA-GPU, Intel-GPU, and AMD-GPU.
208247

209248
It is highly recommended to run the container with the `/root/.chia/mainnet` directory mapped to a local volume for persistant storage of the database and config files
210249

211-
### CPU-Only
250+
#### CPU-Only
212251

213252
Docker Run Example:
214253

@@ -241,7 +280,7 @@ services:
241280
### Remote compute server
242281
# CHIAPOS_RECOMPUTE_HOST: 192.168.1.12
243282
```
244-
### NVIDIA-GPU
283+
#### NVIDIA-GPU
245284

246285
Docker Run Example:
247286

@@ -279,7 +318,7 @@ services:
279318
```
280319
Note: for nvidia you also need the `NVIDIA Container Toolkit` installed on the host, for more info please see: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker
281320

282-
### Intel-GPU
321+
#### Intel-GPU
283322

284323
Docker Run Example:
285324

@@ -318,7 +357,7 @@ services:
318357
```
319358
Note: for ARC GPU's you will need to be running kernel 6.2+ on your docker host
320359

321-
### AMD-GPU
360+
#### AMD-GPU
322361

323362
Docker Run Example:
324363

@@ -357,7 +396,7 @@ services:
357396
# CHIAPOS_MAX_OPENCL_DEVICES: 0
358397
```
359398

360-
### Further Customization
399+
#### Further Customization
361400

362401
You can modify the container options by uncommenting the relevent settings in the docker-compose example and changing them from the defaults.
363402

0 commit comments

Comments
 (0)