TypeBox

​

Modelo mental (30 segundos)

• Solicitação: { type: "req", id, method, params }
• Resposta: { type: "res", id, ok, payload | error }
• Evento: { type: "event", event, payload, seq?, stateVersion? }

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

​

Onde ficam os esquemas

• Barrel de origem: packages/gateway-protocol/src/schema.ts reexporta módulos de domínio em packages/gateway-protocol/src/schema/*.ts (frames.ts para os envelopes de nível superior e o handshake, agent.ts, sessions.ts, cron.ts etc., por área funcional). protocol-schemas.ts é o registro central ProtocolSchemas que mapeia nomes de esquemas para suas definições TypeBox.
• Validadores em tempo de execução (AJV): packages/gateway-protocol/src/index.ts
• Registro anunciado de recursos/descoberta: src/gateway/server-methods-list.ts
• Handshake do servidor e despacho de métodos: src/gateway/server.impl.ts
• Cliente Node: src/gateway/client.ts
• JSON Schema gerado: dist/protocol.schema.json (saída da compilação, não versionada)
• Modelos Swift gerados: apps/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift

​

Pipeline atual

• pnpm protocol:gen grava o JSON Schema (draft-07) em dist/protocol.schema.json.
• pnpm protocol:gen:swift gera os modelos Swift do Gateway.
• pnpm protocol:check executa ambos os geradores e verifica se a saída Swift está versionada (a saída JSON Schema é um artefato de compilação ignorado pelo Git).

​

Como os esquemas são usados em tempo de execução

• No servidor: cada quadro recebido é validado com AJV. O handshake aceita apenas uma solicitação connect cujos parâmetros correspondam a ConnectParams.
• No cliente: o cliente JS valida os quadros de evento e resposta antes de usá-los.
• Descoberta de recursos: o Gateway envia uma lista conservadora de features.methods e features.events em hello-ok, proveniente de listGatewayMethods() e GATEWAY_EVENTS.
• Essa lista de descoberta não é um despejo gerado de todos os auxiliares chamáveis em coreGatewayHandlers; alguns RPCs auxiliares são implementados em src/gateway/server-methods/*.ts sem serem enumerados na lista de recursos anunciados.

​

Exemplos de quadros

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

​

Cliente mínimo (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();
  }
});

​

Exemplo completo: adicionar um método de ponta a ponta

1. Esquema (fonte de verdade)

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. Validação

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

3. Comportamento do servidor

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

4. Gerar novamente

pnpm protocol:check

5. Testes e documentação

​

Comportamento da geração de código Swift

• um enum GatewayFrame com os casos req, res, event e unknown
• structs/enums de payload fortemente tipados
• valores de ErrorCode, GATEWAY_PROTOCOL_VERSION e GATEWAY_MIN_PROTOCOL_VERSION

​

Versionamento e compatibilidade

• PROTOCOL_VERSION fica em packages/gateway-protocol/src/version.ts (valor atual: 4).
• Os clientes enviam minProtocol e maxProtocol; o servidor rejeita intervalos que não incluam seu protocolo atual.
• Os modelos Swift mantêm tipos de quadro desconhecidos para evitar incompatibilidade com clientes mais antigos.

​

Padrões e convenções de esquema

• A maioria dos objetos usa additionalProperties: false para payloads estritos.
• NonEmptyString (Type.String({ minLength: 1 })) é o padrão para IDs e nomes de métodos/eventos.
• O GatewayFrame de nível superior usa um discriminador em type.
• Métodos com efeitos colaterais geralmente exigem um idempotencyKey nos parâmetros (exemplo: send, poll, agent, chat.send).
• agent aceita internalEvents opcionais para contexto de orquestração gerado em tempo de execução (por exemplo, transferência da conclusão de uma tarefa de subagente/cron); trate isso como uma superfície de API interna.

​

JSON do esquema publicado

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

​

Ao alterar esquemas

1. Atualize os esquemas TypeBox no módulo responsável em packages/gateway-protocol/src/schema/*.ts e registre-os em protocol-schemas.ts.
2. Registre o método/evento em src/gateway/server-methods-list.ts.
3. Atualize src/gateway/method-scopes.ts quando o novo RPC precisar de classificação de escopo de operador ou Node.
4. Execute pnpm protocol:check.
5. Faça commit dos modelos Swift gerados novamente.

​

Relacionado

• Protocolo de saída avançada
• Adaptadores RPC