TypeBox

​

Mentales Modell (30 Sekunden)

• Anfrage: { type: "req", id, method, params }
• Antwort: { type: "res", id, ok, payload | error }
• Ereignis: { type: "event", event, payload, seq?, stateVersion? }

Client                    Gateway
  |---- Anfr.:connect ------->|
  |<---- Antw.:hello-ok -------|
  |<---- Ereignis:tick --------|
  |---- Anfr.:health --------->|
  |<---- Antw.:health ---------|

​

Speicherort der Schemas

• Quell-Barrel: packages/gateway-protocol/src/schema.ts reexportiert Domänenmodule unter packages/gateway-protocol/src/schema/*.ts (frames.ts für die übergeordneten Envelopes und den Handshake, agent.ts, sessions.ts, cron.ts usw. je Funktionsbereich). protocol-schemas.ts ist die zentrale ProtocolSchemas-Registry, die Schemanamen ihren TypeBox-Definitionen zuordnet.
• Laufzeitvalidatoren (AJV): packages/gateway-protocol/src/index.ts
• Veröffentlichte Feature-/Discovery-Registry: src/gateway/server-methods-list.ts
• Server-Handshake und Methodendispatch: src/gateway/server.impl.ts
• Node-Client: src/gateway/client.ts
• Generiertes JSON-Schema: dist/protocol.schema.json (Build-Ausgabe, nicht eingecheckt)
• Generierte Swift-Modelle: apps/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift

​

Aktuelle Pipeline

• pnpm protocol:gen schreibt das JSON-Schema (Draft-07) nach dist/protocol.schema.json.
• pnpm protocol:gen:swift generiert die Swift-Gateway-Modelle.
• pnpm protocol:check führt beide Generatoren aus und prüft, ob die Swift-Ausgabe eingecheckt ist (die JSON-Schema-Ausgabe ist ein von Git ignoriertes Build-Artefakt).

​

Verwendung der Schemas zur Laufzeit

• Serverseitig: Jeder eingehende Frame wird mit AJV validiert. Der Handshake akzeptiert nur eine connect-Anfrage, deren Parameter ConnectParams entsprechen.
• Clientseitig: Der JS-Client validiert Ereignis- und Antwort-Frames, bevor er sie verwendet.
• Feature-Discovery: Der Gateway sendet in hello-ok eine konservative Liste von features.methods und features.events, die aus listGatewayMethods() und GATEWAY_EVENTS stammt.
• Diese Discovery-Liste ist kein generierter Auszug aller aufrufbaren Hilfsfunktionen in coreGatewayHandlers; einige Hilfs-RPCs sind in src/gateway/server-methods/*.ts implementiert, ohne in der veröffentlichten Feature-Liste aufgeführt zu sein.

​

Beispiel-Frames

{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 4,
    "client": {
      "id": "openclaw-macos",
      "displayName": "macos",
      "version": "1.0.0",
      "platform": "macos 15.1",
      "mode": "ui",
      "instanceId": "A1B2"
    }
  }
}

{
  "type": "res",
  "id": "c1",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 4,
    "server": { "version": "dev", "connId": "ws-1" },
    "features": { "methods": ["health"], "events": ["tick"] },
    "snapshot": {
      "presence": [],
      "health": {},
      "stateVersion": { "presence": 0, "health": 0 },
      "uptimeMs": 0
    },
    "auth": { "role": "operator", "scopes": ["operator.read"] },
    "policy": { "maxPayload": 1048576, "maxBufferedBytes": 1048576, "tickIntervalMs": 30000 }
  }
}

{ "type": "req", "id": "r1", "method": "health" }

{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }

{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

​

Minimaler Client (Node.js)

import { WebSocket } from "ws";

const ws = new WebSocket("ws://127.0.0.1:18789");

ws.on("open", () => {
  ws.send(
    JSON.stringify({
      type: "req",
      id: "c1",
      method: "connect",
      params: {
        minProtocol: 4,
        maxProtocol: 4,
        client: {
          id: "cli",
          displayName: "example",
          version: "dev",
          platform: "node",
          mode: "cli",
        },
      },
    }),
  );
});

ws.on("message", (data) => {
  const msg = JSON.parse(String(data));
  if (msg.type === "res" && msg.id === "c1" && msg.ok) {
    ws.send(JSON.stringify({ type: "req", id: "h1", method: "health" }));
  }
  if (msg.type === "res" && msg.id === "h1") {
    console.log("health:", msg.payload);
    ws.close();
  }
});

​

Ausführliches Beispiel: Eine Methode durchgängig hinzufügen

1. Schema (maßgebliche Quelle)

export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;

2. Validierung

export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);

3. Serververhalten

export const systemHandlers: GatewayRequestHandlers = {
  "system.echo": ({ params, respond }) => {
    const text = String(params.text ?? "");
    respond(true, { ok: true, text });
  },
};

4. Neu generieren

pnpm protocol:check

5. Tests und Dokumentation

​

Verhalten der Swift-Codegenerierung

• eine GatewayFrame-Enumeration mit den Fällen req, res, event und unknown
• stark typisierte Payload-Strukturen/-Enumerationen
• ErrorCode-Werte, GATEWAY_PROTOCOL_VERSION und GATEWAY_MIN_PROTOCOL_VERSION

​

Versionierung und Kompatibilität

• PROTOCOL_VERSION befindet sich in packages/gateway-protocol/src/version.ts (aktueller Wert: 4).
• Clients senden minProtocol und maxProtocol; der Server weist Bereiche zurück, die sein aktuelles Protokoll nicht einschließen.
• Die Swift-Modelle behalten unbekannte Frame-Typen bei, um ältere Clients nicht zu beeinträchtigen.

​

Schemamuster und Konventionen

• Die meisten Objekte verwenden additionalProperties: false für strikt definierte Payloads.
• NonEmptyString (Type.String({ minLength: 1 })) ist die Standardeinstellung für IDs sowie Methoden- und Ereignisnamen.
• Das übergeordnete GatewayFrame verwendet einen Diskriminator für type.
• Methoden mit Nebenwirkungen erfordern in den Parametern üblicherweise eine idempotencyKey (Beispiel: send, poll, agent, chat.send).
• agent akzeptiert optional internalEvents für einen zur Laufzeit generierten Orchestrierungskontext (beispielsweise die Übergabe beim Abschluss von Subagent-/Cron-Aufgaben); behandeln Sie dies als interne API-Oberfläche.

​

Live-Schema-JSON

• https://raw.githubusercontent.com/openclaw/openclaw/main/dist/protocol.schema.json

​

Bei Änderungen an Schemas

1. Aktualisieren Sie die TypeBox-Schemas im zuständigen packages/gateway-protocol/src/schema/*.ts-Modul und registrieren Sie sie in protocol-schemas.ts.
2. Registrieren Sie die Methode/das Ereignis in src/gateway/server-methods-list.ts.
3. Aktualisieren Sie src/gateway/method-scopes.ts, wenn der neue RPC eine Bereichsklassifizierung für Operator oder Node benötigt.
4. Führen Sie pnpm protocol:check aus.
5. Checken Sie die neu generierten Swift-Modelle ein.

​

Verwandte Themen

• Protokoll für umfangreiche Ausgaben
• RPC-Adapter