Updates

experimental/hyper-p2p-pheromone-trail/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+*-storage/

experimental/hyper-p2p-pheromone-trail/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+<!-- legacy: v0.1.0 -->
+
+- Initial release.
+<!-- legacy: v0.2.0 -->
+
+- Production-grade docs, validation, and expanded tests.
+<!-- legacy: v0.3.0 -->
+
+- Wave 6: presence-tier API tables, architecture wire section, validation test.
+
+<!-- legacy: v0.3.1 -->
+
+- Wave 7: correct protocol in docs, getStats(), wire tables, category README.
+## [0.3.2] - 2026-05-21
+
+### Changed
+- Exhaustive documentation pass (api, architecture, README) per DOC_STANDARDS.md.

experimental/hyper-p2p-pheromone-trail/README.md

@@ -0,0 +1,43 @@
+# hyper-p2p-pheromone-trail
+
+Production experimental (wave 4) module: Hyperswarm discovery + Protomux when `topic` is set.
+
+**Category:** Experimental (Wave 4)
+
+**Composes with:** `hyper-p2p-whisper-mesh`, `hyper-p2p-entropy-beacon`
+
+**Protocol:** `pheromone-trail/v1`
+
+## When to use
+
+Multi-peer apps that need experimental (wave 4) 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
+
+```js
+const { HyperP2PPheromoneTrail } = require('hyper-p2p-pheromone-trail')
+const topic = process.argv[2] // 64-char hex or string
+const mod = new HyperP2PPheromoneTrail({ topic, enableBackgroundTimers: false })
+await mod.ready()   // joins swarm when topic set
+// ... application logic ...
+await mod.close()
+```
+
+## Docs
+
+- [docs/api.md](docs/api.md) — constructor, methods, events, errors
+- [docs/architecture.md](docs/architecture.md) — wire types, state, composition
+- [../_shared/PRODUCTION.md](../../_shared/PRODUCTION.md) — production checklist
+- [../_shared/DOC_STANDARDS.md](../../_shared/DOC_STANDARDS.md) — documentation standards
+
+- Integration: [`../../real_tests/integration/`](../../../real_tests/integration/) — `pheromone-trail-two-node.js`
+
+## Test
+
+```bash
+npm install && npm test
+```

experimental/hyper-p2p-pheromone-trail/docs/api.md

