openclaw-overlay-plugin 0.8.18 → 0.8.20

package/src/scripts/messaging/inbox.ts

@@ -1,64 +0,0 @@
-/**
- * Inbox and ack commands.
- */
-
-import { OVERLAY_URL } from '../config.js';
-import { ok, fail } from '../output.js';
-import { loadIdentity, verifyRelaySignature } from '../wallet/identity.js';
-
-/**
- * Inbox command: fetch pending messages.
- */
-export async function cmdInbox(args: string[]): Promise<any> {
-  const { identityKey } = await loadIdentity();
-
-  let since = '';
-  for (let i = 0; i < args.length; i++) {
-    if (args[i] === '--since' && args[i + 1]) since = `&since=${args[++i]}`;
-  }
-
-  const resp = await fetch(`${OVERLAY_URL}/relay/inbox?identity=${identityKey}${since}`);
-  if (!resp.ok) {
-    const body = await resp.text();
-    return fail(`Relay inbox failed (${resp.status}): ${body}`);
-  }
-
-  const result = await resp.json();
-
-  // Verify signatures on received messages
-  const messages = await Promise.all(
-    result.messages.map(async (msg: any) => ({
-      ...msg,
-      signatureValid: msg.signature
-        ? (await verifyRelaySignature(msg.from, msg.to, msg.type, msg.payload, msg.signature)).valid
-        : null,
-    }))
-  );
-
-  return ok({ messages, count: messages.length, identityKey });
-}
-
-/**
- * Ack command: acknowledge processed messages.
- */
-export async function cmdAck(messageIds: string[]): Promise<any> {
-  if (!messageIds || messageIds.length === 0) {
-    return fail('Usage: ack <messageId> [messageId2 ...]');
-  }
-
-  const { identityKey } = await loadIdentity();
-
-  const resp = await fetch(`${OVERLAY_URL}/relay/ack`, {
-    method: 'POST',
-    headers: { 'Content-Type': 'application/json' },
-    body: JSON.stringify({ identity: identityKey, messageIds }),
-  });
-
-  if (!resp.ok) {
-    const body = await resp.text();
-    return fail(`Relay ack failed (${resp.status}): ${body}`);
-  }
-
-  const result = await resp.json();
-  return ok({ acked: result.acked, messageIds });
-}

package/src/scripts/messaging/index.ts

@@ -1,9 +0,0 @@
-/**
- * Messaging module exports.
- */
-
-export * from './send.js';
-export * from './inbox.js';
-export * from './handlers.js';
-export * from './poll.js';
-export * from './connect.js';

package/src/scripts/messaging/poll.ts

@@ -1,59 +0,0 @@
-/**
- * Poll command: fetch and process all pending messages.
- */
-
-import { OVERLAY_URL } from '../config.js';
-import { ok, fail } from '../output.js';
-import { loadIdentity } from '../wallet/identity.js';
-import { processMessage } from './handlers.js';
-
-/**
- * Poll command: fetch all pending messages and process them.
- */
-export async function cmdPoll(): Promise<any> {
-  const { identityKey, privKey } = await loadIdentity();
-
-  // Fetch inbox
-  const inboxResp = await fetch(`${OVERLAY_URL}/relay/inbox?identity=${identityKey}`);
-  if (!inboxResp.ok) {
-    const body = await inboxResp.text();
-    return fail(`Relay inbox failed (${inboxResp.status}): ${body}`);
-  }
-  const inbox = await inboxResp.json();
-
-  if (inbox.count === 0) {
-    return ok({ processed: 0, messages: [], summary: 'No pending messages.' });
-  }
-
-  const processed: any[] = [];
-  const ackedIds: string[] = [];
-  const unhandled: any[] = [];
-
-  for (const msg of inbox.messages) {
-    const result = await processMessage(msg, identityKey, privKey);
-    if (result.ack) {
-      ackedIds.push(result.id);
-      processed.push(result);
-    } else {
-      unhandled.push(result);
-    }
-  }
-
-  // ACK processed messages
-  if (ackedIds.length > 0) {
-    await fetch(`${OVERLAY_URL}/relay/ack`, {
-      method: 'POST',
-      headers: { 'Content-Type': 'application/json' },
-      body: JSON.stringify({ identity: identityKey, messageIds: ackedIds }),
-    });
-  }
-
-  return ok({
-    processed: processed.length,
-    unhandled: unhandled.length,
-    total: inbox.count,
-    messages: processed,
-    unhandledMessages: unhandled,
-    ackedIds,
-  });
-}

