From a58df5255137f2e6b546e1e1e7b841937702b69b Mon Sep 17 00:00:00 2001 From: Maya Parbhoe <73040345+MeABzZz@users.noreply.github.com> Date: Wed, 21 Oct 2026 17:04:12 -0300 Subject: [PATCH] docs(modules): add registry status line to every module page Derive status from blvm registry/modules.json (blvm-zmq, blvm-miniscript, blvm-governance, blvm-marketplace, blvm-fibre). Each module page now opens with one Registry status line; the catalog index splits modules into in-registry vs build-from-source. Add the orphaned Mining OS page to SUMMARY, and change the bootstrap example pin from blvm-mesh (not in the registry, so bootstrap fails) to blvm-miniscript. --- src/SUMMARY.md | 1 + src/modules/datum.md | 2 ++ src/modules/fibre.md | 2 ++ src/modules/governance-module.md | 2 ++ src/modules/lightning.md | 2 ++ src/modules/marketplace-module.md | 2 ++ src/modules/mesh.md | 2 ++ src/modules/miningos.md | 2 ++ src/modules/miniscript.md | 2 ++ src/modules/overview.md | 21 ++++++++++++--------- src/modules/selective-sync.md | 2 ++ src/modules/stratum-v2.md | 2 ++ src/modules/zmq.md | 2 ++ 13 files changed, 35 insertions(+), 9 deletions(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 78aafd0..125187d 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -98,6 +98,7 @@ - [Commons Mesh](modules/mesh.md) - [Stratum V2](modules/stratum-v2.md) - [Datum](modules/datum.md) +- [Mining OS](modules/miningos.md) - [Selective Sync](modules/selective-sync.md) - [FIBRE](modules/fibre.md) - [ZMQ](modules/zmq.md) diff --git a/src/modules/datum.md b/src/modules/datum.md index 31d5d37..fb2d2ad 100644 --- a/src/modules/datum.md +++ b/src/modules/datum.md @@ -1,5 +1,7 @@ # Datum Module +> **Registry status:** Not listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json). `[modules]` registry bootstrap cannot download `blvm-datum`; [build it from source](overview.md#build-from-source) and place it under `modules_dir`. + ## Overview The Datum module (`blvm-datum`) implements the DATUM Gateway mining protocol for Ocean pool support. Pool communication runs here; miners connect through `blvm-stratum-v2`. diff --git a/src/modules/fibre.md b/src/modules/fibre.md index bcc3a34..cc3c08c 100644 --- a/src/modules/fibre.md +++ b/src/modules/fibre.md @@ -1,5 +1,7 @@ # FIBRE module (`blvm-fibre`) +> **Registry status:** Listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json) as `blvm-fibre`. Pin it under `[modules]` for [registry bootstrap](overview.md#registry-bootstrap-recommended). + UDP/FEC **block** relay as a **loadable Commons module**. Distinct from Dandelion++ transaction relay in [Privacy relay](../node/privacy-relay.md). ## Overview diff --git a/src/modules/governance-module.md b/src/modules/governance-module.md index afca150..6b5a93f 100644 --- a/src/modules/governance-module.md +++ b/src/modules/governance-module.md @@ -1,5 +1,7 @@ # Governance module (`blvm-governance`) +> **Registry status:** Listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json) as `blvm-governance`. Pin it under `[modules]` for [registry bootstrap](overview.md#registry-bootstrap-recommended). + On-chain proposal tracking and optional webhook notifications for **`blvm-node`**. Distinct from the **Bitcoin Commons governance framework** documented under [Governance](../governance/overview.md): this page covers the **loadable module** only. ## Overview diff --git a/src/modules/lightning.md b/src/modules/lightning.md index 6426e1f..fde720f 100644 --- a/src/modules/lightning.md +++ b/src/modules/lightning.md @@ -1,5 +1,7 @@ # Lightning Network Module +> **Registry status:** Not listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json). `[modules]` registry bootstrap cannot download `blvm-lightning`; [build it from source](overview.md#build-from-source) and place it under `modules_dir`. + ## Overview The Lightning Network module (`blvm-lightning`) handles invoice verification, payment routing, channel management, and payment state tracking for blvm-node. diff --git a/src/modules/marketplace-module.md b/src/modules/marketplace-module.md index 31991cb..3fb6a34 100644 --- a/src/modules/marketplace-module.md +++ b/src/modules/marketplace-module.md @@ -1,5 +1,7 @@ # Marketplace module (`blvm-marketplace`) +> **Registry status:** Listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json) as `blvm-marketplace`. Pin it under `[modules]` for [registry bootstrap](overview.md#registry-bootstrap-recommended). + Optional **module discovery, registry, and payment** integration for **`blvm-node`**. Most operators use **`[modules].registry_url`** bootstrap (GitHub Releases + `modules.json`) without loading this module. ## Overview diff --git a/src/modules/mesh.md b/src/modules/mesh.md index 8ef0bec..ed0d5e6 100644 --- a/src/modules/mesh.md +++ b/src/modules/mesh.md @@ -1,5 +1,7 @@ # Commons Mesh Module +> **Registry status:** Not listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json). `[modules]` registry bootstrap cannot download `blvm-mesh`; [build it from source](overview.md#build-from-source) and place it under `modules_dir`. + Payment-gated mesh overlay for **blvm-node**: route discovery, replay prevention, optional payment proofs, and subprocess ModuleAPI. Wire format and smoke tests live in the [blvm-mesh](https://github.com/BTCDecoded/blvm-mesh) repo ([mesh transport](https://github.com/BTCDecoded/blvm-mesh/blob/main/docs/TRANSPORT.md), [mesh API](https://github.com/BTCDecoded/blvm-mesh/blob/main/API.md)). ## Install diff --git a/src/modules/miningos.md b/src/modules/miningos.md index 105d003..47522e2 100644 --- a/src/modules/miningos.md +++ b/src/modules/miningos.md @@ -1,5 +1,7 @@ # Mining OS Module +> **Registry status:** Not listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json). `[modules]` registry bootstrap cannot download `blvm-miningos`; [build it from source](overview.md#build-from-source) and place it under `modules_dir`. + ## Overview The Mining OS module (`blvm-miningos`) integrates BLVM with MiningOS (Mos): BLVM runs as a MiningOS "rack" (worker) and exposes miners as "things". diff --git a/src/modules/miniscript.md b/src/modules/miniscript.md index 7d12a66..5ac60a5 100644 --- a/src/modules/miniscript.md +++ b/src/modules/miniscript.md @@ -1,5 +1,7 @@ # Miniscript module (`blvm-miniscript`) +> **Registry status:** Listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json) as `blvm-miniscript`. Pin it under `[modules]` for [registry bootstrap](overview.md#registry-bootstrap-recommended). + Descriptor and PSBT helpers for **`blvm-node`**. Overrides two core JSON-RPC methods via the module RPC extender when loaded. ## Overview diff --git a/src/modules/overview.md b/src/modules/overview.md index 6694073..6dab62f 100644 --- a/src/modules/overview.md +++ b/src/modules/overview.md @@ -4,15 +4,9 @@ BLVM node runs optional features as separate, process-isolated modules. See [Bui ## Available modules -**Core integration modules** (documented in this book): +Registry status comes from [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json) in the `blvm` repository. Each module page repeats it in a **Registry status** line. -- **[Lightning Network Module](lightning.md)**: Lightning payment processing (LNBits, LDK, Stub) -- **[Commons Mesh Module](mesh.md)**: Payment-gated mesh overlay; four JSON-RPC methods when loaded -- **[Stratum V2 Module](stratum-v2.md)**: Stratum V2 mining protocol -- **[Datum Module](datum.md)**: DATUM Gateway (with Stratum V2) -- **[Selective Sync Module](selective-sync.md)**: IBD sync policy and witness filtering - -**Registry modules** (bootstrap from `registry/modules.json`): +**In the registry** (bootstrap via `[modules].registry_url`): - **blvm-zmq**: ZMQ PUB notifications ([ZMQ module](zmq.md)) - **blvm-miniscript**: Descriptor / PSBT RPC overrides ([Miniscript module](miniscript.md)) @@ -20,6 +14,15 @@ BLVM node runs optional features as separate, process-isolated modules. See [Bui - **blvm-marketplace**: Optional registry/payments ([Marketplace module](marketplace-module.md)) - **blvm-fibre**: FIBRE UDP/FEC block relay ([FIBRE module](fibre.md)) +**Not in the registry** (build from source; registry bootstrap cannot download these): + +- **blvm-lightning**: Lightning payment processing (LNBits, LDK, Stub) ([Lightning Network Module](lightning.md)) +- **blvm-mesh**: Payment-gated mesh overlay; four JSON-RPC methods when loaded ([Commons Mesh Module](mesh.md)) +- **blvm-stratum-v2**: Stratum V2 mining protocol ([Stratum V2 Module](stratum-v2.md)) +- **blvm-datum**: DATUM Gateway (with Stratum V2) ([Datum Module](datum.md)) +- **blvm-selective-sync**: IBD sync policy and witness filtering ([Selective Sync Module](selective-sync.md)) +- **blvm-miningos**: MiningOS rack integration ([Mining OS Module](miningos.md)) + ## Module system architecture ```mermaid @@ -49,8 +52,8 @@ Pin modules in `blvm.toml` under **`[modules]`** (merge into your existing file: ```toml [modules] registry_url = "https://raw.githubusercontent.com/BTCDecoded/blvm/main/registry/modules.json" -blvm-mesh = "0.1.*" blvm-zmq = "0.1.*" +blvm-miniscript = "0.1.*" ``` The node downloads version-pinned binaries from GitHub Releases (`sha256sums.txt` on each tag) when a pinned module is missing on disk. See [blvm README](https://github.com/BTCDecoded/blvm/blob/main/README.md) in the `blvm` repository for the full bootstrap contract. diff --git a/src/modules/selective-sync.md b/src/modules/selective-sync.md index 12dacb6..2300e1a 100644 --- a/src/modules/selective-sync.md +++ b/src/modules/selective-sync.md @@ -1,5 +1,7 @@ # Selective Synchronization Module +> **Registry status:** Not listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json). `[modules]` registry bootstrap cannot download `blvm-selective-sync`; [build it from source](overview.md#build-from-source) and place it under `modules_dir`. + The **blvm-selective-sync** module provides a configurable **sync policy**: operators can avoid serving or persisting certain flagged transaction content during IBD while keeping full cryptographic validation of the chain. ## Requirements diff --git a/src/modules/stratum-v2.md b/src/modules/stratum-v2.md index 79a6a40..0c05530 100644 --- a/src/modules/stratum-v2.md +++ b/src/modules/stratum-v2.md @@ -1,5 +1,7 @@ # Stratum V2 Module +> **Registry status:** Not listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json). `[modules]` registry bootstrap cannot download `blvm-stratum-v2`; [build it from source](overview.md#build-from-source) and place it under `modules_dir`. + ## Overview The Stratum V2 module (`blvm-stratum-v2`) implements [Stratum V2 mining protocol](../node/mining-stratum-v2.md) support: server, pool management, and job distribution. diff --git a/src/modules/zmq.md b/src/modules/zmq.md index 2d2f796..454c7cc 100644 --- a/src/modules/zmq.md +++ b/src/modules/zmq.md @@ -1,5 +1,7 @@ # ZMQ module (`blvm-zmq`) +> **Registry status:** Listed in [`registry/modules.json`](https://github.com/BTCDecoded/blvm/blob/main/registry/modules.json) as `blvm-zmq`. Pin it under `[modules]` for [registry bootstrap](overview.md#registry-bootstrap-recommended). + Bitcoin-compatible **ZeroMQ PUB** notifications for blocks and mempool events. Replaces the former in-process **`[zmq]`** section on `blvm-node`: configure endpoints on this module instead. ## Overview