TypeBox

​

मानसिक मॉडल (30 सेकंड)

• अनुरोध: { type: "req", id, method, params }
• प्रतिक्रिया: { type: "res", id, ok, payload | error }
• इवेंट: { type: "event", event, payload, seq?, stateVersion? }

क्लाइंट                   Gateway
  |---- अनुरोध:कनेक्ट ------->|
  |<---- प्रतिक्रिया:हेलो-ओके --|
  |<---- इवेंट:टिक ------------|
  |---- अनुरोध:हेल्थ --------->|
  |<---- प्रतिक्रिया:हेल्थ -----|

​

स्कीमा कहाँ रहते हैं

• स्रोत बैरल: packages/gateway-protocol/src/schema.ts, packages/gateway-protocol/src/schema/*.ts के अंतर्गत डोमेन मॉड्यूल को पुनः निर्यात करता है (शीर्ष-स्तरीय एनवेलप और हैंडशेक के लिए frames.ts, तथा प्रत्येक फ़ीचर क्षेत्र के लिए agent.ts, sessions.ts, cron.ts, आदि)। protocol-schemas.ts केंद्रीय ProtocolSchemas रजिस्ट्री है, जो स्कीमा नामों को उनकी TypeBox परिभाषाओं से मैप करती है।
• रनटाइम वैलिडेटर (AJV): packages/gateway-protocol/src/index.ts
• विज्ञापित फ़ीचर/डिस्कवरी रजिस्ट्री: src/gateway/server-methods-list.ts
• सर्वर हैंडशेक और मेथड डिस्पैच: src/gateway/server.impl.ts
• Node क्लाइंट: src/gateway/client.ts
• जनरेट किया गया JSON Schema: dist/protocol.schema.json (बिल्ड आउटपुट, कमिट नहीं किया गया)
• जनरेट किए गए Swift मॉडल: apps/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift

​

वर्तमान पाइपलाइन

• pnpm protocol:gen, JSON Schema (draft-07) को dist/protocol.schema.json में लिखता है।
• pnpm protocol:gen:swift, Swift Gateway मॉडल जनरेट करता है।
• pnpm protocol:check, दोनों जनरेटर चलाता है और सत्यापित करता है कि Swift आउटपुट कमिट किया गया है (JSON Schema आउटपुट एक gitignored बिल्ड आर्टिफ़ैक्ट है)।

​

रनटाइम पर स्कीमा का उपयोग कैसे होता है

• सर्वर पक्ष: प्रत्येक इनबाउंड फ़्रेम को AJV से सत्यापित किया जाता है। हैंडशेक केवल ऐसा connect अनुरोध स्वीकार करता है, जिसके पैरामीटर ConnectParams से मेल खाते हों।
• क्लाइंट पक्ष: JS क्लाइंट इवेंट और प्रतिक्रिया फ़्रेमों का उपयोग करने से पहले उन्हें सत्यापित करता है।
• फ़ीचर डिस्कवरी: Gateway, listGatewayMethods() और GATEWAY_EVENTS से एक सीमित features.methods और features.events सूची hello-ok में भेजता है।
• यह डिस्कवरी सूची coreGatewayHandlers में मौजूद प्रत्येक कॉल किए जा सकने वाले हेल्पर का जनरेट किया हुआ डंप नहीं है; कुछ हेल्पर RPC, विज्ञापित फ़ीचर सूची में शामिल हुए बिना src/gateway/server-methods/*.ts में कार्यान्वित होते हैं।

​

उदाहरण फ़्रेम

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

​

न्यूनतम क्लाइंट (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();
  }
});

​

विस्तृत उदाहरण: किसी मेथड को शुरू से अंत तक जोड़ना

1. स्कीमा (सत्य का स्रोत)

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. सत्यापन

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

3. सर्वर व्यवहार

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

4. पुनः जनरेट करें

pnpm protocol:check

5. परीक्षण और दस्तावेज़

​

Swift कोड जनरेशन का व्यवहार

• req, res, event, और unknown केस वाला एक GatewayFrame enum
• दृढ़ता से टाइप किए गए पेलोड स्ट्रक्ट/enum
• ErrorCode मान, GATEWAY_PROTOCOL_VERSION, और GATEWAY_MIN_PROTOCOL_VERSION

​

संस्करण निर्धारण और संगतता

• PROTOCOL_VERSION, packages/gateway-protocol/src/version.ts में रहता है (वर्तमान मान: 4)।
• क्लाइंट minProtocol और maxProtocol भेजते हैं; सर्वर उन सीमाओं को अस्वीकार करता है जिनमें उसका वर्तमान प्रोटोकॉल शामिल नहीं है।
• पुराने क्लाइंट को टूटने से बचाने के लिए Swift मॉडल अज्ञात फ़्रेम प्रकारों को बनाए रखते हैं।

​

स्कीमा पैटर्न और परंपराएँ

• अधिकांश ऑब्जेक्ट सख्त पेलोड के लिए additionalProperties: false का उपयोग करते हैं।
• NonEmptyString (Type.String({ minLength: 1 })), ID और मेथड/इवेंट नामों के लिए डिफ़ॉल्ट है।
• शीर्ष-स्तरीय GatewayFrame, type पर एक डिस्क्रिमिनेटर का उपयोग करता है।
• दुष्प्रभाव वाले मेथड को आम तौर पर पैरामीटर में एक idempotencyKey की आवश्यकता होती है (उदाहरण: send, poll, agent, chat.send)।
• agent, रनटाइम द्वारा जनरेट किए गए ऑर्केस्ट्रेशन संदर्भ के लिए वैकल्पिक internalEvents स्वीकार करता है (उदाहरण के लिए, सबएजेंट/Cron कार्य पूर्णता हैंडऑफ़); इसे आंतरिक API सतह मानें।

​

लाइव स्कीमा JSON

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

​

स्कीमा बदलते समय

1. स्वामी packages/gateway-protocol/src/schema/*.ts मॉड्यूल में TypeBox स्कीमा अपडेट करें और उन्हें protocol-schemas.ts में पंजीकृत करें।
2. मेथड/इवेंट को src/gateway/server-methods-list.ts में पंजीकृत करें।
3. जब नए RPC को ऑपरेटर या Node स्कोप वर्गीकरण की आवश्यकता हो, तो src/gateway/method-scopes.ts अपडेट करें।
4. pnpm protocol:check चलाएँ।
5. पुनः जनरेट किए गए Swift मॉडल कमिट करें।

​

संबंधित

• रिच आउटपुट प्रोटोकॉल
• RPC अडैप्टर