TypeBox

​

Ментальна модель (30 секунд)

• Запит: { type: "req", id, method, params }
• Відповідь: { type: "res", id, ok, payload | error }
• Подія: { type: "event", event, payload, seq?, stateVersion? }

Клієнт                   Gateway
  |---- запит:connect ------>|
  |<---- відповідь:hello-ok --|
  |<---- подія:tick ----------|
  |---- запит:health -------->|
  |<---- відповідь:health ----|

​

Де розташовані схеми

• Вихідний barrel-файл: packages/gateway-protocol/src/schema.ts повторно експортує доменні модулі з packages/gateway-protocol/src/schema/*.ts (frames.ts для конвертів верхнього рівня та рукостискання, agent.ts, sessions.ts, cron.ts тощо — відповідно до функціональної області). protocol-schemas.ts — центральний реєстр ProtocolSchemas, який зіставляє назви схем з їхніми визначеннями TypeBox.
• Валідатори часу виконання (AJV): packages/gateway-protocol/src/index.ts
• Рекламований реєстр функцій/виявлення можливостей: src/gateway/server-methods-list.ts
• Серверне рукостискання та диспетчеризація методів: src/gateway/server.impl.ts
• Клієнт вузла: src/gateway/client.ts
• Згенерована JSON Schema: dist/protocol.schema.json (результат збирання, не додається до репозиторію)
• Згенеровані моделі Swift: apps/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift

​

Поточний конвеєр

• pnpm protocol:gen записує JSON Schema (draft-07) у dist/protocol.schema.json.
• pnpm protocol:gen:swift генерує моделі Gateway для Swift.
• pnpm protocol:check запускає обидва генератори й перевіряє, що результат для Swift додано до репозиторію (результат JSON Schema є ігнорованим Git артефактом збирання).

​

Як схеми використовуються під час виконання

• На стороні сервера: кожен вхідний фрейм перевіряється за допомогою AJV. Рукостискання приймає лише запит connect, параметри якого відповідають ConnectParams.
• На стороні клієнта: клієнт JS перевіряє фрейми подій і відповідей перед їх використанням.
• Виявлення можливостей: Gateway надсилає консервативні списки features.methods і features.events у hello-ok, отримані з listGatewayMethods() і GATEWAY_EVENTS.
• Цей список виявлення можливостей не є згенерованим переліком усіх доступних для виклику допоміжних функцій у coreGatewayHandlers; деякі допоміжні RPC реалізовано в src/gateway/server-methods/*.ts, але їх не перелічено в рекламованому списку функцій.

​

Приклади фреймів

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

​

Мінімальний клієнт (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();
  }
});

​

Практичний приклад: наскрізне додавання методу

1. Схема (джерело істини)

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. Перевірка

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

3. Поведінка сервера

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

4. Повторне генерування

pnpm protocol:check

5. Тести та документація

​

Поведінка генерування коду Swift

• перелік GatewayFrame з варіантами req, res, event і unknown
• строго типізовані структури/переліки корисного навантаження
• значення ErrorCode, GATEWAY_PROTOCOL_VERSION і GATEWAY_MIN_PROTOCOL_VERSION

​

Версіонування та сумісність

• PROTOCOL_VERSION міститься в packages/gateway-protocol/src/version.ts (поточне значення: 4).
• Клієнти надсилають minProtocol і maxProtocol; сервер відхиляє діапазони, які не містять його поточної версії протоколу.
• Моделі Swift зберігають невідомі типи фреймів, щоб не порушувати роботу старіших клієнтів.

​

Шаблони та угоди схем

• Більшість об’єктів використовують additionalProperties: false для строгих корисних навантажень.
• NonEmptyString (Type.String({ minLength: 1 })) використовується типово для ідентифікаторів і назв методів/подій.
• GatewayFrame верхнього рівня використовує дискримінатор за полем type.
• Методи з побічними ефектами зазвичай вимагають idempotencyKey у параметрах (наприклад: send, poll, agent, chat.send).
• agent приймає необов’язковий параметр internalEvents для згенерованого під час виконання контексту оркестрації (наприклад, передавання результату завершення завдання субагента/Cron); вважайте це внутрішньою поверхнею API.

​

Актуальна JSON-схема

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

​

Коли ви змінюєте схеми

1. Оновіть схеми TypeBox у відповідному модулі packages/gateway-protocol/src/schema/*.ts і зареєструйте їх у protocol-schemas.ts.
2. Зареєструйте метод/подію в src/gateway/server-methods-list.ts.
3. Оновіть src/gateway/method-scopes.ts, якщо новому RPC потрібна класифікація області доступу оператора або вузла.
4. Виконайте pnpm protocol:check.
5. Додайте повторно згенеровані моделі Swift до коміту.

​

Пов’язане

• Протокол розширеного виведення
• Адаптери RPC