package/src/scripts/messaging/send.ts

@@ -1,54 +0,0 @@
-/**
- * Send relay message command.
- */
-
-import { OVERLAY_URL } from '../config.js';
-import { ok, fail } from '../output.js';
-import { loadIdentity, signRelayMessage } from '../wallet/identity.js';
-
-/**
- * Send command: send a typed message to another agent.
- */
-export async function cmdSend(
-  targetKey: string | undefined,
-  type: string | undefined,
-  payloadStr: string | undefined
-): Promise<any> {
-  if (!targetKey || !type || !payloadStr) {
-    return fail('Usage: send <identityKey> <type> <json_payload>');
-  }
-
-  if (!/^0[23][0-9a-fA-F]{64}$/.test(targetKey)) {
-    return fail('Target must be a compressed public key (66 hex chars, 02/03 prefix)');
-  }
-
-  let payload: unknown;
-  try {
-    payload = JSON.parse(payloadStr);
-  } catch {
-    return fail('payload must be valid JSON');
-  }
-
-  const { identityKey, privKey } = await loadIdentity();
-  const signature = await signRelayMessage(privKey, targetKey, type, payload);
-
-  const resp = await fetch(`${OVERLAY_URL}/relay/send`, {
-    method: 'POST',
-    headers: { 'Content-Type': 'application/json' },
-    body: JSON.stringify({
-      from: identityKey,
-      to: targetKey,
-      type,
-      payload,
-      signature,
-    }),
-  });
-
-  if (!resp.ok) {
-    const body = await resp.text();
-    return fail(`Relay send failed (${resp.status}): ${body}`);
-  }
-
-  const result = await resp.json();
-  return ok({ sent: true, messageId: result.id, to: targetKey, type, signed: true });
-}

package/src/scripts/output.ts

@@ -1,30 +0,0 @@
-/**
- * JSON output helpers for CLI commands.
- * All CLI output follows the { success, data/error } wrapper format.
- */
-
-// Global flag to prevent exit when used as a library
-let noExitFlag = false;
-
-export function setNoExit(value: boolean) {
-  noExitFlag = value;
-}
-
-/**
- * Output a successful result and exit (unless noExit is set).
- */
-export function ok<T>(data: T): any {
-  if (noExitFlag) return { success: true, data };
-  console.log(JSON.stringify({ success: true, data }));
-  process.exit(0);
-}
-
-/**
- * Output an error and exit (unless noExit is set).
- */
-export function fail(error: string | Error): any {
-  const message = error instanceof Error ? error.message : String(error);
-  if (noExitFlag) return { success: false, error: message };
-  console.log(JSON.stringify({ success: false, error: message }));
-  process.exit(1);
-}

package/src/scripts/overlay/advertisement.ts

