Raven ScottandCursor
425a44c4b7
Adds listPatterns, entryCount, activeTunnelCount, chainLength, and richer getStats with protocol fields; new trust-security category README. Co-authored-by: Cursor <[email protected]>
hyper-p2p-relay-tunnel
Production routing & paths module: Hyperswarm discovery + Protomux when topic is set.
Category: Routing & paths
Composes with: hyper-p2p-intent-router, hyper-p2p-merge-registry
Protocol: relay-tunnel/v1
When to use
Multi-peer apps that need routing & paths over a shared Hyperswarm topic.
When not to use
Single-process tools with no P2P topic (use local APIs only or skip ready()).
Quick start
const { HyperP2PRelayTunnel } = require('hyper-p2p-relay-tunnel')
const topic = process.argv[2] // 64-char hex or string
const mod = new HyperP2PRelayTunnel({ topic, enableBackgroundTimers: false })
await mod.ready() // joins swarm when topic set
// ... 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
-
Integration:
../../real_tests/integration/—relay-tunnel-two-node.js
Test
npm install && npm test