This commit is contained in:
Raven Scott
2026-05-20 21:02:45 -04:00
parent 1f3f4b24a2
commit 14d0980b4f
734 changed files with 682 additions and 746 deletions
@@ -0,0 +1,99 @@
# API: hyper-p2p-trust-graph
**Protocol:** `trust-graph/v1`
**Export:** `HyperP2PTrustGraph`
## Overview
Production trust & security module: Hyperswarm discovery + Protomux when `topic` is set.
## Constructor
```js
const mod = new HyperP2PTrustGraph(opts)
```
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `topic` | varies | null | topic |
| `keyPair` | KeyPair | random Ed25519 | keyPair |
| `decay` | number | 0.95 | decay |
| `maxDepth` | number | 4 | maxDepth |
## Methods
### `addEdge(from, to, weight = 1)`
- **Returns:** `value`
- **Throws:** — (none documented in method body)
### `decaySweep(—)`
- **Returns:** `value`
- **Throws:** — (none documented in method body)
### `trustScore(from, to)`
- **Returns:** `value`
- **Throws:** — (none documented in method body)
### `edges(—)`
- **Returns:** `value`
- **Throws:** — (none documented in method body)
### `toJSON(—)`
- **Returns:** `value`
- **Throws:** — (none documented in method body)
### `merge(remote)`
- **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 |
| `decay` | pruned |
| `edge` | edge |
| `merge` | updated |
## 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 `trust-graph/v1`.
## Testing
```bash
npm install && npm test
```
Integration: [`../../real_tests/integration/trust-graph-two-node.js`](../../../real_tests/integration/trust-graph-two-node.js)
@@ -0,0 +1,43 @@
# Architecture: hyper-p2p-trust-graph
**Category:** Trust & security
```mermaid
flowchart LR
App[Application] --> Mod[HyperP2PTrustGraph]
Mod --> Mux[Protomux trust-graph/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 |
|------|--------|-----------|----------|
| `edge` | edge | 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-attestation-chain`, `hyper-p2p-reputation-system`.