bsv-mcp 0.0.36 → 0.2.7

package/tools/wallet/a2bPublishMcp.ts

@@ -1,15 +1,14 @@
-import { PrivateKey, Utils } from "@bsv/sdk";
+import type { PrivateKey } from "@bsv/sdk";
+import { Utils } from "@bsv/sdk";
 import { Client } from "@modelcontextprotocol/sdk/client/index.js";
 import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import type {
 	ClientNotification,
 	ClientRequest,
 	ServerNotification,
 	ServerRequest,
 } from "@modelcontextprotocol/sdk/types.js";
-import { createOrdinals } from "js-1sat-ord";
 import type {
 	ChangeResult,
 	CreateOrdinalsConfig,
@@ -18,9 +17,12 @@ import type {
 	LocalSigner,
 	PreMAP,
 } from "js-1sat-ord";
-import { Sigma } from "sigma-protocol";
+import { createOrdinals } from "js-1sat-ord";
 import { z } from "zod";
+import packageJson from "../../package.json";
+import { V5Broadcaster } from "../../utils/broadcaster";
 import type { Wallet } from "./wallet";
+
 const { toArray, toBase64 } = Utils;
 
 // API endpoint for the A2B Overlay service
@@ -134,7 +136,7 @@ async function fetchMcpMetadata(
 		// Create and connect a client
 		client = new Client({
 			name: "metadata-fetcher",
-			version: "1.0.0",
+			version: packageJson.version,
 		});
 
 		await client.connect(transport);
@@ -186,33 +188,23 @@ async function fetchMcpMetadata(
 export function registerA2bPublishMcpTool(
 	server: McpServer,
 	wallet: Wallet,
+	identityPk: PrivateKey | undefined,
 	config: { disableBroadcasting: boolean },
 ) {
 	server.tool(
 		"wallet_a2bPublishMcp",
 		"Publish an MCP tool configuration record on-chain via Ordinal inscription. This creates a permanent, immutable, and discoverable tool definition that can be accessed by other MCP servers. The tool is published as a JSON inscription with metadata and optional digital signatures for authenticity verification.",
-		{ args: a2bPublishMcpArgsSchema },
-		async (
-			{ args }: { args: A2bPublishMcpArgs },
-			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
-		) => {
+		{ ...a2bPublishMcpArgsSchema.shape },
+		async ({ toolName, command, args, keywords, env, description, destinationAddress }) => {
 			try {
-				// Load optional identity key for sigma signing
-				const identityKeyWif = process.env.IDENTITY_KEY_WIF;
-				let identityPk: PrivateKey | undefined;
-				if (identityKeyWif) {
-					try {
-						identityPk = PrivateKey.fromWif(identityKeyWif);
-					} catch (e) {
-						console.warn(
-							"Warning: Invalid IDENTITY_KEY_WIF environment variable; sigma signing disabled",
-							e,
-						);
-					}
+				if (!identityPk) {
+					console.warn(
+						"Warning: No identity key provided; sigma signing disabled for A2B MCP publish",
+					);
 				}
 
-				const paymentPk = wallet.getPrivateKey();
-				if (!paymentPk) throw new Error("No private key available");
+				const paymentPk = wallet.getPaymentKey();
+				if (!paymentPk) throw new Error("No payment private key available");
 
 				const { paymentUtxos } = await wallet.getUtxos();
 				if (!paymentUtxos?.length)
@@ -221,20 +213,20 @@ export function registerA2bPublishMcpTool(
 				const walletAddress = paymentPk.toAddress().toString();
 
 				// Fetch MCP metadata (tools, prompts, resources)
-				const metadata = await fetchMcpMetadata(args.command, args.args);
+				const metadata = await fetchMcpMetadata(command, args);
 				// console.log(`Discovered ${metadata.tools.length} tools, ${metadata.prompts.length} prompts, and ${metadata.resources.length} resources`);
 
 				// Assemble tool configuration
 				const toolConfig: McpConfig = {
-					command: args.command,
-					args: args.args,
+					command,
+					args,
 					tools: metadata.tools,
 					prompts: metadata.prompts,
 					resources: metadata.resources,
-					env: args.env
-						? args.env.reduce(
-								(acc, { key, description }) => {
-									acc[key] = description;
+					env: env
+						? env.reduce(
+								(acc, { key, description: desc }) => {
+									acc[key] = desc;
 									return acc;
 								},
 								{} as Record<string, string>,
@@ -248,9 +240,9 @@ export function registerA2bPublishMcpTool(
 				// Prepare the full configuration with metadata
 				const fullConfig = {
 					mcpServers: {
-						[args.toolName]: {
-							description: args.description || "",
-							keywords: args.keywords || [],
+						[toolName]: {
+							description: description || "",
+							keywords: keywords || [],
 							tools: metadata.tools || [],
 							prompts: metadata.prompts || [],
 							resources: metadata.resources || [],
@@ -269,7 +261,7 @@ export function registerA2bPublishMcpTool(
 				};
 
 				// Destination for the ordinal
-				const targetAddress = args.destinationAddress ?? walletAddress;
+				const targetAddress = destinationAddress ?? walletAddress;
 				const destinations: Destination[] = [
 					{ address: targetAddress, inscription },
 				];
@@ -284,20 +276,27 @@ export function registerA2bPublishMcpTool(
 					changeAddress: walletAddress,
 					metaData,
 				} as CreateOrdinalsConfig;
+
+				// Use the passed identityPk for signing if available
 				if (identityPk) {
 					createOrdinalsConfig.signer = {
 						idKey: identityPk,
 					} as LocalSigner;
 				}
-				// Inscribe the ordinal on-chain via js-1sat-ord
-				const result = await createOrdinals(createOrdinalsConfig);
 
-				const changeResult = result as ChangeResult;
+				// Inscribe the ordinal on-chain via js-1sat-ord
+				let result: ChangeResult | undefined;
+				if (!config.disableBroadcasting) {
+					result = await createOrdinals(createOrdinalsConfig);
+				} else {
+					console.warn("Broadcasting disabled. Transaction not created.");
+				}
 
 				// Broadcast the transaction
-				if (!config.disableBroadcasting) {
-					await changeResult.tx.broadcast();
-					const txid = changeResult.tx.id("hex");
+				if (!config.disableBroadcasting && result) {
+					const broadcaster = new V5Broadcaster();
+					await result.tx.broadcast(broadcaster);
+					const txid = result.tx.id("hex");
 
 					setTimeout(async () => {
 						// Call the ingest endpoint to process the transaction
@@ -331,12 +330,12 @@ export function registerA2bPublishMcpTool(
 										txid,
 										outpoint,
 										onchainUrl,
-										toolName: args.toolName,
+										toolName,
 										toolCount: metadata.tools.length,
 										promptCount: metadata.prompts.length,
 										resourceCount: metadata.resources.length,
 										description:
-											args.description || `MCP Tool: ${args.toolName}`,
+											description || `MCP Tool: ${toolName}`,
 										address: targetAddress,
 									},
 									null,
@@ -350,7 +349,7 @@ export function registerA2bPublishMcpTool(
 					content: [
 						{
 							type: "text",
-							text: changeResult.tx.toHex(),
+							text: result?.tx.toHex() || "",
 						},
 					],
 				};

package/tools/wallet/createOrdinals.ts

@@ -1,12 +1,6 @@
 import { PrivateKey } from "@bsv/sdk";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import type {
-	CallToolResult,
-	ServerNotification,
-	ServerRequest,
-} from "@modelcontextprotocol/sdk/types.js";
-import { createOrdinals } from "js-1sat-ord";
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import type {
 	ChangeResult,
 	CreateOrdinalsCollectionItemMetadata,
@@ -17,8 +11,9 @@ import type {
 	LocalSigner,
 	PreMAP,
 } from "js-1sat-ord";
-import { Sigma } from "sigma-protocol";
+import { createOrdinals } from "js-1sat-ord";
 import { z } from "zod";
+import { V5Broadcaster } from "../../utils/broadcaster";
 import type { Wallet } from "./wallet";
 
 /**
@@ -52,11 +47,8 @@ export function registerCreateOrdinalsTool(server: McpServer, wallet: Wallet) {
 	server.tool(
 		"wallet_createOrdinals",
 		"Creates and inscribes ordinals (NFTs) on the Bitcoin SV blockchain. This tool lets you mint new digital artifacts by encoding data directly into the blockchain. Supports various content types including images, text, JSON, and HTML. The tool handles transaction creation, fee calculation, and broadcasting.",
-		{ args: createOrdinalsArgsSchema },
-		async (
-			{ args }: { args: CreateOrdinalsArgs },
-			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
-		): Promise<CallToolResult> => {
+		{ ...createOrdinalsArgsSchema.shape },
+		async ({ dataB64, contentType, destinationAddress, metadata }): Promise<CallToolResult> => {
 			try {
 				// Load optional identity key for sigma signing
 				const identityKeyWif = process.env.IDENTITY_KEY_WIF;
@@ -91,14 +83,14 @@ export function registerCreateOrdinalsTool(server: McpServer, wallet: Wallet) {
 
 				// 4. Create the inscription object
 				const inscription: Inscription = {
-					dataB64: args.dataB64,
-					contentType: args.contentType,
+					dataB64: dataB64,
+					contentType: contentType,
 				};
 
 				// 5. Create the destination
 				const destinations: Destination[] = [
 					{
-						address: args.destinationAddress || walletAddress,
+						address: destinationAddress || walletAddress,
 						inscription,
 					},
 				];
@@ -108,7 +100,7 @@ export function registerCreateOrdinalsTool(server: McpServer, wallet: Wallet) {
 					destinations,
 					paymentPk,
 					changeAddress: walletAddress,
-					metaData: args.metadata as
+					metaData: metadata as
 						| PreMAP
 						| CreateOrdinalsCollectionMetadata
 						| CreateOrdinalsCollectionItemMetadata,
@@ -129,7 +121,8 @@ export function registerCreateOrdinalsTool(server: McpServer, wallet: Wallet) {
 
 				const disableBroadcasting = process.env.DISABLE_BROADCASTING === "true";
 				if (!disableBroadcasting) {
-					await changeResult.tx.broadcast();
+					const broadcaster = new V5Broadcaster();
+					await changeResult.tx.broadcast(broadcaster);
 
 					// 8. Refresh the wallet's UTXOs after spending
 					try {
@@ -150,8 +143,8 @@ export function registerCreateOrdinalsTool(server: McpServer, wallet: Wallet) {
 									txid: changeResult.tx.id("hex"),
 									spentOutpoints: changeResult.spentOutpoints,
 									payChange: changeResult.payChange,
-									inscriptionAddress: args.destinationAddress || walletAddress,
-									contentType: args.contentType,
+									inscriptionAddress: destinationAddress || walletAddress,
+									contentType: contentType,
 								}),
 							},
 						],

package/tools/wallet/fetchPaymentUtxos.ts

@@ -1,6 +1,9 @@
 import { P2PKH, Transaction, Utils } from "@bsv/sdk";
 import type { Utxo } from "js-1sat-ord";
-const { toBase64 } = Utils;
+import { V5_API_URL } from "../constants";
+import { getBeefTransactionById, getTransactionById } from "./utxo";
+
+const { toBase64, toHex, toArray } = Utils;
 
 /**
  * Type definition for WhatsOnChain UTXO response
@@ -56,13 +59,10 @@ export async function fetchPaymentUtxos(
 		const utxos: (Utxo | null)[] = await Promise.all(
 			data.map(async (utxo: WhatsOnChainUtxo) => {
 				// Get the transaction hex to extract the correct script
-				const script = await getScriptFromTransaction(
-					utxo.tx_hash,
-					utxo.tx_pos,
-				);
-
+				const tx = await getBeefTransactionById(utxo.tx_hash);
+				const script = tx?.outputs[utxo.tx_pos]?.lockingScript.toHex();
 				if (!script) {
-					console.warn(
+					console.error(
 						`Could not get script for UTXO: ${utxo.tx_hash}:${utxo.tx_pos}`,
 					);
 					return null;
@@ -72,7 +72,7 @@ export async function fetchPaymentUtxos(
 					txid: utxo.tx_hash,
 					vout: utxo.tx_pos,
 					satoshis: utxo.value,
-					script: script,
+					script,
 				};
 			}),
 		);
@@ -87,44 +87,53 @@ export async function fetchPaymentUtxos(
 	}
 }
 
-/**
- * Gets the script from a transaction for a specific output index
- *
- * @param txid - The transaction ID
- * @param vout - The output index
- * @returns The script as hex string or undefined if an error occurs
- */
-async function getScriptFromTransaction(
-	txid: string,
-	vout: number,
-): Promise<string | undefined> {
+type V5Utxo = {
+	outpoint: string;
+	height: number;
+	idx: number;
+	satoshis: number;
+	script: string;
+	owners: string[];
+	data: Record<string, unknown>;
+};
+
+export async function fetchPaymentUtxosFromV5(
+	address: string,
+): Promise<Utxo[] | undefined> {
 	try {
-		const response = await fetch(
-			`https://api.whatsonchain.com/v1/bsv/main/tx/${txid}/hex`,
-		);
-
+		const url = `${V5_API_URL}/own/${address}/utxos?refresh=true&txo=true&script=true&limit=250&tags=p2pkh`;
+		console.error(`Fetching UTXOs from V5: ${url}`);
+		const response = await fetch(url);
 		if (!response.ok) {
-			console.error(
-				`WhatsOnChain API error fetching tx hex: ${response.status} ${response.statusText}`,
-			);
+			console.error(`V5 UTXO fetch failed: ${response.status} ${response.statusText}`);
 			return undefined;
 		}
-
-		const txHex = await response.text();
-		const tx = Transaction.fromHex(txHex);
-		const output = tx.outputs[vout];
-
-		if (!output) {
-			console.error(`Output index ${vout} not found in transaction ${txid}`);
+		const data = (await response.json()) as V5Utxo[] | null;
+		if (!Array.isArray(data)) {
+			console.error(`V5 UTXO response was not an array: ${typeof data}`);
 			return undefined;
 		}
-
-		return toBase64(output.lockingScript.toBinary());
+		const utxos: Utxo[] = [];
+		for (const utxo of data) {
+			if (!utxo.data.p2pkh) {
+				// Skip if not a P2PKH
+				continue;
+			}
+			const [txid, vout] = utxo.outpoint.split("_");
+			if (!txid || !vout) {
+				console.error(`Invalid outpoint: ${utxo.outpoint}`);
+				continue;
+			}
+			utxos.push({
+				txid,
+				vout: Number.parseInt(vout),
+				satoshis: utxo.satoshis,
+				script: toHex(toArray(utxo.script, "base64")),
+			} as Utxo);
+		}
+		return utxos;
 	} catch (error) {
-		console.error(
-			`Error getting script for transaction ${txid}:${vout}:`,
-			error,
-		);
+		console.error("Error fetching payment UTXOs from V5:", error);
 		return undefined;
 	}
 }