openclaw-overlay-plugin 0.8.14 → 0.8.16

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;
-}>;

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

@@ -1,103 +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 { NETWORK, OVERLAY_URL, PROTOCOL_ID, WALLET_DIR } from '../config.js';
-import { Utils, PushDrop, Transaction } from '@bsv/sdk';
-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 async function buildPushDropScript(wallet, payload) {
-    const jsonBytes = Utils.toArray(JSON.stringify(payload), 'utf8');
-    const fields = [jsonBytes];
-    const token = new PushDrop(wallet._setup.wallet);
-    const script = await token.lock(fields, [0, PROTOCOL_ID], '1', 'self', true, true);
-    return script.toHex();
-}
-/**
- * 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 async function buildRealOverlayTransaction(payload, topic) {
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    const lockingScript = await buildPushDropScript(wallet, payload);
-    const response = await wallet._setup.wallet.createAction({
-        description: 'topic manager submission',
-        outputs: [
-            {
-                lockingScript,
-                satoshis: 1,
-                outputDescription: 'overlay',
-                basket: topic, // basket is the topic manager
-            }
-        ],
-        options: {
-            acceptDelayedBroadcast: false,
-        }
-    });
-    // --- 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([topic]),
-        },
-        body: new Uint8Array(response.tx),
-    });
-    if (!submitResp.ok) {
-        const errText = await submitResp.text();
-        throw new Error(`Overlay submission failed: ${submitResp.status} — ${errText}`);
-    }
-    const wocNet = NETWORK === 'mainnet' ? '' : 'test.';
-    return {
-        txid: response.txid,
-        funded: 'stored-beef',
-        explorer: `https://${wocNet}whatsonchain.com/tx/${response.txid}`,
-    };
-}
-/**
- * Lookup data from an overlay lookup service.
- */
-export async function lookupOverlay(service, query) {
-    const resp = await fetch(`${OVERLAY_URL}/lookup`, {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify({ service, query }),
-    });
-    if (!resp.ok) {
-        const errText = await resp.text();
-        throw new Error(`Lookup failed: ${resp.status} — ${errText}`);
-    }
-    return resp.json();
-}
-/**
- * Parse an overlay output from BEEF data.
- *
- * Handles both formats:
- * - OP_FALSE OP_RETURN <protocol> <json> (standard)
- * - OP_RETURN <protocol> <json> (legacy)
- */
-export async function parseOverlayOutput(beefData, outputIndex) {
-    try {
-        const tx = Transaction.fromBEEF(beefData);
-        const txid = tx.id('hex');
-        const output = tx.outputs[outputIndex];
-        if (!output)
-            return { data: null, txid: null };
-        const { fields } = PushDrop.decode(output.lockingScript);
-        return { data: JSON.parse(Utils.toUTF8(fields[0])), txid };
-    }
-    catch {
-        return { data: null, txid: null };
-    }
-}

package/dist/src/scripts/payment/build.d.ts

@@ -1,24 +0,0 @@
-/**
- * Payment building using a2a-bsv wallet.createPayment().
- *
- * This replaces the old buildDirectPayment() which used plain P2PKH scripts
- * and manual UTXO management. The new implementation:
- * - Uses proper BRC-29 locking scripts via wallet.createPayment()
- * - Relies on wallet's createAction() for UTXO management
- * - Uses noSend: true (recipient broadcasts via acceptPayment())
- */
-import type { PaymentResult } from './types.js';
-/**
- * Build a BRC-29 payment using the a2a-bsv wallet.
- *
- * This creates a payment transaction using proper BRC-29 locking scripts.
- * The transaction uses noSend: true, meaning:
- * - The sender does NOT broadcast the transaction
- * - The recipient broadcasts it when they call acceptPayment()
- *
- * @param recipientPubKey - Recipient's compressed public key (66 hex chars, 02/03 prefix)
- * @param sats - Amount to send in satoshis
- * @param desc - Optional description for the payment
- * @returns PaymentResult with BEEF and derivation metadata for the recipient
- */
-export declare function buildDirectPayment(recipientPubKey: string, sats: number, desc?: string): Promise<PaymentResult>;

package/dist/src/scripts/payment/build.js

