@1sat/wallet-toolbox 0.0.9 → 0.0.11

package/dist/api/balance/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * Balance Module
  *
- * Functions for querying wallet balance and payment UTXOs.
+ * Skills for querying wallet balance and payment UTXOs.
  */
-import type { WalletInterface } from "@bsv/sdk";
+import type { Skill } from "../skills/types";
 export interface Balance {
     /** Balance in satoshis */
     satoshis: number;
@@ -18,21 +18,33 @@ export interface PaymentUtxo {
     satoshis: number;
     script: string;
 }
+/** Input for getBalance skill (no required params) */
+export type GetBalanceInput = Record<string, never>;
 /**
  * Get wallet balance with USD conversion.
  */
-export declare function getBalance(cwi: WalletInterface, chain?: "main" | "test", wocApiKey?: string): Promise<Balance>;
+export declare const getBalance: Skill<GetBalanceInput, Balance>;
+/** Input for getPaymentUtxos skill (no required params) */
+export type GetPaymentUtxosInput = Record<string, never>;
 /**
  * Get payment UTXOs for external use.
  */
-export declare function getPaymentUtxos(cwi: WalletInterface): Promise<PaymentUtxo[]>;
+export declare const getPaymentUtxos: Skill<GetPaymentUtxosInput, PaymentUtxo[]>;
+/** Input for getExchangeRate skill (no required params) */
+export type GetExchangeRateInput = Record<string, never>;
 /**
  * Get current BSV/USD exchange rate.
  */
-export declare function getExchangeRate(chain?: "main" | "test", wocApiKey?: string): Promise<number>;
+export declare const getExchangeRate: Skill<GetExchangeRateInput, number>;
+/** Input for getChainInfo skill (no required params) */
+export type GetChainInfoInput = Record<string, never>;
+/** Output for getChainInfo skill */
+export interface ChainInfo {
+    blocks: number;
+}
 /**
  * Get chain info from WhatsOnChain.
  */
-export declare function getChainInfo(chain?: "main" | "test", wocApiKey?: string): Promise<{
-    blocks: number;
-} | null>;
+export declare const getChainInfo: Skill<GetChainInfoInput, ChainInfo | null>;
+/** All balance skills for registry */
+export declare const balanceSkills: (Skill<GetBalanceInput, Balance> | Skill<GetPaymentUtxosInput, PaymentUtxo[]> | Skill<GetExchangeRateInput, number> | Skill<GetChainInfoInput, ChainInfo | null>)[];

package/dist/api/balance/index.js

@@ -1,47 +1,15 @@
 /**
  * Balance Module
  *
- * Functions for querying wallet balance and payment UTXOs.
+ * Skills for querying wallet balance and payment UTXOs.
  */
 import { FUNDING_BASKET, WOC_MAINNET_URL, WOC_TESTNET_URL, EXCHANGE_RATE_CACHE_TTL } from "../constants";
 // Module-level cache for exchange rate
 let exchangeRateCache = null;
-/**
- * Get wallet balance with USD conversion.
- */
-export async function getBalance(cwi, chain = "main", wocApiKey) {
-    const exchangeRate = await getExchangeRate(chain, wocApiKey);
-    const result = await cwi.listOutputs({ basket: FUNDING_BASKET, limit: 10000 });
-    console.log(`[getBalance] Found ${result.outputs.length} outputs in "${FUNDING_BASKET}" basket, total: ${result.totalOutputs}`);
-    const satoshis = result.outputs.reduce((sum, o) => sum + o.satoshis, 0);
-    console.log(`[getBalance] Total satoshis: ${satoshis}`);
-    const bsv = satoshis / 100_000_000;
-    const usdInCents = Math.round(bsv * exchangeRate * 100);
-    return { satoshis, bsv, usdInCents };
-}
-/**
- * Get payment UTXOs for external use.
- */
-export async function getPaymentUtxos(cwi) {
-    const result = await cwi.listOutputs({
-        basket: FUNDING_BASKET,
-        include: "locking scripts",
-        limit: 10000,
-    });
-    return result.outputs.map((o) => {
-        const [txid, voutStr] = o.outpoint.split(".");
-        return {
-            txid,
-            vout: parseInt(voutStr, 10),
-            satoshis: o.satoshis,
-            script: o.lockingScript || "",
-        };
-    });
-}
-/**
- * Get current BSV/USD exchange rate.
- */
-export async function getExchangeRate(chain = "main", wocApiKey) {
+// ============================================================================
+// Internal helpers
+// ============================================================================
+async function fetchExchangeRate(chain, wocApiKey) {
     if (exchangeRateCache && Date.now() - exchangeRateCache.timestamp < EXCHANGE_RATE_CACHE_TTL) {
         return exchangeRateCache.rate;
     }
@@ -62,21 +30,106 @@ export async function getExchangeRate(chain = "main", wocApiKey) {
         return exchangeRateCache?.rate ?? 0;
     }
 }
+/**
+ * Get wallet balance with USD conversion.
+ */
+export const getBalance = {
+    meta: {
+        name: "getBalance",
+        description: "Get wallet balance in satoshis, BSV, and USD cents",
+        category: "balance",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    async execute(ctx) {
+        const exchangeRate = await fetchExchangeRate(ctx.chain, ctx.wocApiKey);
+        const result = await ctx.wallet.listOutputs({ basket: FUNDING_BASKET, limit: 10000 });
+        const satoshis = result.outputs.reduce((sum, o) => sum + o.satoshis, 0);
+        const bsv = satoshis / 100_000_000;
+        const usdInCents = Math.round(bsv * exchangeRate * 100);
+        return { satoshis, bsv, usdInCents };
+    },
+};
+/**
+ * Get payment UTXOs for external use.
+ */
+export const getPaymentUtxos = {
+    meta: {
+        name: "getPaymentUtxos",
+        description: "Get payment UTXOs from the wallet for external use",
+        category: "balance",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    async execute(ctx) {
+        const result = await ctx.wallet.listOutputs({
+            basket: FUNDING_BASKET,
+            include: "locking scripts",
+            limit: 10000,
+        });
+        return result.outputs.map((o) => {
+            const [txid, voutStr] = o.outpoint.split(".");
+            return {
+                txid,
+                vout: Number.parseInt(voutStr, 10),
+                satoshis: o.satoshis,
+                script: o.lockingScript || "",
+            };
+        });
+    },
+};
+/**
+ * Get current BSV/USD exchange rate.
+ */
+export const getExchangeRate = {
+    meta: {
+        name: "getExchangeRate",
+        description: "Get current BSV/USD exchange rate from WhatsOnChain",
+        category: "balance",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    async execute(ctx) {
+        return fetchExchangeRate(ctx.chain, ctx.wocApiKey);
+    },
+};
 /**
  * Get chain info from WhatsOnChain.
  */
-export async function getChainInfo(chain = "main", wocApiKey) {
-    const baseUrl = chain === "main" ? WOC_MAINNET_URL : WOC_TESTNET_URL;
-    const headers = {};
-    if (wocApiKey)
-        headers["woc-api-key"] = wocApiKey;
-    try {
-        const response = await fetch(`${baseUrl}/chain/info`, { headers });
-        if (!response.ok)
+export const getChainInfo = {
+    meta: {
+        name: "getChainInfo",
+        description: "Get current chain info (block height) from WhatsOnChain",
+        category: "balance",
+        inputSchema: {
+            type: "object",
+            properties: {},
+        },
+    },
+    async execute(ctx) {
+        const baseUrl = ctx.chain === "main" ? WOC_MAINNET_URL : WOC_TESTNET_URL;
+        const headers = {};
+        if (ctx.wocApiKey)
+            headers["woc-api-key"] = ctx.wocApiKey;
+        try {
+            const response = await fetch(`${baseUrl}/chain/info`, { headers });
+            if (!response.ok)
+                return null;
+            return await response.json();
+        }
+        catch {
             return null;
-        return await response.json();
-    }
-    catch {
-        return null;
-    }
-}
+        }
+    },
+};
+// ============================================================================
+// Module exports
+// ============================================================================
+/** All balance skills for registry */
+export const balanceSkills = [getBalance, getPaymentUtxos, getExchangeRate, getChainInfo];

package/dist/api/broadcast/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * Broadcast Module
  *
- * Functions for broadcasting transactions.
+ * Skills for broadcasting transactions.
  */
-import { type WalletInterface } from "@bsv/sdk";
+import type { Skill } from "../skills/types";
 export interface BroadcastRequest {
     /** Raw transaction hex */
     rawtx: string;
@@ -19,4 +19,6 @@ export interface BroadcastResponse {
 /**
  * Broadcast a transaction and internalize it into the wallet.
  */
-export declare function broadcast(cwi: WalletInterface, request: BroadcastRequest): Promise<BroadcastResponse>;
+export declare const broadcast: Skill<BroadcastRequest, BroadcastResponse>;
+/** All broadcast skills for registry */
+export declare const broadcastSkills: Skill<BroadcastRequest, BroadcastResponse>[];

package/dist/api/broadcast/index.js

@@ -1,45 +1,73 @@
 /**
  * Broadcast Module
  *
- * Functions for broadcasting transactions.
+ * Skills for broadcasting transactions.
  */
-import { Beef, Transaction, } from "@bsv/sdk";
+import { Beef, Transaction } from "@bsv/sdk";
+// ============================================================================
+// Skills
+// ============================================================================
 /**
  * Broadcast a transaction and internalize it into the wallet.
  */
-export async function broadcast(cwi, request) {
-    try {
-        let tx;
-        switch (request.format) {
-            case "beef":
-                tx = Transaction.fromHexBEEF(request.rawtx);
-                break;
-            case "ef":
-                tx = Transaction.fromHexEF(request.rawtx);
-                break;
-            default:
-                tx = Transaction.fromHex(request.rawtx);
-        }
-        const txid = tx.id("hex");
-        const beef = new Beef();
-        beef.mergeTransaction(tx);
-        const outputs = tx.outputs.map((_, index) => ({
-            outputIndex: index,
-            protocol: "wallet payment",
-            paymentRemittance: {
-                derivationPrefix: "default",
-                derivationSuffix: `${txid}.${index}`,
-                senderIdentityKey: "",
+export const broadcast = {
+    meta: {
+        name: "broadcast",
+        description: "Broadcast a transaction and internalize it into the wallet",
+        category: "broadcast",
+        inputSchema: {
+            type: "object",
+            properties: {
+                rawtx: { type: "string", description: "Raw transaction hex" },
+                format: {
+                    type: "string",
+                    description: "Transaction format (tx, beef, ef)",
+                    enum: ["tx", "beef", "ef"],
+                },
+                description: { type: "string", description: "Description for wallet records" },
             },
-        }));
-        await cwi.internalizeAction({
-            tx: Array.from(beef.toBinary()),
-            outputs,
-            description: request.description || "Broadcast transaction",
-        });
-        return { txid };
-    }
-    catch (error) {
-        return { error: error instanceof Error ? error.message : "Unknown error" };
-    }
-}
+            required: ["rawtx"],
+        },
+    },
+    async execute(ctx, input) {
+        try {
+            let tx;
+            switch (input.format) {
+                case "beef":
+                    tx = Transaction.fromHexBEEF(input.rawtx);
+                    break;
+                case "ef":
+                    tx = Transaction.fromHexEF(input.rawtx);
+                    break;
+                default:
+                    tx = Transaction.fromHex(input.rawtx);
+            }
+            const txid = tx.id("hex");
+            const beef = new Beef();
+            beef.mergeTransaction(tx);
+            const outputs = tx.outputs.map((_, index) => ({
+                outputIndex: index,
+                protocol: "wallet payment",
+                paymentRemittance: {
+                    derivationPrefix: "default",
+                    derivationSuffix: `${txid}.${index}`,
+                    senderIdentityKey: "",
+                },
+            }));
+            await ctx.wallet.internalizeAction({
+                tx: Array.from(beef.toBinary()),
+                outputs,
+                description: input.description || "Broadcast transaction",
+            });
+            return { txid };
+        }
+        catch (error) {
+            return { error: error instanceof Error ? error.message : "Unknown error" };
+        }
+    },
+};
+// ============================================================================
+// Module exports
+// ============================================================================
+/** All broadcast skills for registry */
+export const broadcastSkills = [broadcast];

package/dist/api/index.d.ts

@@ -1,29 +1,29 @@
 /**
  * 1Sat Wallet Toolbox API Layer
  *
- * This module provides the OneSatApi class for interacting with the 1Sat ecosystem.
- * All methods work with any BRC-100 compatible wallet interface (CWI).
+ * This module provides skills (self-describing actions) for interacting with the 1Sat ecosystem.
+ * All skills work with any BRC-100 compatible wallet interface via OneSatContext.
  *
  * Usage:
  * ```typescript
- * import { OneSatApi } from '@1sat/wallet-toolbox';
+ * import { createContext, transferOrdinal, skillRegistry } from '@1sat/wallet-toolbox/api';
  *
- * // Create API instance with a CWI-compatible wallet
- * const api = new OneSatApi(cwi);
+ * // Create context with a BRC-100 compatible wallet
+ * const ctx = createContext(wallet, { services, chain: 'main' });
  *
- * // Use the API
- * const balance = await api.getBalance();
- * const ordinals = await api.listOrdinals();
- * const result = await api.sendBsv([{ address: '...', satoshis: 1000 }]);
- * ```
+ * // Execute skills directly
+ * const result = await transferOrdinal.execute(ctx, { outpoint: '...', address: '...' });
  *
- * You can also import functions directly from modules:
- * ```typescript
- * import { listOrdinals } from '@1sat/wallet-toolbox/api/ordinals';
- * import { sendBsv } from '@1sat/wallet-toolbox/api/payments';
+ * // Or via registry (useful for AI agents)
+ * const skill = skillRegistry.get('transferOrdinal');
+ * const result = await skill.execute(ctx, { outpoint: '...', address: '...' });
+ *
+ * // Get MCP-compatible tool list
+ * const tools = skillRegistry.toMcpTools();
  * ```
  */
-export { OneSatApi } from "./OneSatApi";
+export { type OneSatContext, type Skill, type SkillMetadata, type SkillCategory, type JsonSchemaProperty, createContext, } from "./skills/types";
+export { SkillRegistry, skillRegistry, type McpTool } from "./skills/registry";
 export * from "./constants";
 export * from "./balance";
 export * from "./payments";
@@ -33,4 +33,5 @@ export * from "./inscriptions";
 export * from "./locks";
 export * from "./signing";
 export * from "./broadcast";
+export * from "./sweep";
 export type { WalletInterface, WalletOutput, CreateActionArgs, CreateActionResult, CreateActionOutput, CreateActionInput, ListOutputsResult, ListOutputsArgs, } from "@bsv/sdk";

package/dist/api/index.js

@@ -1,33 +1,34 @@
 /**
  * 1Sat Wallet Toolbox API Layer
  *
- * This module provides the OneSatApi class for interacting with the 1Sat ecosystem.
- * All methods work with any BRC-100 compatible wallet interface (CWI).
+ * This module provides skills (self-describing actions) for interacting with the 1Sat ecosystem.
+ * All skills work with any BRC-100 compatible wallet interface via OneSatContext.
  *
  * Usage:
  * ```typescript
- * import { OneSatApi } from '@1sat/wallet-toolbox';
+ * import { createContext, transferOrdinal, skillRegistry } from '@1sat/wallet-toolbox/api';
  *
- * // Create API instance with a CWI-compatible wallet
- * const api = new OneSatApi(cwi);
+ * // Create context with a BRC-100 compatible wallet
+ * const ctx = createContext(wallet, { services, chain: 'main' });
  *
- * // Use the API
- * const balance = await api.getBalance();
- * const ordinals = await api.listOrdinals();
- * const result = await api.sendBsv([{ address: '...', satoshis: 1000 }]);
- * ```
+ * // Execute skills directly
+ * const result = await transferOrdinal.execute(ctx, { outpoint: '...', address: '...' });
  *
- * You can also import functions directly from modules:
- * ```typescript
- * import { listOrdinals } from '@1sat/wallet-toolbox/api/ordinals';
- * import { sendBsv } from '@1sat/wallet-toolbox/api/payments';
+ * // Or via registry (useful for AI agents)
+ * const skill = skillRegistry.get('transferOrdinal');
+ * const result = await skill.execute(ctx, { outpoint: '...', address: '...' });
+ *
+ * // Get MCP-compatible tool list
+ * const tools = skillRegistry.toMcpTools();
  * ```
  */
-// Export the main API class
-export { OneSatApi } from "./OneSatApi";
+// Export skill types and helpers
+export { createContext, } from "./skills/types";
+// Export skill registry
+export { SkillRegistry, skillRegistry } from "./skills/registry";
 // Export constants
 export * from "./constants";
-// Export module functions and types
+// Export module skills and types
 export * from "./balance";
 export * from "./payments";
 export * from "./ordinals";
@@ -36,3 +37,27 @@ export * from "./inscriptions";
 export * from "./locks";
 export * from "./signing";
 export * from "./broadcast";
+// Export sweep module (uses external signing, not skill-based)
+export * from "./sweep";
+// Register all skills with the global registry
+import { skillRegistry } from "./skills/registry";
+import { balanceSkills } from "./balance";
+import { paymentsSkills } from "./payments";
+import { ordinalsSkills } from "./ordinals";
+import { tokensSkills } from "./tokens";
+import { inscriptionsSkills } from "./inscriptions";
+import { locksSkills } from "./locks";
+import { signingSkills } from "./signing";
+import { broadcastSkills } from "./broadcast";
+import { sweepSkills } from "./sweep";
+skillRegistry.registerAll([
+    ...balanceSkills,
+    ...paymentsSkills,
+    ...ordinalsSkills,
+    ...tokensSkills,
+    ...inscriptionsSkills,
+    ...locksSkills,
+    ...signingSkills,
+    ...broadcastSkills,
+    ...sweepSkills,
+]);

package/dist/api/inscriptions/index.d.ts

@@ -1,18 +1,16 @@
 /**
  * Inscriptions Module
  *
- * Functions for creating inscriptions.
+ * Skills for creating inscriptions.
  */
-import { type WalletInterface } from "@bsv/sdk";
+import type { Skill } from "../skills/types";
 export interface InscribeRequest {
-    /** Base64 encoded data */
-    base64Data: string;
-    /** MIME type of the content */
-    mimeType: string;
+    /** Base64 encoded content */
+    base64Content: string;
+    /** Content type (MIME type) */
+    contentType: string;
     /** Optional MAP metadata */
     map?: Record<string, string>;
-    /** Destination address for the inscription (required - use a derived address) */
-    destination: string;
 }
 export interface InscribeResponse {
     txid?: string;
@@ -22,4 +20,6 @@ export interface InscribeResponse {
 /**
  * Create an inscription.
  */
-export declare function inscribe(cwi: WalletInterface, request: InscribeRequest): Promise<InscribeResponse>;
+export declare const inscribe: Skill<InscribeRequest, InscribeResponse>;
+/** All inscription skills for registry */
+export declare const inscriptionsSkills: Skill<InscribeRequest, InscribeResponse>[];

package/dist/api/inscriptions/index.js

@@ -1,17 +1,21 @@
 /**
  * Inscriptions Module
  *
- * Functions for creating inscriptions.
+ * Skills for creating inscriptions.
  */
-import { P2PKH, Script, Utils, } from "@bsv/sdk";
+import { P2PKH, PublicKey, Script, Utils } from "@bsv/sdk";
 import { Inscription } from "@bopen-io/templates";
-import { MAX_INSCRIPTION_BYTES } from "../constants";
-/**
- * Build an inscription locking script.
- */
-function buildInscriptionScript(address, base64Data, mimeType) {
-    const content = Utils.toArray(base64Data, "base64");
-    const inscription = Inscription.create(new Uint8Array(content), mimeType);
+import { MAX_INSCRIPTION_BYTES, ORDINALS_BASKET } from "../constants";
+// ============================================================================
+// Constants
+// ============================================================================
+const ORDINAL_PROTOCOL = [1, "ordinal"];
+// ============================================================================
+// Internal helpers
+// ============================================================================
+function buildInscriptionScript(address, base64Content, contentType) {
+    const content = Utils.toArray(base64Content, "base64");
+    const inscription = Inscription.create(new Uint8Array(content), contentType);
     const inscriptionScript = inscription.lock();
     const p2pkhScript = new P2PKH().lock(address);
     const combined = new Script();
@@ -21,30 +25,74 @@ function buildInscriptionScript(address, base64Data, mimeType) {
         combined.chunks.push(chunk);
     return combined;
 }
+// ============================================================================
+// Skills
+// ============================================================================
 /**
  * Create an inscription.
  */
-export async function inscribe(cwi, request) {
-    try {
-        const decoded = Buffer.from(request.base64Data, "base64");
-        if (decoded.length > MAX_INSCRIPTION_BYTES) {
-            return { error: `Inscription data too large: ${decoded.length} bytes (max ${MAX_INSCRIPTION_BYTES})` };
+export const inscribe = {
+    meta: {
+        name: "inscribe",
+        description: "Create a new inscription with the given content and type",
+        category: "inscriptions",
+        inputSchema: {
+            type: "object",
+            properties: {
+                base64Content: { type: "string", description: "Base64 encoded content" },
+                contentType: { type: "string", description: "Content type (MIME type)" },
+                map: {
+                    type: "object",
+                    description: "Optional MAP metadata",
+                    properties: {},
+                },
+            },
+            required: ["base64Content", "contentType"],
+        },
+    },
+    async execute(ctx, input) {
+        try {
+            const decoded = Utils.toArray(input.base64Content, "base64");
+            if (decoded.length > MAX_INSCRIPTION_BYTES) {
+                return { error: `Inscription data too large: ${decoded.length} bytes (max ${MAX_INSCRIPTION_BYTES})` };
+            }
+            const keyID = Date.now().toString();
+            const { publicKey } = await ctx.wallet.getPublicKey({
+                protocolID: ORDINAL_PROTOCOL,
+                keyID,
+                counterparty: "self",
+                forSelf: true,
+            });
+            const address = PublicKey.fromString(publicKey).toAddress();
+            const lockingScript = buildInscriptionScript(address, input.base64Content, input.contentType);
+            const result = await ctx.wallet.createAction({
+                description: "Create inscription",
+                outputs: [
+                    {
+                        lockingScript: lockingScript.toHex(),
+                        satoshis: 1,
+                        outputDescription: "Inscription",
+                        basket: ORDINALS_BASKET,
+                        tags: [`type:${input.contentType}`],
+                        customInstructions: JSON.stringify({
+                            protocolID: ORDINAL_PROTOCOL,
+                            keyID,
+                        }),
+                    },
+                ],
+            });
+            if (!result.txid) {
+                return { error: "no-txid-returned" };
+            }
+            return { txid: result.txid, rawtx: result.tx ? Utils.toHex(result.tx) : undefined };
         }
-        const lockingScript = buildInscriptionScript(request.destination, request.base64Data, request.mimeType);
-        const result = await cwi.createAction({
-            description: "Create inscription",
-            outputs: [{
-                    lockingScript: lockingScript.toHex(),
-                    satoshis: 1,
-                    outputDescription: "Inscription",
-                }],
-        });
-        if (!result.txid) {
-            return { error: "no-txid-returned" };
+        catch (error) {
+            return { error: error instanceof Error ? error.message : "unknown-error" };
         }
-        return { txid: result.txid, rawtx: result.tx ? Utils.toHex(result.tx) : undefined };
-    }
-    catch (error) {
-        return { error: error instanceof Error ? error.message : "unknown-error" };
-    }
-}
+    },
+};
+// ============================================================================
+// Module exports
+// ============================================================================
+/** All inscription skills for registry */
+export const inscriptionsSkills = [inscribe];