bsv-mcp 0.0.21 → 0.0.23

package/tools/utils/index.ts

@@ -12,24 +12,28 @@ export function registerUtilsTools(server: McpServer): void {
 	server.tool(
 		"utils_convertData",
 		"Converts data between different encodings (utf8, hex, base64, binary). Useful for transforming data formats when working with blockchain data, encryption, or file processing.\n\n" +
-		"Parameters:\n" +
-		"- data (required): The string to convert\n" +
-		"- from (required): Source encoding format (utf8, hex, base64, or binary)\n" +
-		"- to (required): Target encoding format (utf8, hex, base64, or binary)\n\n" +
-		"Example usage:\n" +
-		"- UTF-8 to hex: {\"data\": \"hello world\", \"from\": \"utf8\", \"to\": \"hex\"} → 68656c6c6f20776f726c64\n" +
-		"- UTF-8 to base64: {\"data\": \"Hello World\", \"from\": \"utf8\", \"to\": \"base64\"} → SGVsbG8gV29ybGQ=\n" +
-		"- base64 to UTF-8: {\"data\": \"SGVsbG8gV29ybGQ=\", \"from\": \"base64\", \"to\": \"utf8\"} → Hello World\n" +
-		"- hex to base64: {\"data\": \"68656c6c6f20776f726c64\", \"from\": \"hex\", \"to\": \"base64\"} → aGVsbG8gd29ybGQ=\n\n" +
-		"Notes:\n" +
-		"- All parameters are required\n" +
-		"- The tool returns the converted data as a string\n" +
-		"- For binary conversion, data is represented as an array of byte values",
+			"Parameters:\n" +
+			"- data (required): The string to convert\n" +
+			"- from (required): Source encoding format (utf8, hex, base64, or binary)\n" +
+			"- to (required): Target encoding format (utf8, hex, base64, or binary)\n\n" +
+			"Example usage:\n" +
+			'- UTF-8 to hex: {"data": "hello world", "from": "utf8", "to": "hex"} → 68656c6c6f20776f726c64\n' +
+			'- UTF-8 to base64: {"data": "Hello World", "from": "utf8", "to": "base64"} → SGVsbG8gV29ybGQ=\n' +
+			'- base64 to UTF-8: {"data": "SGVsbG8gV29ybGQ=", "from": "base64", "to": "utf8"} → Hello World\n' +
+			'- hex to base64: {"data": "68656c6c6f20776f726c64", "from": "hex", "to": "base64"} → aGVsbG8gd29ybGQ=\n\n' +
+			"Notes:\n" +
+			"- All parameters are required\n" +
+			"- The tool returns the converted data as a string\n" +
+			"- For binary conversion, data is represented as an array of byte values",
 		{
 			args: z.object({
 				data: z.string().describe("The data string to be converted"),
-				from: encodingSchema.describe("Source encoding format (utf8, hex, base64, or binary)"),
-				to: encodingSchema.describe("Target encoding format to convert to (utf8, hex, base64, or binary)"),
+				from: encodingSchema.describe(
+					"Source encoding format (utf8, hex, base64, or binary)",
+				),
+				to: encodingSchema.describe(
+					"Target encoding format to convert to (utf8, hex, base64, or binary)",
+				),
 			}),
 		},
 		async ({ args }) => {

package/tools/wallet/createOrdinals.ts

@@ -2,13 +2,13 @@ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { createOrdinals } from "js-1sat-ord";
-import type { 
-	ChangeResult, 
-	Destination, 
-	Inscription, 
-	PreMAP,
+import type {
+	ChangeResult,
+	CreateOrdinalsCollectionItemMetadata,
 	CreateOrdinalsCollectionMetadata,
-	CreateOrdinalsCollectionItemMetadata
+	Destination,
+	Inscription,
+	PreMAP,
 } from "js-1sat-ord";
 import { z } from "zod";
 import type { Wallet } from "./wallet";
@@ -24,9 +24,15 @@ export const createOrdinalsArgsSchema = z.object({
 	// Content type (e.g., "image/jpeg", "text/plain", etc.)
 	contentType: z.string().describe("MIME type of the content"),
 	// Optional destination address (if not provided, uses the wallet's address)
-	destinationAddress: z.string().optional().describe("Optional destination address for the ordinal"),
+	destinationAddress: z
+		.string()
+		.optional()
+		.describe("Optional destination address for the ordinal"),
 	// Optional metadata for the inscription
-	metadata: z.any().optional().describe("Optional MAP metadata for the inscription")
+	metadata: z
+		.any()
+		.optional()
+		.describe("Optional MAP metadata for the inscription"),
 });
 
 export type CreateOrdinalsArgs = z.infer<typeof createOrdinalsArgsSchema>;
@@ -53,7 +59,9 @@ export function registerCreateOrdinalsTool(server: McpServer, wallet: Wallet) {
 				// 2. Get payment UTXOs from wallet
 				const { paymentUtxos } = await wallet.getUtxos();
 				if (!paymentUtxos || paymentUtxos.length === 0) {
-					throw new Error("No payment UTXOs available to fund this inscription");
+					throw new Error(
+						"No payment UTXOs available to fund this inscription",
+					);
 				}
 
 				// 3. Get the wallet address for change/destination if not provided
@@ -79,19 +87,25 @@ export function registerCreateOrdinalsTool(server: McpServer, wallet: Wallet) {
 					destinations,
 					paymentPk,
 					changeAddress: walletAddress,
-					metaData: args.metadata as PreMAP | CreateOrdinalsCollectionMetadata | CreateOrdinalsCollectionItemMetadata,
+					metaData: args.metadata as
+						| PreMAP
+						| CreateOrdinalsCollectionMetadata
+						| CreateOrdinalsCollectionItemMetadata,
 				});
 
 				const changeResult = result as ChangeResult;
-				
+
 				// 7. Broadcast the transaction
 				await changeResult.tx.broadcast();
-				
+
 				// 8. Refresh the wallet's UTXOs after spending
 				try {
 					await wallet.refreshUtxos();
 				} catch (refreshError) {
-					console.warn("Failed to refresh UTXOs after transaction:", refreshError);
+					console.warn(
+						"Failed to refresh UTXOs after transaction:",
+						refreshError,
+					);
 				}
 
 				// 9. Return transaction details

package/tools/wallet/getAddress.ts

@@ -11,7 +11,12 @@ export function registerGetAddressTool(server: McpServer): void {
 		"wallet_getAddress",
 		"Retrieves the current wallet's Bitcoin SV address. This address can be used to receive BSV, ordinals, or tokens, and is derived from the wallet's private key.",
 		{
-			args: z.object({}).optional().describe("No parameters required - simply returns the current wallet address"),
+			args: z
+				.object({})
+				.optional()
+				.describe(
+					"No parameters required - simply returns the current wallet address",
+				),
 		},
 		async () => {
 			try {

package/tools/wallet/purchaseListing.ts

@@ -7,9 +7,9 @@ import {
 	type ExistingListing,
 	type Payment,
 	type Royalty,
+	TokenType,
 	type TokenUtxo,
 	type Utxo,
-	TokenType,
 	oneSatBroadcaster,
 	purchaseOrdListing,
 	purchaseOrdTokenListing,
@@ -160,31 +160,30 @@ Please fund this wallet address with enough BSV to cover the purchase price
 
 				// Create the purchase transaction based on listing type
 				let transaction: ChangeResult;
-				
+
 				if (args.listingType === "token") {
 					if (!args.tokenProtocol) {
 						throw new Error("tokenProtocol is required for token listings");
 					}
-					
+
 					if (!args.tokenID) {
 						throw new Error("tokenID is required for token listings");
 					}
-					
+
 					// Validate token data from the listing
 					if (!listingData.data.bsv20) {
 						throw new Error("This is not a valid BSV-20 token listing");
 					}
-					
+
 					// For BSV-20, the amount should be included in the listing data
 					if (!listingData.data.bsv20.amt) {
 						throw new Error("Token listing doesn't have an amount specified");
 					}
-					
+
 					// Convert the token protocol to the enum type expected by js-1sat-ord
-					const protocol = args.tokenProtocol === "bsv-20" 
-						? TokenType.BSV20
-						: TokenType.BSV21;
-					
+					const protocol =
+						args.tokenProtocol === "bsv-20" ? TokenType.BSV20 : TokenType.BSV21;
+
 					// Create a TokenUtxo with the required fields
 					const listingUtxo: TokenUtxo = {
 						txid,
@@ -195,7 +194,7 @@ Please fund this wallet address with enough BSV to cover the purchase price
 						id: args.tokenID,
 						payout: listingData.data.list.payout,
 					};
-					
+
 					transaction = await purchaseOrdTokenListing({
 						protocol,
 						tokenID: args.tokenID,
@@ -214,13 +213,13 @@ Please fund this wallet address with enough BSV to cover the purchase price
 						script: listingData.script,
 						satoshis: listingData.satoshis,
 					};
-					
+
 					// Create the ExistingListing object for NFT listings
 					const listing: ExistingListing = {
 						payout: listingData.data.list.payout,
 						listingUtxo,
 					};
-					
+
 					// Check for royalties in the NFT origin data
 					// Royalties are only supported for NFTs, not for tokens
 					// The royalties are defined by the original creator as a JSON string
@@ -233,7 +232,7 @@ Please fund this wallet address with enough BSV to cover the purchase price
 							// Remove console.warn
 						}
 					}
-					
+
 					transaction = await purchaseOrdListing({
 						utxos: paymentUtxos,
 						paymentPk,
@@ -285,8 +284,11 @@ Please fund this wallet address with enough BSV to cover the purchase price
 								price: listingData.data.list.price,
 								marketFee,
 								marketFeeAddress: MARKET_WALLET_ADDRESS,
-								royaltiesPaid: args.listingType === "nft" && listingData.origin?.data?.map?.royalties ? 
-									JSON.parse(listingData.origin.data.map.royalties) : undefined,
+								royaltiesPaid:
+									args.listingType === "nft" &&
+									listingData.origin?.data?.map?.royalties
+										? JSON.parse(listingData.origin.data.map.royalties)
+										: undefined,
 							}),
 						},
 					],

package/tools/wallet/schemas.ts

@@ -73,14 +73,26 @@ export const walletDecryptArgsSchema = z.object({
 });
 
 // Combined wallet encryption/decryption args
-export const walletEncryptionArgsSchema = z.object({
-	mode: z.enum(["encrypt", "decrypt"]).describe("Operation mode: 'encrypt' to encrypt plaintext or 'decrypt' to decrypt data"),
-	data: z.union([
-		z.string().describe("Text data to encrypt or decrypt"),
-		z.array(z.number()).describe("Binary data to encrypt or decrypt")
-	]).describe("Data to process: text/data for encryption or decryption"),
-	encoding: z.enum(["utf8", "hex", "base64"]).optional().default("utf8").describe("Encoding of text data (default: utf8)"),
-}).describe("Schema for encryption and decryption operations");
+export const walletEncryptionArgsSchema = z
+	.object({
+		mode: z
+			.enum(["encrypt", "decrypt"])
+			.describe(
+				"Operation mode: 'encrypt' to encrypt plaintext or 'decrypt' to decrypt data",
+			),
+		data: z
+			.union([
+				z.string().describe("Text data to encrypt or decrypt"),
+				z.array(z.number()).describe("Binary data to encrypt or decrypt"),
+			])
+			.describe("Data to process: text/data for encryption or decryption"),
+		encoding: z
+			.enum(["utf8", "hex", "base64"])
+			.optional()
+			.default("utf8")
+			.describe("Encoding of text data (default: utf8)"),
+	})
+	.describe("Schema for encryption and decryption operations");
 
 // Create HMAC arguments
 export const createHmacArgsSchema = z.object({
@@ -278,30 +290,41 @@ export const sendToAddressArgsSchema = z.object({
 /**
  * Schema for purchase listing arguments
  */
-export const purchaseListingArgsSchema = z.object({
-	listingOutpoint: z
-		.string()
-		.describe("The outpoint of the listing to purchase (txid_vout format)"),
-	ordAddress: z
-		.string()
-		.describe("The ordinal address to receive the purchased item"),
-	listingType: z
-		.enum(["nft", "token"])
-		.default("nft")
-		.describe("Type of listing: 'nft' for ordinal NFTs, 'token' for BSV-20 tokens"),
-	tokenProtocol: z
-		.enum(["bsv-20", "bsv-21"])
-		.optional().default("bsv-21")
-		.describe("Token protocol for token listings (required when listingType is 'token')"),
-	tokenID: z
-		.string()
-		.optional()
-		.describe("Token ID for BSV-21 tokens or ticker for BSV-20 tokens (required when listingType is 'token')"),
-	description: z
-		.string()
-		.optional()
-		.describe("Optional description for the transaction"),
-}).describe("Schema for the wallet_purchaseListing tool arguments (purchase NFTs or tokens), with detailed field descriptions.");
+export const purchaseListingArgsSchema = z
+	.object({
+		listingOutpoint: z
+			.string()
+			.describe("The outpoint of the listing to purchase (txid_vout format)"),
+		ordAddress: z
+			.string()
+			.describe("The ordinal address to receive the purchased item"),
+		listingType: z
+			.enum(["nft", "token"])
+			.default("nft")
+			.describe(
+				"Type of listing: 'nft' for ordinal NFTs, 'token' for BSV-20 tokens",
+			),
+		tokenProtocol: z
+			.enum(["bsv-20", "bsv-21"])
+			.optional()
+			.default("bsv-21")
+			.describe(
+				"Token protocol for token listings (required when listingType is 'token')",
+			),
+		tokenID: z
+			.string()
+			.optional()
+			.describe(
+				"Token ID for BSV-21 tokens or ticker for BSV-20 tokens (required when listingType is 'token')",
+			),
+		description: z
+			.string()
+			.optional()
+			.describe("Optional description for the transaction"),
+	})
+	.describe(
+		"Schema for the wallet_purchaseListing tool arguments (purchase NFTs or tokens), with detailed field descriptions.",
+	);
 
 // Export types
 export type SendToAddressArgs = z.infer<typeof sendToAddressArgsSchema>;

package/tools/wallet/sendOrdinals.ts

@@ -10,12 +10,19 @@ import type { Wallet } from "./wallet";
  * Schema for the sendOrdinals tool arguments
  */
 export const sendOrdinalsArgsSchema = z.object({
-  // Outpoint of the inscription to send (txid_vout format)
-  inscriptionOutpoint: z.string().describe("Inscription outpoint in format txid_vout"),
-  // Destination address to send the inscription to
-  destinationAddress: z.string().describe("Destination address for the inscription"),
-  // Optional metadata for the ordinal transfer
-  metadata: z.any().optional().describe("Optional MAP metadata for the transfer"),
+	// Outpoint of the inscription to send (txid_vout format)
+	inscriptionOutpoint: z
+		.string()
+		.describe("Inscription outpoint in format txid_vout"),
+	// Destination address to send the inscription to
+	destinationAddress: z
+		.string()
+		.describe("Destination address for the inscription"),
+	// Optional metadata for the ordinal transfer
+	metadata: z
+		.any()
+		.optional()
+		.describe("Optional MAP metadata for the transfer"),
 });
 
 export type SendOrdinalsArgs = z.infer<typeof sendOrdinalsArgsSchema>;
@@ -24,97 +31,104 @@ export type SendOrdinalsArgs = z.infer<typeof sendOrdinalsArgsSchema>;
  * Registers the wallet_sendOrdinals tool for transferring ordinals
  */
 export function registerSendOrdinalsTool(server: McpServer, wallet: Wallet) {
-  server.tool(
-    "wallet_sendOrdinals",
-    "Transfers ordinals (NFTs) from your wallet to another address on the Bitcoin SV blockchain. This tool enables sending inscriptions you own to any valid BSV address. The transaction is created, signed, and broadcast automatically, with appropriate fee calculation and change handling.",
-    { args: sendOrdinalsArgsSchema },
-    async (
-      { args }: { args: SendOrdinalsArgs },
-      extra: RequestHandlerExtra,
-    ): Promise<CallToolResult> => {
-      try {
-        // 1. Get private key from wallet
-        const paymentPk = wallet.getPrivateKey();
-        if (!paymentPk) {
-          throw new Error("No private key available in wallet");
-        }
+	server.tool(
+		"wallet_sendOrdinals",
+		"Transfers ordinals (NFTs) from your wallet to another address on the Bitcoin SV blockchain. This tool enables sending inscriptions you own to any valid BSV address. The transaction is created, signed, and broadcast automatically, with appropriate fee calculation and change handling.",
+		{ args: sendOrdinalsArgsSchema },
+		async (
+			{ args }: { args: SendOrdinalsArgs },
+			extra: RequestHandlerExtra,
+		): Promise<CallToolResult> => {
+			try {
+				// 1. Get private key from wallet
+				const paymentPk = wallet.getPrivateKey();
+				if (!paymentPk) {
+					throw new Error("No private key available in wallet");
+				}
 
-        // 2. Get payment UTXOs from wallet
-        const { paymentUtxos, nftUtxos } = await wallet.getUtxos();
-        if (!paymentUtxos || paymentUtxos.length === 0) {
-          throw new Error("No payment UTXOs available to fund this transaction");
-        }
+				// 2. Get payment UTXOs from wallet
+				const { paymentUtxos, nftUtxos } = await wallet.getUtxos();
+				if (!paymentUtxos || paymentUtxos.length === 0) {
+					throw new Error(
+						"No payment UTXOs available to fund this transaction",
+					);
+				}
 
-        // 3. Get the wallet address for change
-        const walletAddress = paymentPk.toAddress().toString();
+				// 3. Get the wallet address for change
+				const walletAddress = paymentPk.toAddress().toString();
 
-        // 4. Parse the inscription outpoint
-        const [txid, voutStr] = args.inscriptionOutpoint.split('_');
-        if (!txid || !voutStr) {
-          throw new Error("Invalid inscription outpoint format. Expected txid_vout");
-        }
-        const vout = Number.parseInt(voutStr, 10);
-        
-        // 5. Find the inscription in nftUtxos
-        const inscription = nftUtxos.find(
-          (utxo) => utxo.txid === txid && utxo.vout === vout
-        );
-        
-        if (!inscription) {
-          throw new Error(
-            `Inscription ${args.inscriptionOutpoint} not found in your wallet`
-          );
-        }
+				// 4. Parse the inscription outpoint
+				const [txid, voutStr] = args.inscriptionOutpoint.split("_");
+				if (!txid || !voutStr) {
+					throw new Error(
+						"Invalid inscription outpoint format. Expected txid_vout",
+					);
+				}
+				const vout = Number.parseInt(voutStr, 10);
 
-        // 6. Create config and transfer the inscription
-        const sendOrdinalsConfig: SendOrdinalsConfig = {
-          paymentPk,
-          paymentUtxos,
-          ordinals: [inscription],
-          destinations: [{ address: args.destinationAddress }],
-          changeAddress: walletAddress,
-        };
+				// 5. Find the inscription in nftUtxos
+				const inscription = nftUtxos.find(
+					(utxo) => utxo.txid === txid && utxo.vout === vout,
+				);
 
-        // Add metadata if provided
-        if (args.metadata) {
-          sendOrdinalsConfig.metaData = args.metadata;
-        }
+				if (!inscription) {
+					throw new Error(
+						`Inscription ${args.inscriptionOutpoint} not found in your wallet`,
+					);
+				}
 
-        // Using the wallet's key for both payment and ordinals
-        sendOrdinalsConfig.ordPk = paymentPk;
+				// 6. Create config and transfer the inscription
+				const sendOrdinalsConfig: SendOrdinalsConfig = {
+					paymentPk,
+					paymentUtxos,
+					ordinals: [inscription],
+					destinations: [{ address: args.destinationAddress }],
+					changeAddress: walletAddress,
+				};
 
-        const result = await sendOrdinals(sendOrdinalsConfig);
-        const changeResult = result as ChangeResult;
-        
-        // 7. Broadcast the transaction
-        await changeResult.tx.broadcast();
-        
-        // 8. Refresh the wallet's UTXOs after spending
-        try {
-          await wallet.refreshUtxos();
-        } catch (refreshError) {
-          console.warn("Failed to refresh UTXOs after transaction:", refreshError);
-        }
+				// Add metadata if provided
+				if (args.metadata) {
+					sendOrdinalsConfig.metaData = args.metadata;
+				}
 
-        // 9. Return transaction details
-        return {
-          content: [
-            {
-              type: "text",
-              text: JSON.stringify({
-                txid: changeResult.tx.id("hex"),
-                spentOutpoints: changeResult.spentOutpoints,
-                payChange: changeResult.payChange,
-                inscriptionOutpoint: args.inscriptionOutpoint,
-                destinationAddress: args.destinationAddress,
-              }),
-            },
-          ],
-        };
-      } catch (err: unknown) {
-        const msg = err instanceof Error ? err.message : String(err);
-        return { content: [{ type: "text", text: msg }], isError: true };
-      }
-    },
-  );
-} 
+				// Using the wallet's key for both payment and ordinals
+				sendOrdinalsConfig.ordPk = paymentPk;
+
+				const result = await sendOrdinals(sendOrdinalsConfig);
+				const changeResult = result as ChangeResult;
+
+				// 7. Broadcast the transaction
+				await changeResult.tx.broadcast();
+
+				// 8. Refresh the wallet's UTXOs after spending
+				try {
+					await wallet.refreshUtxos();
+				} catch (refreshError) {
+					console.warn(
+						"Failed to refresh UTXOs after transaction:",
+						refreshError,
+					);
+				}
+
+				// 9. Return transaction details
+				return {
+					content: [
+						{
+							type: "text",
+							text: JSON.stringify({
+								txid: changeResult.tx.id("hex"),
+								spentOutpoints: changeResult.spentOutpoints,
+								payChange: changeResult.payChange,
+								inscriptionOutpoint: args.inscriptionOutpoint,
+								destinationAddress: args.destinationAddress,
+							}),
+						},
+					],
+				};
+			} catch (err: unknown) {
+				const msg = err instanceof Error ? err.message : String(err);
+				return { content: [{ type: "text", text: msg }], isError: true };
+			}
+		},
+	);
+}

package/tools/wallet/sendToAddress.ts

@@ -3,9 +3,9 @@ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import { toSatoshi } from "satoshi-token";
 import type { z } from "zod";
+import { getBsvPriceWithCache } from "../bsv/getPrice";
 import { sendToAddressArgsSchema } from "./schemas";
 import type { Wallet } from "./wallet";
-import { getBsvPriceWithCache } from "../bsv/getPrice";
 
 // Use the schema imported from schemas.ts
 export type SendToAddressArgs = z.infer<typeof sendToAddressArgsSchema>;

package/tools/wallet/tools.test.ts

@@ -11,7 +11,7 @@ type WalletToolName =
 	| "wallet_getPublicKey"
 	| "wallet_createSignature"
 	| "wallet_verifySignature"
-	| "wallet_encryption";	
+	| "wallet_encryption";
 
 const toolNames: WalletToolName[] = [
 	"wallet_getPublicKey",
@@ -34,9 +34,9 @@ function getDummyArgs(tool: WalletToolName): Record<string, unknown> {
 				signature: "sig",
 				publicKey: "pubkey",
 			};
-			// TODO we merged encrypt and decrypt into encryption we need to update the test file
+		// TODO we merged encrypt and decrypt into encryption we need to update the test file
 		// case "wallet_encryption":
-		// 	if 
+		// 	if
 		// 	return { data: "test", publicKey: "pubkey" };
 		// case "wallet_decryption":
 		// 	return { encryptedData: "data" };