Skip to content
This repository has been archived by the owner on Jun 3, 2024. It is now read-only.

Latest commit

 

History

History
185 lines (127 loc) · 6.94 KB

README.md

File metadata and controls

185 lines (127 loc) · 6.94 KB
Raw

⚠️ ARCHIVED ⚠️

This project is no longer maintained. There are plenty of other dero miners which are much more performant. Use them.

dero-stratum-miner

lint goreleaser Discord telegram chat

💡 About

dero-stratum-miner adds support for mining to a stratum pool using the official derod mining algorithm.

📦 Installation

The latest release can always be found here.

Linux

Manual installation

  1. Open a terminal

  2. Make a new directory for the miner
    mkdir dero-stratum-miner && cd dero-stratum-miner

  3. Download the latest release
    curl -sLJO "https://github.com/whalesburg/dero-stratum-miner/releases/download/v1.0.5/dero-stratum-miner-v1.0.5-linux-amd64.tar.gz"

  4. Unpack the archive
    tar xavf dero-stratum-miner-v1.0.5-linux-amd64.tar.gz

  5. Make the file executable
    chmod u+x dero-stratum-miner

The miner can be started by using the command ./dero-stratum-miner

Using a package manager

# -> download the latest release file first.

# debian / ubuntu
dpkg -i dero-stratum-miner-v1.0.5-linux-amd64.deb

# rhel / fedora / suse
rpm -i dero-stratum-miner-v1.0.5-linux-amd64.rpm

# alpine
apk add --allow-untrusted dero-stratum-miner-v1.0.5-linux-amd64.apk

Arch (btw)

$ yay -S dero-stratum-miner-bin

Windows

  1. Download the latest release for windows
  2. Unzip the archive
  3. Open a terminal in the newly created folder with right click -> "Open in Windows Terminal"

The miner can be started by using the command .\dero-stratum-miner.exe

MacOS

  1. Download the latest release for windows
  2. Unzip the archive
  3. Open a terminal in the newly created folder with right click -> "Open Terminal"

The miner can be started by using the command ./dero-stratum-miner

Android

  1. Install termux ( Playstore, F-Droid )

  2. Open termux

  3. Update all packages
    pkg update

  4. Make a new directory for the miner
    mkdir dero-stratum-miner && cd dero-stratum-miner

  5. Download the latest release
    curl -sLJO "https://github.com/whalesburg/dero-stratum-miner/releases/download/v1.0.5/dero-stratum-miner-v1.0.5-linux-arm64.tar.gz"

  6. Unpack the archive
    tar xavf dero-stratum-miner-v1.0.5-linux-arm64.tar.gz

  7. Make the file executable
    chmod u+x dero-stratum-miner

The miner can be started by using the command ./dero-stratum-miner

mmpOS

dero-stratum-miner is natively integrated in mmpOS. Simply select "DERO stratum miner" when your miner profile and that's it!

HiveOS

To use dero-stratum-miner on hiveOS, you have to create a custom miner.

Option Value
Miner name dero-stratum-miner
Installation URL https://github.com/whalesburg/dero-stratum-miner/releases/download/v1.0.5/dero-stratum-miner-1.0.5.hiveOS.tar.gz
Hash algorithm astrobwt
Wallet and worker template %WAL%.%WORKER_NAME%
Pool URL pool.whalesburg.com:4300
Extra config arguments (optional) -m $THREAD_NUMBERS (limit the amount of threads used for mining)

🚀 Usage

Start the miner

To simply start the miner and get going, you can use the following command:

$ ./dero-stratum-miner -w $YOUR_WALLET

Enable TLS

By default the dero-stratum-miner has TLS disabled. Enabling TLS can improve your privacy but it will also generate a minimal network and CPU overhead. To do that, you can add the stratum+tls:// prefix to the pool URL.

$ ./dero-stratum-miner -w $YOUR_WALLET -r stratum+tls://pool.whalesburg.com:4300

Enabled the api

To fetch stats from the miner, an internal API can be enabled by using the --api-enabled parameter.

$ ./dero-stratum-miner -w $YOUR_WALLET --api-enabled

Full Help

$ ./dero-stratum-miner --help
Dero Stratum Miner

Usage:
  dero-stratum-miner [flags]
  dero-stratum-miner [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  version     Print the version info

Flags:
      --api-enabled                 enable the API server
      --api-listen string           address to listen for API requests (default ":8080")
      --api-transport string        transport to use for API requests (default "tcp")
      --console-log-level int8      console log level
  -r, --daemon-rpc-address string   stratum pool url (default "pool.whalesburg.com:4300")
      --debug                       enable debug mode
      --dns-server string           DNS server to use (only effective on linux arm) (default "1.1.1.1")
  -h, --help                        help for dero-stratum-miner
      --ignore-tls-validation       ignore TLS validation
  -m, --mining-threads int          number of threads to use (default 32)
      --non-interactive             non-interactive mode
  -t, --testnet                     use testnet
  -v, --version                     version for dero-stratum-miner
  -w, --wallet-address string       wallet of the miner. Rewards will be sent to this address

Use "dero-stratum-miner [command] --help" for more information about a command.

🆘 Support

If you want to report a bug, please open an issue on github.
For general support please join our telegram group or discord server.