feat: loadable openclaw channel plugin v1 (agent=account)

Rewritten against the real openclaw v2026.5.7 plugin SDK (generic
third-party channel path): createChannelPluginBase + createChatChannelPlugin
with required capabilities, minimal ChannelSetupAdapter, agent=account
config resolution, attached outbound -> Fabric POST, inbound socket per
account -> runtime.channel.turn (wakeup->admission). Compat notes mark
SDK-coupled seams for future openclaw upgrades. Verified: builds clean,
installs, 'openclaw channels list' -> Fabric installed/configured/enabled.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
h z
2026-05-15 17:54:32 +01:00
parent 7fed6d07f6
commit ece77ff2c7
8 changed files with 412 additions and 159 deletions

View File

@@ -1,46 +1,55 @@
import path from 'node:path';
import os from 'node:os';
import { defineChannelPluginEntry } from 'openclaw/plugin-sdk/channel-core';
// Fabric channel plugin entry.
// COMPAT NOTE (openclaw v2026.5.7): defineChannelPluginEntry signature
// { id, name, description, plugin, setRuntime?, registerFull? }. setRuntime
// receives the PluginRuntime (has channel.turn kernel); registerFull receives
// the OpenClawPluginApi for runtime startup (transport + tools).
import { defineChannelPluginEntry } from 'openclaw/plugin-sdk/core';
import type { OpenClawPluginApi } from 'openclaw/plugin-sdk/core';
import { fabricChannelPlugin } from './src/channel.js';
import { FabricInbound } from './src/inbound.js';
import { listEnabledFabricAccounts } from './src/accounts.js';
import { registerFabricTools } from './src/tools.js';
import { FabricClient } from './src/fabric-client.js';
import { IdentityRegistry } from './src/identity.js';
import { FabricInbound } from './src/inbound.js';
import { buildFabricChannelPlugin } from './src/channel.js';
import { registerFabricTools } from './src/tools.js';
type PluginConfig = { identityFilePath?: string; debugMode?: boolean };
function centerApiBase(api: OpenClawPluginApi): string {
const section = ((api.config as Record<string, unknown>)?.channels as Record<string, any>)?.[
'fabric'
];
return section?.centerApiBase ?? 'http://localhost:7001/api';
}
import path from 'node:path';
import os from 'node:os';
let runtimeRef: unknown = null;
let inbound: FabricInbound | null = null;
export { fabricChannelPlugin } from './src/channel.js';
export default defineChannelPluginEntry({
id: 'fabric',
name: 'Fabric',
description: 'Fabric channel plugin — OpenClaw agents speak in Fabric guilds',
plugin: fabricChannelPlugin,
// Channel object: config/security/outbound. Visible turn replies flow
// through the inbound channel-turn delivery adapter; outbound.sendText
// covers proactive sends via the shared message tool.
plugin: buildFabricChannelPlugin(async () => ({ messageId: undefined })),
setRuntime(runtime: unknown) {
runtimeRef = runtime;
},
// registerFull: runtime pieces (transport, tools). Guarded so the long-lived
// Fabric connections start once per gateway process.
registerFull(api: OpenClawPluginApi) {
const cfg = (api.pluginConfig ?? {}) as PluginConfig;
const identityFilePath =
cfg.identityFilePath ?? path.join(os.homedir(), '.openclaw', 'fabric-identity.json');
const client = new FabricClient(centerApiBase(api));
const identity = new IdentityRegistry(identityFilePath);
registerFull(apiRaw: OpenClawPluginApi) {
// COMPAT: access the subset we use through a loose view so SDK type
// drift in unrelated api members doesn't break the build.
const api = apiRaw as unknown as {
config?: unknown;
pluginConfig?: { identityFilePath?: string };
logger: { info: (m: string) => void; warn: (m: string) => void };
on: (ev: string, fn: () => void) => void;
registerTool: (d: unknown) => void;
};
const cfg = (api.config ?? {}) as { channels?: { fabric?: { centerApiBase?: string } } };
const centerApiBase = cfg.channels?.fabric?.centerApiBase ?? 'http://localhost:7001/api';
const idFile =
api.pluginConfig?.identityFilePath ??
path.join(os.homedir(), '.openclaw', 'fabric-identity.json');
// tools operate against a default Center; per-account keys come from config
const client = new FabricClient(centerApiBase);
const identity = new IdentityRegistry(idFile);
registerFabricTools(
{ registerTool: (d) => api.registerTool(d as never), logger: api.logger },
{ registerTool: (d) => api.registerTool(d), logger: api.logger },
client,
identity,
);
@@ -49,14 +58,23 @@ export default defineChannelPluginEntry({
const _G = globalThis as Record<string, unknown>;
if (_G._fabricInboundStarted) return;
_G._fabricInboundStarted = true;
inbound = new FabricInbound(
(api as unknown as { runtime: any }).runtime,
client,
identity,
api.logger,
);
const accounts = listEnabledFabricAccounts(cfg as never).map((a) => ({
agentId: a.accountId,
fabricApiKey: a.fabricApiKey,
}));
// also include any tool-registered identities
for (const e of identity.list()) {
if (!accounts.some((x) => x.agentId === e.agentId)) {
accounts.push({ agentId: e.agentId, fabricApiKey: e.fabricApiKey });
}
}
if (!runtimeRef) {
api.logger.warn('fabric: runtime not set; inbound disabled');
return;
}
inbound = new FabricInbound(runtimeRef as never, client, identity, api.logger, accounts);
void inbound.start();
api.logger.info('fabric: inbound transport started');
api.logger.info(`fabric: inbound started for ${accounts.length} account(s)`);
});
api.on('gateway_stop', () => {