@@ -1,138 +0,0 @@
-/**
- * SHIP and SLAP advertisement commands.
- * 
- * SHIP: Service Health & Information Protocol (tm_ship)
- * SLAP: Service Level Agreement Protocol (tm_slap)
- */
-
-import { PushDrop, Utils } from '@bsv/sdk';
-import { NETWORK, WALLET_DIR, TOPICS, DEFAULT_SLAP_TRACKERS } from '../config.js';
-import { BSVAgentWallet } from 'openclaw-plugin-core';
-import { ok, fail } from '../output.js';
-
-/**
- * Advertise a SHIP record.
- * Announce that you host a specific Topic Manager (tm_).
- */
-export async function cmdAdvertiseSHIP(domain?: string, topic?: string): Promise<any> {
-  if (!domain || !topic) {
-    return fail('Usage: advertise-ship <domain> <topic>');
-  }
-
-  if (!topic.startsWith('tm_')) {
-    return fail('Topic must start with "tm_"');
-  }
-
-  try {
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    const token = new PushDrop(wallet._setup.wallet);
-    
-    // SHIP format: Payload is the domain hosting the topic
-    const fields = [Utils.toArray(domain, 'utf8')];
-    // Context is [0, topic] to identify the topic manager being advertised
-    const lockingScript = (await token.lock(fields, [0, topic], '1', 'self', true, true)).toHex();
-
-    const response = await wallet._setup.wallet.createAction({
-      description: `advertise SHIP for ${topic}`,
-      outputs: [{
-        lockingScript,
-        satoshis: 1,
-        outputDescription: 'SHIP advertisement',
-        basket: TOPICS.SHIP
-      }]
-    });
-
-    // Broadcast to primary overlay and SLAP trackers
-    const trackers = [
-      ...DEFAULT_SLAP_TRACKERS[NETWORK]
-    ];
-
-    const results = await broadcastToTrackers(response.tx as number[], [TOPICS.SHIP, topic], trackers);
-
-    return ok({
-      advertised: 'SHIP',
-      topic,
-      domain,
-      txid: response.txid,
-      broadcasts: results
-    });
-  } catch (err: any) {
-    return fail(`SHIP advertisement failed: ${err.message}`);
-  }
-}
-
-/**
- * Advertise a SLAP record.
- * Announce that you host a specific Lookup Service (ls_).
- */
-export async function cmdAdvertiseSLAP(domain?: string, service?: string): Promise<any> {
-  if (!domain || !service) {
-    return fail('Usage: advertise-slap <domain> <service>');
-  }
-
-  if (!service.startsWith('ls_')) {
-    return fail('Service must start with "ls_"');
-  }
-
-  try {
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    const token = new PushDrop(wallet._setup.wallet);
-    
-    // SLAP format: Payload is the domain hosting the lookup service
-    const fields = [Utils.toArray(domain, 'utf8')];
-    // Context is [0, service] to identify the lookup service being advertised
-    const lockingScript = (await token.lock(fields, [0, service], '1', 'self', true, true)).toHex();
-
-    const response = await wallet._setup.wallet.createAction({
-      description: `advertise SLAP for ${service}`,
-      outputs: [{
-        lockingScript,
-        satoshis: 1,
-        outputDescription: 'SLAP advertisement',
-        basket: TOPICS.SLAP
-      }]
-    });
-
-    // Broadcast to primary overlay and SLAP trackers
-    const trackers = [
-      ...DEFAULT_SLAP_TRACKERS[NETWORK]
-    ];
-
-    const results = await broadcastToTrackers(response.tx as number[], [TOPICS.SLAP, service], trackers);
-
-    return ok({
-      advertised: 'SLAP',
-      service,
-      domain,
-      txid: response.txid,
-      broadcasts: results
-    });
-  } catch (err: any) {
-    return fail(`SLAP advertisement failed: ${err.message}`);
-  }
-}
-
-/**
- * Helper to broadcast BEEF to multiple trackers/overlays.
- */
-async function broadcastToTrackers(tx: number[], topics: string[], trackers: string[]) {
-  const results: Record<string, any> = {};
-  const body = new Uint8Array(tx);
-
-  for (const url of trackers) {
-    try {
-      const resp = await fetch(`${url.replace(/\/$/, '')}/submit`, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/octet-stream',
-          'X-Topics': JSON.stringify(topics)
-        },
-        body
-      });
-      results[url] = resp.ok ? 'success' : `error: ${resp.status}`;
-    } catch (err: any) {
-      results[url] = `failed: ${err.message}`;
-    }
-  }
-  return results;
-}

package/src/scripts/overlay/discover.ts

