TypeBox

​

Zihinsel model (30 saniye)

• İstek: { type: "req", id, method, params }
• Yanıt: { type: "res", id, ok, payload | error }
• Olay: { type: "event", event, payload, seq?, stateVersion? }

İstemci                   Gateway
  |---- istek:connect ------->|
  |<---- yanıt:hello-ok -------|
  |<---- olay:tick ------------|
  |---- istek:health --------->|
  |<---- yanıt:health ---------|

​

Şemaların bulunduğu yer

• Kaynak dışa aktarma noktası: packages/gateway-protocol/src/schema.ts, packages/gateway-protocol/src/schema/*.ts altındaki alan modüllerini yeniden dışa aktarır (üst düzey zarflar ve el sıkışma için frames.ts; özellik alanına göre agent.ts, sessions.ts, cron.ts vb.). protocol-schemas.ts, şema adlarını TypeBox tanımlarıyla eşleyen merkezi ProtocolSchemas kayıt defteridir.
• Çalışma zamanı doğrulayıcıları (AJV): packages/gateway-protocol/src/index.ts
• Duyurulan özellik/keşif kayıt defteri: src/gateway/server-methods-list.ts
• Sunucu el sıkışması ve yöntem yönlendirmesi: src/gateway/server.impl.ts
• Node istemcisi: src/gateway/client.ts
• Üretilen JSON Schema: dist/protocol.schema.json (derleme çıktısıdır, depoya kaydedilmez)
• Üretilen Swift modelleri: apps/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift

​

Geçerli işlem hattı

• pnpm protocol:gen, JSON Schema’yı (draft-07) dist/protocol.schema.json konumuna yazar.
• pnpm protocol:gen:swift, Swift Gateway modellerini üretir.
• pnpm protocol:check, her iki üreticiyi çalıştırır ve Swift çıktısının depoya kaydedildiğini doğrular (JSON Schema çıktısı, git tarafından yok sayılan bir derleme yapıtıdır).

​

Şemaların çalışma zamanında kullanımı

• Sunucu tarafı: gelen her çerçeve AJV ile doğrulanır. El sıkışma yalnızca parametreleri ConnectParams ile eşleşen bir connect isteğini kabul eder.
• İstemci tarafı: JS istemcisi, olay ve yanıt çerçevelerini kullanmadan önce doğrular.
• Özellik keşfi: Gateway, listGatewayMethods() ve GATEWAY_EVENTS kaynaklarından alınan temkinli bir features.methods ve features.events listesini hello-ok içinde gönderir.
• Bu keşif listesi, coreGatewayHandlers içindeki çağrılabilir her yardımcının üretilmiş bir dökümü değildir; bazı yardımcı RPC’ler duyurulan özellik listesinde sıralanmadan src/gateway/server-methods/*.ts içinde uygulanır.

​

Örnek çerçeveler

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

​

Asgari istemci (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();
  }
});

​

Ayrıntılı örnek: uçtan uca yöntem ekleme

1. Şema (doğruluk kaynağı)

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. Doğrulama

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

3. Sunucu davranışı

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

4. Yeniden üretme

pnpm protocol:check

5. Testler ve belgeler

​

Swift kod üretimi davranışı

• req, res, event ve unknown durumlarını içeren bir GatewayFrame enum’u
• kesin tür belirtilmiş yük yapıları/enum’ları
• ErrorCode değerleri, GATEWAY_PROTOCOL_VERSION ve GATEWAY_MIN_PROTOCOL_VERSION

​

Sürüm oluşturma ve uyumluluk

• PROTOCOL_VERSION, packages/gateway-protocol/src/version.ts içinde bulunur (geçerli değer: 4).
• İstemciler minProtocol ve maxProtocol gönderir; sunucu geçerli protokolünü içermeyen aralıkları reddeder.
• Swift modelleri, eski istemcilerin bozulmasını önlemek için bilinmeyen çerçeve türlerini korur.

​

Şema kalıpları ve kuralları

• Çoğu nesne katı yükler için additionalProperties: false kullanır.
• NonEmptyString (Type.String({ minLength: 1 })), kimlikler ve yöntem/olay adları için varsayılandır.
• Üst düzey GatewayFrame, type üzerinde bir ayırt edici kullanır.
• Yan etkileri olan yöntemler genellikle parametrelerde bir idempotencyKey gerektirir (örnek: send, poll, agent, chat.send).
• agent, çalışma zamanında üretilen orkestrasyon bağlamı (örneğin alt ajan/cron görevi tamamlanma devri) için isteğe bağlı internalEvents kabul eder; bunu dahili API yüzeyi olarak değerlendirin.

​

Canlı şema JSON’u

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

​

Şemaları değiştirdiğinizde

1. Sahibi olan packages/gateway-protocol/src/schema/*.ts modülündeki TypeBox şemalarını güncelleyin ve bunları protocol-schemas.ts içinde kaydedin.
2. Yöntemi/olayı src/gateway/server-methods-list.ts içinde kaydedin.
3. Yeni RPC operatör veya node kapsamı sınıflandırması gerektiriyorsa src/gateway/method-scopes.ts dosyasını güncelleyin.
4. pnpm protocol:check komutunu çalıştırın.
5. Yeniden üretilen Swift modellerini depoya kaydedin.

​

İlgili

• Zengin çıktı protokolü
• RPC bağdaştırıcıları