Updates
This commit is contained in:
@@ -0,0 +1,2 @@
|
||||
node_modules/
|
||||
*-storage/
|
||||
@@ -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.
|
||||
@@ -0,0 +1,43 @@
|
||||
# hyper-p2p-crdt-map
|
||||
|
||||
Production state & crdts module: Hyperswarm discovery + Protomux when `topic` is set.
|
||||
|
||||
**Category:** State & CRDTs
|
||||
|
||||
**Composes with:** `hyper-p2p-reactive-state`, `hyper-p2p-conflict-set`
|
||||
|
||||
**Protocol:** `crdt-map/v1`
|
||||
|
||||
## When to use
|
||||
|
||||
Multi-peer apps that need state & crdts 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 { HyperP2PCrdtMap } = require('hyper-p2p-crdt-map')
|
||||
const topic = process.argv[2] // 64-char hex or string
|
||||
const mod = new HyperP2PCrdtMap({ 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/) — `crdt-map-two-node.js`
|
||||
|
||||
## Test
|
||||
|
||||
```bash
|
||||
npm install && npm test
|
||||
```
|
||||
@@ -0,0 +1,96 @@
|
||||
# API: hyper-p2p-crdt-map
|
||||
|
||||
**Protocol:** `crdt-map/v1`
|
||||
|
||||
**Export:** `HyperP2PCrdtMap`
|
||||
|
||||
## Overview
|
||||
|
||||
Production state & crdts module: Hyperswarm discovery + Protomux when `topic` is set.
|
||||
|
||||
## Constructor
|
||||
|
||||
```js
|
||||
const mod = new HyperP2PCrdtMap(opts)
|
||||
```
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `topic` | varies | null | topic |
|
||||
| `keyPair` | KeyPair | random Ed25519 | keyPair |
|
||||
|
||||
## Methods
|
||||
|
||||
### `set(key, value)`
|
||||
|
||||
- **Returns:** `value`
|
||||
- **Throws:** — (none documented in method body)
|
||||
|
||||
### `get(key)`
|
||||
|
||||
- **Returns:** `value`
|
||||
- **Throws:** — (none documented in method body)
|
||||
|
||||
### `delete(key)`
|
||||
|
||||
- **Returns:** `value`
|
||||
- **Throws:** — (none documented in method body)
|
||||
|
||||
### `keys(—)`
|
||||
|
||||
- **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 |
|
||||
| `merge` | updated |
|
||||
| `set` | cell |
|
||||
|
||||
## 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 `crdt-map/v1`.
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
npm install && npm test
|
||||
```
|
||||
|
||||
Integration: [`../../real_tests/integration/crdt-map-two-node.js`](../../../real_tests/integration/crdt-map-two-node.js)
|
||||
@@ -0,0 +1,43 @@
|
||||
# Architecture: hyper-p2p-crdt-map
|
||||
|
||||
**Category:** State & CRDTs
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
App[Application] --> Mod[HyperP2PCrdtMap]
|
||||
Mod --> Mux[Protomux crdt-map/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 |
|
||||
|------|--------|-----------|----------|
|
||||
| `set` | cell | 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-reactive-state`, `hyper-p2p-conflict-set`.
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
require('bare-process/global')
|
||||
const { HyperP2PCrdtMap } = require('../index.js')
|
||||
|
||||
async function main () {
|
||||
const m = new HyperP2PCrdtMap()
|
||||
m.set('hello', 'world')
|
||||
console.log('get', m.get('hello'))
|
||||
await m.close()
|
||||
}
|
||||
main().catch(console.error)
|
||||
@@ -0,0 +1,96 @@
|
||||
require('bare-process/global')
|
||||
const EventEmitter = require('bare-events')
|
||||
const b4a = require('b4a')
|
||||
const { initModuleSwarm, gossipSend } = require('../../_shared/p2p-bare.js')
|
||||
|
||||
const PROTOCOL = 'crdt-map/v1'
|
||||
|
||||
class HyperP2PCrdtMap 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._cells = new Map()
|
||||
this.swarm = null
|
||||
this._peerMsgs = null
|
||||
}
|
||||
|
||||
_shouldWin (incoming, current) {
|
||||
if (!current) return true
|
||||
if (incoming.ts > current.ts) return true
|
||||
if (incoming.ts === current.ts && incoming.peerId > current.peerId) return true
|
||||
return false
|
||||
}
|
||||
|
||||
set (key, value) {
|
||||
const cell = { key, value, ts: Date.now(), peerId: this.peerId }
|
||||
const cur = this._cells.get(key)
|
||||
if (this._shouldWin(cell, cur)) {
|
||||
this._cells.set(key, cell)
|
||||
if (this._peerMsgs) gossipSend(this, { type: 'set', cell })
|
||||
this.emit('set', cell)
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
get (key) {
|
||||
const c = this._cells.get(key)
|
||||
return c ? c.value : undefined
|
||||
}
|
||||
|
||||
delete (key) {
|
||||
return this.set(key, null)
|
||||
}
|
||||
|
||||
keys () {
|
||||
return [...this._cells.keys()]
|
||||
}
|
||||
|
||||
merge (remote) {
|
||||
if (!remote || !remote.cells) return 0
|
||||
let n = 0
|
||||
for (const cell of remote.cells) {
|
||||
const cur = this._cells.get(cell.key)
|
||||
if (this._shouldWin(cell, cur)) {
|
||||
this._cells.set(cell.key, cell)
|
||||
n++
|
||||
}
|
||||
}
|
||||
if (n) this.emit('merge', { updated: n })
|
||||
return n
|
||||
}
|
||||
|
||||
toJSON () {
|
||||
return { cells: [...this._cells.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 === 'set' && data.cell) this.merge({ cells: [data.cell] })
|
||||
}
|
||||
})
|
||||
return this
|
||||
}
|
||||
|
||||
|
||||
getStats () {
|
||||
return { ...this._stats }
|
||||
}
|
||||
|
||||
async close () {
|
||||
if (this.swarm) await this.swarm.destroy().catch(() => {})
|
||||
this.swarm = null
|
||||
this.emit('closed')
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { HyperP2PCrdtMap, PROTOCOL }
|
||||
+1774
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"name": "hyper-p2p-crdt-map",
|
||||
"version": "0.3.1",
|
||||
"description": "LWW-Map CRDT 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" }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
require('bare-process/global')
|
||||
const test = require('brittle')
|
||||
const { HyperP2PCrdtMap } = require('../index.js')
|
||||
|
||||
test('crdt-map: set get', async (t) => {
|
||||
const m = new HyperP2PCrdtMap()
|
||||
m.set('k', { v: 1 })
|
||||
t.is(m.get('k').v, 1)
|
||||
await m.close()
|
||||
})
|
||||
|
||||
test('crdt-map: merge LWW', async (t) => {
|
||||
const a = new HyperP2PCrdtMap()
|
||||
const b = new HyperP2PCrdtMap()
|
||||
a.set('x', 'a')
|
||||
b.merge(a.toJSON())
|
||||
t.is(b.get('x'), 'a')
|
||||
await a.close()
|
||||
await b.close()
|
||||
})
|
||||
test('hyper-p2p-crdt-map: close without leak', async (t) => {
|
||||
const m = new HyperP2PCrdtMap()
|
||||
await m.close()
|
||||
t.pass()
|
||||
})
|
||||
test('hyper-p2p-crdt-map: validation rejects invalid input', async (t) => {
|
||||
const m = new HyperP2PCrdtMap()
|
||||
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()
|
||||
})
|
||||
Reference in New Issue
Block a user