@@ -0,0 +1,97 @@
+# API: hyper-p2p-pheromone-trail
+
+**Protocol:** `pheromone-trail/v1`
+
+**Export:** `HyperP2PPheromoneTrail`
+
+## Overview
+
+Production experimental (wave 4) module: Hyperswarm discovery + Protomux when `topic` is set.
+
+## Constructor
+
+```js
+const mod = new HyperP2PPheromoneTrail(opts)
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `topic` | varies | null | topic |
+| `keyPair` | KeyPair | random Ed25519 | keyPair |
+| `evaporationRate` | number | 0.9 | evaporationRate |
+
+## Methods
+
+### `deposit(pathId, strength = 1, dest = null)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `sniff(pathId)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `evaporate(—)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `bestPath(dest)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `merge(remote)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `toJSON(—)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `ready(—)`
+
+- **Returns:** `Promise`
+- **Throws:** — (none documented in method body)
+
+### `getStats(—)`
+
+- **Returns:** `object`
+- **Throws:** — (none documented in method body)
+
+### `close(—)`
+
+- **Returns:** `Promise<void>`
+- **Throws:** — (none documented in method body)
+
+## Events
+
+| Event | Payload |
+|-------|---------|
+| `closed` | no payload |
+| `deposit` | cur |
+| `evaporate` | pruned |
+
+## getStats()
+
+Returns `{ ...this._stats }` — typically `ops`, `errors`, and module-specific counters (`created`, `relays`, `open`, `peers`, etc.).
+Library-only modules may include `mode: 'local'`.
+
+## Errors
+
+Stable message substrings: see [`../_shared/ERROR_CODES.md`](../../_shared/ERROR_CODES.md).
+
+## P2P
+
+When `topic` is set, `ready()` joins Hyperswarm and opens Protomux `pheromone-trail/v1`.
+
+## Testing
+
+```bash
+npm install && npm test
+```
+
+Integration: [`../../real_tests/integration/pheromone-trail-two-node.js`](../../../real_tests/integration/pheromone-trail-two-node.js)

experimental/hyper-p2p-pheromone-trail/docs/architecture.md

@@ -0,0 +1,43 @@
+# Architecture: hyper-p2p-pheromone-trail
+
+**Category:** Experimental (Wave 4)
+
+```mermaid
+flowchart LR
+  App[Application] --> Mod[HyperP2PPheromoneTrail]
+  Mod --> Mux[Protomux pheromone-trail/v1]
+  Mux --> Swarm[Hyperswarm]
+```
+
+## Sequence (P2P)
+
+```mermaid
+sequenceDiagram
+  participant App
+  participant Mod as Module
+  participant SW as Hyperswarm
+  participant Peer
+  App->>Mod: ready(topic)
+  Mod->>SW: join(topic)
+  SW->>Peer: connection
+  Mod->>Peer: gossip / Protomux
+  Peer-->>Mod: onmessage
+  Mod-->>App: emit(event)
+```
+
+## Wire messages
+
+| type | fields | direction | behavior |
+|------|--------|-----------|----------|
+| `deposit` | trail | gossip | Handled in onmessage / gossipSend |
+
+## State model
+
+- In-memory `Map` / `Set` structures for hot path
+- Optional Hyperbee/Hypercore persistence when `storageDir` or `memoryOnly` is configured
+- `close()` tears down swarm, timers, and clears ephemeral state
+
+## Composition
+
+Composes with: `hyper-p2p-whisper-mesh`, `hyper-p2p-entropy-beacon`.
+

experimental/hyper-p2p-pheromone-trail/examples/basic.js

@@ -0,0 +1,9 @@
+require('bare-process/global')
+const { HyperP2PPheromoneTrail } = require('../index.js')
+async function main () {
+  const p = new HyperP2PPheromoneTrail()
+  p.deposit('path-a', 1, 'peer-z')
+  console.log('best', p.bestPath('peer-z'))
+  await p.close()
+}
+main().catch(console.error)

experimental/hyper-p2p-pheromone-trail/index.js

@@ -0,0 +1,105 @@
+require('bare-process/global')
+const EventEmitter = require('bare-events')
+const b4a = require('b4a')
+const { initModuleSwarm, gossipSend } = require('../../_shared/p2p-bare.js')
+
+const PROTOCOL = 'pheromone-trail/v1'
+
+class HyperP2PPheromoneTrail extends EventEmitter {
+  constructor (opts = {}) {
+    super()
+    this._stats = { ops: 0, errors: 0 }
+
+    this.topic = opts.topic || null
+    this.keyPair = opts.keyPair || require('hypercore-crypto').keyPair()
+    this.evaporationRate = opts.evaporationRate ?? 0.9
+    this._trails = new Map()
+    this.swarm = null
+    this._peerMsgs = null
+  }
+
+  deposit (pathId, strength = 1, dest = null) {
+    const id = String(pathId)
+    const cur = this._trails.get(id) || { pathId: id, dest, strength: 0, updatedAt: Date.now() }
+    cur.strength = Math.min(1, cur.strength + strength)
+    cur.dest = dest != null ? String(dest) : cur.dest
+    cur.updatedAt = Date.now()
+    this._trails.set(id, cur)
+    if (this._peerMsgs) gossipSend(this, { type: 'deposit', trail: cur })
+    this.emit('deposit', cur)
+    return cur
+  }
+
+  sniff (pathId) {
+    const t = this._trails.get(String(pathId))
+    return t ? { ...t } : null
+  }
+
+  evaporate () {
+    let n = 0
+    for (const [id, t] of this._trails) {
+      t.strength *= this.evaporationRate
+      if (t.strength < 0.01) {
+        this._trails.delete(id)
+        n++
+      } else {
+        t.updatedAt = Date.now()
+      }
+    }
+    if (n) this.emit('evaporate', { pruned: n })
+    return n
+  }
+
+  bestPath (dest) {
+    const d = String(dest)
+    let best = null
+    for (const t of this._trails.values()) {
+      if (t.dest !== d) continue
+      if (!best || t.strength > best.strength) best = t
+    }
+    return best
+  }
+
+  merge (remote) {
+    if (!remote || !remote.trails) return 0
+    let n = 0
+    for (const t of remote.trails) {
+      const cur = this._trails.get(t.pathId)
+      if (!cur || t.strength > cur.strength) {
+        this._trails.set(t.pathId, t)
+        n++
+      }
+    }
+    return n
+  }
+
+  toJSON () {
+    return { trails: [...this._trails.values()] }
+  }
+
+  async ready () {
+    if (this.swarm || !this.topic) return this
+    await initModuleSwarm(this, {
+      keyPair: this.keyPair,
+      topic: this.topic,
+      protocol: PROTOCOL,
+      onmessage: (data) => {
+        if (data && data.type === 'deposit' && data.trail) this.merge({ trails: [data.trail] })
+      }
+    })
+    return this
+  }
+
+
+  getStats () {
+    return { ...this._stats }
+  }
+
+  async close () {
+    if (this.swarm) await this.swarm.destroy().catch(() => {})
+    this.swarm = null
+    this.emit('closed')
+  }
+}
+
+module.exports = { HyperP2PPheromoneTrail, PROTOCOL }

experimental/hyper-p2p-pheromone-trail/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "hyper-p2p-pheromone-trail",
+  "version": "0.3.1",
+  "description": "Ant-colony evaporating route scent for Bare/Pear P2P.",
+  "main": "index.js",
+  "type": "commonjs",
+  "license": "Apache-2.0",
+  "scripts": { "test": "brittle-bare test/test.js" },
+  "dependencies": {
+    "bare-events": "^2.8.0",
+    "bare-process": "^4.4.0",
+    "b4a": "^1.6.7",
+    "hypercore-crypto": "^3.0.0",
+    "protomux": "^3.0.0",
+    "compact-encoding": "^2.0.0"
+  },
+  "peerDependencies": { "hyperswarm": "^4.0.0", "bare": ">=1.0.0" },
+  "devDependencies": { "brittle": "^3.0.0" },
+  "imports": {
+    "process": { "bare": "bare-process", "default": "process" },
+    "events": { "bare": "bare-events", "default": "events" }
+  }
+}

experimental/hyper-p2p-pheromone-trail/test/test.js

@@ -0,0 +1,44 @@
+require('bare-process/global')
+const test = require('brittle')
+const { HyperP2PPheromoneTrail } = require('../index.js')
+
+test('pheromone-trail: deposit and bestPath', async (t) => {
+  const p = new HyperP2PPheromoneTrail()
+  p.deposit('route-1', 0.8, 'dest-a')
+  p.deposit('route-2', 0.3, 'dest-a')
+  const best = p.bestPath('dest-a')
+  t.is(best.pathId, 'route-1')
+  await p.close()
+})
+
+test('pheromone-trail: evaporate', async (t) => {
+  const p = new HyperP2PPheromoneTrail({ evaporationRate: 0.01 })
+  p.deposit('x', 0.05, 'd')
+  p.evaporate()
+  t.not(p.sniff('x'))
+  await p.close()
+})
+test('hyper-p2p-pheromone-trail: close without leak', async (t) => {
+  const m = new HyperP2PPheromoneTrail()
+  await m.close()
+  t.pass()
+})
+test('hyper-p2p-pheromone-trail: validation rejects invalid input', async (t) => {
+  const m = new HyperP2PPheromoneTrail()
+  try {
+    if (typeof m.addNeighbor === 'function') m.addNeighbor(null)
+    else if (typeof m.buildCircuit === 'function') m.buildCircuit([])
+    else if (typeof m.grant === 'function') m.grant(null, -1)
+    else if (typeof m.enqueue === 'function') m.enqueue('bad', null)
+    else if (typeof m.reportSample === 'function') m.reportSample(null, -1, -1)
+    else if (typeof m.fanout === 'function') m.fanout(null, 0)
+    else if (typeof m.probe === 'function') m.probe(null)
+    else if (typeof m.resolve === 'function') m.resolve(null)
+    else if (typeof m.acquire === 'function') m.acquire(null)
+    else throw new Error('no validation hook')
+    t.fail('expected throw')
+  } catch (err) {
+    t.ok(err instanceof Error)
+  }
+  await m.close()
+})