@@ -5,7 +5,8 @@ A standalone, high-performance Stratum mining-pool server written in Go.
55It started as a pool for ** Bitcoin Core (` bitcoind ` ) variants** — any coin whose
66proof-of-work is a hash of the standard 80-byte block header — and now also ships
77** pluggable mining engines** for coins with entirely different mining models
8- (Ethash, RandomX, KawPow, kHeavyHash, Equihash, Autolykos2, BeamHash III, Blake3).
8+ (Ethash, RandomX, KawPow, kHeavyHash, Equihash, Autolykos2, BeamHash III, Blake3,
9+ Poseidon2).
910
1011> Docs: [ Tutorial] ( TUTORIAL.md ) · [ Pluggable engines] ( docs/PLUGGABLE_ENGINES.md ) ·
1112> [ End-to-end testing] ( docs/E2E.md )
@@ -33,7 +34,7 @@ Built-in algorithms: `sha256`, `sha256d`, `scrypt`, `x11`, `keccak`, `groestl`,
3334` algorithm.RegisterHash ` — see the [ tutorial] ( TUTORIAL_zh.md ) . Ready-to-use coin
3435templates live in [ ` coins/ ` ] ( coins/ ) .
3536
36- ### Pluggable engines (opt-in via build tags)
37+ ### Pluggable engines
3738
3839For coins whose block structure, PoW verification and Stratum dialect differ from
3940Bitcoin, a pluggable ` engine.Engine ` reuses everything except node interaction
@@ -47,6 +48,7 @@ Bitcoin, a pluggable `engine.Engine` reuses everything except node interaction
4748| ` ergo ` | Ergo (Autolykos2) | * (default)* | pure Go (powkit + REST) |
4849| ` beam ` | Beam (BeamHash III) | * (default)* | pure Go; TLS-JSON client transport |
4950| ` alephium ` | Alephium (Blake3) | * (default)* | pure Go; binary protocol, multi-chain |
51+ | ` quantus ` | Quantus (QTC / Poseidon2) | * (default)* | QUIC + LuckyPool TCP/TLS; fixed difficulty; finalized PROP/SOLO payouts |
5052| ` ethash ` | Ethereum Classic … | ` -tags ethash ` | go-etchash + go-ethereum |
5153| ` randomx ` | Monero (CryptoNote) | ` -tags randomx ` | cgo; prebuilt lib in go-randomx |
5254| ` kaspa ` | Kaspa (kHeavyHash) | ` -tags kaspa ` | kaspad gRPC + consensus |
@@ -72,24 +74,56 @@ Copy `config.example.json` to `config.json`, edit the `daemons`, `poolAddress`,
7274` ports ` and ` storage ` (Redis) sections, then:
7375
7476``` bash
75- ./not-only-mining-pool -c config.json
77+ ./nomp -c config.json
7678```
7779
7880Engine coins add an ` "engine" ` field (e.g. ` "engine": "ethash" ` ); GBT coins omit
7981it (or use ` "gbt" ` ). Per-engine example configs live under ` engine/<name>/ ` .
8082
83+ For Quantus, see the [ configuration and miner instructions] ( engine/quantus/README.md ) .
84+ It supports the official miner and SRBMiner-Multi through native QUIC and
85+ LuckyPool Quantus Stratum over TCP/TLS.
86+
87+ ### Quantus mining and payments
88+
89+ Start with [ ` config.quantus.example.json ` ] ( engine/quantus/config.quantus.example.json ) .
90+ Configure the node's miner endpoint, authentication token and certificate pin,
91+ the pool's TLS certificate, and Redis. Mining is included in the default Go build;
92+ ports use fixed integer share difficulty.
93+
94+ Optional ** PROP/SOLO payments** settle finalized mining rewards in exact base
95+ units (1 QTC = 10^12 units). Signed transactions are persisted before broadcast,
96+ and finalized receipts prevent duplicate debits after a restart. ` GET /payments `
97+ exposes balances, pending transaction hashes and finalized receipts.
98+
99+ Payments require the [ signing bridge setup] ( engine/quantus/README.md#自动支付 )
100+ (Node.js 20+, Rust and the official Quantus signing library), a dedicated funded
101+ hot wallet, and Redis with ` appendonly yes ` and ` appendfsync always ` .
102+ Wormhole mining rewards must still be collected with the official Quantus CLI;
103+ automatic wormhole collection and Quantus PPS/PPLNS are not implemented.
104+
81105## Testing
82106
83107- ** Unit tests** (hermetic): ` go test -short ./... ` , and with every engine tag:
84108 ` CGO_ENABLED=1 go test -short -tags "neoscrypt ethash randomx kaspa kawpow" ./... `
85109- ** End-to-end** (real nodes, regtest/simnet): a reproducible Docker suite mines a
86110 real block for every coin. All 10 coins pass in CI. See
87111 [ docs/E2E.md] ( docs/E2E.md ) .
112+ - ** Quantus development-chain E2E** (separate local runner): tested with
113+ quantus-node 1.0.1 and the official quantus-miner 4.2.0 CPU engine. The run
114+ confirmed ** 128 pool blocks** , paid ** 1.23 QTC** , and recovered an unconfirmed
115+ transaction after a pool crash without a duplicate debit. See the
116+ [ validation report] ( docs/QUANTUS_E2E.md ) . SRBMiner GPU binaries and production
117+ throughput have not been tested.
88118
89119``` bash
90120docker build -t nomp-e2e -f scripts/e2e/Dockerfile .
91121docker run --rm nomp-e2e # every coin
92122docker run --rm nomp-e2e BTC XMR # a subset
123+
124+ # Quantus, after installing its signing bridge and node/miner binaries
125+ python3 scripts/e2e/quantus.py \
126+ --node /path/to/quantus-node --miner /path/to/quantus-miner
93127```
94128
95129## Continuous integration
@@ -111,10 +145,11 @@ every push and PR:
111145| Pluggable engines (architecture + status) | [ docs/PLUGGABLE_ENGINES.md] ( docs/PLUGGABLE_ENGINES.md ) | [ docs/PLUGGABLE_ENGINES_zh.md] ( docs/PLUGGABLE_ENGINES_zh.md ) |
112146| End-to-end testing | [ docs/E2E.md] ( docs/E2E.md ) | [ docs/E2E_zh.md] ( docs/E2E_zh.md ) |
113147
148+ Quantus: [ setup and payment configuration] ( engine/quantus/README.md ) ·
149+ [ development-chain test report] ( docs/QUANTUS_E2E.md ) .
150+
114151## TODO
115152
116- - Engine-mode share persistence to Redis (block submission already works; this is
117- for stats/payments — see the TODO in ` stratum/engine.go ` )
118153- More algorithms
119154- Web front-end
120155
0 commit comments