@@ -1,54 +0,0 @@
-/**
- * Payment building using a2a-bsv wallet.createPayment().
- *
- * This replaces the old buildDirectPayment() which used plain P2PKH scripts
- * and manual UTXO management. The new implementation:
- * - Uses proper BRC-29 locking scripts via wallet.createPayment()
- * - Relies on wallet's createAction() for UTXO management
- * - Uses noSend: true (recipient broadcasts via acceptPayment())
- */
-import { NETWORK, WALLET_DIR } from '../config.js';
-import { BSVAgentWallet } from '../../core/index.js';
-async function getBSVAgentWallet() {
-    return BSVAgentWallet;
-}
-/**
- * Build a BRC-29 payment using the a2a-bsv wallet.
- *
- * This creates a payment transaction using proper BRC-29 locking scripts.
- * The transaction uses noSend: true, meaning:
- * - The sender does NOT broadcast the transaction
- * - The recipient broadcasts it when they call acceptPayment()
- *
- * @param recipientPubKey - Recipient's compressed public key (66 hex chars, 02/03 prefix)
- * @param sats - Amount to send in satoshis
- * @param desc - Optional description for the payment
- * @returns PaymentResult with BEEF and derivation metadata for the recipient
- */
-export async function buildDirectPayment(recipientPubKey, sats, desc) {
-    // Validate recipient pubkey format
-    if (!/^0[23][0-9a-fA-F]{64}$/.test(recipientPubKey)) {
-        throw new Error('Recipient must be a compressed public key (66 hex chars starting with 02 or 03)');
-    }
-    const BSVAgentWallet = await getBSVAgentWallet();
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    try {
-        const result = await wallet.createPayment({
-            to: recipientPubKey,
-            satoshis: sats,
-            description: desc || 'agent payment',
-        });
-        // Return format compatible with existing code
-        return {
-            beef: result.beef,
-            txid: result.txid,
-            satoshis: result.satoshis,
-            derivationPrefix: result.derivationPrefix,
-            derivationSuffix: result.derivationSuffix,
-            senderIdentityKey: result.senderIdentityKey,
-        };
-    }
-    finally {
-        await wallet.destroy();
-    }
-}

package/dist/src/scripts/payment/commands.d.ts

@@ -1,15 +0,0 @@
-/**
- * Payment CLI commands: pay, verify, accept.
- */
-/**
- * Pay command: send satoshis to another agent.
- */
-export declare function cmdPay(pubkey: string | undefined, satoshis: string | undefined, description?: string): Promise<any>;
-/**
- * Verify command: verify an incoming payment BEEF.
- */
-export declare function cmdVerify(beefBase64: string | undefined): Promise<any>;
-/**
- * Accept command: accept and internalize a payment.
- */
-export declare function cmdAccept(beef: string | undefined, derivationPrefix: string | undefined, derivationSuffix: string | undefined, senderIdentityKey: string | undefined, description?: string): Promise<any>;

package/dist/src/scripts/payment/commands.js

@@ -1,73 +0,0 @@
-/**
- * Payment CLI commands: pay, verify, accept.
- */
-import { NETWORK, WALLET_DIR } from '../config.js';
-import { ok, fail } from '../output.js';
-import { buildDirectPayment } from './build.js';
-import { BSVAgentWallet } from '../../core/index.js';
-async function getBSVAgentWallet() {
-    return BSVAgentWallet;
-}
-/**
- * Pay command: send satoshis to another agent.
- */
-export async function cmdPay(pubkey, satoshis, description) {
-    if (!pubkey || !satoshis) {
-        return fail('Usage: pay <pubkey> <satoshis> [description]');
-    }
-    const sats = parseInt(satoshis, 10);
-    if (isNaN(sats) || sats <= 0) {
-        return fail('satoshis must be a positive integer');
-    }
-    try {
-        const payment = await buildDirectPayment(pubkey, sats, description || 'agent payment');
-        return ok(payment);
-    }
-    catch (err) {
-        return fail(err instanceof Error ? err.message : String(err));
-    }
-}
-/**
- * Verify command: verify an incoming payment BEEF.
- */
-export async function cmdVerify(beefBase64) {
-    if (!beefBase64) {
-        return fail('Usage: verify <beef_base64>');
-    }
-    const BSVAgentWallet = await getBSVAgentWallet();
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    try {
-        const result = wallet.verifyPayment({ beef: beefBase64 });
-        await wallet.destroy();
-        return ok(result);
-    }
-    catch (err) {
-        await wallet.destroy();
-        return fail(err instanceof Error ? err.message : String(err));
-    }
-}
-/**
- * Accept command: accept and internalize a payment.
- */
-export async function cmdAccept(beef, derivationPrefix, derivationSuffix, senderIdentityKey, description) {
-    if (!beef || !derivationPrefix || !derivationSuffix || !senderIdentityKey) {
-        return fail('Usage: accept <beef> <prefix> <suffix> <senderKey> [description]');
-    }
-    const BSVAgentWallet = await getBSVAgentWallet();
-    const wallet = await BSVAgentWallet.load({ network: NETWORK, storageDir: WALLET_DIR });
-    try {
-        const receipt = await wallet.acceptPayment({
-            beef,
-            derivationPrefix,
-            derivationSuffix,
-            senderIdentityKey,
-            description: description || undefined,
-        });
-        await wallet.destroy();
-        return ok(receipt);
-    }
-    catch (err) {
-        await wallet.destroy();
-        return fail(err instanceof Error ? err.message : String(err));
-    }
-}

