From bd7d32770bb992044ebc2bf042a3f28a8117f1ba Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 15:02:05 -0500 Subject: [PATCH 1/8] Update README.md --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 20fca82..8a5d9f7 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Dependencies: ### Linux -Use Ubuntu 16.04 LTS or 18.04 LTS. +Use Ubuntu 16.04 LTS or 18.04 LTS, or Ubuntu on Windows Linux Subsystem(WLS). Install Golang and required packages: @@ -65,6 +65,8 @@ Build stratum: ### Windows +If you are using Windows Linux Sytem (WLS), please check the instruction under ### Lunix. + Just like Monero, keva-stratum can be built on Windows using the MinGW toolchain within [MSYS2](https://www.msys2.org/) environment. - Download and install the [MSYS2 installer](https://www.msys2.org/), either the 64-bit or the 32-bit package, depending on your system. @@ -116,7 +118,8 @@ Now we are ready to build: ### Running Stratum - +Is the command exactly the same for linux and windows? + ./keva-stratum config.json If you need to bind to privileged ports and don't want to run from `root`: @@ -124,14 +127,14 @@ 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 (config.json) Configuration is self-describing, just copy *config.example.json* to *config.json* and run stratum with path to config file as 1st argument. ```javascript { // Address for block rewards - "address": "YOUR-ADDRESS-NOT-EXCHANGE", + "address": "YOUR-ADDRESS-NOT-EXCHANGE", --how do user get the address by themselves? // Don't validate address "bypassAddressValidation": true, // Don't validate shares @@ -182,8 +185,8 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso "host": "127.0.0.1", "port": 18081, "timeout": "10s", - "user": "yourusername", - "password": "yourpassword" + "user": "yourusername", #should be the same as kevacoin.config + "password": "yourpassword" #should be the same as kevacoin.config } ] } @@ -191,6 +194,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso The `upstream` is used to point to the Kevacoin daemon `kevacoind`. The `user` and `password` under `upstream` are mandatory, and they must be the same as the ones specified in Kevacoin configuration file `kevacoin.conf`. You must use `anything.WorkerID` as username in your miner. Either disable address validation or use `
.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. +Should we add the URL for https://github.com/xmrig/xmrig/wiki/Ubuntu-Build ### License From 77eb85d972b70947d93d24d95b9c3387e9f3b23c Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 15:03:14 -0500 Subject: [PATCH 2/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a5d9f7..66ee97d 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso ```javascript { // Address for block rewards - "address": "YOUR-ADDRESS-NOT-EXCHANGE", --how do user get the address by themselves? + "address": "YOUR-ADDRESS-NOT-EXCHANGE", --how do users get the address by themselves? // Don't validate address "bypassAddressValidation": true, // Don't validate shares From 740fe9ec3638de35a059b59d95369f0b90f029fb Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 15:09:44 -0500 Subject: [PATCH 3/8] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 66ee97d..cfc8295 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso ```javascript { // Address for block rewards - "address": "YOUR-ADDRESS-NOT-EXCHANGE", --how do users get the address by themselves? + "address": "YOUR-ADDRESS-NOT-EXCHANGE", --The value should be the same as defined in kevacoin.conf.BTW,how do users get the address by themselves? // Don't validate address "bypassAddressValidation": true, // Don't validate shares @@ -185,8 +185,8 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso "host": "127.0.0.1", "port": 18081, "timeout": "10s", - "user": "yourusername", #should be the same as kevacoin.config - "password": "yourpassword" #should be the same as kevacoin.config + "user": "yourusername", #The value should be the same as kevacoin.config + "password": "yourpassword" #The value should be the same as kevacoin.config } ] } @@ -194,7 +194,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso The `upstream` is used to point to the Kevacoin daemon `kevacoind`. The `user` and `password` under `upstream` are mandatory, and they must be the same as the ones specified in Kevacoin configuration file `kevacoin.conf`. You must use `anything.WorkerID` as username in your miner. Either disable address validation or use `
.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. -Should we add the URL for https://github.com/xmrig/xmrig/wiki/Ubuntu-Build +Should we add the URL for https://github.com/xmrig/xmrig/wiki/Ubuntu-Build, and descripe how it works with the keva-stratum? ### License From cd4eaf30f2871cc11e60c1663737efaa3d1fd10a Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 18:12:52 -0500 Subject: [PATCH 4/8] Update README.md --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index cfc8295..20066a1 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,14 @@ Build stratum: cmake .. make +Run 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 + ### Mac OS X Install Golang and required packages: @@ -62,6 +70,13 @@ Build stratum: cmake .. make +Run 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 ### Windows @@ -116,16 +131,8 @@ Now we are ready to build: make - -### Running Stratum -Is the command exactly the same for linux and windows? - - ./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 +Run stratum: + keva-stratum.exe config.json ## Configuration (config.json) @@ -134,7 +141,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso ```javascript { // Address for block rewards - "address": "YOUR-ADDRESS-NOT-EXCHANGE", --The value should be the same as defined in kevacoin.conf.BTW,how do users get the address by themselves? + "address": "YOUR-ADDRESS-NOT-EXCHANGE", --The value should be the same as defined in kevacoin.conf // Don't validate address "bypassAddressValidation": true, // Don't validate shares @@ -194,8 +201,6 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso The `upstream` is used to point to the Kevacoin daemon `kevacoind`. The `user` and `password` under `upstream` are mandatory, and they must be the same as the ones specified in Kevacoin configuration file `kevacoin.conf`. You must use `anything.WorkerID` as username in your miner. Either disable address validation or use `
.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. -Should we add the URL for https://github.com/xmrig/xmrig/wiki/Ubuntu-Build, and descripe how it works with the keva-stratum? - ### License Released under the GNU General Public License v2. From 048b93af74b9447d92290c6763bc808394dbbc7d Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 18:14:46 -0500 Subject: [PATCH 5/8] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 20066a1..fc3c8b8 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,8 @@ Build stratum: make Run stratum: - ./keva-stratum config.json + + ./keva-stratum config.json If you need to bind to privileged ports and don't want to run from `root`: @@ -70,7 +71,8 @@ Build stratum: cmake .. make -Run stratum: +Run stratum: + ./keva-stratum config.json If you need to bind to privileged ports and don't want to run from `root`: @@ -131,7 +133,8 @@ Now we are ready to build: make -Run stratum: +Run stratum: + keva-stratum.exe config.json ## Configuration (config.json) From 576cc1b6bf5d5d89486beb053d1bd25ed2f2880a Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 18:16:54 -0500 Subject: [PATCH 6/8] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fc3c8b8..50101de 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,10 @@ Build stratum: cmake .. make -Run stratum: +Run stratum: - ./keva-stratum config.json + ./keva-stratum config.json + If you need to bind to privileged ports and don't want to run from `root`: @@ -195,8 +196,8 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso "host": "127.0.0.1", "port": 18081, "timeout": "10s", - "user": "yourusername", #The value should be the same as kevacoin.config - "password": "yourpassword" #The value should be the same as kevacoin.config + "user": "yourusername", #The value should be the same as defined in kevacoin.config + "password": "yourpassword" #The value should be the same as defined in kevacoin.config } ] } From dcddc7655ff3bcd5c2edb8ad5277f8f3c4706d74 Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 18:20:05 -0500 Subject: [PATCH 7/8] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50101de..ec7d0bb 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso ```javascript { // Address for block rewards - "address": "YOUR-ADDRESS-NOT-EXCHANGE", --The value should be the same as defined in kevacoin.conf + "address": "YOUR-ADDRESS-NOT-EXCHANGE", //The value should be the same as defined in kevacoin.conf // Don't validate address "bypassAddressValidation": true, // Don't validate shares @@ -196,8 +196,8 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso "host": "127.0.0.1", "port": 18081, "timeout": "10s", - "user": "yourusername", #The value should be the same as defined in kevacoin.config - "password": "yourpassword" #The value should be the same as defined in kevacoin.config + "user": "yourusername", //The value should be the same as defined in kevacoin.config + "password": "yourpassword" //The value should be the same as defined in kevacoin.config } ] } From 85de926dd69e463648d3f1ae5f835640404636cc Mon Sep 17 00:00:00 2001 From: Mike <41298556+mail2mz@users.noreply.github.com> Date: Sun, 24 Nov 2019 18:25:24 -0500 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec7d0bb..b747b52 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso ```javascript { // Address for block rewards - "address": "YOUR-ADDRESS-NOT-EXCHANGE", //The value should be the same as defined in kevacoin.conf + "address": "YOUR-ADDRESS-NOT-EXCHANGE", //Please use 'kevacoin-cli getnewaddress' to get the address // Don't validate address "bypassAddressValidation": true, // Don't validate shares