Initial Commit

openspec/archive/2026-05-11-network-discovery-gundb/proposal.md

@@ -0,0 +1,79 @@
+# OpenSpec Change: network-discovery-gundb
+
+- **Change ID**: network-discovery-gundb
+- **Package**: `@suaveplan/network-discovery-gundb`
+- **Category**: browser
+- **Target path**: `packages/network/network-discovery-gundb`
+- **Status**: PROPOSED
+- **Date**: 2026-05-11
+- **Parent**: `network-transport-family` (2026-05-11) — Wave 2
+- **Migration source**: `../suaveplan/packages/browser/network-discovery-gundb` + `../suaveplan/enterprise/network-discovery-gundb.md`
+
+---
+
+## Summary
+
+Migrate `@suaveplan/network-discovery-gundb` as a browser-tier `DiscoveryStrategy` for `@suaveplan/network`. GunDB gossip-over-WebSocket discovery. Decentralised graph database that gossips peer metadata with eventual consistency. `GunDBDiscovery` + Gun node manager + initializer.
+
+---
+
+## Current-state audit
+
+Upstream source layout (`../suaveplan/packages/browser/network-discovery-gundb/src/`):
+
+- `gundb-discovery.ts` (244 L) — `DiscoveryStrategy` impl
+- `gun-node-manager.ts` (211 L) — Gun node lifecycle
+- `gundb-initializer.ts` (128 L) — relay/storage bootstrap
+- `types.ts` (123 L)
+
+See `../suaveplan/enterprise/network-discovery-gundb.md` for full upstream surface inventory.
+
+---
+
+## Parity Checklist
+
+| Capability | Upstream | Migrated | Notes |
+|---|---|---|---|
+| `DiscoveryStrategy` impl | ✅ | ✅ | |
+| Gun-node lifecycle | ✅ | ✅ | |
+| Relay/storage bootstrap | ✅ | ✅ | |
+| Public Gun-relay defaults | ⚠️ (insecure) | ⬆️ | Relay list REQUIRED; constructor throws `INVALID_OPTIONS` if missing. |
+| Security-fragile audit | upstream flag | ⬆️ | Add Zod boundary on every wire payload + constant-time peer-ID compare. |
+| Structured errors | 🚫 | ⬆️ | `defineCodes` registry with strategy-specific codes. |
+| Zod boundary validation | 🚫 | ⬆️ | Every public option struct. |
+| OTel instrumentation | 🚫 | ⬆️ | Spans + counters + histograms keyed by strategy. |
+| AbortSignal | 🚫 | ⬆️ | Threaded through `start`/`stop`/`connect`. |
+| `export *` barrels | check | ⬆️ | Convert to explicit named exports per §6a. |
+| Test-runner imports | direct vitest | ⬆️ | Rewrite to `@suaveplan/testing/runner` per §7. |
+| 100% test coverage | 🚫 | ⬆️ | Bring to 100/100/100/100. |
+| Property tests | 🚫 | ⬆️ | fast-check property suite where applicable. |
+
+---
+
+## Available workspace deps on genesis
+
+- `@suaveplan/network` ✅
+- `@suaveplan/network-bootstrap` ⬅ Wave 1
+- `@suaveplan/service-discovery` ⬅ Wave 1
+- `@suaveplan/types`, `@suaveplan/error`, `@suaveplan/events`, `@suaveplan/timing` ✅
+- `@suaveplan/testing` ✅
+- External: `gun` — add to root catalog under `network-discovery`.
+
+**Blocking note.** Wave 1 must land first. **Security note.** Upstream audit flags GunDB as security-fragile — migration tightens wire-payload validation and rejects unsigned peer announces.
+
+---
+
+## Acceptance gate
+
+1. `bunx turbo lint typecheck test --filter=@suaveplan/network-discovery-gundb` green.
+2. `bunx turbo test:coverage --filter=@suaveplan/network-discovery-gundb` 100/100/100/100.
+3. `bun run docs:check` green (sibling `.md` per `.ts`).
+4. `STATUS.md` row flipped from `–` to `✅`.
+5. `network-bootstrap` chain integration test demonstrates this strategy as a working entry.
+
+---
+
+## Out of scope
+
+- Hosting / running any required relays or trackers (deployment concern).
+- React Storybook stories — discovery is a universal/headless tier; UI lives in a dedicated devtools package (future).

openspec/archive/2026-05-11-network-discovery-gundb/tasks.md

@@ -0,0 +1,56 @@
+# Tasks — network-discovery-gundb
+
+## Phase 1: Scaffold
+
+- [ ] 1.1 Create `packages/network/network-discovery-gundb/` with standard feature-module layout.
+- [ ] 1.2 `package.json` at `0.1.0`, `"sideEffects": false`, subpath exports per module.
+- [ ] 1.3 Test config via `createTestConfig()`.
+- [ ] 1.4 `tests/dep-graph.test.ts`.
+
+## Phase 2: Types + errors
+
+- [ ] 2.1 Port public types into `src/types/` + sibling `.md`.
+- [ ] 2.2 `defineCodes` registry per parity checklist.
+- [ ] 2.3 Zod schemas for every public option struct.
+
+## Phase 3: Core strategy
+
+- [ ] 3.1 Port the `DiscoveryStrategy` implementation module(s) listed in the audit.
+- [ ] 3.2 Replace ad-hoc retry/event utilities with `@suaveplan/retry` + `@suaveplan/events`.
+- [ ] 3.3 Inject `Clock` and `Rng` via `@suaveplan/types` contracts.
+- [ ] 3.4 Thread `AbortSignal` through every async path.
+
+## Phase 4: Observability
+
+- [ ] 4.1 OTel spans for strategy lifecycle.
+- [ ] 4.2 Counters for discovered peers / failures.
+- [ ] 4.3 Histograms for handshake / signaling duration.
+
+## Phase 5: Integration
+
+- [ ] 5.1 Cross-package integration test with `@suaveplan/network-bootstrap`: register this strategy in the discovery chain, run a node, observe `peer:found` events.
+- [ ] 5.2 Optional: register discovered peers into `@suaveplan/service-discovery`.
+
+## Phase 6: Tests + docs
+
+- [ ] 6.1 Unit tests per feature module via `@suaveplan/testing/runner`.
+- [ ] 6.2 fast-check property tests where applicable (peer dedup, retry idempotency).
+- [ ] 6.3 100/100/100/100 coverage gate.
+- [ ] 6.4 Sibling `.md` doc per `.ts` impl file.
+- [ ] 6.5 Root `README.md` with basic + advanced examples.
+
+## Phase 7: Verification
+
+- [ ] 7.1 `bunx turbo lint typecheck test --filter=@suaveplan/network-discovery-gundb` green.
+- [ ] 7.2 `bunx turbo test:coverage --filter=@suaveplan/network-discovery-gundb` 100/100/100/100.
+- [ ] 7.3 `bun run docs:check --filter=@suaveplan/network-discovery-gundb` green.
+- [ ] 7.4 `MANIFEST.md` regen.
+- [ ] 7.5 `STATUS.md` row flipped from `–` to `✅`.
+
+## Pre-archive checklist
+
+- [ ] Row 1 — Phase 7 green.
+- [ ] Row 2 — Parity 🚫 list empty.
+- [ ] Row 3 — `openspec/specs/network-discovery-gundb/spec.md` written.
+- [ ] Row 4 — `network-bootstrap` integration test passes.
+- [ ] Row 5 — Folder archived.