tawasuyu

tawasuyu/brahman

Rust 212TOML 64JSON 13HTML 12666 Definitions

⎇ e570c6ca6fb6f5bc576e6a2f021d8b22a2209438 crates/protocol/SDD.md Markdown · 63 lines · 3.0 KB History raw

docs: fix factual errors en SDDs y STATUS/ROADMAP e570c6ca6 · sergio ·

1# protocol/ — Contratos canónicos + routing
2
3**Propósito.** Núcleo de intercomunicación del fractal: tipos canónicos
4(`Card`, capabilities, soma), handshake módulo↔Init, broker que empareja
5flows por tipo, y wire types de red. No corre lógica de dominio.
6
7## Crates
8
9| crate                  | tipo | rol                                                      |
10| ---------------------- | ---- | -------------------------------------------------------- |
11| `brahman-card`         | lib  | Struct `Card` (19 campos, ver abajo)                     |
12| `brahman-card-wit`     | lib  | Extracción WIT desde componentes WASM                    |
13| `brahman-cards`        | lib  | Templates Nickel + helpers consumer/producer/broker      |
14| `brahman-handshake`    | lib  | Init↔módulo: Hello, Ping, ListSessions, ListMatches      |
15| `brahman-broker`       | lib  | Service locator: flow.input ↔ flow.output por tipo       |
16| `brahman-admin`        | lib  | Socket admin separado: snapshots de sesiones+matches     |
17| `brahman-sidecar`      | lib  | `spawn(card)` para que apps se presenten al Init         |
18| `brahman-net`          | lib  | Malla libp2p opcional (TCP+noise+yamux+kad)              |
19| `ente-card`            | lib  | Alias legacy — re-export de `brahman-card`               |
20
21## Struct `Card` (anatomía completa)
22
23```rust
24pub struct Card {
25    schema_version: u16,         // versión del esquema fractal
26    id: Ulid,                     // identidad opaca única
27    lineage: Option<Ulid>,        // ancestro genealógico
28    label: String,                // nombre humano-legible
29    provides: BTreeSet<Capability>,
30    requires: BTreeSet<Capability>,
31    permissions: Permissions,     // sandbox declarativo
32    soma: SomaSpec,               // runtime Linux (ns + cgroup + rlimits)
33    payload: Payload,             // WASM | ELF | Virtual | Legacy
34    supervision: Supervision,     // restart policy
35    lifecycle: Lifecycle,         // ortogonal a supervision
36    priority: Priority,
37    flow: Flows,                  // contratos de datos in/out
38    service_socket: Option<PathBuf>,  // data plane separado
39    references: Vec<CardReference>,    // grafo de relaciones
40    kind: CardKind,               // Ente | Monada | Index | ...
41    data: Option<DataFacet>,      // None para entes runtime
42    genesis: Vec<Card>,           // hijas a encarnar inmediatamente
43    priority_contexts: BTreeMap<String, ContextBias>,
44}
45```
46
47## Dependencias
48
49- Intra: handshake → card + broker; sidecar → card; net → handshake.
50- Cross: consumido por todos los `modules/*` y `apps/*`.
51- No depende de `init/` ni de `runtime/` (es la base).
52
53## Invariantes
54
55- Serialización: `postcard` length-prefixed sobre Unix SOCK_STREAM, JSON
56  sobre HTTP (gateway). Schemas reproducibles vía Nickel.
57- Identidad: `peer_id` libp2p + firma Ed25519 anclada al peer.
58- Sesiones: el handshake mantiene una sesión por módulo encarnado.
59
60## Estado
61
62Base estable (6,260 LOC con tests). 19 TODOs concentrados en handshake
63(trust remoto fase 3) y broker. Ver `docs/changelog/protocol.md`.

SDD.md

protocol/ — Contratos canónicos + routing

Propósito. Núcleo de intercomunicación del fractal: tipos canónicos (Card, capabilities, soma), handshake módulo↔Init, broker que empareja flows por tipo, y wire types de red. No corre lógica de dominio.

Crates

cratetiporol
brahman-cardlibStruct Card (19 campos, ver abajo)
brahman-card-witlibExtracción WIT desde componentes WASM
brahman-cardslibTemplates Nickel + helpers consumer/producer/broker
brahman-handshakelibInit↔módulo: Hello, Ping, ListSessions, ListMatches
brahman-brokerlibService locator: flow.input ↔ flow.output por tipo
brahman-adminlibSocket admin separado: snapshots de sesiones+matches
brahman-sidecarlibspawn(card) para que apps se presenten al Init
brahman-netlibMalla libp2p opcional (TCP+noise+yamux+kad)
ente-cardlibAlias legacy — re-export de brahman-card

Struct Card (anatomía completa)

pub struct Card {
    schema_version: u16,         // versión del esquema fractal
    id: Ulid,                     // identidad opaca única
    lineage: Option<Ulid>,        // ancestro genealógico
    label: String,                // nombre humano-legible
    provides: BTreeSet<Capability>,
    requires: BTreeSet<Capability>,
    permissions: Permissions,     // sandbox declarativo
    soma: SomaSpec,               // runtime Linux (ns + cgroup + rlimits)
    payload: Payload,             // WASM | ELF | Virtual | Legacy
    supervision: Supervision,     // restart policy
    lifecycle: Lifecycle,         // ortogonal a supervision
    priority: Priority,
    flow: Flows,                  // contratos de datos in/out
    service_socket: Option<PathBuf>,  // data plane separado
    references: Vec<CardReference>,    // grafo de relaciones
    kind: CardKind,               // Ente | Monada | Index | ...
    data: Option<DataFacet>,      // None para entes runtime
    genesis: Vec<Card>,           // hijas a encarnar inmediatamente
    priority_contexts: BTreeMap<String, ContextBias>,
}

Dependencias

Invariantes

Estado

Base estable (6,260 LOC con tests). 19 TODOs concentrados en handshake (trust remoto fase 3) y broker. Ver docs/changelog/protocol.md.