Add Supercomputer category: 12 P2P resource-sharing modules (164 total)

Introduce a new production category for distributed system resource pooling over Hyperswarm — CPU, RAM, GPU, bandwidth, disk, jobs, cache, and egress. New modules (supercomputer/): - hyper-p2p-capacity-registry — gossip CPU/RAM/GPU/disk/bandwidth ads - hyper-p2p-cpu-share — CPU millisecond credit pool - hyper-p2p-ram-pool — RAM byte lend/claim/release - hyper-p2p-gpu-slot — GPU slot register/reserve - hyper-p2p-bandwidth-share — shared up/down Mbps - hyper-p2p-disk-stripe — striped block shards - hyper-p2p-job-dispatcher — submit/claim/complete jobs - hyper-p2p-thermal-guard — load/temperature throttle signals - hyper-p2p-cache-farm — distributed LRU cache - hyper-p2p-net-gateway — peer internet egress routing - hyper-p2p-cluster-affinity — hardware tag placement scoring - hyper-p2p-work-stealer — shard queues + work stealing Each package: index.js, tests, README, api/architecture docs, examples/basic.js. Shared layering guide: _shared/SUPERCOMPUTER_LAYERS.md. Registry, module-paths, MODULE_CATEGORIES, and workspace README updated to 164. Parent workspace also adds docs/supercomputer hub and demo-supercomputer-mesh (outside this repo). Co-authored-by: Cursor <[email protected]>
2026-05-21 00:38:53 -04:00
parent 70119888cd
commit 693385bd7c
114 changed files with 24378 additions and 6 deletions
@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.3.0
+
+- Initial Supercomputer category release (net-gateway/v1).
@@ -0,0 +1,30 @@
+# hyper-p2p-net-gateway
+
+Production **Supercomputer** module: pool P2P system resources over Hyperswarm.
+
+**Category:** Supercomputer · **Protocol:** `net-gateway/v1` · **Export:** `HyperP2PNetGateway`
+
+## When to use
+
+Peer internet egress gateway registration and routing.
+
+## Quick start
+
+```js
+const { HyperP2PNetGateway } = require('hyper-p2p-net-gateway')
+const mod = new HyperP2PNetGateway({ topic: 'my-super-mesh' })
+await mod.ready()
+// ...
+await mod.close()
+```
+
+## Docs
+
+- [docs/api.md](docs/api.md)
+- [docs/architecture.md](docs/architecture.md)
+
+## Test
+
+```bash
+npm install && npm test
+```
@@ -0,0 +1,36 @@
+# API: hyper-p2p-net-gateway
+
+**Protocol:** `net-gateway/v1` · **Export:** `HyperP2PNetGateway`
+
+## Overview
+
+Peer internet egress gateway registration and routing.
+
+## Constructor
+
+```js
+const mod = new HyperP2PNetGateway(opts)
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `topic` | Buffer \| string \| null | `null` | Hyperswarm topic |
+| `keyPair` | KeyPair | random | Discovery identity |
+
+## Methods
+
+See [`index.js`](../index.js) for the full method list. All modules implement `getStats()`, `async ready()`, and `async close()`.
+
+## getStats()
+
+Returns `{ ...stats, protocol: 'net-gateway/v1' }` plus module-specific counters.
+
+## P2P
+
+When `topic` is set, `ready()` joins Hyperswarm and opens Protomux `net-gateway/v1`.
+
+## Testing
+
+```bash
+npm install && npm test
+```
@@ -0,0 +1,14 @@
+# Architecture: hyper-p2p-net-gateway
+
+**Category:** Supercomputer · **Protocol:** `net-gateway/v1`
+
+```mermaid
+flowchart LR
+  App[Application] --> Mod[HyperP2PNetGateway]
+  Mod --> Mux[Protomux net-gateway/v1]
+  Mux --> Swarm[Hyperswarm]
+```
+
+## Composition
+
+See [`../../_shared/SUPERCOMPUTER_LAYERS.md`](../../_shared/SUPERCOMPUTER_LAYERS.md) and [`../README.md`](../README.md).
@@ -0,0 +1,10 @@
+require('bare-process/global')
+const { HyperP2PNetGateway } = require('../index.js')
+
+async function main () {
+  const mod = new HyperP2PNetGateway()
+  console.log('stats', mod.getStats())
+  await mod.close()
+  console.log('done')
+}
+main().catch(console.error)
@@ -0,0 +1,93 @@
+require('bare-process/global')
+const EventEmitter = require('bare-events')
+const b4a = require('b4a')
+const { initModuleSwarm, gossipSend } = require('../../_shared/p2p-bare.js')
+
+const PROTOCOL = 'net-gateway/v1'
+
+class HyperP2PNetGateway extends EventEmitter {
+  constructor (opts = {}) {
+    super()
+    this._stats = { registered: 0, routed: 0 }
+    this.topic = opts.topic || null
+    this.keyPair = opts.keyPair || require('hypercore-crypto').keyPair()
+    this.peerId = b4a.toString(this.keyPair.publicKey, 'hex')
+    this._gateways = new Map()
+    this._usage = new Map()
+    this.swarm = null
+    this._peerMsgs = null
+  }
+
+  _pid (peerId) {
+    return typeof peerId === 'string' ? peerId : b4a.toString(peerId, 'hex')
+  }
+
+  registerGateway (peerId, caps = {}) {
+    const id = this._pid(peerId)
+    const gw = {
+      peerId: id,
+      maxBytes: caps.maxBytes ?? 1_000_000_000,
+      regions: caps.regions || [],
+      nat: caps.nat ?? 'unknown',
+      at: Date.now()
+    }
+    this._gateways.set(id, gw)
+    this._usage.set(id, 0)
+    this._stats.registered++
+    if (this._peerMsgs) gossipSend(this, { type: 'register', gateway: gw })
+    this.emit('register', gw)
+    return gw
+  }
+
+  requestRoute (bytes, preferPeerId = null) {
+    if (bytes < 0) throw new Error('bytes must be non-negative')
+    let gw = preferPeerId ? this._gateways.get(this._pid(preferPeerId)) : null
+    if (!gw) {
+      for (const g of this._gateways.values()) {
+        const used = this._usage.get(g.peerId) || 0
+        if (used + bytes <= g.maxBytes) { gw = g; break }
+      }
+    }
+    if (!gw) return null
+    const used = (this._usage.get(gw.peerId) || 0) + bytes
+    if (used > gw.maxBytes) return null
+    this._usage.set(gw.peerId, used)
+    this._stats.routed += bytes
+    if (this._peerMsgs) gossipSend(this, { type: 'route', peerId: gw.peerId, bytes, used })
+    this.emit('route', { gateway: gw.peerId, bytes, used })
+    return gw
+  }
+
+  listGateways () { return [...this._gateways.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?.type === 'register' && data.gateway) {
+          this._gateways.set(data.gateway.peerId, data.gateway)
+          this._usage.set(data.gateway.peerId, this._usage.get(data.gateway.peerId) || 0)
+        } else if (data?.type === 'route') {
+          const cur = this._usage.get(data.peerId) || 0
+          if (data.used > cur) this._usage.set(data.peerId, data.used)
+        }
+      }
+    })
+    return this
+  }
+
+  getStats () {
+    return { ...this._stats, gateways: this._gateways.size, protocol: PROTOCOL }
+  }
+
+  async close () {
+    if (this.swarm) await this.swarm.destroy().catch(() => {})
+    this.swarm = null
+    this._gateways.clear()
+    this._usage.clear()
+    this.emit('closed')
+  }
+}
+
+module.exports = { HyperP2PNetGateway, PROTOCOL }
@@ -0,0 +1,23 @@
+{
+  "name": "hyper-p2p-net-gateway",
+  "version": "0.3.0",
+  "description": "Peer internet egress gateway credits for Bare/Pear P2P supercomputer mesh.",
+  "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" }
+  }
+}
@@ -0,0 +1,22 @@
+require('bare-process/global')
+const test = require('brittle')
+const { HyperP2PNetGateway } = require('../index.js')
+
+test('net-gateway: register route', async (t) => {
+  const g = new HyperP2PNetGateway()
+  g.registerGateway('gw-1', { maxBytes: 1_000_000 })
+  const gw = g.requestRoute(5000)
+  t.ok(gw)
+  await g.close()
+})
+
+test('net-gateway: validation', async (t) => {
+  const g = new HyperP2PNetGateway()
+  try {
+    g.requestRoute(-1)
+    t.fail('expected throw')
+  } catch (e) {
+    t.ok(e instanceof Error)
+  }
+  await g.close()
+})