Skip to content

Commit

Permalink
update LICENSE & README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
x100111010 committed Sep 22, 2024
1 parent 9f68e11 commit 8b30205
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2022 Brandon Smith
Copyright (c) 2024 Spectre Network developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Spectre Stratum Adapter

[![GitHub release](https://img.shields.io/github/v/release/spectre-project/spectre-stratum-bridge.svg)](https://github.com/spectre-project/spectre-stratum-bridge/releases)
[![LICENSE](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/spectre-project/spectre-stratum-bridge/blob/main/LICENSE)
[![GitHub downloads](https://img.shields.io/github/downloads/spectre-project/spectre-stratum-bridge/total.svg)](https://github.com/spectre-project/spectre-stratum-bridge/releases)
[![Join the Spectre Discord Server](https://img.shields.io/discord/1233113243741061240.svg?label=&logo=discord&logoColor=ffffff&color=5865F2)](https://discord.com/invite/FZPYpwszcF)

This is a lightweight daemon that allows mining to a local (or remote)
spectre node using stratum-base miners. It is up to the community to
build a stratum based miner, the original built-in miner is using gRPC
Expand All @@ -13,10 +18,12 @@ Shares-based work allocation with miner-like periodic stat output:
===============================================================================
worker name | avg hashrate | acc/stl/inv | blocks | uptime
-------------------------------------------------------------------------------
ghostface | 4.17KH/s | 3/0/0 | 0 | 21m17s
ghostface | 12.62KH/s | 6/0/0 | 6 | 17h36m38s
-------------------------------------------------------------------------------
Total | 12.62KH/s | 6/0/0 | 6 | 17h36m46s
-------------------------------------------------------------------------------
| 4.17KH/s | 3/0/0 | 0 | 22m31s
======================================================== spr_bridge_v0.3.15 ===
Network Hashrate: 138.40MH/s
======================================================== spr_bridge_v0.3.16 ===
```

## Variable difficulty engine (vardiff)
Expand All @@ -29,6 +36,17 @@ difficulty adjustments, and stable measured hashrates (1hr avg
hashrates within +/- 10% of actual). The minimum share difficulty is 12
and optimized for CPUs mining SpectreX.

## Solo mining mode

`solo_mining`: If set to `true`, stratum's variable difficulty (vardiff)
calculations are bypassed, and network difficulty is used instead.
Over several days, the hashrate will essentially reflect your raw luck, as only
successfully mined blocks impact the hashrate estimates. This makes it a useful
way to gauge luck. `:)`

If you prefer more frequent hashrate updates based on submitted shares, you'll
need to leave `solo_mining` set to `false`.

## Grafana UI

The grafana monitoring UI is an optional component but included for
Expand Down Expand Up @@ -134,6 +152,6 @@ the better alternative.

## Kudos

* https://github.com/KaffinPX/KStratum
* https://github.com/onemorebsmith/kaspa-stratum-bridge
* https://github.com/rdugan/kaspa-stratum-bridge
- https://github.com/KaffinPX/KStratum
- https://github.com/onemorebsmith/kaspa-stratum-bridge
- https://github.com/rdugan/kaspa-stratum-bridge

0 comments on commit 8b30205

Please sign in to comment.