@@ -1,83 +0,0 @@
-/**
- * Overlay discovery commands.
- */
-
-import { OVERLAY_URL, LOOKUP_SERVICES } from '../config.js';
-import { ok } from '../output.js';
-import { lookupOverlay, parseOverlayOutput } from './transaction.js';
-
-/**
- * Discover command: query the overlay for agents and services.
- */
-export async function cmdDiscover(args: string[]): Promise<any> {
-
-  // Parse flags
-  let serviceFilter: string | null = null;
-  let agentFilter: string | null = null;
-
-  for (let i = 0; i < args.length; i++) {
-    if (args[i] === '--service' && args[i + 1]) serviceFilter = args[++i];
-    else if (args[i] === '--agent' && args[i + 1]) agentFilter = args[++i];
-  }
-
-  const results: {
-    agents: any[];
-    services: any[];
-    agentError?: string;
-    serviceError?: string;
-  } = { agents: [], services: [] };
-
-  // Query agents
-  if (!serviceFilter) {
-    try {
-      const agentQuery = agentFilter ? { name: agentFilter } : { type: 'list' };
-      const agentResult = await lookupOverlay(LOOKUP_SERVICES.AGENTS, agentQuery);
-
-      if (agentResult.outputs) {
-        for (const output of agentResult.outputs) {
-          try {
-            const { data, txid } = await parseOverlayOutput(output.beef, output.outputIndex);
-            if (data?.type === 'identity') {
-              // Handle both 'name' and 'agentName' for backward compatibility
-              const name = data.name || data.agentName || 'Unknown Agent';
-              results.agents.push({ ...data, name, txid });
-            }
-          } catch { /* ignore */ }
-        }
-      }
-    } catch (err: any) {
-      results.agentError = String(err);
-    }
-  }
-
-  // Query services
-  if (!agentFilter) {
-    try {
-      const serviceQuery = serviceFilter ? { serviceType: serviceFilter } : {};
-      const serviceResult = await lookupOverlay(LOOKUP_SERVICES.SERVICES, serviceQuery);
-
-      if (serviceResult.outputs) {
-        for (const output of serviceResult.outputs) {
-          try {
-            const { data, txid } = await parseOverlayOutput(output.beef, output.outputIndex);
-            if (data?.type === 'service') {
-              results.services.push({ ...data, txid });
-            }
-          } catch { /* ignore */ }
-        }
-      }
-    } catch (err: any) {
-      results.serviceError = String(err);
-    }
-  }
-
-  return ok({
-    overlayUrl: OVERLAY_URL,
-    agentCount: results.agents.length,
-    serviceCount: results.services.length,
-    agents: results.agents,
-    services: results.services,
-    ...(results.agentError && { agentError: results.agentError }),
-    ...(results.serviceError && { serviceError: results.serviceError }),
-  });
-}

package/src/scripts/overlay/index.ts

@@ -1,8 +0,0 @@
-/**
- * Overlay module exports.
- */
-
-export * from './transaction.js';
-export * from './registration.js';
-export * from './services.js';
-export * from './discover.js';

package/src/scripts/overlay/registration.ts

