Skip to content

Commit

Permalink
Merge pull request #1 from evesnow91/master
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
deepgully authored Jan 16, 2019
2 parents e4e8b35 + 47d87a5 commit 1683332
Showing 1 changed file with 36 additions and 21 deletions.
57 changes: 36 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,66 @@
# zilminer

> Zilliqa miner with OpenCL, CUDA support
> Zilliqa miner with OpenCL and CUDA support.
**zilminer** is an Ethash GPU mining worker to support Zilliqa Proof of Work mining.
**zilminer** is an Ethash GPU mining worker that support Zilliqa's Proof-of-Work process.

This project is forked from [ethminer](https://github.com/ethereum-mining/ethminer). See [ethminer README](ethminer.README.md) for more details.
This project is a fork of [ethminer](https://github.com/ethereum-mining/ethminer). Please do see [ethminer README](ethminer.README.md) for more details.

## Features

* Zilliqa Getwork Protocol
* All ethminer Features
* Zilliqa Getwork protocol
* All ethminer features


## Install

Standalone **executables** for *Linux*, *macOS* and *Windows* are provided in
the [Releases] section.
Download an archive for your operating system and unpack the content to a place
accessible from command line. The zilminer is ready to go.
accessible from command line. After which, the zilminer will be ready to go.


## Usage

The **zilminer** is a command line program. This means you launch it either
from a Windows command prompt or Linux console, or create shortcuts to
predefined command lines using a Linux Bash script or Windows batch/cmd file.
For a full list of available command, please run:
The **zilminer** is a command line program. This means you will have to launch it either
from a Windows command prompt or Linux Bash console. You can also create shortcuts to
predefined commands using a Linux Bash script or Windows batch/cmd file.
For the full list of available commands, please enter the following:

```sh
zilminer --help
```

## Settings on client

## Settings on Zilliqa Node
1. Setup Zilliqa Node by following the [Zilliqa Mining Guide](https://github.com/Zilliqa/Zilliqa/wiki/Mining)
2. Change the `constants.xml` for the following parameter:
* Set `GETWORK_SERVER_MINE` to `true`.
* Set `GETWORK_SERVER_PORT` to the port you will be using to GetWork. (default is `4202`)
* Set the other mining parameters to `false`:
```
<CUDA_GPU_MINE>false</CUDA_GPU_MINE>
<FULL_DATASET_MINE>false</FULL_DATASET_MINE>
<OPENCL_GPU_MINE>false</OPENCL_GPU_MINE>
<REMOTE_MINE>false</REMOTE_MINE>
```
3. Launch your node and find out your IP address with the following command:
```
curl https://ipinfo.io/ip
```
## Settings on zilminer client
Key in the following command in your command prompt:
```sh
zilminer --max-submit=1 --farm-recheck 10000 --work-timeout=7200 --farm-retries=10 --retry-delay=10 \
-P zil://wallet_address.worker_name@zil_node_ip:4202
-P zil://wallet_address.worker_name@zil_node_ip:get_work_port
```
please change the *wallet_address*, *worker_name* and *zil_node_ip* accodingly.
> Please change the *wallet_address*, *worker_name*, *zil_node_ip*, and *get_work_port* accodingly.

## Settings on Zilliqa Node
1. Setup Zilliqa Node follow [Zilliqa Mining Guide](https://github.com/Zilliqa/Zilliqa/wiki/Mining)
2. Change `constans.xml`
* Set `GETWORK_SERVER_MINE` to `true`
* Set other mining method to `false`
3. Start the node, connect *zilminer* to your Node
* For `wallet_address`: You can use the [Zilliqa Wallet](https://wallet.zilliqa.com/) to create a new keypair and a Zilliqa address.
* For `worker_name` You can key in any abitrary worker name you desire.
* For `zil_node_ip`: Please key in the IP address of the Zilliqa node.
* For `get_work_port`: Please key in the port used in `GETWORK_SERVER_PORT`. Default is `4202`.

## Build

Expand Down

0 comments on commit 1683332

Please sign in to comment.