diff options
| author | Nsable-sh <nsable-sh@noreply.git.bitflash.network> | 2026-08-07 17:14:36 -0300 |
|---|---|---|
| committer | Bitflash <admin@bitflash.network> | 2026-08-07 17:21:08 -0300 |
| commit | b1eb8b66b8d7b47c7fb2e85d5d4db86a11823366 (patch) | |
| tree | 8f0cb17723ce1dc434ae7be7a148f7fec3f977a0 /docs | |
| parent | 060a37de4a1f08ffb5939c8fc47a805c5d0d0024 (diff) | |
pool: publish round proof ledger
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/pool-directory.md | 12 |
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 @@ | |||
| 4 | Nodes discover pools through Nostr and `.btf`; the website only helps humans | 4 | Nodes discover pools through Nostr and `.btf`; the website only helps humans |
| 5 | compare operators. | 5 | compare operators. |
| 6 | 6 | ||
| 7 | Operators can publish the `pool_status.json` file produced by: | 7 | Operators can publish the `pool_status.json` and `pool_rounds.json` files |
| 8 | produced by: | ||
| 8 | 9 | ||
| 9 | ```bash | 10 | ```bash |
| 10 | bitflash -nogui -gen -operator -poolstatusfile=/var/www/pool_status.json | 11 | bitflash -nogui -gen -operator \ |
| 12 | -poolstatusfile=/var/www/pool_status.json \ | ||
| 13 | -poolroundsfile=/var/www/pool_rounds.json | ||
| 11 | ``` | 14 | ``` |
| 12 | 15 | ||
| 13 | Build a static directory from one or more status files: | 16 | Build 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 | ||
| 29 | 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, | ||
| 31 | block hash, coinbase txid, coinbase value, pool fee, total shares, per-address | ||
| 32 | share counts, computed payouts, and payout txids once paid. | ||
| 33 | |||
| 26 | Ranking order is intentionally simple: | 34 | Ranking order is intentionally simple: |
| 27 | 35 | ||
| 28 | 1. online pools first; | 36 | 1. online pools first; |