Updates

experimental/hyper-p2p-gravity-well/.gitignore

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

experimental/hyper-p2p-gravity-well/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-gravity-well/README.md

@@ -0,0 +1,43 @@
+# hyper-p2p-gravity-well
+
+Production experimental (wave 4) module: Hyperswarm discovery + Protomux when `topic` is set.
+
+**Category:** Experimental (Wave 4)
+
+**Composes with:** `hyper-p2p-pheromone-trail`, `hyper-p2p-whisper-mesh`, `hyper-p2p-entropy-beacon`
+
+**Protocol:** `gravity-well/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 { HyperP2PGravityWell } = require('hyper-p2p-gravity-well')
+const topic = process.argv[2] // 64-char hex or string
+const mod = new HyperP2PGravityWell({ 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/) — `gravity-well-two-node.js`
+
+## Test
+
+```bash
+npm install && npm test
+```

experimental/hyper-p2p-gravity-well/docs/api.md

@@ -0,0 +1,92 @@
+# API: hyper-p2p-gravity-well
+
+**Protocol:** `gravity-well/v1`
+
+**Export:** `HyperP2PGravityWell`
+
+## Overview
+
+Production experimental (wave 4) module: Hyperswarm discovery + Protomux when `topic` is set.
+
+## Constructor
+
+```js
+const mod = new HyperP2PGravityWell(opts)
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `topic` | varies | null | topic |
+| `keyPair` | KeyPair | random Ed25519 | keyPair |
+
+## Methods
+
+### `setWell(peerId, mass = 1)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `attract(msg)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `drain(—)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `mergeWells(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 |
+|-------|---------|
+| `attract` | entry |
+| `closed` | no payload |
+| `drain` | summary |
+| `well` | peerId |
+
+## 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 `gravity-well/v1`.
+
+## Testing
+
+```bash
+npm install && npm test
+```
+
+Integration: [`../../real_tests/integration/gravity-well-two-node.js`](../../../real_tests/integration/gravity-well-two-node.js)

experimental/hyper-p2p-gravity-well/docs/architecture.md

@@ -0,0 +1,43 @@
+# Architecture: hyper-p2p-gravity-well
+
+**Category:** Experimental (Wave 4)
+
+```mermaid
+flowchart LR
+  App[Application] --> Mod[HyperP2PGravityWell]
+  Mod --> Mux[Protomux gravity-well/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 |
+|------|--------|-----------|----------|
+| `attract` | entry, wells | 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-pheromone-trail`, `hyper-p2p-whisper-mesh`, `hyper-p2p-entropy-beacon`.
+

experimental/hyper-p2p-gravity-well/examples/basic.js

@@ -0,0 +1,10 @@
+require('bare-process/global')
+const { HyperP2PGravityWell } = require('../index.js')
+async function main () {
+  const g = new HyperP2PGravityWell()
+  g.setWell('sink', 9)
+  g.attract({ hello: 'world' })
+  console.log('drained', g.drain().length)
+  await g.close()
+}
+main().catch(console.error)

experimental/hyper-p2p-gravity-well/index.js

@@ -0,0 +1,101 @@
+require('bare-process/global')
+const EventEmitter = require('bare-events')
+const b4a = require('b4a')
+const { initModuleSwarm, gossipSend } = require('../../_shared/p2p-bare.js')
+
+const PROTOCOL = 'gravity-well/v1'
+
+class HyperP2PGravityWell 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.peerId = b4a.toString(this.keyPair.publicKey, 'hex')
+    this._wells = new Map()
+    this._sink = []
+    this.swarm = null
+    this._peerMsgs = null
+  }
+
+  setWell (peerId, mass = 1) {
+    const id = typeof peerId === 'string' ? peerId : b4a.toString(peerId, 'hex')
+    this._wells.set(id, { peerId: id, mass: Math.max(0, mass), updatedAt: Date.now() })
+    this.emit('well', { peerId: id, mass })
+    return this._wells.get(id)
+  }
+
+  _bestWell () {
+    let best = null
+    for (const w of this._wells.values()) {
+      if (!best || w.mass > best.mass) best = w
+    }
+    return best || { peerId: this.peerId, mass: 1 }
+  }
+
+  attract (msg) {
+    const well = this._bestWell()
+    const entry = { msg, targetWell: well.peerId, mass: well.mass, at: Date.now() }
+    this._sink.push(entry)
+    if (this._peerMsgs) gossipSend(this, { type: 'attract', entry })
+    this.emit('attract', entry)
+    return entry
+  }
+
+  drain () {
+    if (!this._sink.length) return []
+    const batch = this._sink.splice(0, this._sink.length)
+    const summary = {
+      count: batch.length,
+      topWell: this._bestWell().peerId,
+      preview: batch.slice(0, 3).map((e) => e.msg)
+    }
+    this.emit('drain', summary)
+    return batch
+  }
+
+  mergeWells (remote) {
+    if (!remote || !remote.wells) return 0
+    let n = 0
+    for (const w of remote.wells) {
+      const cur = this._wells.get(w.peerId)
+      if (!cur || w.mass > cur.mass) {
+        this._wells.set(w.peerId, w)
+        n++
+      }
+    }
+    return n
+  }
+
+  toJSON () {
+    return { wells: [...this._wells.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 === 'attract' && data.entry) this._sink.push(data.entry)
+        if (data && data.wells) this.mergeWells(data)
+      }
+    })
+    return this
+  }
+
+
+  getStats () {
+    return { ...this._stats }
+  }
+
+  async close () {
+    if (this.swarm) await this.swarm.destroy().catch(() => {})
+    this.swarm = null
+    this.emit('closed')
+  }
+}
+
+module.exports = { HyperP2PGravityWell, PROTOCOL }

experimental/hyper-p2p-gravity-well/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "hyper-p2p-gravity-well",
+  "version": "0.3.1",
+  "description": "Trust-weighted message gravity wells 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-gravity-well/test/test.js

@@ -0,0 +1,47 @@
+require('bare-process/global')
+const test = require('brittle')
+const { HyperP2PGravityWell } = require('../index.js')
+
+test('gravity-well: attract and drain', async (t) => {
+  const g = new HyperP2PGravityWell()
+  g.setWell('heavy-peer', 10)
+  g.setWell('light-peer', 1)
+  g.attract({ data: 'msg' })
+  const batch = g.drain()
+  t.is(batch.length, 1)
+  await g.close()
+})
+
+test('gravity-well: merge wells', async (t) => {
+  const a = new HyperP2PGravityWell()
+  const b = new HyperP2PGravityWell()
+  a.setWell('p1', 5)
+  b.mergeWells(a.toJSON())
+  t.is(b._wells.get('p1').mass, 5)
+  await a.close()
+  await b.close()
+})
+test('hyper-p2p-gravity-well: close without leak', async (t) => {
+  const m = new HyperP2PGravityWell()
+  await m.close()
+  t.pass()
+})
+test('hyper-p2p-gravity-well: validation rejects invalid input', async (t) => {
+  const m = new HyperP2PGravityWell()
+  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()
+})