diff options
| author | Nsable-sh <nsable-sh@noreply.git.bitflash.network> | 2026-08-12 11:58:03 -0300 |
|---|---|---|
| committer | Nsable-sh <nsable-sh@noreply.git.bitflash.network> | 2026-08-12 11:58:03 -0300 |
| commit | b0ed2ce585d2a6fd7c6d8d4db7422734aedccb58 (patch) | |
| tree | 509f8424e4fed7eb00a1fa3294a26da70eb5e7ef /README.md | |
| parent | bc3de301d9ed0e5fb5e2034be2e066d77cf23804 (diff) | |
site: document public deployment contract
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
| @@ -38,6 +38,8 @@ Worth being precise, because the difference matters if you are relying on it. | |||
| 38 | 38 | ||
| 39 | This is unlinkability between peers, not anonymity against a network observer. | 39 | This is unlinkability between peers, not anonymity against a network observer. |
| 40 | For Tor routing, start the node with `-tor`; see [Tor mode](docs/tor.md). | 40 | For Tor routing, start the node with `-tor`; see [Tor mode](docs/tor.md). |
| 41 | For a plain SOCKS5 proxy without Tor-specific defaults, use | ||
| 42 | `-socks=HOST:PORT`. | ||
| 41 | 43 | ||
| 42 | --- | 44 | --- |
| 43 | 45 | ||
| @@ -74,6 +76,14 @@ scripts/verify-release.sh latest | |||
| 74 | See [release verification](docs/release-verification.md) for the full release | 76 | See [release verification](docs/release-verification.md) for the full release |
| 75 | audit flow and the maintainer signing step. | 77 | audit flow and the maintainer signing step. |
| 76 | 78 | ||
| 79 | Public mirrors should make the latest checksum files available both under the | ||
| 80 | versioned release directory and at the release root: | ||
| 81 | |||
| 82 | ```text | ||
| 83 | https://releases.bitflash.network/v1.2.18/SHA256SUMS | ||
| 84 | https://releases.bitflash.network/SHA256SUMS # alias to latest | ||
| 85 | ``` | ||
| 86 | |||
| 77 | Bitflash also ships a deterministic UTXO-set commitment tool: | 87 | Bitflash also ships a deterministic UTXO-set commitment tool: |
| 78 | 88 | ||
| 79 | ```bash | 89 | ```bash |
| @@ -113,6 +123,12 @@ python3 scripts/build-explorer.py --datadir ~/.bitflash ./explorer-out | |||
| 113 | python3 scripts/build-explorer.py ~/.bitflash/blk0001.dat ~/.bitflash/blk0002.dat ./explorer-out | 123 | python3 scripts/build-explorer.py ~/.bitflash/blk0001.dat ~/.bitflash/blk0002.dat ./explorer-out |
| 114 | ``` | 124 | ``` |
| 115 | 125 | ||
| 126 | The generated explorer is static and self-contained: `index.html`, | ||
| 127 | `style.css`, `explorer.js`, `blocks.json`, `block/*.json`, and `logo.png`. It is | ||
| 128 | safe to host behind a strict policy such as `default-src 'none'; img-src 'self'; | ||
| 129 | style-src 'self'; script-src 'self'; connect-src 'self'; base-uri 'none'; | ||
| 130 | form-action 'none'`. | ||
| 131 | |||
| 116 | **Keep your node current.** Consensus rules have changed since the first | 132 | **Keep your node current.** Consensus rules have changed since the first |
| 117 | releases — 1.2.1 fixed a bug that let anyone spend anyone's coins, and 1.2.2 | 133 | releases — 1.2.1 fixed a bug that let anyone spend anyone's coins, and 1.2.2 |
| 118 | added a per-block signature-operation cap. A node on an older build will accept | 134 | added a per-block signature-operation cap. A node on an older build will accept |
| @@ -265,6 +281,7 @@ default both are created in the data directory; use `-poolstatusfile=PATH` and | |||
| 265 | `-poolroundsfile=PATH` to write them somewhere a dashboard or web sync can read. | 281 | `-poolroundsfile=PATH` to write them somewhere a dashboard or web sync can read. |
| 266 | The files are informational only: nodes still discover pools through Nostr and | 282 | The files are informational only: nodes still discover pools through Nostr and |
| 267 | `.btf`, not through any web domain. | 283 | `.btf`, not through any web domain. |
| 284 | See [public pool directory](docs/pool-directory.md) for the website/API shape. | ||
| 268 | 285 | ||
| 269 | **Participant** — mine to someone else's pool. Enter or select the pool's `.btf` address and enable Start Mining. | 286 | **Participant** — mine to someone else's pool. Enter or select the pool's `.btf` address and enable Start Mining. |
| 270 | 287 | ||