Skip to content

Commit 9ed9098

Browse files
committed
docs: document Quantus payouts and development-chain validation
1 parent c596f52 commit 9ed9098

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ A standalone, high-performance Stratum mining-pool server written in Go.
55
It started as a pool for **Bitcoin Core (`bitcoind`) variants** — any coin whose
66
proof-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
3435
templates live in [`coins/`](coins/).
3536

36-
### Pluggable engines (opt-in via build tags)
37+
### Pluggable engines
3738

3839
For coins whose block structure, PoW verification and Stratum dialect differ from
3940
Bitcoin, a pluggable `engine.Engine` reuses everything except node interaction
@@ -73,7 +74,7 @@ Copy `config.example.json` to `config.json`, edit the `daemons`, `poolAddress`,
7374
`ports` and `storage` (Redis) sections, then:
7475

7576
```bash
76-
./not-only-mining-pool -c config.json
77+
./nomp -c config.json
7778
```
7879

7980
Engine coins add an `"engine"` field (e.g. `"engine": "ethash"`); GBT coins omit
@@ -83,18 +84,46 @@ For Quantus, see the [configuration and miner instructions](engine/quantus/READM
8384
It supports the official miner and SRBMiner-Multi through native QUIC and
8485
LuckyPool Quantus Stratum over TCP/TLS.
8586

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+
86105
## Testing
87106

88107
- **Unit tests** (hermetic): `go test -short ./...`, and with every engine tag:
89108
`CGO_ENABLED=1 go test -short -tags "neoscrypt ethash randomx kaspa kawpow" ./...`
90109
- **End-to-end** (real nodes, regtest/simnet): a reproducible Docker suite mines a
91110
real block for every coin. All 10 coins pass in CI. See
92111
[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.
93118

94119
```bash
95120
docker build -t nomp-e2e -f scripts/e2e/Dockerfile .
96121
docker run --rm nomp-e2e # every coin
97122
docker 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
98127
```
99128

100129
## Continuous integration
@@ -116,10 +145,11 @@ every push and PR:
116145
| Pluggable engines (architecture + status) | [docs/PLUGGABLE_ENGINES.md](docs/PLUGGABLE_ENGINES.md) | [docs/PLUGGABLE_ENGINES_zh.md](docs/PLUGGABLE_ENGINES_zh.md) |
117146
| End-to-end testing | [docs/E2E.md](docs/E2E.md) | [docs/E2E_zh.md](docs/E2E_zh.md) |
118147

148+
Quantus: [setup and payment configuration](engine/quantus/README.md) ·
149+
[development-chain test report](docs/QUANTUS_E2E.md).
150+
119151
## TODO
120152

121-
- Engine-mode share persistence to Redis (block submission already works; this is
122-
for stats/payments — see the TODO in `stratum/engine.go`)
123153
- More algorithms
124154
- Web front-end
125155

0 commit comments

Comments
 (0)