Raven ScottandCursor
7cb1612e71
Complete manual documentation cleanup for the storage stack and expand category-level guides across the library. Documentation (23 storage modules): - Rewrite Methods sections in all storage-hypercore, storage-hyperbee, storage-autobase, and storage-hyperdrive api.md files from index.js - Remove every "module-specific (see implementation)" placeholder in storage - Fix bitfield-scheduler, bee-batch-write, bee-range-watch, drive-gc-sweep APIs Category READMEs (modules/): - trust-security, consensus-coordination, routing-advanced — tables + hub links - MODULE_CATEGORIES.md typo fix (scaffold tier description) Code: - hyper-p2p-trust-graph: hasEdge(), nodeCount(), getStats with protocol - hyper-p2p-circuit-breaker: listCircuitIds(), reset() - hyper-p2p-distributed-lock: getStats merges metrics + active lock counts Parent workspace (not in this repo) also received doc hubs for all 29 categories in docs/README.md and MODULE_DOC_PASS.md giant-pass tracker. Co-authored-by: Cursor <[email protected]>
hyper-p2p-bee-secondary-index
In-memory secondary-key → primary-key index for Hyperbee; route lookup intents through hyper-p2p-intent-router when queries cross peers. Local-only scheduling layer (no Hyperswarm join).
Category: Storage (Hyperbee)
Composes with: hyper-p2p-intent-router
Protocol: bee-secondary-index/v1
When to use
Queries need a non-primary key path into bee records.
When not to use
Primary-key-only access patterns or indexes persisted inside bee itself.
Quick start
const { HyperP2PBeeSecondaryIndex } = require('hyper-p2p-bee-secondary-index')
const mod = new HyperP2PBeeSecondaryIndex()
mod.attach(/* Hyperbee instance */)
await mod.ready()
// ... application logic ...
await mod.close()
Docs
- docs/api.md — constructor, methods, events, errors
- docs/architecture.md — wire types, state, composition
- ../_shared/PRODUCTION.md — production checklist
- ../_shared/DOC_STANDARDS.md — documentation standards
Test
npm install && npm test