openclaw-overlay-plugin 0.8.15 → 0.8.17

package/dist/src/scripts/overlay/advertisement.js

@@ -1,122 +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 '../../core/wallet.js';
-import { ok, fail } from '../output.js';
-/**
- * Advertise a SHIP record.
- * Announce that you host a specific Topic Manager (tm_).
- */
-export async function cmdAdvertiseSHIP(domain, topic) {
-    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, [TOPICS.SHIP, topic], trackers);
-        return ok({
-            advertised: 'SHIP',
-            topic,
-            domain,
-            txid: response.txid,
-            broadcasts: results
-        });
-    }
-    catch (err) {
-        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, service) {
-    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, [TOPICS.SLAP, service], trackers);
-        return ok({
-            advertised: 'SLAP',
-            service,
-            domain,
-            txid: response.txid,
-            broadcasts: results
-        });
-    }
-    catch (err) {
-        return fail(`SLAP advertisement failed: ${err.message}`);
-    }
-}
-/**
- * Helper to broadcast BEEF to multiple trackers/overlays.
- */
-async function broadcastToTrackers(tx, topics, trackers) {
-    const results = {};
-    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) {
-            results[url] = `failed: ${err.message}`;
-        }
-    }
-    return results;
-}

package/dist/src/scripts/overlay/discover.d.ts

@@ -1,7 +0,0 @@
-/**
- * Overlay discovery commands.
- */
-/**
- * Discover command: query the overlay for agents and services.
- */
-export declare function cmdDiscover(args: string[]): Promise<any>;

package/dist/src/scripts/overlay/discover.js

@@ -1,74 +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) {
-    // Parse flags
-    let serviceFilter = null;
-    let agentFilter = 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: [], 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) {
-            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) {
-            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/dist/src/scripts/overlay/index.d.ts

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

package/dist/src/scripts/overlay/index.js

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

package/dist/src/scripts/overlay/registration.d.ts

@@ -1,19 +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
- */
-/**
- * Register command: register this agent on the overlay network.
- */
-export declare function cmdRegister(): Promise<any>;
-/**
- * Unregister command: submit revocation tx to remove agent from overlay network.
- */
-export declare function cmdUnregister(): Promise<any>;

package/dist/src/scripts/overlay/registration.js

@@ -1,176 +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 } from '@bsv/sdk';
-import { BSVAgentWallet } from '../../core/index.js';
-async function getBSVAgentWallet() {
-    return BSVAgentWallet;
-}
-/**
- * Register command: register this agent on the overlay network.
- */
-export async function cmdRegister() {
-    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 = ['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',
-        identityKey,
-        name: agentName,
-        description: agentDescription,
-        channels: {
-            overlay: OVERLAY_URL,
-        },
-        capabilities,
-        timestamp: new Date().toISOString(),
-    };
-    let identityResult;
-    try {
-        identityResult = await buildRealOverlayTransaction(identityPayload, TOPICS.IDENTITY);
-    }
-    catch (err) {
-        return fail(`Registration failed: ${err.message}`);
-    }
-    // Optionally register services if pre-configured
-    let serviceTxid = 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',
-                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() {
-    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);
-    outputs.forEach((o) => {
-        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()
-        }))
-    });
-    const txid = response.txid;
-    // --- 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),
-    });
-    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
-    });
-}

package/dist/src/scripts/overlay/services.d.ts

@@ -1,29 +0,0 @@
-/**
- * Overlay service commands: services, advertise, remove, readvertise.
- *
- * Service payloads match the openclaw-overlay server schema:
- * - protocol: "clawdbot-overlay-v1"
- * - type: "service"
- * - identityKey: provider's compressed public key
- * - serviceId: unique service identifier
- * - name: human-readable name
- * - description: what the service does
- * - pricing: { model: "per-task", amountSats: number }
- * - timestamp: ISO 8601 time
- */
-/**
- * Services command: list currently advertised services.
- */
-export declare function cmdServices(): Promise<any>;
-/**
- * Advertise command: add a new service advertisement.
- */
-export declare function cmdAdvertise(serviceId: string | undefined, name: string | undefined, priceSatsStr: string | undefined, description?: string): Promise<any>;
-/**
- * Remove command: remove a service from local registry.
- */
-export declare function cmdRemove(serviceId: string | undefined): Promise<any>;
-/**
- * Readvertise command: update an existing service advertisement.
- */
-export declare function cmdReadvertise(serviceId: string | undefined, name?: string, priceSatsStr?: string, description?: string): Promise<any>;

