upleb.uk

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

summaryrefslogtreecommitdiff
path: root/docs/pool-directory.md
diff options
context:
space:
mode:
authorNsable-sh <nsable-sh@noreply.git.bitflash.network>2026-08-12 11:58:03 -0300
committerNsable-sh <nsable-sh@noreply.git.bitflash.network>2026-08-12 11:58:03 -0300
commitb0ed2ce585d2a6fd7c6d8d4db7422734aedccb58 (patch)
tree509f8424e4fed7eb00a1fa3294a26da70eb5e7ef /docs/pool-directory.md
parentbc3de301d9ed0e5fb5e2034be2e066d77cf23804 (diff)
site: document public deployment contract
Diffstat (limited to 'docs/pool-directory.md')
-rw-r--r--docs/pool-directory.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/pool-directory.md b/docs/pool-directory.md
index 76269b9..ff0640a 100644
--- a/docs/pool-directory.md
+++ b/docs/pool-directory.md
@@ -26,6 +26,10 @@ The generated output contains:
26- `index.html`: human-readable ranking page. 26- `index.html`: human-readable ranking page.
27- `pools.json`: machine-readable API for `api.bitflash.network/pools.json`. 27- `pools.json`: machine-readable API for `api.bitflash.network/pools.json`.
28 28
29The website is a convenience layer, not a consensus or discovery dependency.
30Nodes discover pools through Nostr descriptors and `.btf`; a missing website
31must not stop mining or pool operation.
32
29When a source is an HTTP(S) `pool_status.json`, the directory links to a 33When 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, 34`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 35block hash, coinbase txid, coinbase value, pool fee, total shares, per-address
@@ -41,3 +45,17 @@ Ranking order is intentionally simple:
41 45
42An entry is considered online when the source says the pool is running and its 46An entry is considered online when the source says the pool is running and its
43status file is no more than 120 seconds old. 47status file is no more than 120 seconds old.
48
49## Recommended Hostnames
50
51Use:
52
53```text
54pool.bitflash.network human-readable pool directory
55api.bitflash.network/pools.json
56status.bitflash.network relay/node health, not pool ranking
57docs.bitflash.network operator setup guide
58```
59
60The GUI may use the API as a shortcut for humans, but it should keep the
61existing decentralized pool discovery path as the source of truth.