upleb.uk

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

summaryrefslogtreecommitdiff
path: root/README.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 /README.md
parentbc3de301d9ed0e5fb5e2034be2e066d77cf23804 (diff)
site: document public deployment contract
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index ef4f39b..e671302 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,8 @@ Worth being precise, because the difference matters if you are relying on it.
38 38
39This is unlinkability between peers, not anonymity against a network observer. 39This is unlinkability between peers, not anonymity against a network observer.
40For Tor routing, start the node with `-tor`; see [Tor mode](docs/tor.md). 40For Tor routing, start the node with `-tor`; see [Tor mode](docs/tor.md).
41For 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
74See [release verification](docs/release-verification.md) for the full release 76See [release verification](docs/release-verification.md) for the full release
75audit flow and the maintainer signing step. 77audit flow and the maintainer signing step.
76 78
79Public mirrors should make the latest checksum files available both under the
80versioned release directory and at the release root:
81
82```text
83https://releases.bitflash.network/v1.2.18/SHA256SUMS
84https://releases.bitflash.network/SHA256SUMS # alias to latest
85```
86
77Bitflash also ships a deterministic UTXO-set commitment tool: 87Bitflash 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
113python3 scripts/build-explorer.py ~/.bitflash/blk0001.dat ~/.bitflash/blk0002.dat ./explorer-out 123python3 scripts/build-explorer.py ~/.bitflash/blk0001.dat ~/.bitflash/blk0002.dat ./explorer-out
114``` 124```
115 125
126The generated explorer is static and self-contained: `index.html`,
127`style.css`, `explorer.js`, `blocks.json`, `block/*.json`, and `logo.png`. It is
128safe to host behind a strict policy such as `default-src 'none'; img-src 'self';
129style-src 'self'; script-src 'self'; connect-src 'self'; base-uri 'none';
130form-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
117releases — 1.2.1 fixed a bug that let anyone spend anyone's coins, and 1.2.2 133releases — 1.2.1 fixed a bug that let anyone spend anyone's coins, and 1.2.2
118added a per-block signature-operation cap. A node on an older build will accept 134added 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.
266The files are informational only: nodes still discover pools through Nostr and 282The 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.
284See [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