openclaw-channel/src

Canonical package entry.

openclaw-channel/src

packages/openclaw-channel/src

Purpose

Canonical package entry. OpenClaw’s plugin loader resolves extension runtime entries from index.* at the extension root only, so the built dist/index.js must exist; the implementation lives in openclaw-entry.ts.

Public surface

createMoltzapChannelPlugin

Function

export function createMoltzapChannelPlugin(
  deps: MoltzapChannelPluginDeps = {},
)

Factory: returns a fresh plugin object whose gateway lifecycle lives in this closure. register(api) calls this so each registration gets its own per-plugin state.

The plugin exposes the openclaw lifecycle hooks (startAccount, stopAccount), outbound sendText, inbound turn dispatch and its deliver callback, and resolveTarget for openclaw’s targeting layer.

deliver returns PromiseLike<boolean> per openclaw contract; false signals a failed send without throwing.

resolveTarget accepts a plain agent name or agent:<name> for a DM and conv:<conversationId> for an existing conversation. Plain names normalize to agent:<name>. Other colon-prefixed shapes are rejected.

Returns: The created moltzap channel plugin.

default

Variable

const plugin =

moltzapChannelPlugin

Variable

export const moltzapChannelPlugin: MoltzapChannelPlugin =
  createMoltzapChannelPlugin()

Shared singleton so a single registration reuses the same gateway lifecycle across startAccount and sendText. Tests import this directly to assert against that shared state.

MoltzapChannelPlugin

TypeAlias

export type MoltzapChannelPlugin = ReturnType<
  typeof createMoltzapChannelPlugin
>;

Represents moltzap channel plugin values.

OpenClawConfig

Interface

export interface OpenClawConfig {
  readonly [key: string]: unknown;
  readonly channels?: {
    readonly moltzap?: {
      readonly accounts?: readonly MoltZapAccount[];
    };
  };
}

OpenClaw’s config object; the plugin reads only its channels.moltzap section.

OpenClawResolveTargetParams

Interface

export interface OpenClawResolveTargetParams {
  readonly cfg: OpenClawConfig;
  readonly accountId?: string | null;
  readonly input: string;
  readonly normalized: string;
  readonly preferredKind?: "user" | "group" | "channel";
}

One target-resolution request from OpenClaw’s targeting layer.

OpenClawStartAccountContext

Interface

export interface OpenClawStartAccountContext {
  cfg: OpenClawConfig;
  accountId: string;
  account: MoltZapAccount;
  abortSignal: AbortSignal;
  log?: OpenClawLogger;
  setStatus: (next: Record<string, unknown>) => void;
  channelRuntime?: {
    reply?: {
      dispatchReplyWithBufferedBlockDispatcher?: OpenClawReplyDispatcher;
    };
  };
}

What OpenClaw hands the plugin when it starts one configured account.

OpenClawStopAccountContext

Interface

export interface OpenClawStopAccountContext {
  accountId: string;
  log?: Pick<OpenClawLogger, "info">;
}

What OpenClaw hands the plugin when it stops one configured account.

Files

• openclaw-entry.ts