package/dist/src/scripts/payment/index.d.ts

@@ -1,6 +0,0 @@
-/**
- * Payment module exports.
- */
-export * from './types.js';
-export * from './build.js';
-export * from './commands.js';

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

@@ -1,6 +0,0 @@
-/**
- * Payment module exports.
- */
-export * from './types.js';
-export * from './build.js';
-export * from './commands.js';

package/dist/src/scripts/payment/types.d.ts

@@ -1,56 +0,0 @@
-/**
- * Payment-specific type definitions.
- */
-export interface PaymentResult {
-    /** Base64-encoded Atomic BEEF transaction data */
-    beef: string;
-    /** Transaction ID (hex) */
-    txid: string;
-    /** Amount paid in satoshis */
-    satoshis: number;
-    /** BRC-29 derivation prefix (base64) - needed by recipient */
-    derivationPrefix: string;
-    /** BRC-29 derivation suffix (base64) - needed by recipient */
-    derivationSuffix: string;
-    /** Sender's identity key (compressed hex) - needed by recipient */
-    senderIdentityKey: string;
-}
-export interface PaymentParams {
-    /** Recipient's compressed public key (hex, 66 chars starting with 02/03) */
-    to: string;
-    /** Amount to pay in satoshis */
-    satoshis: number;
-    /** Optional human-readable description */
-    description?: string;
-}
-export interface VerifyParams {
-    /** Base64-encoded BEEF */
-    beef: string;
-    /** Expected amount (optional) */
-    expectedAmount?: number;
-    /** Expected sender identity key (optional) */
-    expectedSender?: string;
-}
-export interface VerifyResult {
-    valid: boolean;
-    txid: string;
-    outputCount: number;
-    errors: string[];
-}
-export interface AcceptParams {
-    /** Base64-encoded Atomic BEEF */
-    beef: string;
-    /** Output index (default: 0) */
-    vout?: number;
-    /** BRC-29 derivation prefix from PaymentResult */
-    derivationPrefix: string;
-    /** BRC-29 derivation suffix from PaymentResult */
-    derivationSuffix: string;
-    /** Sender's identity key from PaymentResult */
-    senderIdentityKey: string;
-    /** Optional description */
-    description?: string;
-}
-export interface AcceptResult {
-    accepted: boolean;
-}

package/dist/src/scripts/payment/types.js

@@ -1,4 +0,0 @@
-/**
- * Payment-specific type definitions.
- */
-export {};

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

@@ -1,6 +0,0 @@
-/**
- * Services module exports.
- */
-export * from './request.js';
-export * from './respond.js';
-export * from './queue.js';

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

@@ -1,6 +0,0 @@
-/**
- * Services module exports.
- */
-export * from './request.js';
-export * from './respond.js';
-export * from './queue.js';

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

@@ -1,11 +0,0 @@
-/**
- * Service queue commands.
- */
-/**
- * Service queue command: list pending service requests.
- */
-export declare function cmdServiceQueue(): Promise<any>;
-/**
- * Research queue command: list pending research requests.
- */
-export declare function cmdResearchQueue(): Promise<any>;

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

@@ -1,28 +0,0 @@
-/**
- * Service queue commands.
- */
-import fs from 'node:fs';
-import { PATHS } from '../config.js';
-import { ok } from '../output.js';
-import { readJsonl } from '../utils/storage.js';
-/**
- * Service queue command: list pending service requests.
- */
-export async function cmdServiceQueue() {
-    if (!fs.existsSync(PATHS.serviceQueue)) {
-        return ok({ pending: [], count: 0 });
-    }
-    const entries = readJsonl(PATHS.serviceQueue);
-    const pending = entries.filter(e => e.status === 'pending');
-    return ok({ pending, count: pending.length, total: entries.length });
-}
-/**
- * Research queue command: list pending research requests.
- */
-export async function cmdResearchQueue() {
-    if (!fs.existsSync(PATHS.researchQueue)) {
-        return ok({ pending: [] });
-    }
-    const entries = readJsonl(PATHS.researchQueue);
-    return ok({ pending: entries, count: entries.length });
-}

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

@@ -1,7 +0,0 @@
-/**
- * Service request command.
- */
-/**
- * Request service command: send a service request with optional payment.
- */
-export declare function cmdRequestService(targetKey: string | undefined, serviceId: string | undefined, satsStr?: string, inputJsonStr?: string): Promise<any>;