bsv-mcp 0.0.21 → 0.0.23

package/tools/wallet/tools.ts

@@ -1,7 +1,11 @@
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { ToolCallback } from "@modelcontextprotocol/sdk/server/mcp.js";
 import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import type {
+	CallToolResult,
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
 import type { z } from "zod";
 import type {
 	abortActionArgsSchema,
@@ -34,6 +38,7 @@ import {
 	walletEncryptionArgsSchema,
 } from "./schemas";
 
+import { Utils, type WalletProtocol } from "@bsv/sdk";
 import { registerCreateOrdinalsTool } from "./createOrdinals";
 import type { createOrdinalsArgsSchema } from "./createOrdinals";
 import { registerGetAddressTool } from "./getAddress";
@@ -41,7 +46,6 @@ import { registerPurchaseListingTool } from "./purchaseListing";
 import { registerSendToAddressTool } from "./sendToAddress";
 import { registerTransferOrdTokenTool } from "./transferOrdToken";
 import type { transferOrdTokenArgsSchema } from "./transferOrdToken";
-import { Utils, type WalletProtocol } from "@bsv/sdk";
 
 // Define mapping from tool names to argument schemas
 type ToolArgSchemas = {
@@ -79,7 +83,7 @@ type ToolArgSchemas = {
 // Define a type for the handler function with proper argument types
 type ToolHandler = (
 	params: { args: unknown },
-	extra: RequestHandlerExtra,
+	extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
 ) => Promise<CallToolResult>;
 
 // Define a map type for tool name to handler functions
@@ -127,7 +131,7 @@ export function registerWalletTools(
 		{ args: getPublicKeyArgsSchema },
 		async (
 			{ args }: { args: z.infer<typeof getPublicKeyArgsSchema> },
-			extra: RequestHandlerExtra,
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
 		) => {
 			try {
 				const result = await wallet.getPublicKey(args);
@@ -146,7 +150,7 @@ export function registerWalletTools(
 		{ args: createSignatureArgsSchema },
 		async (
 			{ args }: { args: z.infer<typeof createSignatureArgsSchema> },
-			extra: RequestHandlerExtra,
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
 		) => {
 			try {
 				const result = await wallet.createSignature(args);
@@ -165,7 +169,7 @@ export function registerWalletTools(
 		{ args: verifySignatureArgsSchema },
 		async (
 			{ args }: { args: z.infer<typeof verifySignatureArgsSchema> },
-			extra: RequestHandlerExtra,
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
 		) => {
 			try {
 				const result = await wallet.verifySignature(args);
@@ -181,33 +185,33 @@ export function registerWalletTools(
 	registerTool(
 		"wallet_encryption",
 		"Combined tool for encrypting and decrypting data using the wallet's cryptographic keys.\n\n" +
-		"PARAMETERS:\n" +
-		"- mode: (required) Either \"encrypt\" to encrypt plaintext or \"decrypt\" to decrypt ciphertext\n" +
-		"- data: (required) Text string or array of numbers to process\n" +
-		"- encoding: (optional) For text input, the encoding format (utf8, hex, base64) - default is utf8\n\n" +
-		"EXAMPLES:\n" +
-		"1. Encrypt text data:\n" +
-		"   {\n" +
-		"     \"mode\": \"encrypt\",\n" +
-		"     \"data\": \"Hello World\"\n" +
-		"   }\n\n" +
-		"2. Decrypt previously encrypted data:\n" +
-		"   {\n" +
-		"     \"mode\": \"decrypt\",\n" +
-		"     \"data\": [encrypted bytes from previous response]\n" +
-		"   }",
+			"PARAMETERS:\n" +
+			'- mode: (required) Either "encrypt" to encrypt plaintext or "decrypt" to decrypt ciphertext\n' +
+			"- data: (required) Text string or array of numbers to process\n" +
+			"- encoding: (optional) For text input, the encoding format (utf8, hex, base64) - default is utf8\n\n" +
+			"EXAMPLES:\n" +
+			"1. Encrypt text data:\n" +
+			"   {\n" +
+			'     "mode": "encrypt",\n' +
+			'     "data": "Hello World"\n' +
+			"   }\n\n" +
+			"2. Decrypt previously encrypted data:\n" +
+			"   {\n" +
+			'     "mode": "decrypt",\n' +
+			'     "data": [encrypted bytes from previous response]\n' +
+			"   }",
 		{ args: walletEncryptionArgsSchema },
 		async (
 			{ args }: { args: z.infer<typeof walletEncryptionArgsSchema> },
-			extra: RequestHandlerExtra,
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
 		) => {
 			try {
 				const { mode, data, encoding } = args;
-				
+
 				// Set default values for required parameters
 				const protocolID: WalletProtocol = [1, "aes256"];
 				const keyID = "default";
-				
+
 				// Convert string data to binary if needed
 				let binaryData: number[];
 				if (Array.isArray(data)) {
@@ -217,8 +221,9 @@ export function registerWalletTools(
 					const { toArray } = Utils;
 					binaryData = toArray(data, encoding || "utf8");
 				}
-				
-				let result: { ciphertext?: number[]; plaintext?: number[] | string } = {};
+
+				let result: { ciphertext?: number[]; plaintext?: number[] | string } =
+					{};
 				if (mode === "encrypt") {
 					result = await wallet.encrypt({
 						plaintext: binaryData,
@@ -231,7 +236,7 @@ export function registerWalletTools(
 						protocolID,
 						keyID,
 					});
-					
+
 					// For decryption, convert plaintext back to string if it's likely UTF-8 text
 					if (result.plaintext as number[]) {
 						try {
@@ -239,11 +244,13 @@ export function registerWalletTools(
 							const textResult = toUTF8(result.plaintext as number[]);
 							// If conversion succeeds and seems like valid text, return as string
 							if (textResult && textResult.length > 0) {
-								return { 
-									content: [{ 
-										type: "text", 
-										text: JSON.stringify({ plaintext: textResult }) 
-									}] 
+								return {
+									content: [
+										{
+											type: "text",
+											text: JSON.stringify({ plaintext: textResult }),
+										},
+									],
 								};
 							}
 						} catch (e) {
@@ -251,13 +258,19 @@ export function registerWalletTools(
 						}
 					}
 				}
-				
+
 				return { content: [{ type: "text", text: JSON.stringify(result) }] };
 			} catch (error) {
-				const errorMessage = error instanceof Error ? error.message : String(error);
-				return { 
-					content: [{ type: "text", text: `Error during ${args.mode}: ${errorMessage}` }],
-					isError: true
+				const errorMessage =
+					error instanceof Error ? error.message : String(error);
+				return {
+					content: [
+						{
+							type: "text",
+							text: `Error during ${args.mode}: ${errorMessage}`,
+						},
+					],
+					isError: true,
 				};
 			}
 		},
@@ -265,6 +278,6 @@ export function registerWalletTools(
 
 	// Register createOrdinals tool
 	registerCreateOrdinalsTool(server, wallet);
-	
+
 	return handlers;
 }

package/tools/wallet/transferOrdToken.ts

@@ -0,0 +1,138 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import type {
+	ServerNotification,
+	ServerRequest,
+} from "@modelcontextprotocol/sdk/types.js";
+import {
+	type Distribution,
+	type Payment,
+	type TokenChangeResult,
+	TokenInputMode,
+	TokenSelectionStrategy,
+	TokenType,
+	type TokenUtxo,
+	type TransferOrdTokensConfig,
+	type Utxo,
+	selectTokenUtxos,
+	transferOrdTokens,
+} from "js-1sat-ord";
+import { z } from "zod";
+import type { Wallet } from "./wallet";
+
+// Schema for BSV-20/BSV-21 token transfer arguments
+export const transferOrdTokenArgsSchema = z.object({
+	protocol: z.enum(["bsv-20", "bsv-21"]),
+	tokenID: z.string(),
+	sendAmount: z.number(),
+	paymentUtxos: z.array(
+		z.object({
+			txid: z.string(),
+			vout: z.number(),
+			satoshis: z.number(),
+			script: z.string(),
+		}),
+	),
+	tokenUtxos: z.array(
+		z.object({
+			txid: z.string(),
+			vout: z.number(),
+			satoshis: z.literal(1),
+			script: z.string(),
+			amt: z.string(),
+			id: z.string(),
+		}),
+	),
+	distributions: z.array(z.object({ address: z.string(), tokens: z.number() })),
+	decimals: z.number(),
+	additionalPayments: z
+		.array(z.object({ to: z.string(), amount: z.number() }))
+		.optional(),
+});
+export type TransferOrdTokenArgs = z.infer<typeof transferOrdTokenArgsSchema>;
+
+/**
+ * Register the wallet_transferOrdToken tool for transferring BSV tokens.
+ */
+export function registerTransferOrdTokenTool(
+	server: McpServer,
+	wallet: Wallet,
+) {
+	server.tool(
+		"wallet_transferOrdToken",
+		"Transfers BSV-20 or BSV-21 tokens from your wallet via js-1sat-ord transferOrdTokens.",
+		{ args: transferOrdTokenArgsSchema },
+		async (
+			{ args }: { args: TransferOrdTokenArgs },
+			extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
+		) => {
+			try {
+				// fetch keys
+				const paymentPk = wallet.getPrivateKey();
+				if (!paymentPk) throw new Error("No private key available");
+				const ordPk = paymentPk;
+				const changeAddress = paymentPk.toAddress().toString();
+				const ordAddress = changeAddress;
+
+				// select token UTXOs
+				const { selectedUtxos: inputTokens } = selectTokenUtxos(
+					args.tokenUtxos as TokenUtxo[],
+					args.sendAmount,
+					args.decimals,
+					{
+						inputStrategy: TokenSelectionStrategy.SmallestFirst,
+						outputStrategy: TokenSelectionStrategy.LargestFirst,
+					},
+				);
+
+				// build config
+				const config: TransferOrdTokensConfig = {
+					protocol:
+						args.protocol === "bsv-20" ? TokenType.BSV20 : TokenType.BSV21,
+					tokenID: args.tokenID,
+					utxos: args.paymentUtxos as Utxo[],
+					inputTokens,
+					distributions: args.distributions as Distribution[],
+					tokenChangeAddress: ordAddress,
+					changeAddress,
+					paymentPk,
+					ordPk,
+					additionalPayments: (args.additionalPayments as Payment[]) || [],
+					decimals: args.decimals,
+					inputMode: TokenInputMode.Needed,
+					splitConfig: {
+						outputs: inputTokens.length === 1 ? 2 : 1,
+						threshold: args.sendAmount,
+					},
+				};
+
+				// execute transfer
+				const result: TokenChangeResult = await transferOrdTokens(config);
+				await result.tx.broadcast();
+
+				// refresh UTXOs
+				try {
+					await wallet.refreshUtxos();
+				} catch {}
+
+				// respond
+				return {
+					content: [
+						{
+							type: "text",
+							text: JSON.stringify({
+								txid: result.tx.id("hex"),
+								spentOutpoints: result.spentOutpoints,
+								payChange: result.payChange,
+								tokenChange: result.tokenChange,
+							}),
+						},
+					],
+				};
+			} catch (err: unknown) {
+				const msg = err instanceof Error ? err.message : String(err);
+				return { content: [{ type: "text", text: msg }], isError: true };
+			}
+		},
+	);
+}

package/tools/wallet/wallet.ts

@@ -5,12 +5,7 @@
  *
  * See: https://github.com/bitcoin-sv/ts-sdk/blob/main/src/wallet/Wallet.interfaces.ts
  */
-import {
-	LockingScript,
-	PrivateKey,
-	ProtoWallet,
-	Transaction,
-} from "@bsv/sdk";
+import { LockingScript, PrivateKey, ProtoWallet, Transaction } from "@bsv/sdk";
 import type {
 	AbortActionArgs,
 	AbortActionResult,
@@ -87,13 +82,12 @@ export class Wallet extends ProtoWallet implements WalletInterface {
 			}
 
 			const address = privateKey.toAddress();
-			
+
 			const utxos = await fetchPayUtxos(address);
 			const nftUtxos = await fetchNftUtxos(address);
 			this.paymentUtxos = utxos;
 			this.nftUtxos = nftUtxos;
 			this.lastUtxoFetch = Date.now();
-
 		} catch (error) {
 			console.error("Error refreshing UTXOs:", error);
 			throw error;
@@ -130,7 +124,7 @@ export class Wallet extends ProtoWallet implements WalletInterface {
 		if (!privateKey) {
 			throw new Error("No private key available");
 		}
-		
+
 		const publicKey = privateKey.toPublicKey();
 		return {
 			publicKey: publicKey.toDER("hex") as PubKeyHex,

package/tools/wallet/transferOrdToken/index.ts

@@ -1,103 +0,0 @@
-import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { z } from "zod";
-import {
-  transferOrdTokens,
-  TokenType,
-  TokenInputMode,
-  TokenSelectionStrategy,
-  selectTokenUtxos,
-  type TransferOrdTokensConfig,
-  type Utxo,
-  type TokenUtxo,
-  type Payment,
-  type Distribution,
-  type TokenChangeResult,
-} from "js-1sat-ord";
-import type { Wallet } from "../wallet";
-
-// Schema for BSV-20/BSV-21 token transfer arguments
-export const transferOrdTokenArgsSchema = z.object({
-  protocol: z.enum(["bsv-20", "bsv-21"]),
-  tokenID: z.string(),
-  sendAmount: z.number(),
-  paymentUtxos: z.array(
-    z.object({ txid: z.string(), vout: z.number(), satoshis: z.number(), script: z.string() })
-  ),
-  tokenUtxos: z.array(
-    z.object({ txid: z.string(), vout: z.number(), satoshis: z.literal(1), script: z.string(), amt: z.string(), id: z.string() })
-  ),
-  distributions: z.array(z.object({ address: z.string(), tokens: z.number() })),
-  decimals: z.number(),
-  additionalPayments: z.array(z.object({ to: z.string(), amount: z.number() })).optional(),
-});
-export type TransferOrdTokenArgs = z.infer<typeof transferOrdTokenArgsSchema>;
-
-/**
- * Register the wallet_transferOrdToken tool for transferring BSV tokens.
- */
-export function registerTransferOrdTokenTool(server: McpServer, wallet: Wallet) {
-  server.tool(
-    "wallet_transferOrdToken",
-    "Transfers BSV-20 or BSV-21 tokens from your wallet via js-1sat-ord transferOrdTokens.",
-    { args: transferOrdTokenArgsSchema },
-    async (
-      { args }: { args: TransferOrdTokenArgs },
-      extra: RequestHandlerExtra
-    ) => {
-      try {
-        // fetch keys
-        const paymentPk = wallet.getPrivateKey();
-        if (!paymentPk) throw new Error("No private key available");
-        const ordPk = paymentPk;
-        const changeAddress = paymentPk.toAddress().toString();
-        const ordAddress = changeAddress;
-
-        // select token UTXOs
-        const { selectedUtxos: inputTokens } = selectTokenUtxos(
-          args.tokenUtxos as TokenUtxo[],
-          args.sendAmount,
-          args.decimals,
-          { inputStrategy: TokenSelectionStrategy.SmallestFirst, outputStrategy: TokenSelectionStrategy.LargestFirst }
-        );
-
-        // build config
-        const config: TransferOrdTokensConfig = {
-          protocol: args.protocol === "bsv-20" ? TokenType.BSV20 : TokenType.BSV21,
-          tokenID: args.tokenID,
-          utxos: args.paymentUtxos as Utxo[],
-          inputTokens,
-          distributions: args.distributions as Distribution[],
-          tokenChangeAddress: ordAddress,
-          changeAddress,
-          paymentPk,
-          ordPk,
-          additionalPayments: args.additionalPayments as Payment[] || [],
-          decimals: args.decimals,
-          inputMode: TokenInputMode.Needed,
-          splitConfig: { outputs: inputTokens.length === 1 ? 2 : 1, threshold: args.sendAmount },
-        };
-
-        // execute transfer
-        const result: TokenChangeResult = await transferOrdTokens(config);
-        await result.tx.broadcast();
-
-        // refresh UTXOs
-        try { await wallet.refreshUtxos(); } catch {}
-
-        // respond
-        return {
-          content: [{ type: "text", text: JSON.stringify({
-            txid: result.tx.id("hex"),
-            spentOutpoints: result.spentOutpoints,
-            payChange: result.payChange,
-            tokenChange: result.tokenChange,
-          }) }]
-        };
-      } catch (err: unknown) {
-        const msg = err instanceof Error ? err.message : String(err);
-        return { content: [{ type: "text", text: msg }], isError: true };
-      }
-    }
-  );
-}