​

TypeBox comme source de vérité du protocole

​

Modèle mental (30 secondes)

• Requête : { type: "req", id, method, params }
• Réponse : { type: "res", id, ok, payload | error }
• Événement : { type: "event", event, payload, seq?, stateVersion? }

Client                    Gateway
  |---- req:connect -------->|
  |<---- res:hello-ok --------|
  |<---- event:tick ----------|
  |---- req:health ---------->|
  |<---- res:health ----------|

​

Où se trouvent les schémas

• Source : src/gateway/protocol/schema.ts
• Validateurs runtime (AJV) : src/gateway/protocol/index.ts
• Registre des fonctionnalités/discovery annoncées : src/gateway/server-methods-list.ts
• Handshake serveur + distribution des méthodes : src/gateway/server.impl.ts
• Client de nœud : src/gateway/client.ts
• JSON Schema généré : dist/protocol.schema.json
• Modèles Swift générés : apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

​

Pipeline actuel

• pnpm protocol:gen
  • écrit le JSON Schema (draft‑07) dans dist/protocol.schema.json
• pnpm protocol:gen:swift
  • génère les modèles gateway Swift
• pnpm protocol:check
  • exécute les deux générateurs et vérifie que la sortie est validée dans le dépôt

​

Comment les schémas sont utilisés à l’exécution

• Côté serveur : chaque trame entrante est validée avec AJV. Le handshake n’accepte qu’une requête connect dont les paramètres correspondent à ConnectParams.
• Côté client : le client JS valide les trames d’événement et de réponse avant de les utiliser.
• Discovery des fonctionnalités : Gateway envoie une liste conservatrice features.methods et features.events dans hello-ok depuis listGatewayMethods() et GATEWAY_EVENTS.
• Cette liste de discovery n’est pas un dump généré de chaque helper appelable dans coreGatewayHandlers ; certains RPC helpers sont implémentés dans src/gateway/server-methods/*.ts sans être énumérés dans la liste des fonctionnalités annoncées.

​

Exemples de trames

{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 3,
    "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": 3,
    "server": { "version": "dev", "connId": "ws-1" },
    "features": { "methods": ["health"], "events": ["tick"] },
    "snapshot": {
      "presence": [],
      "health": {},
      "stateVersion": { "presence": 0, "health": 0 },
      "uptimeMs": 0
    },
    "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 }

​

Client minimal (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: 3,
        maxProtocol: 3,
        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();
  }
});

​

Exemple complet : ajouter une méthode de bout en bout

1. Schéma (source de vérité)

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. Validation

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

3. Comportement serveur

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

4. Régénérer

pnpm protocol:check

5. Tests + documentation

​

Comportement du codegen Swift

• un enum GatewayFrame avec les cas req, res, event et unknown
• des structs/enums de charge utile fortement typés
• des valeurs ErrorCode et GATEWAY_PROTOCOL_VERSION

​

Versionnement + compatibilité

• PROTOCOL_VERSION se trouve dans src/gateway/protocol/schema.ts.
• Les clients envoient minProtocol + maxProtocol ; le serveur rejette les incompatibilités.
• Les modèles Swift conservent les types de trame inconnus afin d’éviter de casser les anciens clients.

​

Motifs et conventions des schémas

• La plupart des objets utilisent additionalProperties: false pour des charges utiles strictes.
• NonEmptyString est la valeur par défaut pour les ID et les noms de méthode/événement.
• Le GatewayFrame de niveau supérieur utilise un discriminator sur type.
• Les méthodes avec effets de bord nécessitent généralement un idempotencyKey dans les paramètres (exemple : send, poll, agent, chat.send).
• agent accepte des internalEvents facultatifs pour le contexte d’orchestration généré par le runtime (par exemple le transfert de fin de tâche cron/sous-agent) ; traitez cela comme une surface API interne.

​

JSON Schema actif

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

​

Quand vous modifiez les schémas

1. Mettez à jour les schémas TypeBox.
2. Enregistrez la méthode/l’événement dans src/gateway/server-methods-list.ts.
3. Mettez à jour src/gateway/method-scopes.ts lorsque le nouveau RPC nécessite une classification de portée operator ou node.
4. Exécutez pnpm protocol:check.
5. Validez le schéma régénéré + les modèles Swift.