Initial Commit
This commit is contained in:
@@ -0,0 +1,112 @@
|
||||
# OpenSpec Change: enterprise-server-network-libp2p-server
|
||||
|
||||
- **Change ID**: enterprise-server-network-libp2p-server
|
||||
- **Package**: `@suaveplan/network-libp2p-server`
|
||||
- **Category**: server/network
|
||||
- **Target path**: `server/network/network-libp2p-server`
|
||||
- **Status**: SUPERSEDED-BY-GENESIS-WAVE
|
||||
- **Date**: 2026-04-24
|
||||
- **Reference spec**: `/mnt/s/web/suaveplan/enterprise/network-libp2p-server.md`
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Deliver `@suaveplan/network-libp2p-server` on the genesis branch from scratch at enterprise quality. The package provides a server-side libp2p node with TCP + WebSocket transports, noise encryption, yamux stream multiplexing, Kad-DHT peer discovery, GossipSub pub/sub, and a typed `Libp2pServerAdapter` facade. It exposes `start` / `stop`, `subscribe` / `publish` for topic-based messaging, `dialPeer`, and `peers` queries. Genesis adds Zod-validated options, `@suaveplan/error` codes, OTel spans/counters, retry on dial failures, and full integration tests using two in-process nodes.
|
||||
|
||||
---
|
||||
|
||||
## Current-state audit (genesis)
|
||||
|
||||
Does not exist on genesis — fresh build.
|
||||
|
||||
---
|
||||
|
||||
## Available workspace deps on genesis
|
||||
|
||||
| Package | Role |
|
||||
|---|---|
|
||||
| `@suaveplan/error` (`workspace:^`) | Typed `NETWORK_LIBP2P.*` error codes |
|
||||
| `@suaveplan/types` (`workspace:^`) | `LoggerLike` |
|
||||
| `@suaveplan/events` (`workspace:^`) | Internal event routing |
|
||||
| `@suaveplan/retry` (`workspace:^`) | Dial retry |
|
||||
| `@suaveplan/logger` (`workspace:^`) | Structured logs |
|
||||
| `zod` (`catalog:forms`) | Options validation |
|
||||
| `@opentelemetry/api` (`catalog:observability`) | Spans + gauges |
|
||||
| `libp2p` (`catalog:network`) | Core libp2p |
|
||||
| `@libp2p/tcp` / `@libp2p/websockets` / `@chainsafe/libp2p-noise` / `@chainsafe/libp2p-yamux` / `@libp2p/kad-dht` / `@chainsafe/libp2p-gossipsub` (all `catalog:network`) | Transport + protocol stack |
|
||||
| `tslib` (`catalog:build`) | Runtime helpers |
|
||||
|
||||
---
|
||||
|
||||
## Public API surface
|
||||
|
||||
```ts
|
||||
class Libp2pServerAdapter {
|
||||
constructor(options: Libp2pServerOptions)
|
||||
start(): Promise<void>
|
||||
stop(): Promise<void>
|
||||
peerId(): string
|
||||
multiaddrs(): string[]
|
||||
peers(): string[]
|
||||
dialPeer(multiaddr: string): Promise<void>
|
||||
subscribe(topic: string, handler: (from: string, data: Uint8Array) => void): () => void
|
||||
publish(topic: string, data: Uint8Array): Promise<void>
|
||||
isStarted(): boolean
|
||||
}
|
||||
|
||||
function createLibp2pServerAdapter(options: Libp2pServerOptions): Libp2pServerAdapter
|
||||
|
||||
interface Libp2pServerOptions {
|
||||
listenAddresses?: string[] // default: ['/ip4/0.0.0.0/tcp/0']
|
||||
bootstrapPeers?: string[]
|
||||
dhtEnabled?: boolean // default: true
|
||||
gossipEnabled?: boolean // default: true
|
||||
logger?: LoggerLike
|
||||
}
|
||||
|
||||
const Libp2pServerOptionsSchema: z.ZodSchema<Libp2pServerOptions>
|
||||
|
||||
type Libp2pErrorCode =
|
||||
| 'NETWORK_LIBP2P_START_FAILED'
|
||||
| 'NETWORK_LIBP2P_DIAL_FAILED'
|
||||
| 'NETWORK_LIBP2P_PUBLISH_FAILED'
|
||||
| 'NETWORK_LIBP2P_STOP_FAILED'
|
||||
|
||||
function registerLibp2pErrorCodes(): void
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## File layout
|
||||
|
||||
```text
|
||||
server/network/network-libp2p-server/
|
||||
package.json
|
||||
tsconfig.json
|
||||
vitest.config.ts
|
||||
src/
|
||||
index.ts
|
||||
error-codes.ts
|
||||
constants/index.ts
|
||||
types/
|
||||
libp2p-server.types.ts
|
||||
libp2p-server.types.md
|
||||
adapter/
|
||||
libp2p-server-adapter/
|
||||
libp2p-server-adapter.ts
|
||||
libp2p-server-adapter.md
|
||||
libp2p-server-adapter.types.ts
|
||||
libp2p-server-adapter.test.ts
|
||||
index.ts
|
||||
tests/
|
||||
integration.test.ts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Impact
|
||||
|
||||
Downstream: platform network mesh features. Server-only — Node.js required.
|
||||
|
||||
**Prerequisites on Verdaccio**: `@suaveplan/error`, `@suaveplan/types`, `@suaveplan/events`, `@suaveplan/retry`, `@suaveplan/logger`.
|
||||
@@ -0,0 +1,56 @@
|
||||
# Tasks: enterprise-server-network-libp2p-server
|
||||
|
||||
**Change ID**: enterprise-server-network-libp2p-server
|
||||
**Package**: `@suaveplan/network-libp2p-server`
|
||||
**Target path**: `server/network/network-libp2p-server`
|
||||
**Prerequisites on Verdaccio**: `@suaveplan/error`, `@suaveplan/types`, `@suaveplan/events`, `@suaveplan/retry`, `@suaveplan/logger`
|
||||
|
||||
---
|
||||
|
||||
## 1. Scaffold
|
||||
|
||||
- [x] Create directory tree per `proposal.md`.
|
||||
- [x] `package.json` at `0.1.0`, `"sideEffects": false`, exports `"."` + `adapter` subpath.
|
||||
- [x] Deps: all workspace and catalog deps listed in proposal.
|
||||
- [x] DevDeps: `vitest catalog:testing`, `@vitest/coverage-istanbul catalog:testing`, `@suaveplan/testing workspace:^`.
|
||||
- [x] `tsconfig.json` extending `library-node.json`; `vitest.config.ts` with `pool: 'forks'`, `setupFiles: ['@suaveplan/testing/polyfills']`.
|
||||
- [x] Scripts: `lint`, `typecheck`, `test`, `test:coverage`, `build`, `docs:check`.
|
||||
|
||||
## 2. Types and errors
|
||||
|
||||
- [x] Define `Libp2pServerOptions`, `Libp2pServerOptionsSchema` in `src/types/libp2p-server.types.ts`.
|
||||
- [x] Write `libp2p-server.types.md` (≥200 words).
|
||||
- [x] `src/error-codes.ts`: four codes with metadata; `registerLibp2pErrorCodes()`; eager call.
|
||||
|
||||
## 3. Adapter implementation
|
||||
|
||||
- [x] Implement `Libp2pServerAdapter` in `src/adapter/libp2p-server-adapter/libp2p-server-adapter.ts`:
|
||||
- Constructor builds `createLibp2p({...})` config from options — TCP + WS transports, Noise, Yamux, KadDHT (when `dhtEnabled`), GossipSub (when `gossipEnabled`).
|
||||
- `start()`: `await node.start()`; throw `NETWORK_LIBP2P_START_FAILED` on error; OTel span.
|
||||
- `stop()`: `await node.stop()`; unsubscribe all handlers; OTel span.
|
||||
- `peerId()` / `multiaddrs()` / `peers()`: delegate to libp2p node.
|
||||
- `dialPeer(multiaddr)`: retry up to `maxRetries` with `@suaveplan/retry`; throw `NETWORK_LIBP2P_DIAL_FAILED` on exhaustion; OTel span.
|
||||
- `subscribe(topic, handler)`: GossipSub topic subscription; return unsubscribe fn.
|
||||
- `publish(topic, data)`: GossipSub publish; throw `NETWORK_LIBP2P_PUBLISH_FAILED` on error.
|
||||
- OTel gauge `network_libp2p.peer_count`; counter `network_libp2p.messages_total`.
|
||||
- [x] Write `libp2p-server-adapter.types.ts` with internal types.
|
||||
- [x] Write `libp2p-server-adapter.test.ts` (≤500 lines): two in-process nodes; start/stop lifecycle; dial + subscribe + publish round-trip; peer count updates; `{ timeout: 30000 }`.
|
||||
- [x] Write `libp2p-server-adapter.md` (≥200 words, simple + advanced, API reference).
|
||||
|
||||
## 4. Integration tests
|
||||
|
||||
- [x] `tests/integration.test.ts`: three-node mesh — each node subscribes same topic, one publishes, others receive; graceful stop propagates disconnect event; `{ timeout: 30000 }`.
|
||||
|
||||
## 5. OTel + docs
|
||||
|
||||
- [x] All OTel instrumentation per proposal.
|
||||
- [x] Root `README.md`: quick-start two-node example, subscribe/publish example, bootstrap peers setup, API table.
|
||||
|
||||
## 6. Verify and publish
|
||||
|
||||
- [x] `bunx turbo lint --filter=@suaveplan/network-libp2p-server` — zero errors.
|
||||
- [x] `bunx turbo typecheck --filter=@suaveplan/network-libp2p-server` — zero errors.
|
||||
- [x] `bunx turbo test --filter=@suaveplan/network-libp2p-server` — all pass.
|
||||
- [x] `bunx turbo test:coverage --filter=@suaveplan/network-libp2p-server` — 100%.
|
||||
- [x] `bun scripts/publish.ts --package @suaveplan/network-libp2p-server`.
|
||||
- [x] Update `CLAUDE.md`; archive to `openspec/archive/2026-04-24-enterprise-server-network-libp2p-server/`.
|
||||
Reference in New Issue
Block a user