Concept internals

TypeBox

TypeBox adalah pustaka skema yang mengutamakan TypeScript. Kami menggunakannya untuk mendefinisikan protokol WebSocket Gateway (handshake, permintaan/respons, peristiwa server). Skema tersebut menggerakkan validasi runtime, ekspor JSON Schema, dan pembuatan kode Swift untuk aplikasi macOS. Satu sumber kebenaran; semua yang lain dihasilkan.

Jika Anda menginginkan konteks protokol tingkat lebih tinggi, mulai dari arsitektur Gateway.

Model mental (30 detik)

Setiap pesan Gateway WS adalah salah satu dari tiga frame:

Permintaan: { type: "req", id, method, params }
Respons: { type: "res", id, ok, payload | error }
Peristiwa: { type: "event", event, payload, seq?, stateVersion? }

Frame pertama harus berupa permintaan connect. Setelah itu, klien dapat memanggil metode (mis. health, send, chat.send) dan berlangganan peristiwa (mis. presence, tick, agent).

Alur koneksi (minimal):

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

Metode + peristiwa umum:

Kategori	Contoh	Catatan
Inti	`connect`, `health`, `status`	`connect` harus pertama
Pesan	`send`, `agent`, `agent.wait`, `system-event`, `logs.tail`	efek samping memerlukan `idempotencyKey`
Chat	`chat.history`, `chat.send`, `chat.abort`	WebChat menggunakan ini
Sesi	`sessions.list`, `sessions.patch`, `sessions.delete`	admin sesi
Otomasi	`wake`, `cron.list`, `cron.run`, `cron.runs`	kontrol wake + cron
Node	`node.list`, `node.invoke`, `node.pair.*`	Gateway WS + tindakan node
Peristiwa	`tick`, `presence`, `agent`, `chat`, `health`, `shutdown`	push server

Inventaris discovery otoritatif yang diiklankan berada di src/gateway/server-methods-list.ts (listGatewayMethods, GATEWAY_EVENTS).

Lokasi skema

Sumber: src/gateway/protocol/schema.ts
Validator runtime (AJV): src/gateway/protocol/index.ts
Registri fitur/discovery yang diiklankan: src/gateway/server-methods-list.ts
Handshake server + dispatch metode: src/gateway/server.impl.ts
Klien Node: src/gateway/client.ts
JSON Schema yang dihasilkan: dist/protocol.schema.json
Model Swift yang dihasilkan: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

Pipeline saat ini

pnpm protocol:gen
- menulis JSON Schema (draft-07) ke dist/protocol.schema.json
pnpm protocol:gen:swift
- menghasilkan model gateway Swift
pnpm protocol:check
- menjalankan kedua generator dan memverifikasi output sudah di-commit

Cara skema digunakan saat runtime

