Updated SRBminer and Hive integration documentation

README.md

@@ -32,7 +32,7 @@ Shares-based work allocation with miner-like periodic stat output:
  lemois         |       0.13GH/s |          3/0/0 |            0 |       6m48s
 -------------------------------------------------------------------------------
                 |       0.13GH/s |          3/0/0 |            0 |       7m20s
-========================================================= kls_bridge_v1.0.0 ===
+========================================================= kls_bridge_v1.1.0 ===
 ```
 
 ## Variable difficulty engine (vardiff)

docs/hive-setup.md

@@ -1,54 +1,66 @@
 # Hive configuration
-## Local bridge (1 bridge per miner)
-This assumes that you will be running the kls_bridge on the mining computer. I've provided 2 template flight sheets that can be imported to jumpstart the config process 
 
----
+## Local bridge (1 birdge per miner)
 
-I'll be using bzminer here, so I'm focusing on the file [here](misc/hive-templates/kls_bz_local_adapter.json). Hive gives the option to import from a file or from your clipboard; I'll be copying directly from the clipboard in this example. 
+This assumes that you will be running the `kls_bridge` on the mining
+computer and have configured already a Karlsen wallet in Hive. I've
+provided one template flight sheet that can be imported to jumpstart
+the config process.
 
-Navigate to the template that you want and hit the 'copy file contents' button
+I'll be using SRBminer here, so I'm focusing on the file [here](../misc/hive-templates/kls_srb_local_adapter.json)
+Hive gives the option to import from a file, so please navigate to the
+template that you want and hit the 'Download raw file' button.
 
-![image](https://user-images.githubusercontent.com/59971111/191894038-4435237f-d68e-4248-bb44-60e968319ad3.png)
+Now go to Hive, create a new flight sheet, and click the 'Import from
+File' button.
 
-This will load the contents of the file in your clipboard. Now go to hive, create a new flight sheet, and click the import from clipboard button
+[Hive Setup 1](images/hive-1.png)
 
-![image](https://user-images.githubusercontent.com/59971111/191893779-01ebdceb-da8d-455e-9e87-389685a59cc1.png)
+Once the import happens you'll be presented with a flightsheet filled
+with angry little red boxes like below.
 
-Once the import happens you'll be presented with a flightsheet filled with angry little red boxes like below.
+[Hive Setup 2](images/hive-2.png)
 
-![image](https://user-images.githubusercontent.com/59971111/191894254-4b27961c-5b08-4f9a-af20-2b04922ae2f4.png)
+Set the 'Coin' and 'Wallet' for both miners in the flight sheet, and
+choose 'Configure in miner' for the 'Pool'. Strangly you cannot edit
+the miner configs until you touch the pool config, so re-set it to
+'Configure in miner' if the UI is being weird.
 
- Set the coin & wallet for both miners in the flight sheet, and choose 'Configure in miner' for the pool. Strangly you cannot edit the miner configs until you touch the pool config, so re-set it to 'Configure in miner' if the UI is being weird. 
-
-At this point the flight sheet should be happy:
-![image](https://user-images.githubusercontent.com/59971111/191894518-0b02dacf-9904-4f53-81de-5bb952568146.png)
+[Hive Setup 3](images/hive-3.png)
 
-Last step, you just need to edit the custom miner section with the address of the karlsen node you're mining to. This needs the full ip/port so it'll look similar to `192.168.0.12:42110` save the changes after you're finished
+Last step, you just need to edit the custom miner section with the
+address of the `karlsend` node you're mining to. This needs the full
+ip address and port so it'll look similar to `192.168.0.12:42110`
+save the changes after you're finished.
 
-![image](https://user-images.githubusercontent.com/59971111/191894833-98eabaa2-2210-4ac5-a974-8ad94573a4e5.png)
+[Hive Setup 4](images/hive-4.png)
 
+You should be good to create the flight sheet now. However, you
+should verify the configurations in both miners before you run it.
+Never run something blindly off the internet. :) This is what the
+configuration generally should look like.
 
-You should be good to create the flight sheet now. However, you should verify the configurations in both miners before you run it. Never run something blindly off the internet :)
-
-This is what the configuration generally should look like
-
-![image](https://user-images.githubusercontent.com/59971111/191895060-79033098-4303-496d-b5dd-d4cabcc88946.png)
-
-The important parts are the 'Install URL' (make sure that points back to this repo somewhere) and double check that your wallet address is set correctly. 
-
-You can verify that the bridge is working by either feching miner logs, or checking on the main miner--if it's mining then the bridge is working!
+[Hive Setup 5](images/hive-5.png)
 
+The important parts are the 'Install URL' (make sure that points back
+to this repo somewhere) and double check that your wallet address is
+set correctly.
 
+You can verify that the bridge is working by either feching miner logs,
+or checking on the main miner -- if it's mining then the bridge is
+working!
 
 ## Remote bridge (1 bridge for N miners)
-This is the preferred configuration as it's a bit easier to setup and the bridge can easily handle multiple miners.
-
-Ideally you'd run the bridge on the same machine that your karlsend node is running on. You can follow any of the installation methods defined in the main readme of the repo.
-
-Once the bridge is running, miners can be configured simply by replacing the pool URL with the ip:port of the bridge. In the example below the bridge is running on `192.168.0.25:5555`
-
-![image](https://user-images.githubusercontent.com/59971111/191895463-974c75eb-b31f-4196-a0ac-2f0a689fe829.png)
 
+This is the preferred configuration as it's a bit easier to setup and
+the bridge can easily handle multiple miners.
 
+Ideally you'd run the bridge on the same machine that your `karlsend`
+node is running on. You can follow any of the installation methods
+defined in the main readme of the repo.
 
+Once the bridge is running, miners can be configured simply by replacing
+the pool URL with the ip:port of the bridge. In the example below the
+bridge is running on `192.168.0.25:5555`
 
+[Hive Setup 6](images/hive-6.png)

misc/hive-templates/kls_srb_local_adapter.json

@@ -1,4 +1,5 @@
 {
+    "name": "kls_srb_local_adapter",
     "isFavorite": false,
     "items": [
         {
@@ -8,8 +9,9 @@
             "miner": "srbminer",
             "miner_config": {
                 "url": "127.0.0.1:5555",
-                "algo": "karlsen",
+                "algo": "karlsenhash",
                 "worker": "%WORKER_NAME%",
+                "template": "%WAL%",
                 "user_config": "--disable-cpu"
             },
             "pool_geo": []
@@ -24,7 +26,7 @@
                 "url": "YOUR_KARLSEND_NODE_IP_HERE:42110",
                 "miner": "kls_bridge",
                 "template": "doesnt.matter",
-                "install_url": "https://github.com/karlsen-network/karlsen-stratum-bridge/releases/download/v1.0.0/kls_bridge-1.0.0_hive.tar.gz"
+                "install_url": "https://github.com/karlsen-network/karlsen-stratum-bridge/releases/download/v1.1.0/kls_bridge-1.1.0_hive.tar.gz"
             },
             "pool_geo": []
         }