Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@trexminer
trexminer authored Jun 2, 2019
1 parent 35fa1a4 commit c3df6c5
Showing 1 changed file with 339 additions and 29 deletions.
368 changes: 339 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,343 @@
# T-Rex
T-Rex NVIDIA GPU miner with web control monitoring page. Runs on both Linux and Windows.

Miner has dev fee 1%. When the miner starts and stops mining dev fee it reports it to the console output.

Supported algorithms:
x16r
x16rt
x16s
x17
x22i
x21s
geek
dedal
bcd
hmq1725
sha256t
sha256q
timetravel
lyra2z
bitcore
sonoa
renesis
balloon
polytimos
skunk
c11
phi
tribus
# T-Rex NVIDIA GPU miner

## Overview

T-Rex is a versatile cryptocurrency mining software. It supports a variety of algorithms and we, as developers, are trying to do our best to make it as fast and as convenient to use as possible.

Developer fee is 1%.

## Usage

Full list of command line options:
```
-a, --algo Specify the hash algorithm to use.
astralhash
balloon
bcd
bitcore
c11
dedal
geek
hmq1725
jeonghash
lyra2z
mtp
padihash
pawelhash
phi
polytimos
sha256q
sha256t
skunk
sonoa
timetravel
tribus
x16r
x16rt
x16s
x17
x21s
x22i
x25x
-d, --devices Comma separated list of CUDA devices to use.
Device IDs start counting from 0.
--ab-indexing Afterburner indexing (Sort devices by bus ID. First device starts with 1).
-i, --intensity GPU intensity 8-25 (default: auto).
-o, --url URL of mining server.
-u, --user Username for mining server.
-p, --pass Password for mining server.
-r, --retries Number of times to retry if a network call fails.
-R, --retry-pause Pause in seconds between retries.
-T, --timeout Network timeout, in seconds (default: 300)
--time-limit Miner shutdown interval in seconds. (default: 0 - disabled)
--temperature-color Set temperature color for GPUs stat. Example: 55,65 - it means that
temperatures above 55 will have yellow color, above 65 - red color. (default: 67,77)
--temperature-limit GPU shutdown temperature. (default: 0 - disabled)
--temperature-start GPU temperature to enable card after disable. (default: 0 - disabled)
-b, --api-bind-telnet IP:port for the miner API via telnet (default: 0.0.0.0:4068). Set to 0 to disable.
--api-bind-http IP:port for the miner API via HTTP (default: 0.0.0.0:4067). Set to 0 to disable.
-J --json-response Telnet API server will make json responses.
-N, --hashrate-avr Sliding window length in seconds used to compute average hashrate (default: 60).
--sharerate-avr Sliding window length in seconds used to compute sharerate (default: 600).
--gpu-report-interval GPU stats report frequency. (default: 5. every 5th share)
-q, --quiet Quiet mode. No GPU stats at all.
--hide-date Don't show date in console.
--no-color Disable color output for console.
--no-nvml Disable NVML GPU stats.
--no-watchdog Disable built-in watchdog.
-B, --benchmark Benchmark mode.
-P, --protocol-dump User protocol logging.
-c, --config Load a JSON-format configuration file.
-l, --log-path Full path of the log file.
--cpu-priority Set process priority (default: 2) 0 idle, 2 normal to 5 highest.
--autoupdate Perform auto update whenever a newer version of the miner is available.
--back-to-main-pool-sec Forces miner to switch back to main pool in case working with failover pool.
Parameter is set in seconds. (default: 600)
--exit-on-cuda-error Forces miner to immediately exit on CUDA error.
--exit-on-connection-lost Forces miner to immediately exit on connection lost.
--reconnect-on-fail-shares Forces miner to immediately reconnect to pool on N successively failed shares (default: 10).
--version Display version information and exit.
-h, --help Display this help text and exit.
```

## JSON config file

To start T-Rex with config file `config.txt` type in the console: `t-rex -c config.txt`. Use `config_example` file as a starting point to create your own config.

## Watchdog

Watchdog is intended to observe miner state and restart T-Rex if it crashes or hungs for any reason.
Also, watchdog can optionally perform auto updates if a newer version is available.
We recommend using the watchdog to avoid any downtime in mining and make sure your GPUs are busy 24/7.
If you do need to disable the watchdog, you can do so using `--no-watchdog` parameter.

