Concept internals

TypeBox

TypeBox é uma biblioteca de schema com foco em TypeScript. Nós a usamos para definir o protocolo WebSocket do Gateway (handshake, solicitação/resposta, eventos do servidor). Esses schemas conduzem a validação em tempo de execução, a exportação de JSON Schema e a geração de código Swift para o app macOS. Uma única fonte da verdade; todo o restante é gerado.

Se você quiser o contexto de protocolo de nível mais alto, comece com arquitetura do Gateway.

Modelo mental (30 segundos)

Toda mensagem WS do Gateway é um de três frames:

Solicitaçã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 solicitação 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:

Categoria	Exemplos	Observações
Núcleo	`connect`, `health`, `status`	`connect` deve ser o primeiro
Mensagens	`send`, `agent`, `agent.wait`, `system-event`, `logs.tail`	efeitos colaterais precisam de `idempotencyKey`
Chat	`chat.history`, `chat.send`, `chat.abort`	WebChat usa estes
Sessões	`sessions.list`, `sessions.patch`, `sessions.delete`	administração de sessão
Automação	`wake`, `cron.list`, `cron.run`, `cron.runs`	wake + controle de cron
Nós	`node.list`, `node.invoke`, `node.pair.*`	WS do Gateway + ações de Node
Eventos	`tick`, `presence`, `agent`, `chat`, `health`, `shutdown`	push do servidor

O inventário discovery anunciado autoritativo fica em src/gateway/server-methods-list.ts (listGatewayMethods, GATEWAY_EVENTS).

Onde ficam os schemas

Fonte: src/gateway/protocol/schema.ts
Validadores em tempo de execução (AJV): src/gateway/protocol/index.ts
Registro de feature/discovery anunciado: src/gateway/server-methods-list.ts
Handshake do servidor + despacho de métodos: src/gateway/server.impl.ts
Cliente Node: 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 foi commitada

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

Lado do servidor: todo frame de entrada é validado com AJV. O handshake só aceita uma solicitação connect cujos params correspondam a ConnectParams.
Lado do cliente: o cliente JS valida frames de evento e resposta antes de usá-los.
Feature discovery: o Gateway envia uma lista conservadora de features.methods e features.events em hello-ok a partir de listGatewayMethods() e GATEWAY_EVENTS.
Essa lista de discovery não é um despejo gerado de todo helper chamável em coreGatewayHandlers; alguns RPCs auxiliares são implementados em src/gateway/server-methods/*.ts sem serem enumerados na lista de features anunciada.

Frames de exemplo

Connect (primeira mensagem):

{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 4,
    "maxProtocol": 4,
    "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": 4,
    "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 }
  }
}

Solicitação + resposta:

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

Menor fluxo útil: conectar + health.


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 trabalhado: adicionar um método de ponta a ponta

Exemplo: adicionar uma nova solicitação system.echo que retorna { ok: true, text }.

Schema (fonte da verdade)

Adicione 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 },
);

Adicione ambos a ProtocolSchemas e exporte os tipos:

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;

Validação

Em src/gateway/protocol/index.ts, exporte um validador AJV:

export const validateSystemEchoParams = ajv.compile&lt;SystemEchoParams&gt;(SystemEchoParamsSchema);

Comportamento do servidor

Adicione 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 });
  },
};

Registre-o em src/gateway/server-methods.ts (já mescla systemHandlers), depois adicione "system.echo" à entrada de listGatewayMethods em src/gateway/server-methods-list.ts.

Se o método for chamável por clientes operadores ou Node, classifique-o também em src/gateway/method-scopes.ts para que a aplicação de escopo e o anúncio de features em hello-ok permaneçam alinhados.

Regenerar

pnpm protocol:check

Testes + docs

Adicione um teste de servidor em src/gateway/server.*.test.ts e mencione o método na documentação.

Comportamento da geração de código 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/version.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 schema

A maioria dos objetos usa additionalProperties: false para payloads estritos.
NonEmptyString é o padrão para IDs e nomes de método/evento.
O GatewayFrame de nível superior usa um discriminador em type.
Métodos com efeitos colaterais normalmente exigem um idempotencyKey em params (exemplo: send, poll, agent, chat.send).
agent aceita internalEvents opcionais para contexto de orquestração gerado em tempo de execução (por exemplo, repasse de conclusão de tarefa de subagente/cron); trate isso como superfície de API interna.

JSON de schema ao vivo

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

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

Quando você alterar schemas

Atualize os schemas TypeBox.
Registre o método/evento em src/gateway/server-methods-list.ts.
Atualize src/gateway/method-scopes.ts quando o novo RPC precisar de classificação de escopo de operador ou Node.
Execute pnpm protocol:check.
Faça commit do schema regenerado + modelos Swift.

TypeBox

Modelo mental (30 segundos)

Onde ficam os schemas

Pipeline atual

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

Frames de exemplo

Cliente mínimo (Node.js)

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

Comportamento da geração de código Swift

Versionamento + compatibilidade

Padrões e convenções de schema

JSON de schema ao vivo

Quando você alterar schemas

Relacionados

Ask OpenClaw

# Modelo mental (30 segundos)

# Onde ficam os schemas

# Pipeline atual

# Como os schemas são usados em tempo de execução

# Frames de exemplo

# Cliente mínimo (Node.js)

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

# Comportamento da geração de código Swift

# Versionamento + compatibilidade

# Padrões e convenções de schema

# JSON de schema ao vivo

# Quando você alterar schemas

# Relacionados

Modelo mental (30 segundos)

Onde ficam os schemas

Pipeline atual

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

Frames de exemplo

Cliente mínimo (Node.js)

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

Comportamento da geração de código Swift

Versionamento + compatibilidade

Padrões e convenções de schema

JSON de schema ao vivo

Quando você alterar schemas

Relacionados