@@ -1,199 +0,0 @@
-/**
- * Overlay registration commands: register, unregister.
- * 
- * Registration creates an identity record on the overlay network with:
- * - identityKey: compressed public key (66 hex chars)
- * - name: agent display name
- * - description: what the agent does
- * - channels: contact methods (e.g., { overlay: "https://..." })
- * - capabilities: what the agent can do (e.g., ["services", "jokes"])
- * - timestamp: ISO 8601 registration time
- */
-
-import fs from 'node:fs';
-import { NETWORK, WALLET_DIR, OVERLAY_URL, PROTOCOL_ID, TOPICS, PATHS, AGENT_NAME, AGENT_DESCRIPTION } from '../config.js';
-import { ok, fail } from '../output.js';
-import { loadRegistration, saveRegistration, deleteRegistration, loadServices } from '../utils/storage.js';
-import { buildRealOverlayTransaction } from './transaction.js';
-import { Transaction, Beef, Script, PushDrop, WalletOutput } from '@bsv/sdk'
-
-import { BSVAgentWallet } from 'openclaw-plugin-core';
-
-async function getBSVAgentWallet(): Promise<typeof BSVAgentWallet> {
-  return BSVAgentWallet;
-}
-
-/**
- * Register command: register this agent on the overlay network.
- */
-export async function cmdRegister(): Promise<any> {
-  if (!fs.existsSync(PATHS.walletIdentity)) {
-    return fail('Wallet not initialized. Run: setup');
-  }
-
-  const BSVAgentWallet = await getBSVAgentWallet();
-  const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-  const identityKey = await wallet.getIdentityKey();
-  await wallet.destroy();
-
-  const existingReg = loadRegistration();
-  if (existingReg && existingReg.identityKey === identityKey) {
-    return ok({
-      alreadyRegistered: true,
-      identityKey,
-      identityTxid: existingReg.identityTxid,
-      overlayUrl: OVERLAY_URL,
-    });
-  }
-
-  // Agent metadata from environment/config
-  const agentName = AGENT_NAME;
-  const agentDescription = AGENT_DESCRIPTION;
-
-  // Build capabilities list based on what services we might offer
-  const capabilities: string[] = ['services'];
-  const services = loadServices();
-  if (services.some(s => s.serviceId === 'tell-joke')) {
-    capabilities.push('jokes');
-  }
-
-  // Create identity record on-chain
-  // This payload format matches the openclaw-overlay server's expected schema
-  const identityPayload = {
-    protocol: PROTOCOL_ID,
-    type: 'identity' as const,
-    identityKey,
-    name: agentName,
-    description: agentDescription,
-    channels: {
-      overlay: OVERLAY_URL,
-    },
-    capabilities,
-    timestamp: new Date().toISOString(),
-  };
-
-  let identityResult: { txid: string; funded: string };
-  try {
-    identityResult = await buildRealOverlayTransaction(identityPayload, TOPICS.IDENTITY);
-  } catch (err: any) {
-    return fail(`Registration failed: ${err.message}`);
-  }
-
-  // Optionally register services if pre-configured
-  let serviceTxid: string | null = null;
-
-  if (services.length > 0) {
-    // Register each service individually (server expects 'service' type, not 'service-bundle')
-    for (const service of services) {
-      const servicePayload = {
-        protocol: PROTOCOL_ID,
-        type: 'service' as const,
-        identityKey,
-        serviceId: service.serviceId,
-        name: service.name,
-        description: service.description,
-        pricing: {
-          model: 'per-task',
-          amountSats: service.priceSats,
-        },
-        timestamp: new Date().toISOString(),
-      };
-
-      try {
-        const serviceResult = await buildRealOverlayTransaction(servicePayload, TOPICS.SERVICES);
-        serviceTxid = serviceResult.txid; // Keep last one for backward compat
-      } catch {
-        // Non-fatal — identity registered but this service failed
-      }
-    }
-  }
-
-  // Save registration
-  const registration = {
-    identityKey,
-    agentName,
-    agentDescription,
-    overlayUrl: OVERLAY_URL,
-    identityTxid: identityResult.txid,
-    serviceTxid,
-    funded: identityResult.funded,
-    registeredAt: new Date().toISOString(),
-  };
-  saveRegistration(registration);
-
-  return ok({
-    registered: true,
-    identityKey,
-    identityTxid: identityResult.txid,
-    serviceTxid,
-    overlayUrl: OVERLAY_URL,
-    funded: identityResult.funded,
-    stateFile: PATHS.registration,
-  });
-}
-
-/**
- * Unregister command: submit revocation tx to remove agent from overlay network.
- */
-export async function cmdUnregister(): Promise<any> {
-  
-  const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-  const { outputs, BEEF } = await wallet._setup.wallet.listOutputs({ basket: TOPICS.IDENTITY, include: 'entire transactions' });
-
-  const token = new PushDrop(wallet._setup.wallet);
-  const unlockingScriptTemplate = await token.unlock([0, PROTOCOL_ID], '1', 'self', 'none', true)
-  const tempTx = new Transaction()
-  const beef = Beef.fromBinary(BEEF as number[])
-  outputs.forEach((o: WalletOutput) => {
-    const [txid, v] = o.outpoint.split('.')
-    const sourceOutputIndex = Number(v)
-    const sourceTransaction = beef.findTransactionForSigning(txid)
-    tempTx.addInput({
-      unlockingScriptTemplate,
-      sourceOutputIndex,
-      sourceTransaction
-    })
-  })
-  tempTx.addOutput({
-    lockingScript: Script.fromASM('OP_FALSE OP_RETURN 330123'),
-    satoshis: 0
-  })
-
-  await tempTx.sign()
-
-  const response = await wallet._setup.wallet.createAction({
-    inputBEEF: BEEF,
-    description: 'revoke registration token',
-    inputs: tempTx.inputs.map(o => ({
-      inputDescription: 'previous registration',
-      outpoint: o.sourceTXID + '.' + String(o.sourceOutputIndex),
-      unlockingScript: o.unlockingScript?.toHex() as string
-    }))
-  })
-
-  const txid = response.txid as string;
-
-  // --- Submit to overlay ---
-  // Use binary BEEF with X-Topics header (matches openclaw-overlay server API)
-  const submitResp = await fetch(`${OVERLAY_URL}/submit`, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/octet-stream',
-      'X-Topics': JSON.stringify([TOPICS.IDENTITY]),
-    },
-    body: new Uint8Array(response.tx as number[]),
-  });
-
-  if (!submitResp.ok) {
-    const errText = await submitResp.text();
-    throw new Error(`Overlay submission failed: ${submitResp.status} — ${errText}`);
-  }
-  
-  // Delete local registration
-  deleteRegistration();
-
-  return ok({
-    unregistered: true,
-    txid
-  });
-}