Updates

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`.
+