package/dist/src/scripts/overlay/services.js

@@ -1,167 +0,0 @@
-/**
- * Overlay service commands: services, advertise, remove, readvertise.
- *
- * Service payloads match the openclaw-overlay server schema:
- * - protocol: "clawdbot-overlay-v1"
- * - type: "service"
- * - identityKey: provider's compressed public key
- * - serviceId: unique service identifier
- * - name: human-readable name
- * - description: what the service does
- * - pricing: { model: "per-task", amountSats: number }
- * - timestamp: ISO 8601 time
- */
-import { NETWORK, WALLET_DIR, PROTOCOL_ID, TOPICS } from '../config.js';
-import { ok, fail } from '../output.js';
-import { loadServices, saveServices } from '../utils/storage.js';
-import { buildRealOverlayTransaction } from './transaction.js';
-import { BSVAgentWallet } from '../../core/index.js';
-async function getBSVAgentWallet() {
-    return BSVAgentWallet;
-}
-/**
- * Services command: list currently advertised services.
- */
-export async function cmdServices() {
-    const services = loadServices();
-    return ok({ services, count: services.length });
-}
-/**
- * Advertise command: add a new service advertisement.
- */
-export async function cmdAdvertise(serviceId, name, priceSatsStr, description) {
-    if (!serviceId || !name || !priceSatsStr) {
-        return fail('Usage: advertise <serviceId> <name> <priceSats> [description]');
-    }
-    const priceSats = parseInt(priceSatsStr, 10);
-    if (isNaN(priceSats) || priceSats < 0) {
-        return fail('priceSats must be a non-negative integer');
-    }
-    const BSVAgentWallet = await getBSVAgentWallet();
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    const identityKey = await wallet.getIdentityKey();
-    await wallet.destroy();
-    // Load existing services
-    const services = loadServices();
-    const existing = services.find(s => s.serviceId === serviceId);
-    if (existing) {
-        return fail(`Service '${serviceId}' already exists. Use 'readvertise' to update.`);
-    }
-    // Create service record (local storage format)
-    const newService = {
-        serviceId,
-        name,
-        description: description || `${name} service`,
-        priceSats,
-        registeredAt: new Date().toISOString(),
-    };
-    // Publish on-chain (matches openclaw-overlay server schema)
-    const servicePayload = {
-        protocol: PROTOCOL_ID,
-        type: 'service',
-        identityKey,
-        serviceId,
-        name,
-        description: newService.description,
-        pricing: {
-            model: 'per-task',
-            amountSats: priceSats,
-        },
-        timestamp: new Date().toISOString(),
-    };
-    try {
-        const result = await buildRealOverlayTransaction(servicePayload, TOPICS.SERVICES);
-        newService.txid = result.txid;
-        // Save locally
-        services.push(newService);
-        saveServices(services);
-        return ok({
-            advertised: true,
-            service: newService,
-            txid: result.txid,
-            funded: result.funded,
-        });
-    }
-    catch (err) {
-        return fail(`Failed to advertise service: ${err.message}`);
-    }
-}
-/**
- * Remove command: remove a service from local registry.
- */
-export async function cmdRemove(serviceId) {
-    if (!serviceId) {
-        return fail('Usage: remove <serviceId>');
-    }
-    const services = loadServices();
-    const idx = services.findIndex(s => s.serviceId === serviceId);
-    if (idx === -1) {
-        return fail(`Service '${serviceId}' not found`);
-    }
-    const removed = services.splice(idx, 1)[0];
-    saveServices(services);
-    return ok({
-        removed: true,
-        service: removed,
-        note: 'Removed from local registry. On-chain record remains (blockchain is immutable).',
-    });
-}
-/**
- * Readvertise command: update an existing service advertisement.
- */
-export async function cmdReadvertise(serviceId, name, priceSatsStr, description) {
-    if (!serviceId) {
-        return fail('Usage: readvertise <serviceId> [name] [priceSats] [description]');
-    }
-    const services = loadServices();
-    const existing = services.find(s => s.serviceId === serviceId);
-    if (!existing) {
-        return fail(`Service '${serviceId}' not found. Use 'advertise' to create.`);
-    }
-    const BSVAgentWallet = await getBSVAgentWallet();
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    const identityKey = await wallet.getIdentityKey();
-    await wallet.destroy();
-    // Update fields if provided
-    if (name)
-        existing.name = name;
-    if (priceSatsStr) {
-        const priceSats = parseInt(priceSatsStr, 10);
-        if (isNaN(priceSats) || priceSats < 0) {
-            return fail('priceSats must be a non-negative integer');
-        }
-        existing.priceSats = priceSats;
-    }
-    if (description)
-        existing.description = description;
-    existing.registeredAt = new Date().toISOString();
-    // Publish update on-chain (matches openclaw-overlay server schema)
-    const servicePayload = {
-        protocol: PROTOCOL_ID,
-        type: 'service',
-        identityKey,
-        serviceId,
-        name: existing.name,
-        description: existing.description,
-        pricing: {
-            model: 'per-task',
-            amountSats: existing.priceSats,
-        },
-        timestamp: existing.registeredAt,
-    };
-    try {
-        const result = await buildRealOverlayTransaction(servicePayload, TOPICS.SERVICES);
-        existing.txid = result.txid;
-        // Save locally
-        saveServices(services);
-        return ok({
-            readvertised: true,
-            service: existing,
-            txid: result.txid,
-            funded: result.funded,
-        });
-    }
-    catch (err) {
-        return fail(`Failed to readvertise service: ${err.message}`);
-    }
-}

