TypeBox

​

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

​

Emplacement des schémas

• Point d’exportation source : packages/gateway-protocol/src/schema.ts réexporte les modules de domaine sous packages/gateway-protocol/src/schema/*.ts (frames.ts pour les enveloppes de premier niveau et la négociation initiale, agent.ts, sessions.ts, cron.ts, etc. selon le domaine fonctionnel). protocol-schemas.ts est le registre central ProtocolSchemas qui associe les noms de schémas à leurs définitions TypeBox.
• Validateurs à l’exécution (AJV) : packages/gateway-protocol/src/index.ts
• Registre des fonctionnalités et de découverte annoncées : src/gateway/server-methods-list.ts
• Négociation initiale du serveur et répartition des méthodes : src/gateway/server.impl.ts
• Client Node : src/gateway/client.ts
• JSON Schema généré : dist/protocol.schema.json (sortie de compilation, non suivie dans le dépôt)
• Modèles Swift générés : apps/shared/OpenClawKit/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 Swift du Gateway.
• pnpm protocol:check exécute les deux générateurs et vérifie que la sortie Swift est enregistrée dans le dépôt (la sortie JSON Schema est un artefact de compilation ignoré par Git).

​

Utilisation des schémas à l’exécution

• Côté serveur : chaque trame entrante est validée avec AJV. La négociation initiale 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.
• Découverte des fonctionnalités : le Gateway envoie dans hello-ok une liste prudente features.methods et features.events, issue de listGatewayMethods() et de GATEWAY_EVENTS.
• Cette liste de découverte n’est pas un inventaire généré de tous les assistants appelables dans coreGatewayHandlers ; certains RPC auxiliaires sont implémentés dans src/gateway/server-methods/*.ts sans figurer dans la liste des fonctionnalités annoncées.

​

Exemples de trames

{
  "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 }

​

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: 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();
  }
});

​

Exemple détaillé : 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 du serveur

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

4. Régénération

pnpm protocol:check

5. Tests et documentation

​

Comportement de la génération de code Swift

• une énumération GatewayFrame avec les cas req, res, event et unknown
• des structures et énumérations de charges utiles fortement typées
• les valeurs ErrorCode, GATEWAY_PROTOCOL_VERSION et GATEWAY_MIN_PROTOCOL_VERSION

​

Gestion des versions et compatibilité

• PROTOCOL_VERSION se trouve dans packages/gateway-protocol/src/version.ts (valeur actuelle : 4).
• Les clients envoient minProtocol et maxProtocol ; le serveur rejette les plages qui n’incluent pas son protocole actuel.
• Les modèles Swift conservent les types de trames inconnus afin de ne pas rendre les anciens clients incompatibles.

​

Modèles et conventions des schémas

• La plupart des objets utilisent additionalProperties: false pour imposer des charges utiles strictes.
• NonEmptyString (Type.String({ minLength: 1 })) est utilisé par défaut pour les identifiants ainsi que les noms de méthodes et d’événements.
• Le GatewayFrame de premier niveau utilise un discriminateur sur type.
• Les méthodes ayant des effets de bord exigent généralement un idempotencyKey dans leurs paramètres (exemple : send, poll, agent, chat.send).
• agent accepte un paramètre facultatif internalEvents pour le contexte d’orchestration généré à l’exécution (par exemple, la transmission de l’achèvement d’une tâche d’un sous-agent ou de Cron) ; considérez-le comme une surface d’API interne.

​

JSON du schéma actif

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

​

Lorsque vous modifiez les schémas

1. Mettez à jour les schémas TypeBox dans le module propriétaire packages/gateway-protocol/src/schema/*.ts et enregistrez-les dans protocol-schemas.ts.
2. Enregistrez la méthode ou 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 pour l’opérateur ou le Node.
4. Exécutez pnpm protocol:check.
5. Enregistrez les modèles Swift régénérés dans le dépôt.

​

Ressources connexes

• Protocole de sortie enrichie
• Adaptateurs RPC