upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/pool-directory.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/pool-directory.md b/docs/pool-directory.md
index 6456084..76269b9 100644
--- a/docs/pool-directory.md
+++ b/docs/pool-directory.md
@@ -4,10 +4,13 @@
4Nodes discover pools through Nostr and `.btf`; the website only helps humans 4Nodes discover pools through Nostr and `.btf`; the website only helps humans
5compare operators. 5compare operators.
6 6
7Operators can publish the `pool_status.json` file produced by: 7Operators can publish the `pool_status.json` and `pool_rounds.json` files
8produced by:
8 9
9```bash 10```bash
10bitflash -nogui -gen -operator -poolstatusfile=/var/www/pool_status.json 11bitflash -nogui -gen -operator \
12 -poolstatusfile=/var/www/pool_status.json \
13 -poolroundsfile=/var/www/pool_rounds.json
11``` 14```
12 15
13Build a static directory from one or more status files: 16Build a static directory from one or more status files:
@@ -23,6 +26,11 @@ The generated output contains:
23- `index.html`: human-readable ranking page. 26- `index.html`: human-readable ranking page.
24- `pools.json`: machine-readable API for `api.bitflash.network/pools.json`. 27- `pools.json`: machine-readable API for `api.bitflash.network/pools.json`.
25 28
29When a source is an HTTP(S) `pool_status.json`, the directory links to a
30`pool_rounds.json` proof file next to it. That file records the block height,
31block hash, coinbase txid, coinbase value, pool fee, total shares, per-address
32share counts, computed payouts, and payout txids once paid.
33
26Ranking order is intentionally simple: 34Ranking order is intentionally simple:
27 35
281. online pools first; 361. online pools first;