Sisi server: setiap frame masuk divalidasi dengan AJV. Handshake hanya menerima permintaan connect yang parameternya cocok dengan ConnectParams.
Sisi klien: klien JS memvalidasi frame peristiwa dan respons sebelum menggunakannya.
Discovery fitur: Gateway mengirim daftar features.methods dan features.events yang konservatif dalam hello-ok dari listGatewayMethods() dan GATEWAY_EVENTS.
Daftar discovery itu bukan dump yang dihasilkan dari setiap helper yang dapat dipanggil di coreGatewayHandlers; beberapa RPC helper diimplementasikan di src/gateway/server-methods/*.ts tanpa dicantumkan dalam daftar fitur yang diiklankan.

Contoh frame

Connect (pesan pertama):

{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 3,
    "client": {
      "id": "openclaw-macos",
      "displayName": "macos",
      "version": "1.0.0",
      "platform": "macos 15.1",
      "mode": "ui",
      "instanceId": "A1B2"
    }
  }
}

Respons hello-ok:

{
  "type": "res",
  "id": "c1",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 3,
    "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 }
  }
}

Permintaan + respons:

{ "type": "req", "id": "r1", "method": "health" }

{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }

Peristiwa:

{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

Klien minimal (Node.js)

Alur berguna terkecil: connect + 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: 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();
  }
});

Contoh lengkap: menambahkan metode end-to-end

Contoh: tambahkan permintaan system.echo baru yang mengembalikan { ok: true, text }.

Skema (sumber kebenaran)

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

Tambahkan keduanya ke ProtocolSchemas dan ekspor tipe:

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

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

Validasi

Di src/gateway/protocol/index.ts, ekspor validator AJV:

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

Perilaku server

Tambahkan handler di src/gateway/server-methods/system.ts:

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

Daftarkan di src/gateway/server-methods.ts (sudah menggabungkan systemHandlers), lalu tambahkan "system.echo" ke input listGatewayMethods di src/gateway/server-methods-list.ts.

Jika metode dapat dipanggil oleh klien operator atau node, klasifikasikan juga di src/gateway/method-scopes.ts agar penegakan cakupan dan iklan fitur hello-ok tetap selaras.

Hasilkan ulang

pnpm protocol:check

Pengujian + docs

Tambahkan pengujian server di src/gateway/server.*.test.ts dan catat metode tersebut di docs.

Perilaku pembuatan kode Swift

Generator Swift menghasilkan:

enum GatewayFrame dengan case req, res, event, dan unknown
struct/enum payload bertipe kuat
nilai ErrorCode dan GATEWAY_PROTOCOL_VERSION

Tipe frame yang tidak dikenal dipertahankan sebagai payload mentah untuk kompatibilitas ke depan.

Versioning + kompatibilitas

PROTOCOL_VERSION berada di src/gateway/protocol/schema.ts.
Klien mengirim minProtocol + maxProtocol; server menolak ketidakcocokan.
Model Swift mempertahankan tipe frame yang tidak dikenal untuk menghindari kerusakan pada klien lama.

Pola dan konvensi skema

Sebagian besar objek menggunakan additionalProperties: false untuk payload yang ketat.
NonEmptyString adalah default untuk ID dan nama metode/peristiwa.
GatewayFrame tingkat atas menggunakan discriminator pada type.
Metode dengan efek samping biasanya memerlukan idempotencyKey dalam params (contoh: send, poll, agent, chat.send).
agent menerima internalEvents opsional untuk konteks orkestrasi yang dihasilkan runtime (misalnya serah terima penyelesaian tugas subagent/cron); perlakukan ini sebagai permukaan API internal.

JSON skema live

JSON Schema yang dihasilkan ada di repo pada dist/protocol.schema.json. File mentah yang dipublikasikan biasanya tersedia di:

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

Saat Anda mengubah skema

Perbarui skema TypeBox.
Daftarkan metode/peristiwa di src/gateway/server-methods-list.ts.
Perbarui src/gateway/method-scopes.ts saat RPC baru memerlukan klasifikasi cakupan operator atau node.
Jalankan pnpm protocol:check.
Commit skema yang dihasilkan ulang + model Swift.

TypeBox

Model mental (30 detik)

Lokasi skema

Pipeline saat ini

Cara skema digunakan saat runtime

Contoh frame

Klien minimal (Node.js)

Contoh lengkap: menambahkan metode end-to-end

Perilaku pembuatan kode Swift

Versioning + kompatibilitas

Pola dan konvensi skema

JSON skema live

Saat Anda mengubah skema

Terkait

Ask OpenClaw

# Model mental (30 detik)

# Lokasi skema

# Pipeline saat ini

# Cara skema digunakan saat runtime

# Contoh frame

# Klien minimal (Node.js)

# Contoh lengkap: menambahkan metode end-to-end

# Perilaku pembuatan kode Swift

# Versioning + kompatibilitas

# Pola dan konvensi skema

# JSON skema live

# Saat Anda mengubah skema

# Terkait

Model mental (30 detik)

Lokasi skema

Pipeline saat ini

Cara skema digunakan saat runtime

Contoh frame

Klien minimal (Node.js)

Contoh lengkap: menambahkan metode end-to-end

Perilaku pembuatan kode Swift

Versioning + kompatibilitas

Pola dan konvensi skema

JSON skema live

Saat Anda mengubah skema

Terkait