## HTTP API

By default HTTP API server binds to `0.0.0.0:4067`. It means that you can access your miner via both external and internal network interfaces.
Common example of request structure: `http://your_ip:your_port/handler_name`

* **trex** - Shows miner control monitoring page in your web browser. You can see miner stats realtime and also change miner parameters and config on the fly. Also here you will see updates in case it appears.
To activate the handler navigate to `http://127.0.0.1:4067/trex` using a web browser.

* **config** - Changes your config on HDD and also change some miner parameters on the fly.
You can change multiple parameters with one request. GET and POST requests supported.
If you use config (started miner like this: t-rex.exe -c config_file) then any action with handler "config" will be saved into selected config_file.
You can use this handler for automatization purposes like changing config at runtime, shutting down the miner via API and then restarting it with new parameters applied.

GET usage examples:
1) `http://127.0.0.1:4067/config?protocol-dump=true` - Enables protocol dump on the fly and write it into config_file

2) `http://127.0.0.1:4067/config?algo=x16r&devices=0,1&intensity=20,21` - Will write the following config settings into the config file: `algo=x16r`, `devices=0,1`, `intensity=20,21`

3) `http://127.0.0.1:4067/config?algo=x16r&devices=0,1&intensity=20,21&config=test.conf` - Saves settings into the file `test.conf` which will be created in the folder where the miner resides. `algo=x16r`, `devices=0,1`, `intensity=20,21`

4) `http://127.0.0.1:4067/config?config=test.conf` - Saves your current miner settings into `test.conf` file

5) `http://127.0.0.1:4067/config` - Shows the current config state

6) `http://127.0.0.1:4067/config?hashrate_avr=10&temperature-limit=70&temperature-start=40` - Sets the following parameters on the fly: `hashrate_avr=10`, `temperature-limit=70`, `temperature-start=40`

For POST requests you must use correct json object with parameters you want to change.

URL: `http://127.0.0.1:4067/config`.
Payload: `{"hashrate_avr": 10, "temperature-limit": 70, "temperature-start": 40}`.
Parameters' names and types in json are identical to config json you normally use.

* **summary** Shows all information about current mining process.
To activate the handler navigate to `http://127.0.0.1:4067/summary` using a web browser.

Response example with comments:
```
{
// Number of accepted shares count
"accepted_count": 6,
// Information about the pool your miner is currently connected to
"active_pool":
{
// Current pool difficulty
"difficulty": 5,
// Pool latency
"ping": 97,
// Number of connection attempts in case of connection loss
"retries": 0,
// Pool connection string
"url": "stratum+tcp://...",
// Usually your wallet address
"user": "..."
},
// Algorithm which was set in config
"algorithm": "x16r",
// HTTP API protocol version
"api": "1.2",
// CUDA toolkit version used to built the miner
"cuda": "9.10",
// Software description
"description": "T-Rex NVIDIA GPU miner",
// Current network difficulty
"difficulty": 31968.245093004043,
// Total number of GPUs installed in your system
"gpu_total": 1,
// List of all currently working GPUs in your system with its stats
"gpus": [{
// Internal device id, useful for devs
"device_id": 0,
// Fan blades rotation speed in % of the max speed
"fan_speed": 66,
// User defined device id in config
"gpu_id": 0,
// Average hashrate per N sec defined in config
"hashrate": 4529054,
// Average hashrate per day
"hashrate_day": 5023728,
// Average hashrate per hour
"hashrate_hour": 0,
// Average hashrate per minute
"hashrate_minute": 4671930,
// User defined intensity
"intensity": 21.5,
// Current device name.
"name": "GeForce GTX 1050",
// Current device temperature.
"temperature": 80,
// Current device vendor.
"vendor": "Gigabyte",
// Device state. Might appear if device reached heat limit. (set by --temperature-limit)
"disabled":true,
// Device temperature at disable. Might appear if device reached heat limit.
"disabled_at_temperature": 77
}],
// Total average sum of hashrates for all active devices per N sec defined in config.
"hashrate": 4529054,
// Total average sum of hashrates for a day.
"hashrate_day": 5023728,
// Total average sum of hashrates for an hour.
"hashrate_hour": 0,
// Total average sum of hashrates for a minute.
"hashrate_minute": 4671930,
// Application name
"name": "t-rex",
// Operating system
"os": "linux",
// This is number of rejected shares count.
"rejected_count": 0,
// This is number of found blocks.
"solved_count": 0,
// Current time in sec from the beginning of the epoch. (ref: https://www.epochconverter.com)
"ts": 1537095257,
// Uptime in sec. This shows how long the miner has been running for.
"uptime": 108,
// Miner version.
"version": "0.6.5",
// Information about available update. Appears in case update is available.
"updates":{
// Url of file archive to download.
"url": "https://fileurl",
// Signature of update pack (md5).
"md5sum": "md5...",
// T-Rex version in update.
"version": "0.8.0",
// Short info about changes in update.
"notes": "short update info",
// Whole info about changes in update.
"notes_full": "full update info",
// Information about current update download.
"download_status":
{
// Total bytes downloaded.
"downloaded_bytes": 1775165,
// Total bytes to download.
"total_bytes": 5245345,
// Last error if download failed.
"last_error":"",
// Time elapsed since first byte downloaded.
"time_elapsed_sec": 2.887111,
// Download service state.
"update_in_progress": true,
// Download service named state. ("started", "downloading", "finished", "error", "idle")
"update_state": "downloading",
// Url of file in operation.
"url": "https://fileurl"
},
}
}
```

