Saltar para o conteúdo principal

​
TypeBox como fonte de verdade do protocolo

Última atualização: 2026-01-10 TypeBox é uma biblioteca de esquemas orientada a TypeScript. Nós a usamos para definir o protocolo WebSocket do Gateway (handshake, request/response, eventos do servidor). Esses esquemas conduzem a validação em runtime, a exportação para JSON Schema e o codegen Swift para o app macOS. Uma única fonte de verdade; todo o resto é gerado. Se você quiser o contexto de protocolo em nível mais alto, comece por Arquitetura do Gateway.

​
Modelo mental (30 segundos)

Toda mensagem WS do Gateway é um de três frames:
  • Requisição: { type: "req", id, method, params }
  • Resposta: { type: "res", id, ok, payload | error }
  • Evento: { type: "event", event, payload, seq?, stateVersion? }
O primeiro frame deve ser uma request connect. Depois disso, os clientes podem chamar métodos (por exemplo, health, send, chat.send) e assinar eventos (por exemplo, presence, tick, agent). Fluxo de conexão (mínimo): 
Client                    Gateway
  |---- req:connect -------->|
  |<---- res:hello-ok --------|
  |<---- event:tick ----------|
  |---- req:health ---------->|
  |<---- res:health ----------|
Métodos + eventos comuns:
CategoriaExemplosNotas
Núcleoconnect, health, statusconnect deve ser o primeiro
Mensagenssend, poll, agent, agent.waitefeitos colaterais exigem idempotencyKey
Chatchat.history, chat.send, chat.abort, chat.injectO WebChat usa estes
Sessionssessions.list, sessions.patch, sessions.deleteadministração de sessão
Nodesnode.list, node.invoke, node.pair.*WS do Gateway + ações de nó
Eventstick, presence, agent, chat, health, shutdownpush do servidor
A lista autoritativa vive em src/gateway/server.ts (METHODS, EVENTS).

​
Onde os esquemas ficam

  • Fonte: src/gateway/protocol/schema.ts
  • Validadores em runtime (AJV): src/gateway/protocol/index.ts
  • Handshake do servidor + despacho de métodos: src/gateway/server.ts
  • Cliente de nó: src/gateway/client.ts
  • JSON Schema gerado: dist/protocol.schema.json
  • Modelos Swift gerados: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

​
Pipeline atual

  • pnpm protocol:gen
    • grava JSON Schema (draft‑07) em dist/protocol.schema.json
  • pnpm protocol:gen:swift
    • gera modelos Swift do gateway
  • pnpm protocol:check
    • executa ambos os geradores e verifica se a saída está commitada

​
Como os esquemas são usados em runtime

  • Lado do servidor: todo frame de entrada é validado com AJV. O handshake só aceita uma request connect cujos params correspondem a ConnectParams.
  • Lado do cliente: o cliente JS valida frames de evento e de resposta antes de usá-los.
  • Superfície de métodos: o Gateway anuncia os methods e events suportados em hello-ok.

​
Frames de exemplo

Conectar (primeira mensagem): 
{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 2,
    "maxProtocol": 2,
    "client": {
      "id": "openclaw-macos",
      "displayName": "macos",
      "version": "1.0.0",
      "platform": "macos 15.1",
      "mode": "ui",
      "instanceId": "A1B2"
    }
  }
}
Resposta hello-ok: 
{
  "type": "res",
  "id": "c1",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 2,
    "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 }
  }
}
Request + response: 
{ "type": "req", "id": "r1", "method": "health" }

{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }
Evento: 
{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

​
Cliente mínimo (Node.js)

Fluxo útil mínimo: conectar + health. 
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();
  }
});

​
Exemplo trabalhado: adicionar um método de ponta a ponta

Exemplo: adicionar uma nova request system.echo que retorna { ok: true, text }.
  1. Esquema (fonte de verdade)
Adicionar a src/gateway/protocol/schema.ts: 
export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);
Adicionar ambos a ProtocolSchemas e exportar tipos: 
  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;
  1. Validação
Em src/gateway/protocol/index.ts, exportar um validador AJV: 
export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);
  1. Comportamento do servidor
Adicionar um handler em src/gateway/server-methods/system.ts: 
export const systemHandlers: GatewayRequestHandlers = {
  "system.echo": ({ params, respond }) => {
    const text = String(params.text ?? "");
    respond(true, { ok: true, text });
  },
};
Registrar em src/gateway/server-methods.ts (já faz merge de systemHandlers), depois adicionar "system.echo" a METHODS em src/gateway/server.ts.
  1. Regenerar
pnpm protocol:check
  1. Testes + docs
Adicionar um teste de servidor em src/gateway/server.*.test.ts e anotar o método na documentação.

​
Comportamento do codegen Swift

O gerador Swift emite:
  • Enum GatewayFrame com casos req, res, event e unknown
  • Structs/enums de payload fortemente tipados
  • Valores ErrorCode e GATEWAY_PROTOCOL_VERSION
Tipos de frame desconhecidos são preservados como payloads brutos para compatibilidade futura.

​
Versionamento + compatibilidade

  • PROTOCOL_VERSION fica em src/gateway/protocol/schema.ts.
  • Clientes enviam minProtocol + maxProtocol; o servidor rejeita incompatibilidades.
  • Os modelos Swift mantêm tipos de frame desconhecidos para evitar quebrar clientes mais antigos.

​
Padrões e convenções de esquema

  • A maioria dos objetos usa additionalProperties: false para payloads estritos.
  • NonEmptyString é 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 params (exemplo: send, poll, agent, chat.send).

​
JSON do esquema ao vivo

O JSON Schema gerado está no repositório em dist/protocol.schema.json. O arquivo bruto publicado normalmente está disponível em:

​
Quando você muda esquemas

  1. Atualize os esquemas TypeBox.
  2. Execute pnpm protocol:check.
  3. Faça commit do esquema regenerado + modelos Swift.