# Public Pool Directory

`pool.bitflash.network` should be a public directory, not a network dependency.
Nodes discover pools through Nostr and `.btf`; the website only helps humans
compare operators.

Operators can publish the `pool_status.json` and `pool_rounds.json` files
produced by:

```bash
bitflash -nogui -gen -operator \
  -poolstatusfile=/var/www/pool_status.json \
  -poolroundsfile=/var/www/pool_rounds.json
```

Build a static directory from one or more status files:

```bash
python3 scripts/build-pool-index.py --out-dir public/pool \
  https://operator-one.example/pool_status.json \
  https://operator-two.example/pool_status.json
```

The generated output contains:

- `index.html`: human-readable ranking page.
- `pools.json`: machine-readable API for `api.bitflash.network/pools.json`.

The website is a convenience layer, not a consensus or discovery dependency.
Nodes discover pools through Nostr descriptors and `.btf`; a missing website
must not stop mining or pool operation.

When a source is an HTTP(S) `pool_status.json`, the directory links to a
`pool_rounds.json` proof file next to it. That file records the block height,
block hash, coinbase txid, coinbase value, pool fee, total shares, per-address
share counts, computed payouts, and payout txids once paid.

Ranking order is intentionally simple:

1. online pools first;
2. higher reported hashrate;
3. more authorized miners;
4. lower fee;
5. name as a stable tie-breaker.

An entry is considered online when the source says the pool is running and its
status file is no more than 120 seconds old.

## Recommended Hostnames

Use:

```text
pool.bitflash.network        human-readable pool directory
api.bitflash.network/pools.json
status.bitflash.network      relay/node health, not pool ranking
docs.bitflash.network        operator setup guide
```

The GUI may use the API as a shortcut for humans, but it should keep the
existing decentralized pool discovery path as the source of truth.