프로토콜 진실의 원천으로서의 TypeBox

마지막 업데이트: 2026-01-10

TypeBox는 TypeScript 우선 스키마 라이브러리입니다. 우리는 이를 사용하여 Gateway WebSocket 프로토콜(핸드셰이크, 요청/응답, 서버 이벤트)을 정의합니다. 이러한 스키마는 런타임 검증, JSON Schema 내보내기 및 macOS 앱용 Swift codegen을 구동합니다. 하나의 진실의 원천; 나머지는 모두 생성됩니다.

상위 수준 프로토콜 컨텍스트를 원하는 경우 Gateway architecture로 시작하세요.

멘탈 모델 (30초)

모든 Gateway WS 메시지는 세 가지 프레임 중 하나입니다:

  • Request: { type: "req", id, method, params }
  • Response: { type: "res", id, ok, payload | error }
  • Event: { type: "event", event, payload, seq?, stateVersion? }

첫 번째 프레임은 반드시 connect 요청이어야 합니다. 그 후 클라이언트는 메소드를 호출하고(예: health, send, chat.send) 이벤트를 구독할 수 있습니다(예: presence, tick, agent).

연결 플로우 (최소):

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

일반적인 메소드 + 이벤트:

카테고리예시참고
Coreconnect, health, statusconnect는 첫 번째여야 함
Messagingsend, poll, agent, agent.waitside-effects는 idempotencyKey 필요
Chatchat.history, chat.send, chat.abort, chat.injectWebChat이 이것들을 사용
Sessionssessions.list, sessions.patch, sessions.deletesession 관리
Nodesnode.list, node.invoke, node.pair.*Gateway WS + node 작업
Eventstick, presence, agent, chat, health, shutdown서버 푸시

권위 있는 목록은 src/gateway/server.ts(METHODS, EVENTS)에 있습니다.

스키마가 있는 위치

  • 소스: src/gateway/protocol/schema.ts
  • 런타임 validator (AJV): src/gateway/protocol/index.ts
  • 서버 핸드셰이크 + 메소드 dispatch: src/gateway/server.ts
  • Node 클라이언트: src/gateway/client.ts
  • 생성된 JSON Schema: dist/protocol.schema.json
  • 생성된 Swift 모델: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

현재 파이프라인

  • pnpm protocol:gen
    • JSON Schema (draft‑07)를 dist/protocol.schema.json에 작성
  • pnpm protocol:gen:swift
    • Swift gateway 모델 생성
  • pnpm protocol:check
    • 두 생성기를 실행하고 출력이 커밋되었는지 확인

런타임에서 스키마가 사용되는 방식

  • 서버 측: 모든 인바운드 프레임은 AJV로 검증됩니다. 핸드셰이크는 ConnectParams와 일치하는 params가 있는 connect 요청만 허용합니다.
  • 클라이언트 측: JS 클라이언트는 이벤트 및 응답 프레임을 사용하기 전에 검증합니다.
  • 메소드 표면: Gateway는 hello-ok에서 지원되는 methods 및 events를 알립니다.

예시 프레임

연결 (첫 번째 메시지):

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

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

요청 + 응답:

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

가장 작은 유용한 플로우: connect + 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();
  }
});

작업 예시: 엔드투엔드로 메소드 추가

예시: { ok: true, text }를 반환하는 새로운 system.echo 요청을 추가합니다.

  1. 스키마 (진실의 원천)

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

둘 다 ProtocolSchemas에 추가하고 타입을 내보냅니다:

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;
  1. 검증

src/gateway/protocol/index.ts에서 AJV validator를 내보냅니다:

export const validateSystemEchoParams =
  ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);
  1. 서버 동작

src/gateway/server-methods/system.ts에 핸들러 추가:

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

src/gateway/server-methods.ts에 등록하고(systemHandlers를 이미 병합함), src/gateway/server.ts의 METHODS에 "system.echo"를 추가합니다.

  1. 재생성
pnpm protocol:check
  1. 테스트 + 문서

src/gateway/server.*.test.ts에 서버 테스트를 추가하고 문서에 메소드를 기록합니다.

Swift codegen 동작

Swift 생성기는 다음을 emit합니다:

  • req, res, event 및 unknown 케이스가 있는 GatewayFrame enum
  • 강력한 타입의 payload struct/enum
  • ErrorCode 값 및 GATEWAY_PROTOCOL_VERSION

알 수 없는 프레임 타입은 forward 호환성을 위해 원시 payload로 보존됩니다.

버전 관리 + 호환성

  • PROTOCOL_VERSION은 src/gateway/protocol/schema.ts에 있습니다.
  • 클라이언트는 minProtocol + maxProtocol을 보냅니다. 서버는 불일치를 거부합니다.
  • Swift 모델은 이전 클라이언트가 깨지지 않도록 알 수 없는 프레임 타입을 유지합니다.

스키마 패턴 및 규칙

  • 대부분의 객체는 엄격한 payload를 위해 additionalProperties: false를 사용합니다.
  • NonEmptyString은 ID 및 메소드/이벤트 이름의 기본값입니다.
  • 최상위 GatewayFrame은 type에 discriminator를 사용합니다.
  • Side effect가 있는 메소드는 일반적으로 params에 idempotencyKey가 필요합니다(예: send, poll, agent, chat.send).

라이브 스키마 JSON

생성된 JSON Schema는 dist/protocol.schema.json의 repo에 있습니다. 게시된 원시 파일은 일반적으로 다음에서 사용할 수 있습니다:

스키마를 변경할 때

  1. TypeBox 스키마를 업데이트합니다.
  2. pnpm protocol:check를 실행합니다.
  3. 재생성된 스키마 + Swift 모델을 커밋합니다.
← 문서로 돌아가기