Kevacoin stratum server for solo-mining
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
JustWonder a32423b64f
Update README.md
6 years ago
.circleci
.github
.vscode
cnutil Updated README.md for Windows build instructions. 6 years ago
pool
rpc
stratum No miner address checking for keva. 6 years ago
util
www
.gitignore Updated README.md for Windows build instructions. 6 years ago
CMakeLists.txt
LICENSE
README.md Update README.md 6 years ago
config.example.json
config_keva.json
config_monero.json
main.go

README.md

keva-stratum

High performance CryptoNote mining stratum with Web-interface written in Golang. This project is forked from monero-stratum, with the support for Kevacoin. It includes the part of Monero source code that is required for build and therefore does not need an external Monero source tree. It also builds on Windows through MSYS2.

Go Report Card

Stratum feature list:

  • Be your own pool
  • Rigs availability monitoring
  • Keep track of accepts, rejects, blocks stats
  • Easy detection of sick rigs
  • Daemon failover list
  • Concurrent shares processing
  • Beautiful Web-interface

Installation

Dependencies:

  • go-1.6
  • Everything required to build Monero or Kevacoin. Follow their build instructions to install the dependencies for your system.

Linux

Use Ubuntu 16.04 LTS or 18.04 LTS.

Install Golang and required packages:

sudo apt-get install golang
go get "github.com/goji/httpauth"
go get "github.com/gorilla/mux"
go get "github.com/yvasiyarov/gorelic"

Clone stratum:

git clone https://github.com/kevacoin-project/keva-stratum.git
cd keva-stratum

Build stratum:

cmake .
make

Mac OS X

Install Golang and required packages:

brew update && brew install go
go get "github.com/goji/httpauth"
go get "github.com/gorilla/mux"
go get "github.com/yvasiyarov/gorelic"

Clone stratum:

git clone https://github.com/kevacoin-project/keva-stratum.git
cd keva-stratum

Build stratum:

cmake .
make

Windows

Just like Monero, keva-stratum can be built on Windows using the MinGW toolchain within MSYS2 environment.

  • Download and install the MSYS2 installer, either the 64-bit or the 32-bit package, depending on your system.

  • Open the MSYS shell via the application mingw32 (for 32-bit Windows) or mingw64 (for 64-bit windows).

  • Update packages using pacman:

      pacman -Syu
    
  • Install dependencies:

    To build for 64-bit Windows:

    pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium mingw-w64-x86_64-hidapi
    

    To build for 32-bit Windows:

    pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost mingw-w64-i686-openssl mingw-w64-i686-zeromq mingw-w64-i686-libsodium mingw-w64-i686-hidapi
    

    Install Golang:

    pacman -S mingw-w64-x86_64-go
    go get "github.com/goji/httpauth"
    go get "github.com/gorilla/mux"
    go get "github.com/yvasiyarov/gorelic"
    

Clone stratum:

git clone https://github.com/kevacoin-project/keva-stratum.git
cd keva-stratum

Build stratum:

cmake -G "MSYS Makefiles" .

IMPORTANT: STOP AND CHECK

Check the output of cmake and make sure it finds the OpenSSL library, and the library is inside your MSYS2 directory. e.g. the output should be something like this:

-- Found OpenSSL: C:/msys64/mingw64/lib/libcrypto.dll.a (found version "1.1.1b")

If the OpenSSL is not inside your MSYS2 directory, cmake is not using the correct OpenSSL library. e.g.

-- Found OpenSSL: C:/OpenSSL-Win64/lib/libeay32.lib (found version "1.0.1a")

In the above case, you need to adjust the search path so that cmake uses the correct library.

Now we are ready to build:

make
cp cnutil/libcnutil.dll .

Running Stratum

./keva-stratum config.json

If you need to bind to privileged ports and don't want to run from root:

sudo apt-get install libcap2-bin
sudo setcap 'cap_net_bind_service=+ep' /path/to/keva-stratum

Configuration

Configuration is self-describing, just copy config.example.json to config.json and run stratum with path to config file as 1st argument.

{
  // Address for block rewards
  "address": "YOUR-ADDRESS-NOT-EXCHANGE",
  // Don't validate address
  "bypassAddressValidation": true,
  // Don't validate shares
  "bypassShareValidation": true,

  "threads": 2,

  "estimationWindow": "15m",
  "luckWindow": "24h",
  "largeLuckWindow": "72h",

  // Interval to poll daemon for new jobs
  "blockRefreshInterval": "1s",

  "stratum": {
    // Socket timeout
    "timeout": "15m",

    "listen": [
      {
        "host": "0.0.0.0",
        "port": 1111,
        "diff": 5000,
        "maxConn": 32768
      },
      {
        "host": "0.0.0.0",
        "port": 3333,
        "diff": 10000,
        "maxConn": 32768
      }
    ]
  },

  "frontend": {
    "enabled": true,
    "listen": "0.0.0.0:8082",
    "login": "admin",
    "password": "",
    "hideIP": false
  },

  "upstreamCheckInterval": "5s",

  "upstream": [
    {
      "name": "Main",
      "host": "127.0.0.1",
      "port": 18081,
      "timeout": "10s"
    }
  ]
}

You must use anything.WorkerID as username in your miner. Either disable address validation or use <address>.WorkerID as username. If there is no workerID specified your rig stats will be merged under 0 worker. If mining software contains dev fee rounds its stats will usually appear under 0 worker. This stratum acts like your own pool, the only exception is that you will get rewarded only after block found, shares only used for stats.

License

Released under the GNU General Public License v2.

http://www.gnu.org/licenses/gpl-2.0.html