diff options
Diffstat (limited to 'docs/pool-directory.md')
| -rw-r--r-- | docs/pool-directory.md | 18 |
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 | ||
| 29 | The website is a convenience layer, not a consensus or discovery dependency. | ||
| 30 | Nodes discover pools through Nostr descriptors and `.btf`; a missing website | ||
| 31 | must not stop mining or pool operation. | ||
| 32 | |||
| 29 | When a source is an HTTP(S) `pool_status.json`, the directory links to a | 33 | When 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, |
| 31 | block hash, coinbase txid, coinbase value, pool fee, total shares, per-address | 35 | block hash, coinbase txid, coinbase value, pool fee, total shares, per-address |
| @@ -41,3 +45,17 @@ Ranking order is intentionally simple: | |||
| 41 | 45 | ||
| 42 | An entry is considered online when the source says the pool is running and its | 46 | An entry is considered online when the source says the pool is running and its |
| 43 | status file is no more than 120 seconds old. | 47 | status file is no more than 120 seconds old. |
| 48 | |||
| 49 | ## Recommended Hostnames | ||
| 50 | |||
| 51 | Use: | ||
| 52 | |||
| 53 | ```text | ||
| 54 | pool.bitflash.network human-readable pool directory | ||
| 55 | api.bitflash.network/pools.json | ||
| 56 | status.bitflash.network relay/node health, not pool ranking | ||
| 57 | docs.bitflash.network operator setup guide | ||
| 58 | ``` | ||
| 59 | |||
| 60 | The GUI may use the API as a shortcut for humans, but it should keep the | ||
| 61 | existing decentralized pool discovery path as the source of truth. | ||