* **do-update** Activate download update service.
To start T-Rex update type in the following into your browser address bar and hit Enter:
`http://127.0.0.1:4067/do-update`.
To stop update type in the following into your browser address bar and hit Enter:
`http://127.0.0.1:4067/do-update?stop=true`

* **control** Real time configuration of T-Rex miner.
As of API 1.3 version there are following commands supported.

_shutdown_ - Shuts down your miner. Usage: `http://127.0.0.1:4067/control?command=shutdown`. If you prefer POST set the request body to `{"command": "shutdown"}`.

_hashrate-avr_ - Changes sliding window size in real time. Usage: `http://127.0.0.1:4067/control?hashrate-avr=1`.
It will set sliding window of size 1 sec. If you prefer POST set the request body to `{"hashrate-avr": 1}`.

_gpu-report-interval_ - Changes frequency of GPUs reports appearance in log. Usage: `http://127.0.0.1:4067/control?gpu-report-interval=10`. Now you will see GPUs stats every 10th share. If you prefer POST set the request body to `{"gpu-report-interval": 10}`. Btw, you can disable stats (enter quiet mode) by setting gpu-report-interval to 0.

_no-color_ - Disables color output to console. Usage: `http://127.0.0.1:4067/control?no-color=true`. To enable: `http://127.0.0.1:4067/control?no-color=false`.
If you prefer POST set the request body to `{"no-color": true}`.

_protocol-dump_ - Enables user protocol dump into console/log. To enable: `http://127.0.0.1:4067/control?protocol-dump=true`. To disable: `http://127.0.0.1:4067/control?protocol-dump=false`.
If you prefer POST set the request body to `{"protocol-dump": true}`.

_time-limit_ - Sets time limit in seconds for miner (it will shutdown after timeout). Usage: `http://127.0.0.1:4067/control?time-limit=120`. It will shutdown your miner 120 seconds after this request.
To disable: `http://127.0.0.1:4067/control?time-limit=0`. If you prefer POST set the request body to `{"time-limit": 120}`.

* **file** Creates a file in directory with the miner. This may be useful for external monitoring utilities or scripts which can take commands from this file and do some sort of useful stuff like overclock or system reconfiguration.

`http://127.0.0.1:4067/file?name=test.txt&data=some_sort_of_text_data`

If you prefer POST set the request body to `{"name": "test.txt", "data": "some sort of text data"}`

## Tips

In order to maximise the hashrate our software utilises all
available GPU resources, so it is important that you review your overclock
settings before you start mining. Our general recommendation is to start
from GPU stock settings (no overclock, default power limit), and then after
making sure it is stable, slowly increase your overclock to find the
"sweet spot" where the miner performs at its best and still does not crash.

## Support

Discord:
https://discord.gg/gj7jcYf
Expand Down

0 comments on commit c3df6c5

Please sign in to comment.