Merge pull request #19 from Leon1777/solo

[Feat]: Add solo mining config

.github/workflows/publish.yaml

@@ -28,7 +28,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: 1.21
+          go-version: 1.23.1
 
       - name: Update sources
         if: matrix.TARGET == 'linux/aarch64' || matrix.TARGET == 'windows/x64'

README.md

@@ -34,7 +34,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_v2.1.0 ===
+========================================================= kls_bridge_v2.2.0 ===
 ```
 
 ## Variable difficulty engine (vardiff)

cmd/karlsenbridge/config.yaml

@@ -14,6 +14,9 @@ karlsend_address: localhost:42110
 # prefix handling for testnet addresses is applied
 testnet_mining: false
 
+# solo_mining: if true, use network difficulty instead of stratum variable difficulty (vardiff)
+solo_mining: false
+
 # min_share_diff: only accept shares of the specified difficulty (or higher)
 # from the miner(s). Higher values will reduce the number of shares submitted,
 # thereby reducing network traffic and server load, while lower values will

cmd/karlsenbridge/main.go

@@ -34,6 +34,7 @@ func main() {
 	flag.BoolVar(&cfg.VarDiff, "vardiff", cfg.VarDiff, "true to enable auto-adjusting variable min diff, default `true`")
 	flag.UintVar(&cfg.SharesPerMin, "sharespermin", cfg.SharesPerMin, "number of shares per minute the vardiff engine should target, default `15`")
 	flag.BoolVar(&cfg.VarDiffStats, "vardiffstats", cfg.VarDiffStats, "include vardiff stats readout every 10s in log, default `false`")
+	flag.BoolVar(&cfg.SoloMining, "solo", cfg.SoloMining, "set to true to use network difficulty instead of stratum variable difficulty (vardiff)")
 	flag.UintVar(&cfg.ExtranonceSize, "extranonce", cfg.ExtranonceSize, "size in bytes of extranonce, default `0`")
 	flag.StringVar(&cfg.PromPort, "prom", cfg.PromPort, "address to serve prom stats, default `:2112`")
 	flag.BoolVar(&cfg.UseLogFile, "log", cfg.UseLogFile, "if true will output errors to log file, default `true`")
@@ -50,6 +51,7 @@ func main() {
 	log.Printf("\tlog:             %t", cfg.UseLogFile)
 	log.Printf("\tmin diff:        %d", cfg.MinShareDiff)
 	log.Printf("\tvar diff:        %t", cfg.VarDiff)
+	log.Printf("\tsolo mining:  	 %t", cfg.SoloMining)
 	log.Printf("\tshares per min:  %d", cfg.SharesPerMin)
 	log.Printf("\tvar diff stats:  %t", cfg.VarDiffStats)
 	log.Printf("\tblock wait:      %s", cfg.BlockWaitTime)

misc/hive-templates/kls_srb_local_adapter.json

@@ -26,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/v2.1.0/kls_bridge-v2.1.0_hive.tar.gz"
+                "install_url": "https://github.com/karlsen-network/karlsen-stratum-bridge/releases/download/v2.2.0/kls_bridge-v2.2.0_hive.tar.gz"
             },
             "pool_geo": []
         }

src/karlsenstratum/client_handler.go

@@ -83,7 +83,7 @@ func (c *clientListener) OnDisconnect(ctx *gostratum.StratumContext) {
 	RecordDisconnect(ctx)
 }
 
-func (c *clientListener) NewBlockAvailable(kapi *KarlsenApi) {
+func (c *clientListener) NewBlockAvailable(kapi *KarlsenApi, soloMining bool) {
 	c.clientLock.Lock()
 	addresses := make([]string, 0, len(c.clients))
 	for _, cl := range c.clients {
@@ -128,14 +128,23 @@ func (c *clientListener) NewBlockAvailable(kapi *KarlsenApi) {
 				// first pass through send config/default difficulty
 				state.stratumDiff = newKarlsenDiff()
 				state.stratumDiff.setDiffValue(c.minShareDiff)
-				sendClientDiff(client, state)
+				if !soloMining {
+					sendClientDiff(client, state)
+				}
 				c.shareHandler.setClientVardiff(client, c.minShareDiff)
 			}
 
-			varDiff := c.shareHandler.getClientVardiff(client)
+			varDiff := TargetToDiff(&state.bigDiff)
+			c.shareHandler.setSoloDiff(varDiff)
+			if !soloMining {
+				varDiff = c.shareHandler.getClientVardiff(client)
+			}
+
 			if varDiff != state.stratumDiff.diffValue {
 				// send updated vardiff
-				client.Logger.Info(fmt.Sprintf("changing diff from %f to %f", state.stratumDiff.diffValue, varDiff))
+				if !soloMining {
+					client.Logger.Info(fmt.Sprintf("changing diff from %f to %f", state.stratumDiff.diffValue, varDiff))
+				}
 				state.stratumDiff.setDiffValue(varDiff)
 				sendClientDiff(client, state)
 				c.shareHandler.startClientVardiff(client)

src/karlsenstratum/hasher.go

@@ -46,6 +46,14 @@ func DiffToTarget(diff float64) *big.Int {
 	return t
 }
 
+func TargetToDiff(target *big.Int) float64 {
+	targetFloat := new(big.Float).SetInt(target)
+	diff := new(big.Float).Quo(maxTarget, targetFloat)
+
+	diffFloat, _ := diff.Float64()
+	return diffFloat
+}
+
 func DiffToHash(diff float64) float64 {
 	hashVal := new(big.Float).Mul(minHash, big.NewFloat(diff))
 	hashVal.Quo(hashVal, bigGig)

src/karlsenstratum/share_handler.go

@@ -40,6 +40,7 @@ type WorkStats struct {
 
 type shareHandler struct {
 	karlsen      *rpcclient.RPCClient
+	soloDiff     float64
 	stats        map[string]*WorkStats
 	statsLock    sync.Mutex
 	overall      WorkStats
@@ -150,7 +151,11 @@ func (sh *shareHandler) checkStales(ctx *gostratum.StratumContext, si *submitInf
 	return nil
 }
 
-func (sh *shareHandler) HandleSubmit(ctx *gostratum.StratumContext, event gostratum.JsonRpcEvent) error {
+func (sh *shareHandler) setSoloDiff(diff float64) {
+	sh.soloDiff = diff
+}
+
+func (sh *shareHandler) HandleSubmit(ctx *gostratum.StratumContext, event gostratum.JsonRpcEvent, soloMining bool) error {
 	submitInfo, err := validateSubmit(ctx, event)
 	if err != nil {
 		return err
@@ -213,7 +218,11 @@ func (sh *shareHandler) HandleSubmit(ctx *gostratum.StratumContext, event gostra
 			return err
 		}
 	} else if powValue.Cmp(state.stratumDiff.targetValue) >= 0 {
-		ctx.Logger.Warn("weak block")
+		if soloMining {
+			ctx.Logger.Warn("weak block")
+		} else {
+			ctx.Logger.Warn("weak share")
+		}
 		RecordWeakShare(ctx)
 		return ctx.ReplyLowDiffShare(event.Id)
 	}
@@ -303,8 +312,10 @@ func (sh *shareHandler) startStatsThread() error {
 		rateStr := stringifyHashrate(totalRate)
 		ratioStr := fmt.Sprintf("%d/%d/%d", sh.overall.SharesFound.Load(), sh.overall.StaleShares.Load(), sh.overall.InvalidShares.Load())
 		str += "\n-------------------------------------------------------------------------------\n"
-		str += fmt.Sprintf("                | %14.14s | %14.14s | %12d | %11s",
+		str += fmt.Sprintf(" Total          | %14.14s | %14.14s | %12d | %11s",
 			rateStr, ratioStr, sh.overall.BlocksFound.Load(), time.Since(start).Round(time.Second))
+		str += "\n-------------------------------------------------------------------------------\n"
+		str += " Network Hashrate: " + stringifyHashrate(DiffToHash(sh.soloDiff))
 		str += "\n========================================================= kls_bridge_" + version + " ===\n"
 		// sh.statsLock.Unlock()
 		log.Println(str)

src/karlsenstratum/stratum_server.go

@@ -13,7 +13,7 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
-const version = "v2.1.0"
+const version = "v2.2.0"
 const minBlockWaitTime = 3 * time.Second
 
 type BridgeConfig struct {
@@ -23,6 +23,7 @@ type BridgeConfig struct {
 	PrintStats      bool          `yaml:"print_stats"`
 	UseLogFile      bool          `yaml:"log_to_file"`
 	HealthCheckPort string        `yaml:"health_check_port"`
+	SoloMining      bool          `yaml:"solo_mining"`
 	BlockWaitTime   time.Duration `yaml:"block_wait_time"`
 	MinShareDiff    uint          `yaml:"min_share_diff"`
 	VarDiff         bool          `yaml:"var_diff"`
@@ -94,7 +95,7 @@ func ListenAndServe(cfg BridgeConfig) error {
 	// override the submit handler with an actual useful handler
 	handlers[string(gostratum.StratumMethodSubmit)] =
 		func(ctx *gostratum.StratumContext, event gostratum.JsonRpcEvent) error {
-			if err := shareHandler.HandleSubmit(ctx, event); err != nil {
+			if err := shareHandler.HandleSubmit(ctx, event, cfg.SoloMining); err != nil {
 				ctx.Logger.Sugar().Error(err) // sink error
 			}
 			return nil
@@ -111,10 +112,10 @@ func ListenAndServe(cfg BridgeConfig) error {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 	ksApi.Start(ctx, func() {
-		clientHandler.NewBlockAvailable(ksApi)
+		clientHandler.NewBlockAvailable(ksApi, cfg.SoloMining)
 	})
 
-	if cfg.VarDiff {
+	if cfg.VarDiff || cfg.SoloMining {
 		go shareHandler.startVardiffThread(cfg.SharesPerMin, cfg.VarDiffStats)
 	}