package/dist/src/scripts/overlay/transaction.d.ts

@@ -1,42 +0,0 @@
-/**
- * Overlay transaction building utilities.
- *
- * Follows the openclaw-overlay server API:
- * - Submit: POST /submit with binary BEEF and X-Topics header
- * - OP_RETURN format: OP_FALSE OP_RETURN <"clawdbot-overlay-v1"> <JSON>
- */
-import type { OverlayPayload } from '../types.js';
-import { BSVAgentWallet } from '../../core/wallet.js';
-/**
- * Build an PushDrop locking script with JSON payload using SDK's Script class.
- *
- * @param payload - The data to embed in the OP_RETURN
- * @returns A proper Script object that the SDK can serialize
- */
-export declare function buildPushDropScript(wallet: BSVAgentWallet, payload: OverlayPayload): Promise<string>;
-/**
- * Build and submit an overlay transaction.
- * @param payload - JSON data to store in OP_RETURN
- * @param topic - Topic manager for submission
- * @returns Transaction result with txid and funding info
- */
-export declare function buildRealOverlayTransaction(payload: OverlayPayload, topic: string): Promise<{
-    txid: string;
-    funded: string;
-    explorer: string;
-}>;
-/**
- * Lookup data from an overlay lookup service.
- */
-export declare function lookupOverlay(service: string, query: Record<string, unknown>): Promise<any>;
-/**
- * Parse an overlay output from BEEF data.
- *
- * Handles both formats:
- * - OP_FALSE OP_RETURN <protocol> <json> (standard)
- * - OP_RETURN <protocol> <json> (legacy)
- */
-export declare function parseOverlayOutput(beefData: string | Uint8Array | number[], outputIndex: number): Promise<{
-    data: OverlayPayload | null;
-    txid: string | null;
-}>;